diff --git a/README.adoc b/README.adoc index 2959137..24aa0b5 100644 --- a/README.adoc +++ b/README.adoc @@ -23,3 +23,40 @@ endif::[] This repository contains the https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc] source files for the {company} {product} documentation. To learn how to update the documentation, see the https://datastax.jira.com/wiki/spaces/DOCS/overview[Docs team Confluence site]. + +== Regenerate the Astra CLI command reference + +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. + +. If you haven't done so yet, clone the Astra CLI code repository: ++ +[source,bash] +---- +git clone https://github.com/datastax/astra-cli.git +---- + +. Change directory to the cloned repository: ++ +[source,bash] +---- +cd astra-cli +---- + +. Pull the latest changes: ++ +[source,bash] +---- +git switch main && git pull +---- + +. Run the following command to regenerate the command reference docs: ++ +[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/ +---- ++ +Replace `repos` with the appropriate path to your cloned repositories. diff --git a/antora.yml b/antora.yml index 622621d..f37cc82 100644 --- a/antora.yml +++ b/antora.yml @@ -13,7 +13,6 @@ asciidoc: product: 'Astra CLI' product-short: 'Astra' product-version: '1.0' - product-repo: 'https://github.com/datastax/astra-cli' db-serverless: 'Serverless (non-vector)' db-serverless-vector: 'Serverless (vector)' db-classic: 'Astra Managed Clusters' diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index a2b57ed..ffd57c9 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -8,11 +8,11 @@ .Quickstarts * xref:quickstarts:cqlsh.adoc[] -include::ROOT:partial$partial-nav.adoc[] +include::commands:partial$partial-nav.adoc[] .Release notes -* {product-repo}?tab=readme-ov-file#whats-changed[Release notes] +* https://github.com/datastax/astra-cli?tab=readme-ov-file#whats-changed[Release notes] //- -* {product-repo}[GitHub repository] +* https://github.com/datastax/astra-cli[GitHub repository] diff --git a/modules/ROOT/pages/install.adoc b/modules/ROOT/pages/install.adoc index 7b4ab82..8f0f41a 100644 --- a/modules/ROOT/pages/install.adoc +++ b/modules/ROOT/pages/install.adoc @@ -63,7 +63,7 @@ The response includes available commands and options for the {product}. === Binary installation on macOS and Linux -. Download the appropriate binary archive for your OS and CPU architecture from {product-repo}/releases[GitHub]. +. Download the appropriate binary archive for your OS and CPU architecture from https://github.com/datastax/astra-cli/releases[GitHub]. . Extract the archive into the directory where you want to install the {product}. For example: @@ -162,7 +162,7 @@ The response includes available commands and options for the {product}. === Binary installation on Windows -. Download the `windows` zip file from {product-repo}/releases[GitHub]. +. Download the `windows` zip file from https://github.com/datastax/astra-cli/releases[GitHub]. . Extract the zip file into the directory where you want to install the {product}: + diff --git a/modules/ROOT/pages/manage-cli.adoc b/modules/ROOT/pages/manage-cli.adoc index ed54379..164cc11 100644 --- a/modules/ROOT/pages/manage-cli.adoc +++ b/modules/ROOT/pages/manage-cli.adoc @@ -531,7 +531,7 @@ The {product} home folder contains the following items: * Cache files for <> * Logs -For more information about `ASTRA_HOME`, see the {product-repo}?tab=readme-ov-file#home-folder-location[{product} README]. +For more information about `ASTRA_HOME`, see the https://github.com/datastax/astra-cli?tab=readme-ov-file#home-folder-location[{product} README]. |`.astrarc` a|The {product} configuration file. @@ -544,7 +544,7 @@ _Default location_: The {product} uses this file to store your <> and their associated application tokens. -For more information about the {product} configuration file, see the {product-repo}?tab=readme-ov-file#astrarc-location[{product} README]. +For more information about the {product} configuration file, see the https://github.com/datastax/astra-cli?tab=readme-ov-file#astrarc-location[{product} README]. |=== === Override the default home folder location diff --git a/modules/ROOT/pages/upgrade-pre-1.0.adoc b/modules/ROOT/pages/upgrade-pre-1.0.adoc index d3c264f..35037e3 100644 --- a/modules/ROOT/pages/upgrade-pre-1.0.adoc +++ b/modules/ROOT/pages/upgrade-pre-1.0.adoc @@ -46,5 +46,5 @@ However, there are some changes that might break certain scripted usage, such as * New standardized xref:ROOT:manage-cli.adoc#output-formats[JSON and CSV output formats and exit codes]. * Minor command and flag name changes. -For a full list of name changes, see the {product-repo}?tab=readme-ov-file#whats-changed[release notes]. +For a full list of name changes, see the https://github.com/datastax/astra-cli?tab=readme-ov-file#whats-changed[release notes]. ==== diff --git a/modules/commands/pages/astra-config-create.adoc b/modules/commands/pages/astra-config-create.adoc index 52b4fce..42ffb00 100644 --- a/modules/commands/pages/astra-config-create.adoc +++ b/modules/commands/pages/astra-config-create.adoc @@ -22,7 +22,7 @@ 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 targets +`-e`, `--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. `-d`, `--default`:: Set the created profile as the default profile. Same as 'config use ' `--overwrite`:: Overwrite any existing profile with the same name diff --git a/modules/commands/pages/astra-db-cqlsh-exec.adoc b/modules/commands/pages/astra-db-cqlsh-exec.adoc index 34511bb..9e46b16 100644 --- a/modules/commands/pages/astra-db-cqlsh-exec.adoc +++ b/modules/commands/pages/astra-db-cqlsh-exec.adoc @@ -7,7 +7,8 @@ astra db cqlsh exec [-qV] [--debug] [--no-input] [--[no-]spinner] [--color [--connect-timeout=TIMEOUT] [--encoding=ENCODING] [-k=KEYSPACE] [-o=FORMAT] [-r=REGION] [--request-timeout=TIMEOUT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [-e[=STATEMENT] | -f=FILE] [DB] + [--token=TOKEN [--env=ENV]]] [-e[=STATEMENT] | -f=FILE] + [DB] [ARGS...] ---- @@ -20,7 +21,8 @@ Execute CQL statements for your db using cqlsh == Options -`DB`:: The name/ID of the Astra database to connect to +`DB`:: The name/ID/endpoint of the Astra database to connect to +`ARGS`:: Verbatim arguments to pass to cqlsh directly (anything after '--' is passed through) `--debug`:: Show additional debugging information `--encoding`:: Output encoding (default: utf8) `--connect-timeout`:: Connection timeout in seconds @@ -49,7 +51,7 @@ Execute CQL statements for your db using cqlsh `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-cqlsh-path.adoc b/modules/commands/pages/astra-db-cqlsh-path.adoc index 42c797d..f09bea5 100644 --- a/modules/commands/pages/astra-db-cqlsh-path.adoc +++ b/modules/commands/pages/astra-db-cqlsh-path.adoc @@ -37,7 +37,7 @@ Get the path to the currently installed cqlsh executable `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-cqlsh-start.adoc b/modules/commands/pages/astra-db-cqlsh-start.adoc index 3a9b036..cdc30f2 100644 --- a/modules/commands/pages/astra-db-cqlsh-start.adoc +++ b/modules/commands/pages/astra-db-cqlsh-start.adoc @@ -7,7 +7,7 @@ astra db cqlsh start [-qV] [--debug] [--no-input] [--[no-]spinner] [--color [--connect-timeout=TIMEOUT] [--encoding=ENCODING] [-k=KEYSPACE] [-o=FORMAT] [-r=REGION] [--request-timeout=TIMEOUT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [] [DB] + [--token=TOKEN [--env=ENV]]] [] [DB] [ARGS...] ---- @@ -20,7 +20,8 @@ Connect to your Astra database using cqlsh == Options -`DB`:: The name/ID of the Astra database to connect to +`DB`:: The name/ID/endpoint of the Astra database to connect to +`ARGS`:: Verbatim arguments to pass to cqlsh directly (anything after '--' is passed through) `--debug`:: Show additional debugging information `--encoding`:: Output encoding (default: utf8) `--connect-timeout`:: Connection timeout in seconds @@ -47,7 +48,7 @@ Connect to your Astra database using cqlsh `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-cqlsh-version.adoc b/modules/commands/pages/astra-db-cqlsh-version.adoc index 35565e0..1121485 100644 --- a/modules/commands/pages/astra-db-cqlsh-version.adoc +++ b/modules/commands/pages/astra-db-cqlsh-version.adoc @@ -41,7 +41,7 @@ Display the currently installed cqlsh's version `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-create-cdc.adoc b/modules/commands/pages/astra-db-create-cdc.adoc index ed9195b..72f9dce 100644 --- a/modules/commands/pages/astra-db-create-cdc.adoc +++ b/modules/commands/pages/astra-db-create-cdc.adoc @@ -44,7 +44,7 @@ Create a CDC (Change Data Capture) for a table in a specific keyspace and tenant `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-create-collection.adoc b/modules/commands/pages/astra-db-create-collection.adoc index aaa7699..55ea861 100644 --- a/modules/commands/pages/astra-db-create-collection.adoc +++ b/modules/commands/pages/astra-db-create-collection.adoc @@ -57,7 +57,7 @@ Create a new Data API collection in the specified database and keyspace `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-create-dotenv.adoc b/modules/commands/pages/astra-db-create-dotenv.adoc index 8ebf165..2727cdd 100644 --- a/modules/commands/pages/astra-db-create-dotenv.adoc +++ b/modules/commands/pages/astra-db-create-dotenv.adoc @@ -48,7 +48,7 @@ Create a env file to help you connect to your Astra DB instance. `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== @@ -59,7 +59,7 @@ Create a env file to help you connect to your Astra DB instance. $ astra db create-dotenv # Create a .env file specifying the keys to include -$ astra db create-dotenv --keys ASTRA_DB_APPLICATION_TOKEN,ASTRA_DB_API_ENDPOINT +$ astra db create-dotenv --keys ASTRA_DB_TOKEN,ASTRA_DB_API_ENDPOINT # Create a .env file with a preset specifying the keys to include $ astra db create-dotenv --preset data_api_client diff --git a/modules/commands/pages/astra-db-create-keyspace.adoc b/modules/commands/pages/astra-db-create-keyspace.adoc index 76c6a04..fd81eb3 100644 --- a/modules/commands/pages/astra-db-create-keyspace.adoc +++ b/modules/commands/pages/astra-db-create-keyspace.adoc @@ -43,7 +43,7 @@ Create a new keyspace in the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-create-region.adoc b/modules/commands/pages/astra-db-create-region.adoc index 4104746..36b4017 100644 --- a/modules/commands/pages/astra-db-create-region.adoc +++ b/modules/commands/pages/astra-db-create-region.adoc @@ -42,7 +42,7 @@ Add a new region to an existing database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-create.adoc b/modules/commands/pages/astra-db-create.adoc index 4f91474..6de0a92 100644 --- a/modules/commands/pages/astra-db-create.adoc +++ b/modules/commands/pages/astra-db-create.adoc @@ -5,9 +5,9 @@ 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] - [-r=REGION] [--tier=TIER] [--timeout=] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [--if-not-exists | - --allow-duplicate-names] DB + [-pg=PCU_GROUP] [-r=REGION] [--tier=TIER] [--timeout=] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [--if-not-exists | --allow-duplicate-names] DB ---- @@ -31,6 +31,7 @@ Create a new Astra database `--tier`:: Tier to create the database in `--capacity-units`:: Capacity units to create the database with `--non-vector`:: Create a classic non-vector database +`-pg`, `--pcu-group`:: The PCU group to associate the database to. .Common Options [%collapsible] @@ -50,7 +51,7 @@ Create a new Astra database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== @@ -73,7 +74,7 @@ $ astra db create my_db --async $ astra db create my_db --region us-east1 --if-not-exists # List available vector database regions for creating a database -$ astra db list-regions-vector +$ astra db regions vector ---- diff --git a/modules/commands/pages/astra-db-data-api-exec.adoc b/modules/commands/pages/astra-db-data-api-exec.adoc new file mode 100644 index 0000000..15b3a05 --- /dev/null +++ b/modules/commands/pages/astra-db-data-api-exec.adoc @@ -0,0 +1,71 @@ += astra db data-api exec + +[source,shell] +---- +astra db data-api exec [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-c[=COLLECTION[, + COLLECTION...]]]... [-t[=TABLE[,TABLE...]]]... [-e=CODE] + [-k=KEYSPACE] [-o=FORMAT] [-r=REGION] [-a=PACKAGES[, + PACKAGES...]]... [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [--node | --python | + --ipython] [DB] [ARGS...] + +---- + + +Execute Data API code against a database + + + + + +== Options + +`DB`:: The name or ID of the Astra database to operate on +`ARGS`:: Verbatim arguments to pass to the underlying node/python directly (anything after '--' is passed through) +`-k`, `--keyspace`:: The keyspace to use +`-a`, `--artifacts`:: Additional packages to include (e.g., pandas, lodash) +`-r`, `--region`:: The region to use +`-c`, `--collection`:: The collections to use +`-t`, `--table`:: The tables to use +`-e`, `--execute`:: Code to execute using the Data API +`--node`:: Use astra-db-ts with Node.js (default) +`--python`:: Use astrapy with Python +`--ipython`:: Use astrapy with IPython + +.Common Options +[%collapsible] +==== +`-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 +[%collapsible] +==== +`-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. +==== + + +== Examples +[source,bash] +---- +# Insert a document using astra-db-ts (passing the -p flag to node) +$ astra db data-api exec my_db -c my_coll -e "my_coll.insertOne({ name: 'Joe' })" -- -p + +# Find a row using python +$ astra db data-api exec my_db -l python -t my_table -e "print(my_table.find_one())" + +# Execute a file +$ astra db data-api exec my_db -e @code.js +---- + + diff --git a/modules/commands/pages/astra-db-data-api-repl.adoc b/modules/commands/pages/astra-db-data-api-repl.adoc new file mode 100644 index 0000000..e45b3c4 --- /dev/null +++ b/modules/commands/pages/astra-db-data-api-repl.adoc @@ -0,0 +1,77 @@ += astra db data-api repl + +[source,shell] +---- +astra db data-api repl [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-c[=COLLECTION[, + COLLECTION...]]]... [-t[=TABLE[,TABLE...]]]... [-e=CODE] + [-k=KEYSPACE] [-o=FORMAT] [-r=REGION] [-a=PACKAGES[, + PACKAGES...]]... [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [--node | --python | + --ipython] [DB] [ARGS...] + +---- + + +Start an interactive Data API REPL session against a database + + + + + +== Options + +`DB`:: The name or ID of the Astra database to operate on +`ARGS`:: Verbatim arguments to pass to the underlying node/python directly (anything after '--' is passed through) +`-k`, `--keyspace`:: The keyspace to use +`-a`, `--artifacts`:: Additional packages to include (e.g., pandas, lodash) +`-r`, `--region`:: The region to use +`-c`, `--collection`:: The collections to use +`-t`, `--table`:: The tables to use +`-e`, `--extra`:: Code to execute after starting the REPL (e.g., to import modules or set up the environment) +`--node`:: Use astra-db-ts with Node.js (default) +`--python`:: Use astrapy with Python +`--ipython`:: Use astrapy with IPython + +.Common Options +[%collapsible] +==== +`-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 +[%collapsible] +==== +`-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. +==== + + +== Examples +[source,bash] +---- +# Start a REPL session using astra-db-ts +$ astra db data-api repl my_db + +# Start a REPL session using astrapy +$ astra db data-api repl my_db -l python + +# Start a REPL session with multiple collections available +$ astra db data-api repl my_db -c coll1 -c coll2 + +# Start a REPL session, prompting for the collections/tables to include +$ astra db data-api repl my_db -c -t + +# Start a Data API REPL for a database and execute some initialization code +$ astra db data-api repl my_db -e "console.log('hello');" +---- + + diff --git a/modules/commands/pages/astra-db-data-api.adoc b/modules/commands/pages/astra-db-data-api.adoc new file mode 100644 index 0000000..eb8b273 --- /dev/null +++ b/modules/commands/pages/astra-db-data-api.adoc @@ -0,0 +1,30 @@ += astra db data-api + +[source,shell] +---- +astra db data-api [COMMAND] + +---- + + +Easily work with the Data API __(beta)__ + + + +== Subcommands + +* xref:astra-db-data-api-repl.adoc[astra db data-api repl] +* xref:astra-db-data-api-exec.adoc[astra db data-api exec] + + +== Options + + + +== Examples +[source,bash] +---- + +---- + + diff --git a/modules/commands/pages/astra-db-delete-cdc.adoc b/modules/commands/pages/astra-db-delete-cdc.adoc index d532cae..fb225c1 100644 --- a/modules/commands/pages/astra-db-delete-cdc.adoc +++ b/modules/commands/pages/astra-db-delete-cdc.adoc @@ -43,7 +43,7 @@ Delete a CDC (Change Data Capture) from the database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-delete-collection.adoc b/modules/commands/pages/astra-db-delete-collection.adoc index c3f5a8d..a2c998a 100644 --- a/modules/commands/pages/astra-db-delete-collection.adoc +++ b/modules/commands/pages/astra-db-delete-collection.adoc @@ -42,7 +42,7 @@ Delete an existing Data API collection from the specified database and keyspace `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-delete-keyspace.adoc b/modules/commands/pages/astra-db-delete-keyspace.adoc index 409fa90..eb80b67 100644 --- a/modules/commands/pages/astra-db-delete-keyspace.adoc +++ b/modules/commands/pages/astra-db-delete-keyspace.adoc @@ -43,7 +43,7 @@ Delete a keyspace from the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-delete-region.adoc b/modules/commands/pages/astra-db-delete-region.adoc index 6ec0fc5..05f1edc 100644 --- a/modules/commands/pages/astra-db-delete-region.adoc +++ b/modules/commands/pages/astra-db-delete-region.adoc @@ -42,7 +42,7 @@ Delete a region from an existing database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-delete-table.adoc b/modules/commands/pages/astra-db-delete-table.adoc index 0508779..95ca599 100644 --- a/modules/commands/pages/astra-db-delete-table.adoc +++ b/modules/commands/pages/astra-db-delete-table.adoc @@ -41,7 +41,7 @@ Delete an existing table from the specified database and keyspace `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-delete.adoc b/modules/commands/pages/astra-db-delete.adoc index 8d84b47..8f4d164 100644 --- a/modules/commands/pages/astra-db-delete.adoc +++ b/modules/commands/pages/astra-db-delete.adoc @@ -42,7 +42,7 @@ Delete an existing Astra database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-describe-collection.adoc b/modules/commands/pages/astra-db-describe-collection.adoc index 62d1b72..83db139 100644 --- a/modules/commands/pages/astra-db-describe-collection.adoc +++ b/modules/commands/pages/astra-db-describe-collection.adoc @@ -40,7 +40,7 @@ Describe an existing Data API collection with detailed information including vec `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-describe-table.adoc b/modules/commands/pages/astra-db-describe-table.adoc index 1dd0ee7..2959324 100644 --- a/modules/commands/pages/astra-db-describe-table.adoc +++ b/modules/commands/pages/astra-db-describe-table.adoc @@ -40,7 +40,7 @@ Describe an existing table with detailed information including columns and prima `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-download-scb.adoc b/modules/commands/pages/astra-db-download-scb.adoc index 597245d..ad27008 100644 --- a/modules/commands/pages/astra-db-download-scb.adoc +++ b/modules/commands/pages/astra-db-download-scb.adoc @@ -40,7 +40,7 @@ Download secure connect bundle for a database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-dsbulk-count.adoc b/modules/commands/pages/astra-db-dsbulk-count.adoc index a5c3362..292c092 100644 --- a/modules/commands/pages/astra-db-dsbulk-count.adoc +++ b/modules/commands/pages/astra-db-dsbulk-count.adoc @@ -8,7 +8,7 @@ astra db dsbulk count [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--max-concurrent-queries=QUERIES] [-o=FORMAT] [-query=QUERY] [-r=REGION] [-t=TABLE] [-F=FLAGS]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - [DB] + [DB] [ARGS...] ---- @@ -22,6 +22,7 @@ Count items for a table, a query == Options `DB`:: The name or ID of the Astra database to operate on +`ARGS`:: Verbatim arguments to pass to dsbulk directly (anything after '--' is passed through) `-k`, `--keyspace`:: Keyspace used for loading or unloading data `-t`, `--table`:: Table used for loading or unloading data. `--encoding`:: The file name format to use when writing. This setting is ignored when reading and for non-file URLs @@ -50,7 +51,7 @@ Count items for a table, a query `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-dsbulk-load.adoc b/modules/commands/pages/astra-db-dsbulk-load.adoc index 2a59294..7e18509 100644 --- a/modules/commands/pages/astra-db-dsbulk-load.adoc +++ b/modules/commands/pages/astra-db-dsbulk-load.adoc @@ -10,7 +10,7 @@ astra db dsbulk load [-qV] [--allow-missing-fields] [--dry-run] [--header] [--max-concurrent-queries=QUERIES] [--max-errors=COUNT] [-o=FORMAT] [-r=REGION] [--skip-records=COUNT] [-t=TABLE] --url=URL [-F=FLAGS]... [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [DB] + [--token=TOKEN [--env=ENV]]] [DB] [ARGS...] ---- @@ -24,6 +24,7 @@ Load data leveraging DSBulk == Options `DB`:: The name or ID of the Astra database to operate on +`ARGS`:: Verbatim arguments to pass to dsbulk directly (anything after '--' is passed through) `-k`, `--keyspace`:: Keyspace used for loading or unloading data `-t`, `--table`:: Table used for loading or unloading data. `--encoding`:: The file name format to use when writing. This setting is ignored when reading and for non-file URLs @@ -59,7 +60,7 @@ Load data leveraging DSBulk `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-dsbulk-path.adoc b/modules/commands/pages/astra-db-dsbulk-path.adoc index f00458b..8c3497d 100644 --- a/modules/commands/pages/astra-db-dsbulk-path.adoc +++ b/modules/commands/pages/astra-db-dsbulk-path.adoc @@ -37,7 +37,7 @@ Get the path to the currently installed dsbulk executable `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-dsbulk-unload.adoc b/modules/commands/pages/astra-db-dsbulk-unload.adoc index 9e07df7..7202701 100644 --- a/modules/commands/pages/astra-db-dsbulk-unload.adoc +++ b/modules/commands/pages/astra-db-dsbulk-unload.adoc @@ -10,7 +10,7 @@ astra db dsbulk unload [-qV] [--header] [--no-input] [--[no-]spinner] [--color [-o=FORMAT] [-query=QUERY] [-r=REGION] [--skip-records=COUNT] [-t=TABLE] [--url=URL] [-F=FLAGS]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [DB] + [--env=ENV]]] [DB] [ARGS...] ---- @@ -24,6 +24,7 @@ Unload data leveraging DSBulk == Options `DB`:: The name or ID of the Astra database to operate on +`ARGS`:: Verbatim arguments to pass to dsbulk directly (anything after '--' is passed through) `-k`, `--keyspace`:: Keyspace used for loading or unloading data `-t`, `--table`:: Table used for loading or unloading data. `--encoding`:: The file name format to use when writing. This setting is ignored when reading and for non-file URLs @@ -58,7 +59,7 @@ Unload data leveraging DSBulk `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-dsbulk-version.adoc b/modules/commands/pages/astra-db-dsbulk-version.adoc index 5186b50..b790920 100644 --- a/modules/commands/pages/astra-db-dsbulk-version.adoc +++ b/modules/commands/pages/astra-db-dsbulk-version.adoc @@ -36,7 +36,7 @@ Display the currently installed dsbulk's version `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-endpoints-api.adoc b/modules/commands/pages/astra-db-endpoints-api.adoc index 474a8b0..e8f0c8b 100644 --- a/modules/commands/pages/astra-db-endpoints-api.adoc +++ b/modules/commands/pages/astra-db-endpoints-api.adoc @@ -2,7 +2,7 @@ [source,shell] ---- -astra db endpoints api [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] +astra db endpoints api [-cqV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -12,6 +12,9 @@ astra db endpoints api [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] Get the API endpoint to interact with the specified database +== Aliases + +`astra db endpoints data-api-client` @@ -20,6 +23,7 @@ Get the API endpoint to interact with the specified database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The region to use +`-c`, `--copy`:: Copy the endpoint to clipboard as well as print it .Common Options [%collapsible] @@ -39,7 +43,7 @@ Get the API endpoint to interact with the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-endpoints-data-api.adoc b/modules/commands/pages/astra-db-endpoints-data-api.adoc index 7614981..5c2c837 100644 --- a/modules/commands/pages/astra-db-endpoints-data-api.adoc +++ b/modules/commands/pages/astra-db-endpoints-data-api.adoc @@ -2,7 +2,7 @@ [source,shell] ---- -astra db endpoints data-api [-qV] [--no-input] [--[no-]spinner] [--color +astra db endpoints data-api [-cqV] [--no-input] [--[no-]spinner] [--color [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -20,6 +20,7 @@ Get the Data API endpoint for the specified database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The region to use +`-c`, `--copy`:: Copy the endpoint to clipboard as well as print it .Common Options [%collapsible] @@ -39,7 +40,7 @@ Get the Data API endpoint for the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-endpoints-list.adoc b/modules/commands/pages/astra-db-endpoints-list.adoc index 1f71f24..b8c6490 100644 --- a/modules/commands/pages/astra-db-endpoints-list.adoc +++ b/modules/commands/pages/astra-db-endpoints-list.adoc @@ -10,8 +10,11 @@ astra db endpoints list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] ---- -Get the various endpoints for a database +Get the various endpoints for your database +== Aliases + +`astra db endpoints` @@ -39,7 +42,7 @@ Get the various endpoints for a database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-endpoints-playground.adoc b/modules/commands/pages/astra-db-endpoints-playground.adoc index 229ca83..205fa3e 100644 --- a/modules/commands/pages/astra-db-endpoints-playground.adoc +++ b/modules/commands/pages/astra-db-endpoints-playground.adoc @@ -2,7 +2,7 @@ [source,shell] ---- -astra db endpoints playground [-qV] [--no-input] [--[no-]spinner] [--color +astra db endpoints playground [-cqV] [--no-input] [--[no-]spinner] [--color [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -20,6 +20,7 @@ Get the GraphQL Playground for the specified database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The region to use +`-c`, `--copy`:: Copy the endpoint to clipboard as well as print it .Common Options [%collapsible] @@ -39,7 +40,7 @@ Get the GraphQL Playground for the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-endpoints-swagger.adoc b/modules/commands/pages/astra-db-endpoints-swagger.adoc index ad09f80..bff5799 100644 --- a/modules/commands/pages/astra-db-endpoints-swagger.adoc +++ b/modules/commands/pages/astra-db-endpoints-swagger.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra db endpoints swagger [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] - [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN +astra db endpoints swagger [-cqV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -20,6 +20,7 @@ Get the SwaggerUI endpoint for the specified database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The region to use +`-c`, `--copy`:: Copy the endpoint to clipboard as well as print it .Common Options [%collapsible] @@ -39,7 +40,7 @@ Get the SwaggerUI endpoint for the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-endpoints.adoc b/modules/commands/pages/astra-db-endpoints.adoc index 39df740..d397c14 100644 --- a/modules/commands/pages/astra-db-endpoints.adoc +++ b/modules/commands/pages/astra-db-endpoints.adoc @@ -2,14 +2,18 @@ [source,shell] ---- -astra db endpoints [COMMAND] +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] ---- -Get various endpoints for your database +Get the various endpoints for your database +**Alias of `astra db endpoints list`** + == Subcommands @@ -22,12 +26,39 @@ Get various endpoints for your database == Options +`DB`:: The name or ID of the Astra database to operate on +`-r`, `--region`:: The region to use + +.Common Options +[%collapsible] +==== +`-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 +[%collapsible] +==== +`-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. +==== == Examples [source,bash] ---- +# List the various endpoints for the specified database +$ astra db endpoints my_db +# Get a specific endpoint for the specified database +$ astra db endpoints data-api-client my_db ---- diff --git a/modules/commands/pages/astra-db-get-endpoint-api.adoc b/modules/commands/pages/astra-db-get-endpoint-api.adoc index e8005f8..a50af2a 100644 --- a/modules/commands/pages/astra-db-get-endpoint-api.adoc +++ b/modules/commands/pages/astra-db-get-endpoint-api.adoc @@ -2,7 +2,7 @@ [source,shell] ---- -astra db get-endpoint-api [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] +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 [--env=ENV]]] [DB] @@ -20,6 +20,7 @@ Get the API endpoint to interact with the specified database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The region to use +`-c`, `--copy`:: Copy the endpoint to clipboard as well as print it .Common Options [%collapsible] @@ -39,7 +40,7 @@ Get the API endpoint to interact with the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-get-endpoint-playground.adoc b/modules/commands/pages/astra-db-get-endpoint-playground.adoc index 170ef9d..878ca5a 100644 --- a/modules/commands/pages/astra-db-get-endpoint-playground.adoc +++ b/modules/commands/pages/astra-db-get-endpoint-playground.adoc @@ -2,7 +2,7 @@ [source,shell] ---- -astra db get-endpoint-playground [-qV] [--no-input] [--[no-]spinner] [--color +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] @@ -20,6 +20,7 @@ Get the GraphQL Playground for the specified database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The region to use +`-c`, `--copy`:: Copy the endpoint to clipboard as well as print it .Common Options [%collapsible] @@ -39,7 +40,7 @@ Get the GraphQL Playground for the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-get-endpoint-swagger.adoc b/modules/commands/pages/astra-db-get-endpoint-swagger.adoc index 1d52372..8bd28b6 100644 --- a/modules/commands/pages/astra-db-get-endpoint-swagger.adoc +++ b/modules/commands/pages/astra-db-get-endpoint-swagger.adoc @@ -2,7 +2,7 @@ [source,shell] ---- -astra db get-endpoint-swagger [-qV] [--no-input] [--[no-]spinner] [--color +astra db get-endpoint-swagger [-cqV] [--no-input] [--[no-]spinner] [--color [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -20,6 +20,7 @@ Get the SwaggerUI endpoint for the specified database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The region to use +`-c`, `--copy`:: Copy the endpoint to clipboard as well as print it .Common Options [%collapsible] @@ -39,7 +40,7 @@ Get the SwaggerUI endpoint for the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-get.adoc b/modules/commands/pages/astra-db-get.adoc index 4245e26..34b6cd6 100644 --- a/modules/commands/pages/astra-db-get.adoc +++ b/modules/commands/pages/astra-db-get.adoc @@ -41,7 +41,7 @@ Get information about a specific database. `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-cdcs.adoc b/modules/commands/pages/astra-db-list-cdcs.adoc index 362572a..adc0e5f 100644 --- a/modules/commands/pages/astra-db-list-cdcs.adoc +++ b/modules/commands/pages/astra-db-list-cdcs.adoc @@ -37,7 +37,7 @@ List all CDC (Change Data Capture) connections for the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-clouds.adoc b/modules/commands/pages/astra-db-list-clouds.adoc index cbbe01e..e9870f4 100644 --- a/modules/commands/pages/astra-db-list-clouds.adoc +++ b/modules/commands/pages/astra-db-list-clouds.adoc @@ -36,7 +36,7 @@ List all cloud providers with regions available for Astra DB `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-collections.adoc b/modules/commands/pages/astra-db-list-collections.adoc index 6c8b8e2..c78b51c 100644 --- a/modules/commands/pages/astra-db-list-collections.adoc +++ b/modules/commands/pages/astra-db-list-collections.adoc @@ -40,7 +40,7 @@ List the collections in the specified database and keyspace `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-embedding-providers.adoc b/modules/commands/pages/astra-db-list-embedding-providers.adoc index 29521dc..1c71c6b 100644 --- a/modules/commands/pages/astra-db-list-embedding-providers.adoc +++ b/modules/commands/pages/astra-db-list-embedding-providers.adoc @@ -38,7 +38,7 @@ Find all available embedding providers for a given database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-keyspaces.adoc b/modules/commands/pages/astra-db-list-keyspaces.adoc index 8fa6bdd..0ca8314 100644 --- a/modules/commands/pages/astra-db-list-keyspaces.adoc +++ b/modules/commands/pages/astra-db-list-keyspaces.adoc @@ -37,7 +37,7 @@ List all keyspaces in the specified database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-regions-classic.adoc b/modules/commands/pages/astra-db-list-regions-classic.adoc index 1c3ce0e..597c3e1 100644 --- a/modules/commands/pages/astra-db-list-regions-classic.adoc +++ b/modules/commands/pages/astra-db-list-regions-classic.adoc @@ -42,7 +42,7 @@ List all available regions for classic Astra DB databases `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-regions-serverless.adoc b/modules/commands/pages/astra-db-list-regions-serverless.adoc index 8a1b895..2a9bb04 100644 --- a/modules/commands/pages/astra-db-list-regions-serverless.adoc +++ b/modules/commands/pages/astra-db-list-regions-serverless.adoc @@ -42,7 +42,7 @@ List all available regions for serverless Astra DB databases `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-regions-vector.adoc b/modules/commands/pages/astra-db-list-regions-vector.adoc index 001d474..31a59fc 100644 --- a/modules/commands/pages/astra-db-list-regions-vector.adoc +++ b/modules/commands/pages/astra-db-list-regions-vector.adoc @@ -42,7 +42,7 @@ List all available regions for vector Astra DB databases `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-regions.adoc b/modules/commands/pages/astra-db-list-regions.adoc index 7e9c037..ca5374a 100644 --- a/modules/commands/pages/astra-db-list-regions.adoc +++ b/modules/commands/pages/astra-db-list-regions.adoc @@ -37,7 +37,7 @@ List the regions for the given database `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list-tables.adoc b/modules/commands/pages/astra-db-list-tables.adoc index 2720b06..7fba1c3 100644 --- a/modules/commands/pages/astra-db-list-tables.adoc +++ b/modules/commands/pages/astra-db-list-tables.adoc @@ -39,7 +39,7 @@ List the tables in the specified database and keyspace `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-list.adoc b/modules/commands/pages/astra-db-list.adoc index aa2a99f..f25e2c2 100644 --- a/modules/commands/pages/astra-db-list.adoc +++ b/modules/commands/pages/astra-db-list.adoc @@ -40,7 +40,7 @@ List your non-terminated Astra databases. `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-regions-classic.adoc b/modules/commands/pages/astra-db-regions-classic.adoc index 6e12576..e1fa6b3 100644 --- a/modules/commands/pages/astra-db-regions-classic.adoc +++ b/modules/commands/pages/astra-db-regions-classic.adoc @@ -41,7 +41,7 @@ List all available regions for classic Astra DB databases `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-regions-serverless.adoc b/modules/commands/pages/astra-db-regions-serverless.adoc index 6b0f835..a7a2b98 100644 --- a/modules/commands/pages/astra-db-regions-serverless.adoc +++ b/modules/commands/pages/astra-db-regions-serverless.adoc @@ -2,7 +2,7 @@ [source,shell] ---- -astra db regions serverless [-qV] [--no-input] [--[no-]spinner] [--color +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]] @@ -22,6 +22,7 @@ List all available regions for serverless Astra DB databases `-f`, `--filter`:: Comma-separated case-insensitive partial-match filters on the region name `-c`, `--cloud`:: Comma-separated list of cloud providers to filter on `-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] @@ -41,7 +42,7 @@ List all available regions for serverless Astra DB databases `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-regions-vector.adoc b/modules/commands/pages/astra-db-regions-vector.adoc index 11510fd..7ffba23 100644 --- a/modules/commands/pages/astra-db-regions-vector.adoc +++ b/modules/commands/pages/astra-db-regions-vector.adoc @@ -2,7 +2,7 @@ [source,shell] ---- -astra db regions vector [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] +astra db regions vector [-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 @@ -22,6 +22,7 @@ List all available regions for vector Astra DB databases `-f`, `--filter`:: Comma-separated case-insensitive partial-match filters on the region name `-c`, `--cloud`:: Comma-separated list of cloud providers to filter on `-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] @@ -41,7 +42,7 @@ List all available regions for vector Astra DB databases `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-resume.adoc b/modules/commands/pages/astra-db-resume.adoc index a78cdd5..28ee929 100644 --- a/modules/commands/pages/astra-db-resume.adoc +++ b/modules/commands/pages/astra-db-resume.adoc @@ -39,7 +39,7 @@ Resume a database that is in a stopped state. If the database is already active, `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-status.adoc b/modules/commands/pages/astra-db-status.adoc index 916c63c..4926341 100644 --- a/modules/commands/pages/astra-db-status.adoc +++ b/modules/commands/pages/astra-db-status.adoc @@ -37,7 +37,7 @@ Get the current status of a database. `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-truncate-collection.adoc b/modules/commands/pages/astra-db-truncate-collection.adoc index fc728cb..f94a706 100644 --- a/modules/commands/pages/astra-db-truncate-collection.adoc +++ b/modules/commands/pages/astra-db-truncate-collection.adoc @@ -40,7 +40,7 @@ Atomically delete all documents in a Data API collection `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db-truncate-table.adoc b/modules/commands/pages/astra-db-truncate-table.adoc index a4c110a..d859373 100644 --- a/modules/commands/pages/astra-db-truncate-table.adoc +++ b/modules/commands/pages/astra-db-truncate-table.adoc @@ -40,7 +40,7 @@ Atomically delete all rows in a table `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-db.adoc b/modules/commands/pages/astra-db.adoc index 9f4af30..30f26fc 100644 --- a/modules/commands/pages/astra-db.adoc +++ b/modules/commands/pages/astra-db.adoc @@ -23,6 +23,7 @@ Manage your Astra databases * xref:astra-db-delete.adoc[astra db delete] * xref:astra-db-status.adoc[astra db status] * xref:astra-db-cqlsh.adoc[astra db cqlsh] +* xref:astra-db-data-api.adoc[astra db data-api] * xref:astra-db-dsbulk.adoc[astra db dsbulk] * xref:astra-db-create-dotenv.adoc[astra db create-dotenv] * xref:astra-db-download-scb.adoc[astra db download-scb] @@ -79,7 +80,7 @@ Manage your Astra databases `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-dotenv-list-keys.adoc b/modules/commands/pages/astra-dotenv-list-keys.adoc new file mode 100644 index 0000000..1cfaf1f --- /dev/null +++ b/modules/commands/pages/astra-dotenv-list-keys.adoc @@ -0,0 +1,39 @@ += astra dotenv list-keys + +[source,shell] +---- +astra dotenv list-keys [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] + +---- + + +List all available Astra keys (no values resolved). + + + + + +== Options + + +.Common Options +[%collapsible] +==== +`-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-dotenv-print.adoc b/modules/commands/pages/astra-dotenv-print.adoc new file mode 100644 index 0000000..d4d16ae --- /dev/null +++ b/modules/commands/pages/astra-dotenv-print.adoc @@ -0,0 +1,57 @@ += astra dotenv print + +[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]]] + +---- + + +Fill bound keys and print to stdout. + + + + + +== Options + +`-f`, `--file`:: The target .env file to update. +`-k`, `--keys`:: Comma-separated EnvKey names to filter the resolved binding set. +`--overwrite`:: Always overwrite non-empty values. +`--db`:: Database to bind to. +`--keyspace`:: The keyspace to use. +`--region`:: The region to use. + +.Common Options +[%collapsible] +==== +`-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 +[%collapsible] +==== +`-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. +==== + + +== Examples +[source,bash] +---- + +---- + + diff --git a/modules/commands/pages/astra-dotenv-write.adoc b/modules/commands/pages/astra-dotenv-write.adoc new file mode 100644 index 0000000..f9dfd72 --- /dev/null +++ b/modules/commands/pages/astra-dotenv-write.adoc @@ -0,0 +1,57 @@ += astra dotenv write + +[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]]] + +---- + + +Fill bound keys and write to a .env file. + + + + + +== Options + +`-f`, `--file`:: The target .env file to update. +`-k`, `--keys`:: Comma-separated EnvKey names to filter the resolved binding set. +`--overwrite`:: Always overwrite non-empty values. +`--db`:: Database to bind to. +`--keyspace`:: The keyspace to use. +`--region`:: The region to use. + +.Common Options +[%collapsible] +==== +`-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 +[%collapsible] +==== +`-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. +==== + + +== Examples +[source,bash] +---- + +---- + + diff --git a/modules/commands/pages/astra-dotenv.adoc b/modules/commands/pages/astra-dotenv.adoc new file mode 100644 index 0000000..a33f93a --- /dev/null +++ b/modules/commands/pages/astra-dotenv.adoc @@ -0,0 +1,31 @@ += astra dotenv + +[source,shell] +---- +astra dotenv [COMMAND] + +---- + + +Easily create and update your .env files __(beta)__ + + + +== Subcommands + +* xref:astra-dotenv-write.adoc[astra dotenv write] +* xref:astra-dotenv-print.adoc[astra dotenv print] +* xref:astra-dotenv-list-keys.adoc[astra dotenv list-keys] + + +== Options + + + +== Examples +[source,bash] +---- + +---- + + diff --git a/modules/commands/pages/astra-org-get.adoc b/modules/commands/pages/astra-org-get.adoc index ba606d0..06c11e2 100644 --- a/modules/commands/pages/astra-org-get.adoc +++ b/modules/commands/pages/astra-org-get.adoc @@ -43,7 +43,7 @@ Use the ``--token @file`` syntax to read the token from a file, to avoid potenti `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-org-id.adoc b/modules/commands/pages/astra-org-id.adoc index 7bbed22..a52ee20 100644 --- a/modules/commands/pages/astra-org-id.adoc +++ b/modules/commands/pages/astra-org-id.adoc @@ -36,7 +36,7 @@ Get your organization's ID `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-org-name.adoc b/modules/commands/pages/astra-org-name.adoc index 3c8281b..2d929fd 100644 --- a/modules/commands/pages/astra-org-name.adoc +++ b/modules/commands/pages/astra-org-name.adoc @@ -36,7 +36,7 @@ Get your organization's name `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-org.adoc b/modules/commands/pages/astra-org.adoc index 1b6c1eb..472d5df 100644 --- a/modules/commands/pages/astra-org.adoc +++ b/modules/commands/pages/astra-org.adoc @@ -47,7 +47,7 @@ Use the ``--token @file`` syntax to read the token from a file, to avoid potenti `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-associate.adoc b/modules/commands/pages/astra-pcu-associate.adoc index 996007f..363a6ea 100644 --- a/modules/commands/pages/astra-pcu-associate.adoc +++ b/modules/commands/pages/astra-pcu-associate.adoc @@ -19,7 +19,7 @@ Associate a PCU group to a datacenter == Options `GROUP`:: The name or ID of the PCU group to operate on -`TARGET`:: PCU association target (database name/id or datacenter id) +`TARGET`:: PCU association target (database name/id/endpoint or datacenter id) `--if-not-exists`:: Don't error if the association already exists .Common Options @@ -40,7 +40,7 @@ Associate a PCU group to a datacenter `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-create.adoc b/modules/commands/pages/astra-pcu-create.adoc index 9fd658f..849403a 100644 --- a/modules/commands/pages/astra-pcu-create.adoc +++ b/modules/commands/pages/astra-pcu-create.adoc @@ -49,7 +49,7 @@ Create a new PCU group `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-delete.adoc b/modules/commands/pages/astra-pcu-delete.adoc index 507ebc7..c332d49 100644 --- a/modules/commands/pages/astra-pcu-delete.adoc +++ b/modules/commands/pages/astra-pcu-delete.adoc @@ -39,7 +39,7 @@ Delete an existing Pcu group `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-disassociate.adoc b/modules/commands/pages/astra-pcu-disassociate.adoc index ad082bd..d027551 100644 --- a/modules/commands/pages/astra-pcu-disassociate.adoc +++ b/modules/commands/pages/astra-pcu-disassociate.adoc @@ -19,7 +19,7 @@ Disassociate a PCU group to a datacenter == Options `GROUP`:: The name or ID of the PCU group to operate on -`TARGET`:: PCU association target (database name/id or datacenter id) +`TARGET`:: PCU association target (database name/id/endpoint or datacenter id) `--if-exists`:: Don't error if the association doesn't exist .Common Options @@ -40,7 +40,7 @@ Disassociate a PCU group to a datacenter `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-find-association.adoc b/modules/commands/pages/astra-pcu-find-association.adoc new file mode 100644 index 0000000..e09b02e --- /dev/null +++ b/modules/commands/pages/astra-pcu-find-association.adoc @@ -0,0 +1,54 @@ += astra pcu find-association + +[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 + +---- + + +Find the PCU group associated with a datacenter + + + + + +== Options + +`TARGET`:: PCU association target (database name/id/endpoint or datacenter id) + +.Common Options +[%collapsible] +==== +`-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 +[%collapsible] +==== +`-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. +==== + + +== Examples +[source,bash] +---- +# Find the PCU group associated with a datacenter +$ astra pcu find-association ee6991af-7783-4de9-8da0-c7fa250c89e2-1 + +# Find the PCU group associated with a database +$ astra pcu find-association my_database +---- + + diff --git a/modules/commands/pages/astra-pcu-get.adoc b/modules/commands/pages/astra-pcu-get.adoc index 6a2baf7..100a0c4 100644 --- a/modules/commands/pages/astra-pcu-get.adoc +++ b/modules/commands/pages/astra-pcu-get.adoc @@ -41,7 +41,7 @@ Get information about a specific PCU group. `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-list-associations.adoc b/modules/commands/pages/astra-pcu-list-associations.adoc index 4a660a3..377ef92 100644 --- a/modules/commands/pages/astra-pcu-list-associations.adoc +++ b/modules/commands/pages/astra-pcu-list-associations.adoc @@ -39,7 +39,7 @@ List the associations of a PCU group `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-list-types.adoc b/modules/commands/pages/astra-pcu-list-types.adoc new file mode 100644 index 0000000..f9aeaa4 --- /dev/null +++ b/modules/commands/pages/astra-pcu-list-types.adoc @@ -0,0 +1,53 @@ += astra pcu list-types + +[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]] | + [--token=TOKEN [--env=ENV]]] + +---- + + +List available PCU types + + + + + +== Options + +`-c`, `--cloud`:: Cloud provider filter +`-r`, `--region`:: Region filter + +.Common Options +[%collapsible] +==== +`-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 +[%collapsible] +==== +`-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. +==== + + +== Examples +[source,bash] +---- +# List all PCU types +$ astra pcu list-types +---- + + diff --git a/modules/commands/pages/astra-pcu-list.adoc b/modules/commands/pages/astra-pcu-list.adoc index 72aa973..43b981a 100644 --- a/modules/commands/pages/astra-pcu-list.adoc +++ b/modules/commands/pages/astra-pcu-list.adoc @@ -39,7 +39,7 @@ List your PCU groups `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-park.adoc b/modules/commands/pages/astra-pcu-park.adoc index b97f508..283dc56 100644 --- a/modules/commands/pages/astra-pcu-park.adoc +++ b/modules/commands/pages/astra-pcu-park.adoc @@ -39,7 +39,7 @@ Park an existing PCU group `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-status.adoc b/modules/commands/pages/astra-pcu-status.adoc index 4c6c896..bd244ef 100644 --- a/modules/commands/pages/astra-pcu-status.adoc +++ b/modules/commands/pages/astra-pcu-status.adoc @@ -37,7 +37,7 @@ Get the current status of a PCU group. `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-transfer-association.adoc b/modules/commands/pages/astra-pcu-transfer-association.adoc index 8750bc9..18e8298 100644 --- a/modules/commands/pages/astra-pcu-transfer-association.adoc +++ b/modules/commands/pages/astra-pcu-transfer-association.adoc @@ -19,7 +19,7 @@ Transfer an association from one PCU group to another == Options -`TARGET`:: PCU association target (database name/id or datacenter id) +`TARGET`:: PCU association target (database name/id/endpoint or datacenter id) `-t`, `--to`:: The PCU group to transfer the association to `--if-not-exists`:: Don't error if the association already exists `-f`, `--from`:: The PCU group which initially holds the association. May be omitted to let the CLI automatically detect it @@ -43,7 +43,7 @@ Transfer an association from one PCU group to another `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-unpark.adoc b/modules/commands/pages/astra-pcu-unpark.adoc index 70e2416..841ad32 100644 --- a/modules/commands/pages/astra-pcu-unpark.adoc +++ b/modules/commands/pages/astra-pcu-unpark.adoc @@ -40,7 +40,7 @@ Unpark a parked PCU group `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu-update.adoc b/modules/commands/pages/astra-pcu-update.adoc index 166fbfe..0a38b8e 100644 --- a/modules/commands/pages/astra-pcu-update.adoc +++ b/modules/commands/pages/astra-pcu-update.adoc @@ -49,7 +49,7 @@ Update an existing PCU group `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-pcu.adoc b/modules/commands/pages/astra-pcu.adoc index 7c93f72..beb46ce 100644 --- a/modules/commands/pages/astra-pcu.adoc +++ b/modules/commands/pages/astra-pcu.adoc @@ -28,7 +28,9 @@ Manage your PCU groups and associations * xref:astra-pcu-associate.adoc[astra pcu associate] * xref:astra-pcu-disassociate.adoc[astra pcu disassociate] * xref:astra-pcu-list-associations.adoc[astra pcu list-associations] +* xref:astra-pcu-find-association.adoc[astra pcu find-association] * xref:astra-pcu-transfer-association.adoc[astra pcu transfer-association] +* xref:astra-pcu-list-types.adoc[astra pcu list-types] == Options @@ -52,7 +54,7 @@ Manage your PCU groups and associations `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-role-get.adoc b/modules/commands/pages/astra-role-get.adoc index e798ce1..9dc72fa 100644 --- a/modules/commands/pages/astra-role-get.adoc +++ b/modules/commands/pages/astra-role-get.adoc @@ -40,7 +40,7 @@ Show details for a specific role `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-role-list.adoc b/modules/commands/pages/astra-role-list.adoc index 4c22031..ea7e59c 100644 --- a/modules/commands/pages/astra-role-list.adoc +++ b/modules/commands/pages/astra-role-list.adoc @@ -36,7 +36,7 @@ Display all roles `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-setup.adoc b/modules/commands/pages/astra-setup.adoc index 264b87d..aaef904 100644 --- a/modules/commands/pages/astra-setup.adoc +++ b/modules/commands/pages/astra-setup.adoc @@ -19,7 +19,7 @@ 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 for the token to target. 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. `--name`:: Optional name for the profile. If not provided, you will be prompted for it .Common Options diff --git a/modules/commands/pages/astra-shellenv.adoc b/modules/commands/pages/astra-shellenv.adoc index 20b5232..6b5fa7d 100644 --- a/modules/commands/pages/astra-shellenv.adoc +++ b/modules/commands/pages/astra-shellenv.adoc @@ -2,7 +2,8 @@ [source,shell] ---- -astra shellenv [--ignore-multiple-paths] [--no-update-notifier] +astra shellenv [--ignore-beta-warnings] [--ignore-multiple-paths] + [--no-update-notifier] [--default-args=<$defaultArgs>] [--home=<$home>] [--rc=<$rc>] ---- @@ -29,7 +30,9 @@ Intended to be added to your shell profile (``.zprofile``, ``.bash_profile``, `` `--home`:: Sets the ``ASTRA_HOME`` env var. See ``astra config home path -h`` for how this is resolved. `--rc`:: Sets the ``ASTRARC`` env var. See ``astra config path -h`` for how this is resolved. `--ignore-multiple-paths`:: Ignore warnings about multiple astra home folders or astrarc files being present. Sets ``ASTRA_IGNORE_MULTIPLE_PATHS=true`` under the hood. +`--ignore-beta-warnings`:: Ignore warnings about commands being in beta. Sets ``ASTRA_IGNORE_BETA_WARNINGS=true`` under the hood. `--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. == Examples @@ -47,8 +50,8 @@ $ eval "$(/path/to/astra shellenv --rc /path/to/astrarc)" # Disable update notifications $ eval "$(/path/to/astra shellenv --no-update-notifier)" -# Ignore warnings about multiple astra home folders or astrarc files -$ eval "$(/path/to/astra shellenv --ignore-multiple-paths)" +# Check the helptext for plenty more options +$ astra shellenv -h ---- diff --git a/modules/commands/pages/astra-streaming-create.adoc b/modules/commands/pages/astra-streaming-create.adoc index 8ea57b1..206c098 100644 --- a/modules/commands/pages/astra-streaming-create.adoc +++ b/modules/commands/pages/astra-streaming-create.adoc @@ -45,7 +45,7 @@ Create a new streaming tenant `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-delete.adoc b/modules/commands/pages/astra-streaming-delete.adoc index d69a996..26a16b5 100644 --- a/modules/commands/pages/astra-streaming-delete.adoc +++ b/modules/commands/pages/astra-streaming-delete.adoc @@ -39,7 +39,7 @@ Delete an existing streaming tenant `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-exist.adoc b/modules/commands/pages/astra-streaming-exist.adoc index 072799c..d23708f 100644 --- a/modules/commands/pages/astra-streaming-exist.adoc +++ b/modules/commands/pages/astra-streaming-exist.adoc @@ -37,7 +37,7 @@ Show existence of a streaming tenant `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-get.adoc b/modules/commands/pages/astra-streaming-get.adoc index f2481b2..9127ad1 100644 --- a/modules/commands/pages/astra-streaming-get.adoc +++ b/modules/commands/pages/astra-streaming-get.adoc @@ -41,7 +41,7 @@ Get the info about a streaming tenant. `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-list-clouds.adoc b/modules/commands/pages/astra-streaming-list-clouds.adoc index 70b21f8..1e9ba74 100644 --- a/modules/commands/pages/astra-streaming-list-clouds.adoc +++ b/modules/commands/pages/astra-streaming-list-clouds.adoc @@ -37,7 +37,7 @@ List all available cloud providers for Astra streaming tenants `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-list-regions.adoc b/modules/commands/pages/astra-streaming-list-regions.adoc index 03ba304..c1713c3 100644 --- a/modules/commands/pages/astra-streaming-list-regions.adoc +++ b/modules/commands/pages/astra-streaming-list-regions.adoc @@ -40,7 +40,7 @@ List all available regions for Astra streaming tenants `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-list.adoc b/modules/commands/pages/astra-streaming-list.adoc index d2019e9..d0b856a 100644 --- a/modules/commands/pages/astra-streaming-list.adoc +++ b/modules/commands/pages/astra-streaming-list.adoc @@ -39,7 +39,7 @@ List your Astra streaming tenants `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-pulsar-path.adoc b/modules/commands/pages/astra-streaming-pulsar-path.adoc index a9b6ce4..95fa6cf 100644 --- a/modules/commands/pages/astra-streaming-pulsar-path.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-path.adoc @@ -38,7 +38,7 @@ Get the path to the currently installed pulsar executable `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-pulsar-shell.adoc b/modules/commands/pages/astra-streaming-pulsar-shell.adoc index bd13de2..b7ab84f 100644 --- a/modules/commands/pages/astra-streaming-pulsar-shell.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-shell.adoc @@ -42,7 +42,7 @@ Launch Apache Pulsar shell for a streaming tenant `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-pulsar-token.adoc b/modules/commands/pages/astra-streaming-pulsar-token.adoc index 2ff85f0..959c0d4 100644 --- a/modules/commands/pages/astra-streaming-pulsar-token.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-token.adoc @@ -38,7 +38,7 @@ Get the Pulsar token for a streaming tenant `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-pulsar-version.adoc b/modules/commands/pages/astra-streaming-pulsar-version.adoc index 79d0439..30a4979 100644 --- a/modules/commands/pages/astra-streaming-pulsar-version.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-version.adoc @@ -37,7 +37,7 @@ Display the currently installed pulsar's version `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming-status.adoc b/modules/commands/pages/astra-streaming-status.adoc index c8afaab..4eda9f8 100644 --- a/modules/commands/pages/astra-streaming-status.adoc +++ b/modules/commands/pages/astra-streaming-status.adoc @@ -37,7 +37,7 @@ Get the current status of a streaming tenant. `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-streaming.adoc b/modules/commands/pages/astra-streaming.adoc index 4921536..736dad3 100644 --- a/modules/commands/pages/astra-streaming.adoc +++ b/modules/commands/pages/astra-streaming.adoc @@ -50,7 +50,7 @@ Manage Astra streaming tenants `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-token-create.adoc b/modules/commands/pages/astra-token-create.adoc index ad4dd9e..98b8c5b 100644 --- a/modules/commands/pages/astra-token-create.adoc +++ b/modules/commands/pages/astra-token-create.adoc @@ -38,7 +38,7 @@ Create a new token `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-token-delete.adoc b/modules/commands/pages/astra-token-delete.adoc index 12f6b9a..c5a68f6 100644 --- a/modules/commands/pages/astra-token-delete.adoc +++ b/modules/commands/pages/astra-token-delete.adoc @@ -41,7 +41,7 @@ Delete a token `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-token-get.adoc b/modules/commands/pages/astra-token-get.adoc index 4b4a7fe..e770447 100644 --- a/modules/commands/pages/astra-token-get.adoc +++ b/modules/commands/pages/astra-token-get.adoc @@ -41,7 +41,7 @@ Show your current token `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== @@ -50,6 +50,12 @@ Show your current token ---- # Show your current token $ astra token get + +# Copy your current token +$ astra token get -c + +# Show a token from a different profile +$ astra token get -p ---- diff --git a/modules/commands/pages/astra-token-list.adoc b/modules/commands/pages/astra-token-list.adoc index 8ef0b71..f922e4c 100644 --- a/modules/commands/pages/astra-token-list.adoc +++ b/modules/commands/pages/astra-token-list.adoc @@ -36,7 +36,7 @@ List your tokens' information `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-token.adoc b/modules/commands/pages/astra-token.adoc index b675100..0150590 100644 --- a/modules/commands/pages/astra-token.adoc +++ b/modules/commands/pages/astra-token.adoc @@ -46,7 +46,7 @@ Manage your Astra tokens `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== @@ -55,6 +55,12 @@ Manage your Astra tokens ---- # Show your current token $ astra token + +# Copy your current token +$ astra token -c + +# Show a token from a different profile +$ astra token -p ---- diff --git a/modules/commands/pages/astra-user-delete.adoc b/modules/commands/pages/astra-user-delete.adoc index cb7043d..febd7d5 100644 --- a/modules/commands/pages/astra-user-delete.adoc +++ b/modules/commands/pages/astra-user-delete.adoc @@ -38,7 +38,7 @@ Delete an existing user `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-user-get.adoc b/modules/commands/pages/astra-user-get.adoc index d9547a7..aced4d2 100644 --- a/modules/commands/pages/astra-user-get.adoc +++ b/modules/commands/pages/astra-user-get.adoc @@ -40,7 +40,7 @@ Show details for a specific user `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-user-invite.adoc b/modules/commands/pages/astra-user-invite.adoc index b119fcc..62a9829 100644 --- a/modules/commands/pages/astra-user-invite.adoc +++ b/modules/commands/pages/astra-user-invite.adoc @@ -40,7 +40,7 @@ Invite a user to an organization `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/commands/pages/astra-user-list.adoc b/modules/commands/pages/astra-user-list.adoc index 0b2111b..7d91e0b 100644 --- a/modules/commands/pages/astra-user-list.adoc +++ b/modules/commands/pages/astra-user-list.adoc @@ -36,7 +36,7 @@ List all users in the org `-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`:: Override the target astra environment +`--env`:: Astra environment the token belongs to: prod (default), dev, or test. Leave unset unless you were issued a non-prod token. ==== diff --git a/modules/ROOT/partials/partial-nav.adoc b/modules/commands/partials/partial-nav.adoc similarity index 92% rename from modules/ROOT/partials/partial-nav.adoc rename to modules/commands/partials/partial-nav.adoc index 503e12d..810ebd6 100644 --- a/modules/ROOT/partials/partial-nav.adoc +++ b/modules/commands/partials/partial-nav.adoc @@ -22,6 +22,9 @@ *** xref:commands:astra-db-cqlsh-exec.adoc[] *** xref:commands:astra-db-cqlsh-version.adoc[] *** xref:commands:astra-db-cqlsh-path.adoc[] +** xref:commands:astra-db-data-api.adoc[] +*** xref:commands:astra-db-data-api-repl.adoc[] +*** xref:commands:astra-db-data-api-exec.adoc[] ** xref:commands:astra-db-dsbulk.adoc[] *** xref:commands:astra-db-dsbulk-count.adoc[] *** xref:commands:astra-db-dsbulk-load.adoc[] @@ -67,6 +70,10 @@ ** xref:commands:astra-db-get-endpoint-swagger.adoc[] ** xref:commands:astra-db-get-endpoint-api.adoc[] ** xref:commands:astra-db-get-endpoint-playground.adoc[] +* xref:commands:astra-dotenv.adoc[] +** xref:commands:astra-dotenv-write.adoc[] +** xref:commands:astra-dotenv-print.adoc[] +** xref:commands:astra-dotenv-list-keys.adoc[] * xref:commands:astra-pcu.adoc[] ** xref:commands:astra-pcu-list.adoc[] ** xref:commands:astra-pcu-get.adoc[] @@ -79,7 +86,9 @@ ** xref:commands:astra-pcu-associate.adoc[] ** xref:commands:astra-pcu-disassociate.adoc[] ** xref:commands:astra-pcu-list-associations.adoc[] +** xref:commands:astra-pcu-find-association.adoc[] ** xref:commands:astra-pcu-transfer-association.adoc[] +** xref:commands:astra-pcu-list-types.adoc[] * xref:commands:astra-org.adoc[] ** xref:commands:astra-org-get.adoc[] ** xref:commands:astra-org-id.adoc[]