Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update usage for v2.15.0 #614

Merged
merged 1 commit into from
Oct 18, 2023
Merged

update usage for v2.15.0 #614

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 29 additions & 11 deletions docs/reference/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ USAGE:
aqua [global options] command [command options] [arguments...]

VERSION:
2.14.1 (4afbe990358dcf79950d31aa684bc26ae2e0cee6)
2.15.0 (3fd0124deb506011ed0681185ac3c4c0da7b5e09)

COMMANDS:
init Create a configuration file if it doesn't exist
info Show information
init-policy [Deprecated] Create a policy file if it doesn't exist
policy Manage Policy
install, i Install tools
update-aqua Update aqua
update-aqua, upa Update aqua
generate, g Search packages in registries and output the configuration interactively
which Output the absolute file path of the given command
exec Execute tool
Expand Down Expand Up @@ -459,27 +459,45 @@ DESCRIPTION:

$ aqua gr cli/[email protected]

By default, aqua gr doesn't generate version_overrides.
If --deep is set, aqua generates version_overrides.
By default, aqua gr gets all GitHub Releases to generate version_overrides.
You can limit the number of GitHub Releases by --limit.

e.g.

$ aqua gr --deep suzuki-shunsuke/tfcmt

Note that if --deep is set, GitHub API is called per GitHub Release.
This may cause GitHub API rate limiting.
$ aqua gr --limit 100 suzuki-shunsuke/tfcmt

If --out-testdata is set, aqua inserts testdata into the specified file.

e.g.

$ aqua gr --out-testdata testdata.yaml suzuki-shunsuke/tfcmt

If -cmd is set, aqua sets files.

e.g.

$ aqua gr -cmd gh cli/cli

files:
- name: gh

You can specify multiple commands with commas ",".

e.g.

$ aqua gr -cmd age,age-keygen FiloSottile/age

files:
- name: age
- name: age-keygen


OPTIONS:
--out-testdata value A file path where the testdata is outputted
--deep Resolve version_overrides (default: false)
--help, -h show help
--out-testdata value A file path where the testdata is outputted
--cmd value A list of commands joined with single quotes ','
--limit value, -l value the maximum number of versions (default: 0)
--deep This flag was deprecated and had no meaning from aqua v2.15.0. This flag will be removed in aqua v3.0.0. https://github.com/aquaproj/aqua/issues/2351 (default: false)
--help, -h show help
```

## aqua list
Expand Down