Skip to content

Latest commit

 

History

History
174 lines (117 loc) · 3.8 KB

USAGE.md

File metadata and controls

174 lines (117 loc) · 3.8 KB

Usage

$ aqua-registry help
NAME:
   aqua-registry - CLI to develop aqua Registry. https://github.com/aquaproj/registry-tool

USAGE:
   aqua-registry [global options] command [command options] [arguments...]

VERSION:
   0.1.4 (d7c108f77ea8576de6e7ece77f5fa07ef66a6d0e)

COMMANDS:
   scaffold               Scaffold a package
   create-pr-new-pkg      Create a pull request to add new packages
   generate-registry, gr  Update registry.yaml
   completion             Output shell completion script for bash or zsh
   version                Show version
   init                   Create configuration files
   patch-checksum         Patch a checksum configuration
   help, h                Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h         show help (default: false)
   --log-level value  log level [$AQUA_LOG_LEVEL]
   --version, -v      print the version (default: false)

aqua-registry scaffold

$ aqua-registry help scaffold
NAME:
   aqua-registry scaffold - Scaffold a package

USAGE:
   $ aqua-registry scaffold <package name>

DESCRIPTION:
   Scaffold a package.
   
   aqua >= v1.14.0 is required.
   
   e.g.
   
   $ aqua-registry scaffold cli/cli
   
   This tool does the following things.
   
   1. Scaffold configuration files.
   1. Install packages for testing
   
   --
   
   1. Create directories pkgs/<package name>
   2. Create pkgs/<package name>/pkg.yaml and pkgs/<package name>/registry.yaml
   3. Update registry.yaml
   4. Create or update aqua.yaml
   5. aqua g -i <package name>
   6. aqua i

aqua-registry create-pr-new-pkg

$ aqua-registry help create-pr-new-pkg
NAME:
   aqua-registry create-pr-new-pkg - Create a pull request to add new packages

USAGE:
   aqua-registry create-pr-new-pkg <package name> [<package name> ...]

DESCRIPTION:
   Create a pull request to add new packages.
   
   e.g.
   
   $ aqua-registry create-pr-new-pkg cli/cli
   
   This tool does the following things.
   
   1. Create a feature branch
   2. Create a commit
   3. Push the commit to origin
   4. Open a web browser to create a request with GitHub CLI

aqua-registry init

$ aqua-registry help init
NAME:
   aqua-registry init - Create configuration files

USAGE:
   $ aqua-registry init

DESCRIPTION:
   Create configuration files.
   
   * aqua.yaml
   * aqua-dev.yaml

aqua-registry generate-registry

$ aqua-registry help generate-registry
NAME:
   aqua-registry generate-registry - Update registry.yaml

USAGE:
   aqua-registry gr

DESCRIPTION:
   Update registry.yaml
   
   This command updates registry.yaml on the repository root directory.
   Don't edit it manually, and if you update registry.yaml in the pkgs directory, don't forget to run this command.
   
   No argument is needed.

aqua-registry patch-checksum

$ aqua-registry help patch-checksum
NAME:
   aqua-registry patch-checksum - Patch a checksum configuration

USAGE:
   $ aqua-registry patch-checksum <registry configuration file path>

DESCRIPTION:
   Patch a checksum configuration.
   
   e.g.
   
   $ aqua-registry patch-checksum pkgs/suzuki-shunsuke/tfcmt/registry.yaml

aqua-registry completion

$ aqua-registry help completion
NAME:
   aqua-registry completion - Output shell completion script for bash or zsh

USAGE:
   aqua-registry completion [arguments...]

DESCRIPTION:
   Output shell completion script for bash or zsh
   Run these commands in .bash_profile or .zprofile
   e.g.
   .bash_profile
   
   if command -v aqua-registry &> /dev/null; then source <(aqua-registry completion bash); fi
   
   .zprofile
   
   if command -v aqua-registry &> /dev/null; then source <(aqua-registry completion zsh); fi