diff --git a/README.adoc b/README.adoc index 24aa0b5..8893260 100644 --- a/README.adoc +++ b/README.adoc @@ -29,6 +29,9 @@ To learn how to update the documentation, see the https://datastax.jira.com/wiki The Astra CLI command reference documentation is generated from the literal CLI help text in the Astra CLI code. The command reference documentation should be regenerated and committed to the docs whenever a new version of the Astra CLI is released. +You need a recent JDK installed. +You do not need the Astra CLI itself installed. + . If you haven't done so yet, clone the Astra CLI code repository: + [source,bash] @@ -50,13 +53,25 @@ cd astra-cli git switch main && git pull ---- -. Run the following command to regenerate the command reference docs: +. Set the path to your local clone of this documentation repository (`astra-cli-docs`): ++ +[source,bash] +---- +ASTRA_CLI_DOCS=~/repos/astra-cli-docs +---- + +. Load the Astra CLI development alias: + [source,bash] ---- -source scripts/dev-alias.sh; astra docs && \ - rsync -a --delete build/docs/commands/ ~/repos/astra-cli-docs/modules/commands/pages/ && \ - cp -f build/docs/partial-nav.adoc ~/repos/astra-cli-docs/modules/commands/partials/ +source scripts/dev-alias.sh ---- + +. Regenerate the command reference docs: + -Replace `repos` with the appropriate path to your cloned repositories. +[source,bash] +---- +astra docs && \ + rsync -a --delete build/docs/commands/ $ASTRA_CLI_DOCS/modules/commands/pages/ && \ + cp -f build/docs/partial-nav.adoc $ASTRA_CLI_DOCS/modules/commands/partials/ +---- diff --git a/modules/commands/pages/astra-completions.adoc b/modules/commands/pages/astra-completions.adoc index 6c95a6c..b50e53d 100644 --- a/modules/commands/pages/astra-completions.adoc +++ b/modules/commands/pages/astra-completions.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra completions [-n=<$cliName>] +astra completions [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-h[=all]] [-n=<$cliName>] [-o=FORMAT] ---- @@ -20,8 +21,20 @@ See the help for the ``astra shellenv`` command to setup completions in your she `-n`, `--cli-name`:: CLI name to use in the completion script +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- # Put this in your shell profile (e.g. ``~/.zprofile``) to generate completions and set your PATH diff --git a/modules/commands/pages/astra-config-create.adoc b/modules/commands/pages/astra-config-create.adoc index 42ffb00..79e5d67 100644 --- a/modules/commands/pages/astra-config-create.adoc +++ b/modules/commands/pages/astra-config-create.adoc @@ -2,9 +2,10 @@ [source,shell] ---- -astra config create [-dqV] [--no-input] [--[no-]overwrite] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [-cf=PATH] [-e=ENV] - [-o=FORMAT] -t=TOKEN [NAME] +astra config create [-dqV] [--no-input] [--[no-]overwrite] [--[no-]spinner] [-- + [no-]validate] [--color[=WHEN]] [--dump-logs[=FILE]] [-h + [=all]] [-cf=PATH] [-e=ENV] [--local-endpoint=URL] + [-o=FORMAT] [-t=TOKEN] [NAME] ---- @@ -22,13 +23,14 @@ Use the ``--token @`` syntax to securely read the token from a file, witho `NAME`:: Unique name for the profile `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved. `-t`, `--token`:: Astra token (``AstraCS:...``) or ``@`` to read from file -`-e`, `--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. +`-e`, `--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. +`--local-endpoint`:: The endpoint URL for local Astra environments (required when --env local) `-d`, `--default`:: Set the created profile as the default profile. Same as 'config use ' `--overwrite`:: Overwrite any existing profile with the same name +`--validate`:: Validate the token by making a request to the Astra -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -36,10 +38,11 @@ Use the ``--token @`` syntax to securely read the token from a file, witho `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # (Recommended) Interactively create a new profile diff --git a/modules/commands/pages/astra-config-delete.adoc b/modules/commands/pages/astra-config-delete.adoc index 58987f9..2ade657 100644 --- a/modules/commands/pages/astra-config-delete.adoc +++ b/modules/commands/pages/astra-config-delete.adoc @@ -3,7 +3,8 @@ [source,shell] ---- astra config delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-cf=PATH] [-o=FORMAT] [NAME] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-cf=PATH] + [-o=FORMAT] [NAME] ---- @@ -20,9 +21,8 @@ Delete an existing configuration profile. `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved. `--if-exists`:: Do not fail if the profile does not exist -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -30,10 +30,11 @@ Delete an existing configuration profile. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # Delete a profile named 'my_profile' diff --git a/modules/commands/pages/astra-config-get.adoc b/modules/commands/pages/astra-config-get.adoc index 9a2de01..ddbe852 100644 --- a/modules/commands/pages/astra-config-get.adoc +++ b/modules/commands/pages/astra-config-get.adoc @@ -3,7 +3,8 @@ [source,shell] ---- astra config get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-cf=PATH] [-k=KEY] [-o=FORMAT] [NAME] + [--dump-logs[=FILE]] [-h[=all]] [-cf=PATH] [-k=KEY] + [-o=FORMAT] [NAME] ---- @@ -25,9 +26,8 @@ Get the configuration of a profile or a specific key. `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved. `-k`, `--key`:: Specific configuration key to retrieve -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -35,10 +35,11 @@ Get the configuration of a profile or a specific key. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # Get the configuration of a specific profile diff --git a/modules/commands/pages/astra-config-home-path.adoc b/modules/commands/pages/astra-config-home-path.adoc index e73629f..2357ad6 100644 --- a/modules/commands/pages/astra-config-home-path.adoc +++ b/modules/commands/pages/astra-config-home-path.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra config home path [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [-p | -i] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [-p | -i] ---- @@ -29,9 +29,8 @@ By default, shows informational output when running in a TTY (interactive termin `-p`, `--plain`:: Print only the path to the home folder, without additional information (always) `-i`, `--info`:: Print informational output with context about the path (always) -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -39,10 +38,11 @@ By default, shows informational output when running in a TTY (interactive termin `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # Get information about the path to the astra home folder diff --git a/modules/commands/pages/astra-config-home.adoc b/modules/commands/pages/astra-config-home.adoc index ec15bfa..1d9e520 100644 --- a/modules/commands/pages/astra-config-home.adoc +++ b/modules/commands/pages/astra-config-home.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra config home [COMMAND] +astra config home [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [COMMAND] ---- @@ -19,8 +20,20 @@ All things related to the Astra CLI home folder == Options +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-config-list.adoc b/modules/commands/pages/astra-config-list.adoc index ffbd2ef..4c3c98b 100644 --- a/modules/commands/pages/astra-config-list.adoc +++ b/modules/commands/pages/astra-config-list.adoc @@ -3,7 +3,8 @@ [source,shell] ---- astra config list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-cf=PATH] [-e=ENV] [-o=FORMAT] + [--dump-logs[=FILE]] [-h[=all]] [-cf=PATH] [-e=ENV] + [-o=FORMAT] ---- @@ -20,11 +21,10 @@ List your Astra CLI configurations. == Options `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved. -`-e`, `--env`:: Filter by Astra environment +`-e`, `--env`:: Filter by Astra environment (one of prod|test|dev|local) -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,10 +32,11 @@ List your Astra CLI configurations. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # List your Astra CLI configurations. diff --git a/modules/commands/pages/astra-config-path.adoc b/modules/commands/pages/astra-config-path.adoc index 8678aec..54ba808 100644 --- a/modules/commands/pages/astra-config-path.adoc +++ b/modules/commands/pages/astra-config-path.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra config path [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [-p | -i] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [-p | -i] ---- @@ -29,9 +29,8 @@ By default, shows informational output when running in a TTY (interactive termin `-p`, `--plain`:: Print only the path to the .astrarc file, without additional information (always) `-i`, `--info`:: Print informational output with context about the path (always) -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -39,10 +38,11 @@ By default, shows informational output when running in a TTY (interactive termin `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # Get information about the path to the .astrarc file diff --git a/modules/commands/pages/astra-config-rename.adoc b/modules/commands/pages/astra-config-rename.adoc index 37cc051..7deb50e 100644 --- a/modules/commands/pages/astra-config-rename.adoc +++ b/modules/commands/pages/astra-config-rename.adoc @@ -3,7 +3,8 @@ [source,shell] ---- astra config rename [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-cf=PATH] [-o=FORMAT] [NAME] NAME + [--dump-logs[=FILE]] [-h[=all]] [-cf=PATH] [-o=FORMAT] + [NAME] NAME ---- @@ -20,9 +21,8 @@ Rename an existing configuration profile. `NAME`:: New name for the profile `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved. -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -30,10 +30,11 @@ Rename an existing configuration profile. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # Rename a profile from 'old_name' to 'new_name' diff --git a/modules/commands/pages/astra-config-use.adoc b/modules/commands/pages/astra-config-use.adoc index 37444ba..1966016 100644 --- a/modules/commands/pages/astra-config-use.adoc +++ b/modules/commands/pages/astra-config-use.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra config use [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-cf=PATH] [-o=FORMAT] [NAME] + [--dump-logs[=FILE]] [-h[=all]] [-cf=PATH] [-o=FORMAT] [NAME] ---- @@ -19,9 +19,8 @@ Sets an existing profile to be used as the default for all commands. Use the ``- `NAME`:: Profile to set as default `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved. -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,10 +28,11 @@ Sets an existing profile to be used as the default for all commands. Use the ``- `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # Set an existing profile as the default diff --git a/modules/commands/pages/astra-config.adoc b/modules/commands/pages/astra-config.adoc index ae68df8..7d2b8e1 100644 --- a/modules/commands/pages/astra-config.adoc +++ b/modules/commands/pages/astra-config.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra config [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-cf=PATH] [-e=ENV] [-o=FORMAT] [COMMAND] + [=FILE]] [-h[=all]] [-cf=PATH] [-e=ENV] [-o=FORMAT] [COMMAND] ---- @@ -29,11 +29,10 @@ Manage your Astra CLI configuration profiles == Options `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved. -`-e`, `--env`:: Filter by Astra environment +`-e`, `--env`:: Filter by Astra environment (one of prod|test|dev|local) -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -41,10 +40,11 @@ Manage your Astra CLI configuration profiles `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # List your configuration profiles diff --git a/modules/commands/pages/astra-db-cqlsh-exec.adoc b/modules/commands/pages/astra-db-cqlsh-exec.adoc index 9e46b16..3725e86 100644 --- a/modules/commands/pages/astra-db-cqlsh-exec.adoc +++ b/modules/commands/pages/astra-db-cqlsh-exec.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db cqlsh exec [-qV] [--debug] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-b=PATH] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-b=PATH] [--connect-timeout=TIMEOUT] [--encoding=ENCODING] [-k=KEYSPACE] [-o=FORMAT] [-r=REGION] [--request-timeout=TIMEOUT] [[[-cf=PATH] [-p=NAME]] | @@ -33,9 +33,8 @@ Execute CQL statements for your db using cqlsh `-e`, `--execute`:: Execute the statement then exit `-f`, `--file`:: Execute commands from a CQL file, then exit -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -43,19 +42,18 @@ Execute CQL statements for your db using cqlsh `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Execute a CQL statement diff --git a/modules/commands/pages/astra-db-cqlsh-path.adoc b/modules/commands/pages/astra-db-cqlsh-path.adoc index f09bea5..23cef39 100644 --- a/modules/commands/pages/astra-db-cqlsh-path.adoc +++ b/modules/commands/pages/astra-db-cqlsh-path.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db cqlsh path [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -19,9 +19,8 @@ Get the path to the currently installed cqlsh executable `--if-exists`:: Only return path if cqlsh exists, don't install automatically -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ Get the path to the currently installed cqlsh executable `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the path to the cqlsh executable diff --git a/modules/commands/pages/astra-db-cqlsh-start.adoc b/modules/commands/pages/astra-db-cqlsh-start.adoc index cdc30f2..86dc1bb 100644 --- a/modules/commands/pages/astra-db-cqlsh-start.adoc +++ b/modules/commands/pages/astra-db-cqlsh-start.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db cqlsh start [-qV] [--debug] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-b=PATH] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-b=PATH] [--connect-timeout=TIMEOUT] [--encoding=ENCODING] [-k=KEYSPACE] [-o=FORMAT] [-r=REGION] [--request-timeout=TIMEOUT] [[[-cf=PATH] [-p=NAME]] | @@ -30,9 +30,8 @@ Connect to your Astra database using cqlsh `--request-timeout`:: Request timeout in seconds `-r`, `--region`:: The region to use. Uses the db's default region if not specified. -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -40,19 +39,18 @@ Connect to your Astra database using cqlsh `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Launch cqlsh for a database diff --git a/modules/commands/pages/astra-db-cqlsh-version.adoc b/modules/commands/pages/astra-db-cqlsh-version.adoc index 1121485..a2b7e43 100644 --- a/modules/commands/pages/astra-db-cqlsh-version.adoc +++ b/modules/commands/pages/astra-db-cqlsh-version.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db cqlsh version [-qV] [--debug] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [--connect-timeout=TIMEOUT] [--encoding=ENCODING] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] @@ -23,9 +23,8 @@ Display the currently installed cqlsh's version `--encoding`:: Output encoding (default: utf8) `--connect-timeout`:: Connection timeout in seconds -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -33,19 +32,18 @@ Display the currently installed cqlsh's version `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Display cqlsh's version information diff --git a/modules/commands/pages/astra-db-cqlsh.adoc b/modules/commands/pages/astra-db-cqlsh.adoc index 6905374..f88066c 100644 --- a/modules/commands/pages/astra-db-cqlsh.adoc +++ b/modules/commands/pages/astra-db-cqlsh.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra db cqlsh [COMMAND] +astra db cqlsh [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-h[=all]] [-o=FORMAT] [COMMAND] ---- @@ -22,8 +23,20 @@ Connect to your Astra database using cqlsh == Options +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- # Launch cqlsh for a database diff --git a/modules/commands/pages/astra-db-create-cdc.adoc b/modules/commands/pages/astra-db-create-cdc.adoc index 72f9dce..0bb0259 100644 --- a/modules/commands/pages/astra-db-create-cdc.adoc +++ b/modules/commands/pages/astra-db-create-cdc.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db create-cdc [-qV] [--if-not-exists] [--no-input] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [-k=KEYSPACE] - [-o=FORMAT] --table=TABLE --tenant=TENANT + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-k=KEYSPACE] [-o=FORMAT] --table=TABLE --tenant=TENANT [--topic-partitions=PARTITIONS] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -26,9 +26,8 @@ Create a CDC (Change Data Capture) for a table in a specific keyspace and tenant `--topic-partitions`:: Number of topic partitions `--if-not-exists`:: Will create a new CDC only if none exists -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -36,19 +35,18 @@ Create a CDC (Change Data Capture) for a table in a specific keyspace and tenant `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Create a CDC diff --git a/modules/commands/pages/astra-db-create-collection.adoc b/modules/commands/pages/astra-db-create-collection.adoc index 55ea861..04cbc36 100644 --- a/modules/commands/pages/astra-db-create-collection.adoc +++ b/modules/commands/pages/astra-db-create-collection.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db create-collection [-qV] [--if-not-exists] [--no-input] [--[no-] - spinner] [--color[=WHEN]] [--dump-logs[=FILE]] - -c=COLLECTION [-d=DIMENSION] + spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-h + [=all]] -c=COLLECTION [-d=DIMENSION] [--default-id=DEFAULT_ID] [--embedding-key=EMBEDDING_KEY] [--embedding-model=EMBEDDING_MODEL] @@ -39,9 +39,8 @@ Create a new Data API collection in the specified database and keyspace `--embedding-model`:: Using Vectorize, embedding model to use `--embedding-key`:: Using Vectorize, embedding key used for shared secret -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -49,19 +48,18 @@ Create a new Data API collection in the specified database and keyspace `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Create a basic collection diff --git a/modules/commands/pages/astra-db-create-dotenv.adoc b/modules/commands/pages/astra-db-create-dotenv.adoc index 2727cdd..eb2953a 100644 --- a/modules/commands/pages/astra-db-create-dotenv.adoc +++ b/modules/commands/pages/astra-db-create-dotenv.adoc @@ -3,12 +3,12 @@ [source,shell] ---- astra db create-dotenv [-qV] [--no-input] [--[no-]overwrite] [--print] [--[no-] - spinner] [--color[=WHEN]] [--dump-logs[=FILE]] - [--file=FILE] [-k=KEYSPACE] [-o=FORMAT] [-r=REGION] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - [--keys=KEYS[,KEYS...] [--keys=KEYS[,KEYS...]]... | - --preset=PRESETS[,PRESETS...] [--preset=PRESETS[, - PRESETS...]]...] [DB] + spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-h + [=all]] [--file=FILE] [-k=KEYSPACE] [-o=FORMAT] + [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [--keys=KEYS[,KEYS...] [--keys=KEYS[, + KEYS...]]... | --preset=PRESETS[,PRESETS...] + [--preset=PRESETS[,PRESETS...]]...] [DB] ---- @@ -30,9 +30,8 @@ Create a env file to help you connect to your Astra DB instance. `--keys`:: Comma-separated list of keys to include in the .env file. If not specified, all keys will be included. `--preset`:: The preset(s) to use for the .env file. If not specified, all keys (or the keys from `--keys`) will be used. -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -40,19 +39,18 @@ Create a env file to help you connect to your Astra DB instance. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Create a fully-populated .env file, updating the existing one if it exists diff --git a/modules/commands/pages/astra-db-create-keyspace.adoc b/modules/commands/pages/astra-db-create-keyspace.adoc index fd81eb3..d18dbc4 100644 --- a/modules/commands/pages/astra-db-create-keyspace.adoc +++ b/modules/commands/pages/astra-db-create-keyspace.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db create-keyspace [-qV] [--[no-]async] [--if-not-exists] [--no-input] [-- - [no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]] - -k=KEYSPACE [-o=FORMAT] [--timeout=] + [no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-h + [=all]] -k=KEYSPACE [-o=FORMAT] [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -25,9 +25,8 @@ Create a new keyspace in the specified database `--async`:: Do not wait for the database to become active `--timeout`:: How long the command should wait for the database to become active -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -35,19 +34,18 @@ Create a new keyspace in the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Create a new keyspace diff --git a/modules/commands/pages/astra-db-create-region.adoc b/modules/commands/pages/astra-db-create-region.adoc index 36b4017..f683a13 100644 --- a/modules/commands/pages/astra-db-create-region.adoc +++ b/modules/commands/pages/astra-db-create-region.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db create-region [-qV] [--[no-]async] [--if-not-exists] [--no-input] [-- - [no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]] - [-o=FORMAT] -r=REGION [--timeout=] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] DB + [no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-h + [=all]] [-o=FORMAT] -r=REGION [--timeout=] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] DB ---- @@ -24,9 +24,8 @@ Add a new region to an existing database `--if-not-exists`:: Do not fail if the region already exists `--timeout`:: How long the command should wait for the database to become active -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +33,18 @@ Add a new region to an existing database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Create a region in a database diff --git a/modules/commands/pages/astra-db-create.adoc b/modules/commands/pages/astra-db-create.adoc index 6de0a92..994b4f4 100644 --- a/modules/commands/pages/astra-db-create.adoc +++ b/modules/commands/pages/astra-db-create.adoc @@ -3,11 +3,11 @@ [source,shell] ---- astra db create [-qV] [--[no-]async] [--no-input] [--non-vector] [--[no-] - spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-c=CLOUD] - [--capacity-units=CAPACITY UNITS] [-k=KEYSPACE] [-o=FORMAT] - [-pg=PCU_GROUP] [-r=REGION] [--tier=TIER] [--timeout=] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - [--if-not-exists | --allow-duplicate-names] DB + spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-c=CLOUD] [--capacity-units=CAPACITY UNITS] [-k=KEYSPACE] + [-o=FORMAT] [-pg=PCU_GROUP] [-r=REGION] [--tier=TIER] + [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [--if-not-exists | --allow-duplicate-names] DB ---- @@ -33,9 +33,8 @@ Create a new Astra database `--non-vector`:: Create a classic non-vector database `-pg`, `--pcu-group`:: The PCU group to associate the database to. -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -43,19 +42,18 @@ Create a new Astra database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Create a basic Astra vector database in the 'us-east1' region diff --git a/modules/commands/pages/astra-db-data-api-exec.adoc b/modules/commands/pages/astra-db-data-api-exec.adoc index 15b3a05..342c1e5 100644 --- a/modules/commands/pages/astra-db-data-api-exec.adoc +++ b/modules/commands/pages/astra-db-data-api-exec.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db data-api exec [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-c[=COLLECTION[, + [--dump-logs[=FILE]] [-h[=all]] [-c[=COLLECTION[, COLLECTION...]]]... [-t[=TABLE[,TABLE...]]]... [-e=CODE] [-k=KEYSPACE] [-o=FORMAT] [-r=REGION] [-a=PACKAGES[, PACKAGES...]]... [[[-cf=PATH] [-p=NAME]] | @@ -33,9 +33,8 @@ Execute Data API code against a database `--python`:: Use astrapy with Python `--ipython`:: Use astrapy with IPython -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -43,19 +42,18 @@ Execute Data API code against a database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Insert a document using astra-db-ts (passing the -p flag to node) diff --git a/modules/commands/pages/astra-db-data-api-repl.adoc b/modules/commands/pages/astra-db-data-api-repl.adoc index e45b3c4..9a54624 100644 --- a/modules/commands/pages/astra-db-data-api-repl.adoc +++ b/modules/commands/pages/astra-db-data-api-repl.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db data-api repl [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-c[=COLLECTION[, + [--dump-logs[=FILE]] [-h[=all]] [-c[=COLLECTION[, COLLECTION...]]]... [-t[=TABLE[,TABLE...]]]... [-e=CODE] [-k=KEYSPACE] [-o=FORMAT] [-r=REGION] [-a=PACKAGES[, PACKAGES...]]... [[[-cf=PATH] [-p=NAME]] | @@ -33,9 +33,8 @@ Start an interactive Data API REPL session against a database `--python`:: Use astrapy with Python `--ipython`:: Use astrapy with IPython -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -43,19 +42,18 @@ Start an interactive Data API REPL session against a database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Start a REPL session using astra-db-ts diff --git a/modules/commands/pages/astra-db-data-api.adoc b/modules/commands/pages/astra-db-data-api.adoc index eb8b273..9772112 100644 --- a/modules/commands/pages/astra-db-data-api.adoc +++ b/modules/commands/pages/astra-db-data-api.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra db data-api [COMMAND] +astra db data-api [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [COMMAND] ---- @@ -20,8 +21,20 @@ Easily work with the Data API __(beta)__ == Options +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-db-delete-cdc.adoc b/modules/commands/pages/astra-db-delete-cdc.adoc index fb225c1..6180bba 100644 --- a/modules/commands/pages/astra-db-delete-cdc.adoc +++ b/modules/commands/pages/astra-db-delete-cdc.adoc @@ -3,9 +3,10 @@ [source,shell] ---- astra db delete-cdc [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] (--cdc-id=CDC_ID - | [-k=KEYSPACE --table=TABLE --tenant=TENANT]) [DB] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + (--cdc-id=CDC_ID | [-k=KEYSPACE --table=TABLE + --tenant=TENANT]) [DB] ---- @@ -25,9 +26,8 @@ Delete a CDC (Change Data Capture) from the database `--table`:: The table `--tenant`:: The tenant name -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -35,19 +35,18 @@ Delete a CDC (Change Data Capture) from the database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete a CDC by ID diff --git a/modules/commands/pages/astra-db-delete-collection.adoc b/modules/commands/pages/astra-db-delete-collection.adoc index a2c998a..23be71e 100644 --- a/modules/commands/pages/astra-db-delete-collection.adoc +++ b/modules/commands/pages/astra-db-delete-collection.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db delete-collection [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-c=COLLECTION] [-k=KEYSPACE] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -24,9 +24,8 @@ Delete an existing Data API collection from the specified database and keyspace `-c`, `--collection`:: The collection to use `--if-exists`:: Do not fail if collection does not exist -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +33,18 @@ Delete an existing Data API collection from the specified database and keyspace `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete a collection diff --git a/modules/commands/pages/astra-db-delete-keyspace.adoc b/modules/commands/pages/astra-db-delete-keyspace.adoc index eb80b67..4cba30f 100644 --- a/modules/commands/pages/astra-db-delete-keyspace.adoc +++ b/modules/commands/pages/astra-db-delete-keyspace.adoc @@ -3,10 +3,10 @@ [source,shell] ---- astra db delete-keyspace [-qV] [--[no-]async] [--if-exists] [--no-input] [-- - [no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]] - [-k=KEYSPACE] [-o=FORMAT] [--timeout=] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - [DB] + [no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-h + [=all]] [-k=KEYSPACE] [-o=FORMAT] + [--timeout=] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -25,9 +25,8 @@ Delete a keyspace from the specified database `--async`:: Do not wait for the database to become active `--timeout`:: How long the command should wait for the database to become active -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -35,19 +34,18 @@ Delete a keyspace from the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete a keyspace diff --git a/modules/commands/pages/astra-db-delete-region.adoc b/modules/commands/pages/astra-db-delete-region.adoc index 05f1edc..1b6fb96 100644 --- a/modules/commands/pages/astra-db-delete-region.adoc +++ b/modules/commands/pages/astra-db-delete-region.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db delete-region [-qV] [--[no-]async] [--if-exists] [--no-input] [--[no-] - spinner] [--color[=WHEN]] [--dump-logs[=FILE]] - [-o=FORMAT] -r=REGION [--timeout=] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] DB + spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-h + [=all]] [-o=FORMAT] -r=REGION [--timeout=] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] DB ---- @@ -24,9 +24,8 @@ Delete a region from an existing database `--if-exists`:: Do not fail if region does not exist `--timeout`:: How long the command should wait for the database to become active -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +33,18 @@ Delete a region from an existing database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete a region from a database diff --git a/modules/commands/pages/astra-db-delete-table.adoc b/modules/commands/pages/astra-db-delete-table.adoc index 95ca599..ffe8c04 100644 --- a/modules/commands/pages/astra-db-delete-table.adoc +++ b/modules/commands/pages/astra-db-delete-table.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db delete-table [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] - [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [DB] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-k=KEYSPACE] + [-o=FORMAT] [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -23,9 +23,8 @@ Delete an existing table from the specified database and keyspace `-t`, `--table`:: The table to use `--if-exists`:: Do not fail if table does not exist -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -33,19 +32,18 @@ Delete an existing table from the specified database and keyspace `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete a table diff --git a/modules/commands/pages/astra-db-delete.adoc b/modules/commands/pages/astra-db-delete.adoc index 8f4d164..50c3c39 100644 --- a/modules/commands/pages/astra-db-delete.adoc +++ b/modules/commands/pages/astra-db-delete.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db delete [-qV] [--[no-]async] [--if-exists] [--no-input] [--[no-] - spinner] [--yes] [--color[=WHEN]] [--dump-logs[=FILE]] - [-o=FORMAT] [--timeout=] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [DB] + spinner] [--yes] [--color[=WHEN]] [--dump-logs[=FILE]] [-h + [=all]] [-o=FORMAT] [--timeout=] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -24,9 +24,8 @@ Delete an existing Astra database `--async`:: Do not wait for the database to become active `--timeout`:: How long the command should wait for the database to become terminated -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +33,18 @@ Delete an existing Astra database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete an existing Astra database diff --git a/modules/commands/pages/astra-db-describe-collection.adoc b/modules/commands/pages/astra-db-describe-collection.adoc index 83db139..4855f5e 100644 --- a/modules/commands/pages/astra-db-describe-collection.adoc +++ b/modules/commands/pages/astra-db-describe-collection.adoc @@ -3,9 +3,10 @@ [source,shell] ---- astra db describe-collection [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-c=COLLECTION] - [-k=KEYSPACE] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] - | [--token=TOKEN [--env=ENV]]] [DB] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-c=COLLECTION] [-k=KEYSPACE] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [DB] ---- @@ -22,9 +23,8 @@ Describe an existing Data API collection with detailed information including vec `-k`, `--keyspace`:: The keyspace to use `-c`, `--collection`:: The collection to use -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +32,18 @@ Describe an existing Data API collection with detailed information including vec `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Describe a collection in the default keyspace diff --git a/modules/commands/pages/astra-db-describe-table.adoc b/modules/commands/pages/astra-db-describe-table.adoc index 2959324..51c406a 100644 --- a/modules/commands/pages/astra-db-describe-table.adoc +++ b/modules/commands/pages/astra-db-describe-table.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db describe-table [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] - [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [DB] + [--dump-logs[=FILE]] [-h[=all]] [-k=KEYSPACE] + [-o=FORMAT] [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -22,9 +22,8 @@ Describe an existing table with detailed information including columns and prima `-k`, `--keyspace`:: The keyspace to use `-t`, `--table`:: The table to use -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Describe an existing table with detailed information including columns and prima `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Describe a table in the default keyspace diff --git a/modules/commands/pages/astra-db-download-scb.adoc b/modules/commands/pages/astra-db-download-scb.adoc index ad27008..422af32 100644 --- a/modules/commands/pages/astra-db-download-scb.adoc +++ b/modules/commands/pages/astra-db-download-scb.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db download-scb [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-f=DEST] [-o=FORMAT] [-r=REGION] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - [DB] + [--dump-logs[=FILE]] [-h[=all]] [-f=DEST] [-o=FORMAT] + [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [DB] ---- @@ -22,9 +22,8 @@ Download secure connect bundle for a database `-r`, `--region`:: The cloud provider region to target. Defaults to the default region of the database. `-f`, `--file`:: Destination SCB file -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Download secure connect bundle for a database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Download the SCB for a database, targeting the default region diff --git a/modules/commands/pages/astra-db-dsbulk-count.adoc b/modules/commands/pages/astra-db-dsbulk-count.adoc index 292c092..830ece9 100644 --- a/modules/commands/pages/astra-db-dsbulk-count.adoc +++ b/modules/commands/pages/astra-db-dsbulk-count.adoc @@ -3,8 +3,9 @@ [source,shell] ---- astra db dsbulk count [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [--dsbulk-config=CONFIG_FILE] - [--encoding=ENCODING] [-k=KEYSPACE] [--log-dir=DIRECTORY] + [--dump-logs[=FILE]] [-h[=all]] + [--dsbulk-config=CONFIG_FILE] [--encoding=ENCODING] + [-k=KEYSPACE] [--log-dir=DIRECTORY] [--max-concurrent-queries=QUERIES] [-o=FORMAT] [-query=QUERY] [-r=REGION] [-t=TABLE] [-F=FLAGS]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] @@ -33,9 +34,8 @@ Count items for a table, a query `-F`, `--dsbulk-flag`:: Additional flags to pass to DSBulk loader, can be specified multiple times (e.g., -F '--key1=value1' -F '--key2') `-query`, `--schema.query`:: Optional query to unload or count -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -43,19 +43,18 @@ Count items for a table, a query `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Count all rows in a table diff --git a/modules/commands/pages/astra-db-dsbulk-load.adoc b/modules/commands/pages/astra-db-dsbulk-load.adoc index 7e18509..049e657 100644 --- a/modules/commands/pages/astra-db-dsbulk-load.adoc +++ b/modules/commands/pages/astra-db-dsbulk-load.adoc @@ -4,7 +4,7 @@ ---- astra db dsbulk load [-qV] [--allow-missing-fields] [--dry-run] [--header] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [--delimiter=DELIMITER] + [=FILE]] [-h[=all]] [--delimiter=DELIMITER] [--dsbulk-config=CONFIG_FILE] [--encoding=ENCODING] [-k=KEYSPACE] [--log-dir=DIRECTORY] [-m=MAPPING] [--max-concurrent-queries=QUERIES] [--max-errors=COUNT] @@ -42,9 +42,8 @@ Load data leveraging DSBulk `--dry-run`:: Enable or disable dry-run mode `--allow-missing-fields`:: Ease the mapping -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -52,19 +51,18 @@ Load data leveraging DSBulk `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Load a CSV that includes a header row diff --git a/modules/commands/pages/astra-db-dsbulk-path.adoc b/modules/commands/pages/astra-db-dsbulk-path.adoc index 8c3497d..2ed4cb8 100644 --- a/modules/commands/pages/astra-db-dsbulk-path.adoc +++ b/modules/commands/pages/astra-db-dsbulk-path.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db dsbulk path [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -19,9 +19,8 @@ Get the path to the currently installed dsbulk executable `--if-exists`:: Only return path if dsbulk exists, don't install automatically -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ Get the path to the currently installed dsbulk executable `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the path to the dsbulk executable diff --git a/modules/commands/pages/astra-db-dsbulk-unload.adoc b/modules/commands/pages/astra-db-dsbulk-unload.adoc index 7202701..825dfc6 100644 --- a/modules/commands/pages/astra-db-dsbulk-unload.adoc +++ b/modules/commands/pages/astra-db-dsbulk-unload.adoc @@ -3,9 +3,10 @@ [source,shell] ---- astra db dsbulk unload [-qV] [--header] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [--delimiter=DELIMITER] - [--dsbulk-config=CONFIG_FILE] [--encoding=ENCODING] - [-k=KEYSPACE] [--log-dir=DIRECTORY] [-m=MAPPING] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [--delimiter=DELIMITER] [--dsbulk-config=CONFIG_FILE] + [--encoding=ENCODING] [-k=KEYSPACE] + [--log-dir=DIRECTORY] [-m=MAPPING] [--max-concurrent-queries=QUERIES] [--max-errors=COUNT] [-o=FORMAT] [-query=QUERY] [-r=REGION] [--skip-records=COUNT] [-t=TABLE] [--url=URL] @@ -41,9 +42,8 @@ Unload data leveraging DSBulk `--max-errors`:: Maximum number of errors to tolerate before aborting the operation `-query`, `--schema.query`:: Optional query to unload or count -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -51,19 +51,18 @@ Unload data leveraging DSBulk `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Unload a table to a local directory diff --git a/modules/commands/pages/astra-db-dsbulk-version.adoc b/modules/commands/pages/astra-db-dsbulk-version.adoc index b790920..06e4634 100644 --- a/modules/commands/pages/astra-db-dsbulk-version.adoc +++ b/modules/commands/pages/astra-db-dsbulk-version.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db dsbulk version [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -18,9 +18,8 @@ Display the currently installed dsbulk's version == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -28,19 +27,18 @@ Display the currently installed dsbulk's version `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Display dsbulk's version information diff --git a/modules/commands/pages/astra-db-dsbulk.adoc b/modules/commands/pages/astra-db-dsbulk.adoc index 9b69e37..243f09e 100644 --- a/modules/commands/pages/astra-db-dsbulk.adoc +++ b/modules/commands/pages/astra-db-dsbulk.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra db dsbulk [COMMAND] +astra db dsbulk [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [COMMAND] ---- @@ -23,8 +24,20 @@ Use dsbulk to interface with your Astra DB database == Options +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- # Count all rows in a database table diff --git a/modules/commands/pages/astra-db-endpoints-api.adoc b/modules/commands/pages/astra-db-endpoints-api.adoc index e8f0c8b..5ddc11e 100644 --- a/modules/commands/pages/astra-db-endpoints-api.adoc +++ b/modules/commands/pages/astra-db-endpoints-api.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db endpoints api [-cqV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -25,9 +25,8 @@ Get the API endpoint to interact with the specified database `-r`, `--region`:: The region to use `-c`, `--copy`:: Copy the endpoint to clipboard as well as print it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -35,19 +34,18 @@ Get the API endpoint to interact with the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the API endpoint for the database diff --git a/modules/commands/pages/astra-db-endpoints-data-api.adoc b/modules/commands/pages/astra-db-endpoints-data-api.adoc index 5c2c837..78c9075 100644 --- a/modules/commands/pages/astra-db-endpoints-data-api.adoc +++ b/modules/commands/pages/astra-db-endpoints-data-api.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db endpoints data-api [-cqV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [-r=REGION] [[[-cf=PATH] [-p=NAME]] | + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -22,9 +22,8 @@ Get the Data API endpoint for the specified database `-r`, `--region`:: The region to use `-c`, `--copy`:: Copy the endpoint to clipboard as well as print it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Get the Data API endpoint for the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the Data API endpoint for the database diff --git a/modules/commands/pages/astra-db-endpoints-list.adoc b/modules/commands/pages/astra-db-endpoints-list.adoc index b8c6490..4b58183 100644 --- a/modules/commands/pages/astra-db-endpoints-list.adoc +++ b/modules/commands/pages/astra-db-endpoints-list.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db endpoints list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -24,9 +24,8 @@ Get the various endpoints for your database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The region to use -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +33,18 @@ Get the various endpoints for your database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List the various endpoints for the specified database diff --git a/modules/commands/pages/astra-db-endpoints-playground.adoc b/modules/commands/pages/astra-db-endpoints-playground.adoc index 205fa3e..1b5e665 100644 --- a/modules/commands/pages/astra-db-endpoints-playground.adoc +++ b/modules/commands/pages/astra-db-endpoints-playground.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db endpoints playground [-cqV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [-r=REGION] [[[-cf=PATH] [-p=NAME]] | + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -22,9 +22,8 @@ Get the GraphQL Playground for the specified database `-r`, `--region`:: The region to use `-c`, `--copy`:: Copy the endpoint to clipboard as well as print it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Get the GraphQL Playground for the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the GraphQL Playground for the database diff --git a/modules/commands/pages/astra-db-endpoints-swagger.adoc b/modules/commands/pages/astra-db-endpoints-swagger.adoc index bff5799..36008f9 100644 --- a/modules/commands/pages/astra-db-endpoints-swagger.adoc +++ b/modules/commands/pages/astra-db-endpoints-swagger.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db endpoints swagger [-cqV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -22,9 +22,8 @@ Get the SwaggerUI endpoint for the specified database `-r`, `--region`:: The region to use `-c`, `--copy`:: Copy the endpoint to clipboard as well as print it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Get the SwaggerUI endpoint for the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the SwaggerUI endpoint for the database diff --git a/modules/commands/pages/astra-db-endpoints.adoc b/modules/commands/pages/astra-db-endpoints.adoc index d397c14..8eaf541 100644 --- a/modules/commands/pages/astra-db-endpoints.adoc +++ b/modules/commands/pages/astra-db-endpoints.adoc @@ -3,8 +3,9 @@ [source,shell] ---- astra db endpoints [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] [COMMAND] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [-r=REGION] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] + [COMMAND] ---- @@ -29,9 +30,8 @@ Get the various endpoints for your database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The region to use -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -39,19 +39,18 @@ Get the various endpoints for your database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List the various endpoints for the specified database diff --git a/modules/commands/pages/astra-db-get-endpoint-api.adoc b/modules/commands/pages/astra-db-get-endpoint-api.adoc index a50af2a..581423a 100644 --- a/modules/commands/pages/astra-db-get-endpoint-api.adoc +++ b/modules/commands/pages/astra-db-get-endpoint-api.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db get-endpoint-api [-cqV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -22,9 +22,8 @@ Get the API endpoint to interact with the specified database `-r`, `--region`:: The region to use `-c`, `--copy`:: Copy the endpoint to clipboard as well as print it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Get the API endpoint to interact with the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-db-get-endpoint-playground.adoc b/modules/commands/pages/astra-db-get-endpoint-playground.adoc index 878ca5a..f02d4a6 100644 --- a/modules/commands/pages/astra-db-get-endpoint-playground.adoc +++ b/modules/commands/pages/astra-db-get-endpoint-playground.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db get-endpoint-playground [-cqV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [-r=REGION] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [DB] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [-r=REGION] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -22,9 +22,8 @@ Get the GraphQL Playground for the specified database `-r`, `--region`:: The region to use `-c`, `--copy`:: Copy the endpoint to clipboard as well as print it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Get the GraphQL Playground for the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-db-get-endpoint-swagger.adoc b/modules/commands/pages/astra-db-get-endpoint-swagger.adoc index 8bd28b6..2498391 100644 --- a/modules/commands/pages/astra-db-get-endpoint-swagger.adoc +++ b/modules/commands/pages/astra-db-get-endpoint-swagger.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db get-endpoint-swagger [-cqV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [-r=REGION] [[[-cf=PATH] [-p=NAME]] | + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -22,9 +22,8 @@ Get the SwaggerUI endpoint for the specified database `-r`, `--region`:: The region to use `-c`, `--copy`:: Copy the endpoint to clipboard as well as print it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Get the SwaggerUI endpoint for the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-db-get.adoc b/modules/commands/pages/astra-db-get.adoc index 34b6cd6..997ba72 100644 --- a/modules/commands/pages/astra-db-get.adoc +++ b/modules/commands/pages/astra-db-get.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [=FILE]] [-h[=all]] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -23,9 +23,8 @@ Get information about a specific database. `DB`:: The name or ID of the Astra database to operate on `-k`, `--key`:: Specific database attribute to retrieve -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -33,19 +32,18 @@ Get information about a specific database. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get information about a specific database diff --git a/modules/commands/pages/astra-db-list-cdcs.adoc b/modules/commands/pages/astra-db-list-cdcs.adoc index adc0e5f..d1e6c6f 100644 --- a/modules/commands/pages/astra-db-list-cdcs.adoc +++ b/modules/commands/pages/astra-db-list-cdcs.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db list-cdcs [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [DB] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -19,9 +19,8 @@ List all CDC (Change Data Capture) connections for the specified database `DB`:: The name or ID of the Astra database to operate on -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ List all CDC (Change Data Capture) connections for the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all CDCs in a database diff --git a/modules/commands/pages/astra-db-list-clouds.adoc b/modules/commands/pages/astra-db-list-clouds.adoc index e9870f4..150f2e9 100644 --- a/modules/commands/pages/astra-db-list-clouds.adoc +++ b/modules/commands/pages/astra-db-list-clouds.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db list-clouds [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -18,9 +18,8 @@ List all cloud providers with regions available for Astra DB == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -28,19 +27,18 @@ List all cloud providers with regions available for Astra DB `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all available cloud providers diff --git a/modules/commands/pages/astra-db-list-collections.adoc b/modules/commands/pages/astra-db-list-collections.adoc index c78b51c..4f47c7b 100644 --- a/modules/commands/pages/astra-db-list-collections.adoc +++ b/modules/commands/pages/astra-db-list-collections.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db list-collections [-aqV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--dump-logs[=FILE]] [-h[=all]] [-k=KEYSPACE] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -22,9 +22,8 @@ List the collections in the specified database and keyspace `-k`, `--keyspace`:: The keyspace to use `-a`, `--all`:: List collections in all keyspaces -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ List the collections in the specified database and keyspace `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all collections in the default keyspace diff --git a/modules/commands/pages/astra-db-list-embedding-providers.adoc b/modules/commands/pages/astra-db-list-embedding-providers.adoc index 1c71c6b..81470b1 100644 --- a/modules/commands/pages/astra-db-list-embedding-providers.adoc +++ b/modules/commands/pages/astra-db-list-embedding-providers.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db list-embedding-providers [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [DB] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -20,9 +20,8 @@ Find all available embedding providers for a given database `DB`:: The name or ID of the Astra database to operate on -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -30,19 +29,18 @@ Find all available embedding providers for a given database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Find all available embedding providers for a database diff --git a/modules/commands/pages/astra-db-list-keyspaces.adoc b/modules/commands/pages/astra-db-list-keyspaces.adoc index 0ca8314..e907d02 100644 --- a/modules/commands/pages/astra-db-list-keyspaces.adoc +++ b/modules/commands/pages/astra-db-list-keyspaces.adoc @@ -3,8 +3,9 @@ [source,shell] ---- astra db list-keyspaces [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [DB] ---- @@ -19,9 +20,8 @@ List all keyspaces in the specified database `DB`:: The name or ID of the Astra database to operate on -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +29,18 @@ List all keyspaces in the specified database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all keyspaces in a database diff --git a/modules/commands/pages/astra-db-list-regions-classic.adoc b/modules/commands/pages/astra-db-list-regions-classic.adoc index 597c3e1..409d724 100644 --- a/modules/commands/pages/astra-db-list-regions-classic.adoc +++ b/modules/commands/pages/astra-db-list-regions-classic.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db list-regions-classic [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [-c=FILTER[,FILTER...]]... [-f=FILTER[, - FILTER...]]... [-z=FILTER[,FILTER...]]... + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [-c=FILTER[,FILTER...]]... [-f=FILTER + [,FILTER...]]... [-z=FILTER[,FILTER...]]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] @@ -24,9 +24,8 @@ List all available regions for classic Astra DB databases `-c`, `--cloud`:: Comma-separated list of cloud providers to filter on `-z`, `--zone`:: Comma-separated list of zones to include -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +33,18 @@ List all available regions for classic Astra DB databases `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-db-list-regions-serverless.adoc b/modules/commands/pages/astra-db-list-regions-serverless.adoc index 2a9bb04..a0f810f 100644 --- a/modules/commands/pages/astra-db-list-regions-serverless.adoc +++ b/modules/commands/pages/astra-db-list-regions-serverless.adoc @@ -3,11 +3,11 @@ [source,shell] ---- astra db list-regions-serverless [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [-c=FILTER[,FILTER...]]... [-f=FILTER[, - FILTER...]]... [-z=FILTER[,FILTER...]]... - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [-c=FILTER[,FILTER...]]... + [-f=FILTER[,FILTER...]]... [-z=FILTER[, + FILTER...]]... [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -24,9 +24,8 @@ List all available regions for serverless Astra DB databases `-c`, `--cloud`:: Comma-separated list of cloud providers to filter on `-z`, `--zone`:: Comma-separated list of zones to include -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +33,18 @@ List all available regions for serverless Astra DB databases `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-db-list-regions-vector.adoc b/modules/commands/pages/astra-db-list-regions-vector.adoc index 31a59fc..ecd137c 100644 --- a/modules/commands/pages/astra-db-list-regions-vector.adoc +++ b/modules/commands/pages/astra-db-list-regions-vector.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db list-regions-vector [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [-c=FILTER[,FILTER...]]... [-f=FILTER[, + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [-c=FILTER[,FILTER...]]... [-f=FILTER[, FILTER...]]... [-z=FILTER[,FILTER...]]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] @@ -24,9 +24,8 @@ List all available regions for vector Astra DB databases `-c`, `--cloud`:: Comma-separated list of cloud providers to filter on `-z`, `--zone`:: Comma-separated list of zones to include -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +33,18 @@ List all available regions for vector Astra DB databases `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-db-list-regions.adoc b/modules/commands/pages/astra-db-list-regions.adoc index ca5374a..882b632 100644 --- a/modules/commands/pages/astra-db-list-regions.adoc +++ b/modules/commands/pages/astra-db-list-regions.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db list-regions [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] - | [--token=TOKEN [--env=ENV]]] [DB] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -19,9 +19,8 @@ List the regions for the given database `DB`:: The name or ID of the Astra database to operate on -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ List the regions for the given database `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all regions for the database diff --git a/modules/commands/pages/astra-db-list-reranking-providers.adoc b/modules/commands/pages/astra-db-list-reranking-providers.adoc new file mode 100644 index 0000000..8c90560 --- /dev/null +++ b/modules/commands/pages/astra-db-list-reranking-providers.adoc @@ -0,0 +1,50 @@ += astra db list-reranking-providers + +[source,shell] +---- +astra db list-reranking-providers [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] + +---- + + +Find all available reranking providers for a given database + + + + + +== Options + +`DB`:: The name or ID of the Astra database to operate on + +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + +=== Connection Options +`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command +`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. +`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + + + +== Examples + +[source,bash] +---- +# Find all available reranking providers for a database +$ astra db list-reranking-providers my_db +---- + + diff --git a/modules/commands/pages/astra-db-list-tables.adoc b/modules/commands/pages/astra-db-list-tables.adoc index 7fba1c3..a4e784f 100644 --- a/modules/commands/pages/astra-db-list-tables.adoc +++ b/modules/commands/pages/astra-db-list-tables.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db list-tables [-aqV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] + [--dump-logs[=FILE]] [-h[=all]] [-k=KEYSPACE] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -21,9 +21,8 @@ List the tables in the specified database and keyspace `-k`, `--keyspace`:: The keyspace to use `-a`, `--all`:: List tables in all keyspaces -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -31,19 +30,18 @@ List the tables in the specified database and keyspace `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all tables in the default keyspace diff --git a/modules/commands/pages/astra-db-list.adoc b/modules/commands/pages/astra-db-list.adoc index f25e2c2..9b7726e 100644 --- a/modules/commands/pages/astra-db-list.adoc +++ b/modules/commands/pages/astra-db-list.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db list [-qvV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -22,9 +22,8 @@ List your non-terminated Astra databases. `-v`, `--vector`:: Only show vector-enabled databases -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ List your non-terminated Astra databases. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all your Astra databases diff --git a/modules/commands/pages/astra-db-regions-classic.adoc b/modules/commands/pages/astra-db-regions-classic.adoc index e1fa6b3..cddf4a1 100644 --- a/modules/commands/pages/astra-db-regions-classic.adoc +++ b/modules/commands/pages/astra-db-regions-classic.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db regions classic [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [-c=FILTER[, - FILTER...]]... [-f=FILTER[,FILTER...]]... [-z=FILTER[, - FILTER...]]... [[[-cf=PATH] [-p=NAME]] | + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [-c=FILTER + [,FILTER...]]... [-f=FILTER[,FILTER...]]... [-z=FILTER + [,FILTER...]]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -23,9 +23,8 @@ List all available regions for classic Astra DB databases `-c`, `--cloud`:: Comma-separated list of cloud providers to filter on `-z`, `--zone`:: Comma-separated list of zones to include -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -33,19 +32,18 @@ List all available regions for classic Astra DB databases `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all available regions for classic Astra DB databases diff --git a/modules/commands/pages/astra-db-regions-serverless.adoc b/modules/commands/pages/astra-db-regions-serverless.adoc index a7a2b98..a7fe6f2 100644 --- a/modules/commands/pages/astra-db-regions-serverless.adoc +++ b/modules/commands/pages/astra-db-regions-serverless.adoc @@ -3,10 +3,11 @@ [source,shell] ---- astra db regions serverless [-aqV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-c=FILTER - [,FILTER...]]... [-f=FILTER[,FILTER...]]... - [-z=FILTER[,FILTER...]]... [[[-cf=PATH] [-p=NAME]] - | [--token=TOKEN [--env=ENV]]] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [-c=FILTER[,FILTER...]]... [-f=FILTER[, + FILTER...]]... [-z=FILTER[,FILTER...]]... + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -24,9 +25,8 @@ List all available regions for serverless Astra DB databases `-z`, `--zone`:: Comma-separated list of zones to include `-a`, `--all`:: List all available regions, including those not enabled for the current organization -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +34,18 @@ List all available regions for serverless Astra DB databases `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all available regions for serverless Astra DB databases diff --git a/modules/commands/pages/astra-db-regions-vector.adoc b/modules/commands/pages/astra-db-regions-vector.adoc index 7ffba23..7b5f18e 100644 --- a/modules/commands/pages/astra-db-regions-vector.adoc +++ b/modules/commands/pages/astra-db-regions-vector.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db regions vector [-aqV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [-c=FILTER[, + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [-c=FILTER[, FILTER...]]... [-f=FILTER[,FILTER...]]... [-z=FILTER[, FILTER...]]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] @@ -24,9 +24,8 @@ List all available regions for vector Astra DB databases `-z`, `--zone`:: Comma-separated list of zones to include `-a`, `--all`:: List all available regions, including those not enabled for the current organization -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +33,18 @@ List all available regions for vector Astra DB databases `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all available regions for vector Astra DB databases diff --git a/modules/commands/pages/astra-db-regions.adoc b/modules/commands/pages/astra-db-regions.adoc index ef83533..065f636 100644 --- a/modules/commands/pages/astra-db-regions.adoc +++ b/modules/commands/pages/astra-db-regions.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra db regions [COMMAND] +astra db regions [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [COMMAND] ---- @@ -21,8 +22,20 @@ List available regions for Astra DB databases == Options +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-db-resume.adoc b/modules/commands/pages/astra-db-resume.adoc index 28ee929..c933ddd 100644 --- a/modules/commands/pages/astra-db-resume.adoc +++ b/modules/commands/pages/astra-db-resume.adoc @@ -3,8 +3,9 @@ [source,shell] ---- astra db resume [-qV] [--[no-]async] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [--timeout=] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [DB] ---- @@ -21,9 +22,8 @@ Resume a database that is in a stopped state. If the database is already active, `--async`:: Do not wait for the database to become active `--timeout`:: How long the command should wait for the database to become active -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -31,19 +31,18 @@ Resume a database that is in a stopped state. If the database is already active, `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Resume a database diff --git a/modules/commands/pages/astra-db-status.adoc b/modules/commands/pages/astra-db-status.adoc index 4926341..0c7bc0c 100644 --- a/modules/commands/pages/astra-db-status.adoc +++ b/modules/commands/pages/astra-db-status.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db status [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [DB] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -19,9 +19,8 @@ Get the current status of a database. `DB`:: The name or ID of the Astra database to operate on -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ Get the current status of a database. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the status of a database diff --git a/modules/commands/pages/astra-db-truncate-collection.adoc b/modules/commands/pages/astra-db-truncate-collection.adoc index f94a706..0fd119c 100644 --- a/modules/commands/pages/astra-db-truncate-collection.adoc +++ b/modules/commands/pages/astra-db-truncate-collection.adoc @@ -3,9 +3,10 @@ [source,shell] ---- astra db truncate-collection [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-c=COLLECTION] - [-k=KEYSPACE] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] - | [--token=TOKEN [--env=ENV]]] [DB] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-c=COLLECTION] [-k=KEYSPACE] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [DB] ---- @@ -22,9 +23,8 @@ Atomically delete all documents in a Data API collection `-k`, `--keyspace`:: The keyspace to use `-c`, `--collection`:: The collection to use -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +32,18 @@ Atomically delete all documents in a Data API collection `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Truncate a collection in the default keyspace diff --git a/modules/commands/pages/astra-db-truncate-table.adoc b/modules/commands/pages/astra-db-truncate-table.adoc index d859373..cd80c61 100644 --- a/modules/commands/pages/astra-db-truncate-table.adoc +++ b/modules/commands/pages/astra-db-truncate-table.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db truncate-table [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] - [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [DB] + [--dump-logs[=FILE]] [-h[=all]] [-k=KEYSPACE] + [-o=FORMAT] [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -22,9 +22,8 @@ Atomically delete all rows in a table `-k`, `--keyspace`:: The keyspace to use `-t`, `--table`:: The table to use -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Atomically delete all rows in a table `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Truncate a table in the default keyspace diff --git a/modules/commands/pages/astra-db.adoc b/modules/commands/pages/astra-db.adoc index 30f26fc..0af578b 100644 --- a/modules/commands/pages/astra-db.adoc +++ b/modules/commands/pages/astra-db.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra db [-qvV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [COMMAND] + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -41,6 +41,7 @@ Manage your Astra databases * xref:astra-db-delete-table.adoc[astra db delete-table] * xref:astra-db-truncate-table.adoc[astra db truncate-table] * xref:astra-db-list-embedding-providers.adoc[astra db list-embedding-providers] +* xref:astra-db-list-reranking-providers.adoc[astra db list-reranking-providers] * xref:astra-db-list-cdcs.adoc[astra db list-cdcs] * xref:astra-db-create-cdc.adoc[astra db create-cdc] * xref:astra-db-delete-cdc.adoc[astra db delete-cdc] @@ -62,9 +63,8 @@ Manage your Astra databases `-v`, `--vector`:: Only show vector-enabled databases -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -72,19 +72,18 @@ Manage your Astra databases `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all your Astra databases diff --git a/modules/commands/pages/astra-dotenv-list-keys.adoc b/modules/commands/pages/astra-dotenv-list-keys.adoc index 1cfaf1f..ec3da68 100644 --- a/modules/commands/pages/astra-dotenv-list-keys.adoc +++ b/modules/commands/pages/astra-dotenv-list-keys.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra dotenv list-keys [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] ---- @@ -17,9 +17,8 @@ List all available Astra keys (no values resolved). == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -27,10 +26,11 @@ List all available Astra keys (no values resolved). `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-dotenv-print.adoc b/modules/commands/pages/astra-dotenv-print.adoc index d4d16ae..53616dc 100644 --- a/modules/commands/pages/astra-dotenv-print.adoc +++ b/modules/commands/pages/astra-dotenv-print.adoc @@ -3,10 +3,11 @@ [source,shell] ---- astra dotenv print [-qV] [--no-input] [--[no-]overwrite] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [--db=DB] [-f=FILE] - [--keyspace=KEYSPACE] [-o=FORMAT] [--region=REGION] - [-k=[,...]]... [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [--db=DB] + [-f=FILE] [--keyspace=KEYSPACE] [-o=FORMAT] + [--region=REGION] [-k=[, + ...]]... [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -26,9 +27,8 @@ Fill bound keys and print to stdout. `--keyspace`:: The keyspace to use. `--region`:: The region to use. -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -36,19 +36,18 @@ Fill bound keys and print to stdout. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-dotenv-write.adoc b/modules/commands/pages/astra-dotenv-write.adoc index f9dfd72..28593c9 100644 --- a/modules/commands/pages/astra-dotenv-write.adoc +++ b/modules/commands/pages/astra-dotenv-write.adoc @@ -3,10 +3,11 @@ [source,shell] ---- astra dotenv write [-qV] [--no-input] [--[no-]overwrite] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [--db=DB] [-f=FILE] - [--keyspace=KEYSPACE] [-o=FORMAT] [--region=REGION] - [-k=[,...]]... [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [--db=DB] + [-f=FILE] [--keyspace=KEYSPACE] [-o=FORMAT] + [--region=REGION] [-k=[, + ...]]... [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -26,9 +27,8 @@ Fill bound keys and write to a .env file. `--keyspace`:: The keyspace to use. `--region`:: The region to use. -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -36,19 +36,18 @@ Fill bound keys and write to a .env file. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-dotenv.adoc b/modules/commands/pages/astra-dotenv.adoc index a33f93a..67edd8d 100644 --- a/modules/commands/pages/astra-dotenv.adoc +++ b/modules/commands/pages/astra-dotenv.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra dotenv [COMMAND] +astra dotenv [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-h[=all]] [-o=FORMAT] [COMMAND] ---- @@ -21,8 +22,20 @@ Easily create and update your .env files __(beta)__ == Options +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-nuke.adoc b/modules/commands/pages/astra-nuke.adoc index 4768250..6ccf558 100644 --- a/modules/commands/pages/astra-nuke.adoc +++ b/modules/commands/pages/astra-nuke.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra nuke [-qVy] [--dry-run] [--no-input] [--[no-]preserve-astrarc] [--[no-] - spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] ---- @@ -32,9 +32,8 @@ This will also detect any shell rc files which need ``astra``-related lines remo `--preserve-astrarc`:: Preserve the ``.astrarc`` file in your home directory `-y`, `--yes`:: Whether to nuke without confirmation (if not a dry run) -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -42,10 +41,11 @@ This will also detect any shell rc files which need ``astra``-related lines remo `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # Nuke Astra CLI from your system diff --git a/modules/commands/pages/astra-org-get.adoc b/modules/commands/pages/astra-org-get.adoc index 06c11e2..90b4568 100644 --- a/modules/commands/pages/astra-org-get.adoc +++ b/modules/commands/pages/astra-org-get.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra org get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -25,9 +25,8 @@ Use the ``--token @file`` syntax to read the token from a file, to avoid potenti == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -35,19 +34,18 @@ Use the ``--token @file`` syntax to read the token from a file, to avoid potenti `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get your organization's information diff --git a/modules/commands/pages/astra-org-id.adoc b/modules/commands/pages/astra-org-id.adoc index a52ee20..afdda8c 100644 --- a/modules/commands/pages/astra-org-id.adoc +++ b/modules/commands/pages/astra-org-id.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra org id [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -18,9 +18,8 @@ Get your organization's ID == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -28,19 +27,18 @@ Get your organization's ID `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get your organization's ID diff --git a/modules/commands/pages/astra-org-name.adoc b/modules/commands/pages/astra-org-name.adoc index 2d929fd..a13c251 100644 --- a/modules/commands/pages/astra-org-name.adoc +++ b/modules/commands/pages/astra-org-name.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra org name [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -18,9 +18,8 @@ Get your organization's name == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -28,19 +27,18 @@ Get your organization's name `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get your organization's name diff --git a/modules/commands/pages/astra-org.adoc b/modules/commands/pages/astra-org.adoc index 472d5df..e065b32 100644 --- a/modules/commands/pages/astra-org.adoc +++ b/modules/commands/pages/astra-org.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra org [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [COMMAND] + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -29,9 +29,8 @@ Use the ``--token @file`` syntax to read the token from a file, to avoid potenti == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -39,19 +38,18 @@ Use the ``--token @file`` syntax to read the token from a file, to avoid potenti `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get your organization's information diff --git a/modules/commands/pages/astra-pcu-associate.adoc b/modules/commands/pages/astra-pcu-associate.adoc index 363a6ea..1ff8505 100644 --- a/modules/commands/pages/astra-pcu-associate.adoc +++ b/modules/commands/pages/astra-pcu-associate.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra pcu associate [-qV] [--if-not-exists] [--no-input] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - GROUP TARGET + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] GROUP TARGET ---- @@ -22,9 +22,8 @@ Associate a PCU group to a datacenter `TARGET`:: PCU association target (database name/id/endpoint or datacenter id) `--if-not-exists`:: Don't error if the association already exists -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Associate a PCU group to a datacenter `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Associate a specific datacenter to a PCU group diff --git a/modules/commands/pages/astra-pcu-create.adoc b/modules/commands/pages/astra-pcu-create.adoc index 849403a..92d9024 100644 --- a/modules/commands/pages/astra-pcu-create.adoc +++ b/modules/commands/pages/astra-pcu-create.adoc @@ -3,10 +3,11 @@ [source,shell] ---- astra pcu create [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-c=CLOUD] [-d=DESC] [-it=TYPE] - [--max=MAX] [--min=MIN] [-o=FORMAT] [-pt=TYPE] [-r=REGION] - [--reserved=RESERVED] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [--if-not-exists | --allow-duplicate-names] GROUP + [--dump-logs[=FILE]] [-h[=all]] [-c=CLOUD] [-d=DESC] + [-it=TYPE] [--max=MAX] [--min=MIN] [-o=FORMAT] [-pt=TYPE] + [-r=REGION] [--reserved=RESERVED] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [--if-not-exists | + --allow-duplicate-names] GROUP ---- @@ -31,9 +32,8 @@ Create a new PCU group `--max`:: Maximum capacity units for the PCU group `--reserved`:: Reserved capacity units for the PCU group -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -41,19 +41,18 @@ Create a new PCU group `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Create a basic pcu group diff --git a/modules/commands/pages/astra-pcu-delete.adoc b/modules/commands/pages/astra-pcu-delete.adoc index c332d49..988a2b0 100644 --- a/modules/commands/pages/astra-pcu-delete.adoc +++ b/modules/commands/pages/astra-pcu-delete.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra pcu delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--yes] - [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] ---- @@ -21,9 +21,8 @@ Delete an existing Pcu group `--if-exists`:: Do not fail if PCU group does not exist `--yes`:: Force deletion of PCU group without prompting -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -31,19 +30,18 @@ Delete an existing Pcu group `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete an existing Pcu group diff --git a/modules/commands/pages/astra-pcu-disassociate.adoc b/modules/commands/pages/astra-pcu-disassociate.adoc index d027551..5701617 100644 --- a/modules/commands/pages/astra-pcu-disassociate.adoc +++ b/modules/commands/pages/astra-pcu-disassociate.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra pcu disassociate [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - GROUP TARGET + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] GROUP TARGET ---- @@ -22,9 +22,8 @@ Disassociate a PCU group to a datacenter `TARGET`:: PCU association target (database name/id/endpoint or datacenter id) `--if-exists`:: Don't error if the association doesn't exist -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Disassociate a PCU group to a datacenter `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Disassociate a specific datacenter from a PCU group diff --git a/modules/commands/pages/astra-pcu-find-association.adoc b/modules/commands/pages/astra-pcu-find-association.adoc index e09b02e..85fccd0 100644 --- a/modules/commands/pages/astra-pcu-find-association.adoc +++ b/modules/commands/pages/astra-pcu-find-association.adoc @@ -3,8 +3,9 @@ [source,shell] ---- astra pcu find-association [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] TARGET + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] TARGET ---- @@ -19,9 +20,8 @@ Find the PCU group associated with a datacenter `TARGET`:: PCU association target (database name/id/endpoint or datacenter id) -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +29,18 @@ Find the PCU group associated with a datacenter `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Find the PCU group associated with a datacenter diff --git a/modules/commands/pages/astra-pcu-get.adoc b/modules/commands/pages/astra-pcu-get.adoc index 100a0c4..d3dc9b1 100644 --- a/modules/commands/pages/astra-pcu-get.adoc +++ b/modules/commands/pages/astra-pcu-get.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra pcu get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [GROUP] + [=FILE]] [-h[=all]] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] + | [--token=TOKEN [--env=ENV]]] [GROUP] ---- @@ -23,9 +23,8 @@ Get information about a specific PCU group. `GROUP`:: The name or ID of the PCU group to work with `-k`, `--key`:: Specific PCU group attribute to retrieve -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -33,19 +32,18 @@ Get information about a specific PCU group. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get information about a specific PCU group diff --git a/modules/commands/pages/astra-pcu-list-associations.adoc b/modules/commands/pages/astra-pcu-list-associations.adoc index 377ef92..81ec37c 100644 --- a/modules/commands/pages/astra-pcu-list-associations.adoc +++ b/modules/commands/pages/astra-pcu-list-associations.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra pcu list-associations [-aqV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [GROUP] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [GROUP] ---- @@ -21,9 +21,8 @@ List the associations of a PCU group `GROUP`:: The name or ID of the PCU group to work with `-a`, `--all`:: List all associations for all of your PCU groups -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -31,19 +30,18 @@ List the associations of a PCU group `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List the associations of a PCU group diff --git a/modules/commands/pages/astra-pcu-list-types.adoc b/modules/commands/pages/astra-pcu-list-types.adoc index f9aeaa4..f7d4d7c 100644 --- a/modules/commands/pages/astra-pcu-list-types.adoc +++ b/modules/commands/pages/astra-pcu-list-types.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra pcu list-types [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-c=<$cloudProvider>] [-o=FORMAT] - [-r=<$regionName>] [[[-cf=PATH] [-p=NAME]] | + [--dump-logs[=FILE]] [-h[=all]] [-c=<$cloudProvider>] + [-o=FORMAT] [-r=<$regionName>] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -21,9 +21,8 @@ List available PCU types `-c`, `--cloud`:: Cloud provider filter `-r`, `--region`:: Region filter -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -31,19 +30,18 @@ List available PCU types `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all PCU types diff --git a/modules/commands/pages/astra-pcu-list.adoc b/modules/commands/pages/astra-pcu-list.adoc index 43b981a..ea27648 100644 --- a/modules/commands/pages/astra-pcu-list.adoc +++ b/modules/commands/pages/astra-pcu-list.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra pcu list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -21,9 +21,8 @@ List your PCU groups == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -31,19 +30,18 @@ List your PCU groups `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all your PCU groups diff --git a/modules/commands/pages/astra-pcu-park.adoc b/modules/commands/pages/astra-pcu-park.adoc index 283dc56..2f2b491 100644 --- a/modules/commands/pages/astra-pcu-park.adoc +++ b/modules/commands/pages/astra-pcu-park.adoc @@ -3,8 +3,9 @@ [source,shell] ---- astra pcu park [-qV] [--[no-]async] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [--timeout=] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [GROUP] ---- @@ -21,9 +22,8 @@ Park an existing PCU group `--async`:: Do not wait for the database to become active `--timeout`:: How long the command should wait for the database to become active -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -31,19 +31,18 @@ Park an existing PCU group `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Park an existing PCU group diff --git a/modules/commands/pages/astra-pcu-status.adoc b/modules/commands/pages/astra-pcu-status.adoc index bd244ef..32622af 100644 --- a/modules/commands/pages/astra-pcu-status.adoc +++ b/modules/commands/pages/astra-pcu-status.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra pcu status [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [GROUP] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] ---- @@ -19,9 +19,8 @@ Get the current status of a PCU group. `GROUP`:: The name or ID of the PCU group to work with -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ Get the current status of a PCU group. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the status of a PCU group diff --git a/modules/commands/pages/astra-pcu-transfer-association.adoc b/modules/commands/pages/astra-pcu-transfer-association.adoc index 18e8298..72ef17d 100644 --- a/modules/commands/pages/astra-pcu-transfer-association.adoc +++ b/modules/commands/pages/astra-pcu-transfer-association.adoc @@ -4,9 +4,9 @@ ---- astra pcu transfer-association [-qV] [--if-not-exists] [--no-input] [--[no-] spinner] [--color[=WHEN]] [--dump-logs[=FILE]] - [-o=FORMAT] -t=GROUP [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [-f=GROUP | - --or-create] TARGET + [-h[=all]] [-o=FORMAT] -t=GROUP [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [-f=GROUP | --or-create] TARGET ---- @@ -25,9 +25,8 @@ Transfer an association from one PCU group to another `-f`, `--from`:: The PCU group which initially holds the association. May be omitted to let the CLI automatically detect it `--or-create`:: If the datacenter is not already associated to a PCU group, create the association first -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -35,19 +34,18 @@ Transfer an association from one PCU group to another `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Transfer a datacenter association association from one PCU group to another diff --git a/modules/commands/pages/astra-pcu-unpark.adoc b/modules/commands/pages/astra-pcu-unpark.adoc index 841ad32..90b952a 100644 --- a/modules/commands/pages/astra-pcu-unpark.adoc +++ b/modules/commands/pages/astra-pcu-unpark.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra pcu unpark [-qV] [--[no-]async] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] @@ -22,9 +22,8 @@ Unpark a parked PCU group `--async`:: Do not wait for the database to become active `--timeout`:: How long the command should wait for the database to become active -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Unpark a parked PCU group `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Unpark a parked PCU group diff --git a/modules/commands/pages/astra-pcu-update.adoc b/modules/commands/pages/astra-pcu-update.adoc index 0a38b8e..92af1cf 100644 --- a/modules/commands/pages/astra-pcu-update.adoc +++ b/modules/commands/pages/astra-pcu-update.adoc @@ -3,10 +3,10 @@ [source,shell] ---- astra pcu update [-qV] [--allow-duplicate-names] [--no-input] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [-c=CLOUD] [-d=DESC] - [-it=TYPE] [--max=MAX] [--min=MIN] [-o=FORMAT] [-pt=TYPE] - [-r=REGION] [--reserved=RESERVED] [-t=TITLE] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-c=CLOUD] + [-d=DESC] [-it=TYPE] [--max=MAX] [--min=MIN] [-o=FORMAT] + [-pt=TYPE] [-r=REGION] [--reserved=RESERVED] [-t=TITLE] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] ---- @@ -31,9 +31,8 @@ Update an existing PCU group `--max`:: Maximum capacity units for the PCU group `--reserved`:: Reserved capacity units for the PCU group -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -41,19 +40,18 @@ Update an existing PCU group `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Update an existing PCU group diff --git a/modules/commands/pages/astra-pcu.adoc b/modules/commands/pages/astra-pcu.adoc index beb46ce..e64a3c1 100644 --- a/modules/commands/pages/astra-pcu.adoc +++ b/modules/commands/pages/astra-pcu.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra pcu [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [COMMAND] + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -36,9 +36,8 @@ Manage your PCU groups and associations == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -46,19 +45,18 @@ Manage your PCU groups and associations `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all your PCU groups diff --git a/modules/commands/pages/astra-role-get.adoc b/modules/commands/pages/astra-role-get.adoc index 9dc72fa..ada9d56 100644 --- a/modules/commands/pages/astra-role-get.adoc +++ b/modules/commands/pages/astra-role-get.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra role get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] ROLE + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ROLE ---- @@ -22,9 +22,8 @@ Show details for a specific role `ROLE`:: Role name/id to get -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Show details for a specific role `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get details for a specific role by name diff --git a/modules/commands/pages/astra-role-list.adoc b/modules/commands/pages/astra-role-list.adoc index ea7e59c..3ae2c63 100644 --- a/modules/commands/pages/astra-role-list.adoc +++ b/modules/commands/pages/astra-role-list.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra role list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -18,9 +18,8 @@ Display all roles == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -28,19 +27,18 @@ Display all roles `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all available roles in your organization diff --git a/modules/commands/pages/astra-role.adoc b/modules/commands/pages/astra-role.adoc index d078a4d..8f0a62c 100644 --- a/modules/commands/pages/astra-role.adoc +++ b/modules/commands/pages/astra-role.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra role [COMMAND] +astra role [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-h[=all]] [-o=FORMAT] [COMMAND] ---- @@ -20,8 +21,20 @@ Discover Astra roles == Options +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- # List all available roles diff --git a/modules/commands/pages/astra-setup.adoc b/modules/commands/pages/astra-setup.adoc index aaef904..7c8b8bb 100644 --- a/modules/commands/pages/astra-setup.adoc +++ b/modules/commands/pages/astra-setup.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra setup [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-e=ENV] [--name=NAME] [-o=FORMAT] [-t=TOKEN] + [=FILE]] [-h[=all]] [-e=ENV] [--name=NAME] [-o=FORMAT] [-t=TOKEN] ---- @@ -19,12 +19,11 @@ See ``astra config create`` for a programmatic way to create profiles without in == Options `-t`, `--token`:: Token to use authenticate each call. If not provided, you will be prompted for it -`-e`, `--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. +`-e`, `--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. `--name`:: Optional name for the profile. If not provided, you will be prompted for it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,10 +31,11 @@ See ``astra config create`` for a programmatic way to create profiles without in `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # Start the interactive setup process diff --git a/modules/commands/pages/astra-shellenv.adoc b/modules/commands/pages/astra-shellenv.adoc index 6b5fa7d..f9ce28c 100644 --- a/modules/commands/pages/astra-shellenv.adoc +++ b/modules/commands/pages/astra-shellenv.adoc @@ -2,9 +2,11 @@ [source,shell] ---- -astra shellenv [--ignore-beta-warnings] [--ignore-multiple-paths] - [--no-update-notifier] [--default-args=<$defaultArgs>] - [--home=<$home>] [--rc=<$rc>] +astra shellenv [-qV] [--ignore-beta-warnings] [--ignore-multiple-paths] + [--no-input] [--no-update-notifier] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [--default-args=<$defaultArgs>] [--home=<$home>] [-o=FORMAT] + [--rc=<$rc>] ---- @@ -34,8 +36,20 @@ Intended to be added to your shell profile (``.zprofile``, ``.bash_profile``, `` `--no-update-notifier`:: Disables background update checks notifications. Sets ``ASTRA_NO_UPDATE_NOTIFIER=true`` under the hood. `--default-args`:: Sets the default args used for every CLI command (e.g. --no-spinner or --no-color). Sets ``ASTRA_DEFAULT_ARGS`` under the hood. +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- # Put this in your shell profile (e.g. ``~/.zprofile``) to generate completions and set your PATH diff --git a/modules/commands/pages/astra-streaming-create.adoc b/modules/commands/pages/astra-streaming-create.adoc index 206c098..20c8f5d 100644 --- a/modules/commands/pages/astra-streaming-create.adoc +++ b/modules/commands/pages/astra-streaming-create.adoc @@ -3,10 +3,10 @@ [source,shell] ---- astra streaming create [-qV] [--if-not-exists] [--no-input] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [-c=CLOUD] - --cluster=CLUSTER [-e=EMAIL] [-o=FORMAT] [--plan=PLAN] - -r=REGION [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] TENANT + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-c=CLOUD] --cluster=CLUSTER [-e=EMAIL] [-o=FORMAT] + [--plan=PLAN] -r=REGION [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] TENANT ---- @@ -27,9 +27,8 @@ Create a new streaming tenant `-r`, `--region`:: Cloud provider region to provision `-c`, `--cloud`:: The cloud provider where the tenant should be created. Inferred from the region if not provided. -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -37,19 +36,18 @@ Create a new streaming tenant `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Create a basic streaming tenant in the 'us-east1' region diff --git a/modules/commands/pages/astra-streaming-delete.adoc b/modules/commands/pages/astra-streaming-delete.adoc index 26a16b5..8e994ca 100644 --- a/modules/commands/pages/astra-streaming-delete.adoc +++ b/modules/commands/pages/astra-streaming-delete.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra streaming delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - [TENANT] + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [TENANT] ---- @@ -21,9 +21,8 @@ Delete an existing streaming tenant `TENANT`:: The name of the tenant to operate on `--if-exists`:: Do not fail if tenant does not exist -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -31,19 +30,18 @@ Delete an existing streaming tenant `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete an existing streaming tenant diff --git a/modules/commands/pages/astra-streaming-exist.adoc b/modules/commands/pages/astra-streaming-exist.adoc index d23708f..35096da 100644 --- a/modules/commands/pages/astra-streaming-exist.adoc +++ b/modules/commands/pages/astra-streaming-exist.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra streaming exist [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] - | [--token=TOKEN [--env=ENV]]] TENANT + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] TENANT ---- @@ -19,9 +19,8 @@ Show existence of a streaming tenant `TENANT`:: The name of the tenant to operate on -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ Show existence of a streaming tenant `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Check if a streaming tenant exists diff --git a/modules/commands/pages/astra-streaming-get.adoc b/modules/commands/pages/astra-streaming-get.adoc index 9127ad1..3a68a5c 100644 --- a/modules/commands/pages/astra-streaming-get.adoc +++ b/modules/commands/pages/astra-streaming-get.adoc @@ -3,8 +3,9 @@ [source,shell] ---- astra streaming get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [TENANT] + [--dump-logs[=FILE]] [-h[=all]] [-k=KEY] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [TENANT] ---- @@ -23,9 +24,8 @@ Get the info about a streaming tenant. `TENANT`:: The name of the tenant to operate on `-k`, `--key`:: Specific tenant attribute to retrieve -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -33,19 +33,18 @@ Get the info about a streaming tenant. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get information about a specific tenant diff --git a/modules/commands/pages/astra-streaming-list-clouds.adoc b/modules/commands/pages/astra-streaming-list-clouds.adoc index 1e9ba74..0ff7b3d 100644 --- a/modules/commands/pages/astra-streaming-list-clouds.adoc +++ b/modules/commands/pages/astra-streaming-list-clouds.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra streaming list-clouds [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -19,9 +19,8 @@ List all available cloud providers for Astra streaming tenants == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ List all available cloud providers for Astra streaming tenants `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all available cloud providers for streaming tenants diff --git a/modules/commands/pages/astra-streaming-list-regions.adoc b/modules/commands/pages/astra-streaming-list-regions.adoc index c1713c3..a898fc6 100644 --- a/modules/commands/pages/astra-streaming-list-regions.adoc +++ b/modules/commands/pages/astra-streaming-list-regions.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra streaming list-regions [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [-c=FILTER[,FILTER...]]... [-f=FILTER[, + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [-c=FILTER[,FILTER...]]... [-f=FILTER[, FILTER...]]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] @@ -22,9 +22,8 @@ List all available regions for Astra streaming tenants `-f`, `--filter`:: Comma-separated case-insensitive partial-match filters on the region name `-c`, `--cloud`:: Comma-separated list of cloud providers to filter on -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ List all available regions for Astra streaming tenants `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all available regions for streaming tenants diff --git a/modules/commands/pages/astra-streaming-list.adoc b/modules/commands/pages/astra-streaming-list.adoc index d0b856a..c55eb91 100644 --- a/modules/commands/pages/astra-streaming-list.adoc +++ b/modules/commands/pages/astra-streaming-list.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra streaming list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -21,9 +21,8 @@ List your Astra streaming tenants == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -31,19 +30,18 @@ List your Astra streaming tenants `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-streaming-pulsar-path.adoc b/modules/commands/pages/astra-streaming-pulsar-path.adoc index 95fa6cf..a8f1abb 100644 --- a/modules/commands/pages/astra-streaming-pulsar-path.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-path.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra streaming pulsar path [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -20,9 +20,8 @@ Get the path to the currently installed pulsar executable `--if-exists`:: Only return path if pulsar exists, don't install automatically -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -30,19 +29,18 @@ Get the path to the currently installed pulsar executable `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the path to the pulsar executable diff --git a/modules/commands/pages/astra-streaming-pulsar-shell.adoc b/modules/commands/pages/astra-streaming-pulsar-shell.adoc index b7ab84f..9248a9f 100644 --- a/modules/commands/pages/astra-streaming-pulsar-shell.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-shell.adoc @@ -3,9 +3,10 @@ [source,shell] ---- astra streaming pulsar shell [-FqV] [--no-input] [-np] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [-e=STATEMENT | -f=FILE] [TENANT] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [-e=STATEMENT | + -f=FILE] [TENANT] ---- @@ -24,9 +25,8 @@ Launch Apache Pulsar shell for a streaming tenant `-e`, `--execute`:: Execute the statement and quit `-f`, `--file`:: Input filename with a list of commands to be executed. Each command must be separated by a newline -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,19 +34,18 @@ Launch Apache Pulsar shell for a streaming tenant `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Launch pulsar shell for a tenant diff --git a/modules/commands/pages/astra-streaming-pulsar-token.adoc b/modules/commands/pages/astra-streaming-pulsar-token.adoc index 959c0d4..c6caa4b 100644 --- a/modules/commands/pages/astra-streaming-pulsar-token.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-token.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra streaming pulsar-token [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] TENANT + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] TENANT ---- @@ -20,9 +20,8 @@ Get the Pulsar token for a streaming tenant `TENANT`:: The name of the tenant to operate on -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -30,19 +29,18 @@ Get the Pulsar token for a streaming tenant `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the Pulsar token for a tenant diff --git a/modules/commands/pages/astra-streaming-pulsar-version.adoc b/modules/commands/pages/astra-streaming-pulsar-version.adoc index 30a4979..bf34162 100644 --- a/modules/commands/pages/astra-streaming-pulsar-version.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-version.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra streaming pulsar version [-qV] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] + [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -19,9 +19,8 @@ Display the currently installed pulsar's version == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ Display the currently installed pulsar's version `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Display pulsar's version information diff --git a/modules/commands/pages/astra-streaming-pulsar.adoc b/modules/commands/pages/astra-streaming-pulsar.adoc index 3b5db45..ace4d20 100644 --- a/modules/commands/pages/astra-streaming-pulsar.adoc +++ b/modules/commands/pages/astra-streaming-pulsar.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra streaming pulsar [COMMAND] +astra streaming pulsar [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [COMMAND] ---- @@ -21,8 +22,20 @@ Apache Pulsar operations for your Astra streaming tenants == Options +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- # Launch pulsar shell for a tenant diff --git a/modules/commands/pages/astra-streaming-status.adoc b/modules/commands/pages/astra-streaming-status.adoc index 4eda9f8..befcd3a 100644 --- a/modules/commands/pages/astra-streaming-status.adoc +++ b/modules/commands/pages/astra-streaming-status.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra streaming status [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] - | [--token=TOKEN [--env=ENV]]] [TENANT] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [TENANT] ---- @@ -19,9 +19,8 @@ Get the current status of a streaming tenant. `TENANT`:: The name of the tenant to operate on -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -29,19 +28,18 @@ Get the current status of a streaming tenant. `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get the status of a streaming tenant diff --git a/modules/commands/pages/astra-streaming.adoc b/modules/commands/pages/astra-streaming.adoc index 736dad3..a6110db 100644 --- a/modules/commands/pages/astra-streaming.adoc +++ b/modules/commands/pages/astra-streaming.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra streaming [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [COMMAND] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -32,9 +32,8 @@ Manage Astra streaming tenants == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -42,19 +41,18 @@ Manage Astra streaming tenants `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- diff --git a/modules/commands/pages/astra-token-create.adoc b/modules/commands/pages/astra-token-create.adoc index 98b8c5b..af42d87 100644 --- a/modules/commands/pages/astra-token-create.adoc +++ b/modules/commands/pages/astra-token-create.adoc @@ -3,8 +3,9 @@ [source,shell] ---- astra token create [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-d=DESC] [-o=FORMAT] -r=ROLE - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [--dump-logs[=FILE]] [-h[=all]] [-d=DESC] [-o=FORMAT] + [--org=ORG] [-x=EXPIRY] [-r=ROLE[,ROLE...]]... [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -17,12 +18,13 @@ Create a new token == Options -`-r`, `--role`:: The role for this token +`-r`, `--role`:: List of roles for the token `-d`, `--description`:: An optional description for this token +`--org`:: Optional UUID of the organization under which the token will be created. If not provided, the token is created under the organization/enterprise of the authorization token. +`-x`, `--expiry`:: Optional expiration date for the token in ISO-8601 format (e.g., 2026-08-19T14:30:00Z). If not provided, the org's max expiry will be used (potentially infinite). -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -30,23 +32,28 @@ Create a new token `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- +# Create a token and interactively select your roles +$ astra token create + # Create a token with a specific role $ astra token create --role "Organization Administrator" + +# Create a token with multiple roles +$ astra token create --role "RO User,Billing Admin" ---- diff --git a/modules/commands/pages/astra-token-delete.adoc b/modules/commands/pages/astra-token-delete.adoc index c5a68f6..b067403 100644 --- a/modules/commands/pages/astra-token-delete.adoc +++ b/modules/commands/pages/astra-token-delete.adoc @@ -2,9 +2,10 @@ [source,shell] ---- -astra token delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] TOKEN +astra token delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--yes] + [--color[=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [TOKEN] ---- @@ -22,10 +23,10 @@ Delete a token `TOKEN`:: Token identifier `--if-exists`:: Do not fail if token does not exist +`--yes`:: Force deletion of token without prompting -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -33,19 +34,18 @@ Delete a token `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete a specific token @@ -53,6 +53,9 @@ $ astra token delete # Delete a token without failing if it doesn't exist $ astra token delete --if-exists + +# Delete an interactively selected token without confirmation prompt +$ astra token delete --yes ---- diff --git a/modules/commands/pages/astra-token-get.adoc b/modules/commands/pages/astra-token-get.adoc index e770447..7c3c620 100644 --- a/modules/commands/pages/astra-token-get.adoc +++ b/modules/commands/pages/astra-token-get.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra token get [-cqV] [--no-input] [--[no-]spinner] [--validate] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] +astra token get [-cqvV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -21,11 +21,10 @@ Show your current token == Options `-c`, `--copy`:: Copy the token to clipboard instead of printing it -`--validate`:: Validates the token before returning it +`-v`, `--validate`:: Validates the token before returning it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -33,19 +32,18 @@ Show your current token `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Show your current token diff --git a/modules/commands/pages/astra-token-list.adoc b/modules/commands/pages/astra-token-list.adoc index f922e4c..85d5459 100644 --- a/modules/commands/pages/astra-token-list.adoc +++ b/modules/commands/pages/astra-token-list.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra token list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -18,9 +18,8 @@ List your tokens' information == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -28,19 +27,18 @@ List your tokens' information `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List your tokens' information diff --git a/modules/commands/pages/astra-token.adoc b/modules/commands/pages/astra-token.adoc index 0150590..b0ac464 100644 --- a/modules/commands/pages/astra-token.adoc +++ b/modules/commands/pages/astra-token.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra token [-cqV] [--no-input] [--[no-]spinner] [--validate] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra token [-cqvV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -26,11 +26,10 @@ Manage your Astra tokens == Options `-c`, `--copy`:: Copy the token to clipboard instead of printing it -`--validate`:: Validates the token before returning it +`-v`, `--validate`:: Validates the token before returning it -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -38,19 +37,18 @@ Manage your Astra tokens `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Show your current token diff --git a/modules/commands/pages/astra-upgrade.adoc b/modules/commands/pages/astra-upgrade.adoc index fb861e7..e94ab44 100644 --- a/modules/commands/pages/astra-upgrade.adoc +++ b/modules/commands/pages/astra-upgrade.adoc @@ -3,7 +3,8 @@ [source,shell] ---- astra upgrade [-qV] [--allow-reinstall] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-v=TAG | --pre] + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [-v=TAG | + --pre] ---- @@ -24,9 +25,8 @@ To opt out of Update notifications, set ``ASTRA_NO_UPDATE_NOTIFIER=true``, or, e `-v`, `--version`:: Version to upgrade to (default: latest) `--pre`, `--prerelease`:: Include pre-releases when looking for the latest version -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -34,10 +34,11 @@ To opt out of Update notifications, set ``ASTRA_NO_UPDATE_NOTIFIER=true``, or, e `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== + == Examples + [source,bash] ---- # Upgrade to the latest stable version diff --git a/modules/commands/pages/astra-user-delete.adoc b/modules/commands/pages/astra-user-delete.adoc index febd7d5..b632e9c 100644 --- a/modules/commands/pages/astra-user-delete.adoc +++ b/modules/commands/pages/astra-user-delete.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra user delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] USER + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] USER ---- @@ -20,9 +20,8 @@ Delete an existing user `USER`:: User email/id to delete `--if-exists`:: Do not fail if user does not exist -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -30,19 +29,18 @@ Delete an existing user `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Delete a specific user diff --git a/modules/commands/pages/astra-user-get.adoc b/modules/commands/pages/astra-user-get.adoc index aced4d2..c65fd33 100644 --- a/modules/commands/pages/astra-user-get.adoc +++ b/modules/commands/pages/astra-user-get.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra user get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs - [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] USER + [=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] USER ---- @@ -22,9 +22,8 @@ Show details for a specific user `USER`:: User email/id to get -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Show details for a specific user `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Get details for a specific user by email diff --git a/modules/commands/pages/astra-user-invite.adoc b/modules/commands/pages/astra-user-invite.adoc index 62a9829..f0aad80 100644 --- a/modules/commands/pages/astra-user-invite.adoc +++ b/modules/commands/pages/astra-user-invite.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra user invite [-qV] [--if-not-exists] [--no-input] [--[no-]spinner] [--color - [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-r=<$roles>[, - <$roles>...]]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] USER + [=WHEN]] [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] + [-r=<$roles>[,<$roles>...]]... [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] USER ---- @@ -22,9 +22,8 @@ Invite a user to an organization `-r`, `--roles`:: List of roles to assign the user `--if-not-exists`:: Do not fail if user already exists -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -32,19 +31,18 @@ Invite a user to an organization `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # Invite a user with default "Database Administrator" role diff --git a/modules/commands/pages/astra-user-list.adoc b/modules/commands/pages/astra-user-list.adoc index 7d91e0b..f753bc9 100644 --- a/modules/commands/pages/astra-user-list.adoc +++ b/modules/commands/pages/astra-user-list.adoc @@ -3,8 +3,8 @@ [source,shell] ---- astra user list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] + [--dump-logs[=FILE]] [-h[=all]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -18,9 +18,8 @@ List all users in the org == Options -.Common Options -[%collapsible] -==== +=== Common Options +`-h`, `--help`:: Show this help message and exit. `-o`, `--output`:: One of: human, json, csv `-V`, `--verbose`:: Enable verbose logging output `-q`, `--quiet`:: Only output essential information @@ -28,19 +27,18 @@ List all users in the org `--no-input`:: Don't ask for user input (e.g. confirmation prompts) `--color`:: One of: auto, never, always `--dump-logs`:: Write all logs to an optionally specified file -==== -.Connection Options -[%collapsible] -==== + +=== Connection Options `-cf`, `--config-file`:: The ``.astrarc`` file to use for this command `-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``. `--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks. -`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. -==== +`--env`:: Astra environment the token belongs to: prod (default), dev, test, or local. Leave unset unless you were issued a non-prod token. + == Examples + [source,bash] ---- # List all users in your organization diff --git a/modules/commands/pages/astra-user.adoc b/modules/commands/pages/astra-user.adoc index 3afcd92..9de093a 100644 --- a/modules/commands/pages/astra-user.adoc +++ b/modules/commands/pages/astra-user.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra user [COMMAND] +astra user [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-h[=all]] [-o=FORMAT] [COMMAND] ---- @@ -22,8 +23,20 @@ Manage users in your organization == Options +=== Common Options +`-h`, `--help`:: Show this help message and exit. +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file + + == Examples + [source,bash] ---- # List all your Astra users diff --git a/modules/commands/partials/partial-nav.adoc b/modules/commands/partials/partial-nav.adoc index 810ebd6..a4115c1 100644 --- a/modules/commands/partials/partial-nav.adoc +++ b/modules/commands/partials/partial-nav.adoc @@ -47,6 +47,7 @@ ** xref:commands:astra-db-delete-table.adoc[] ** xref:commands:astra-db-truncate-table.adoc[] ** xref:commands:astra-db-list-embedding-providers.adoc[] +** xref:commands:astra-db-list-reranking-providers.adoc[] ** xref:commands:astra-db-list-cdcs.adoc[] ** xref:commands:astra-db-create-cdc.adoc[] ** xref:commands:astra-db-delete-cdc.adoc[]