Astra CLI 1.0 Release

modules/ROOT/partials/partial-nav.adoc

@@ -6,6 +6,7 @@
 ** xref:commands:astra-config-create.adoc[]
 ** xref:commands:astra-config-get.adoc[]
 ** xref:commands:astra-config-delete.adoc[]
+** xref:commands:astra-config-rename.adoc[]
 ** xref:commands:astra-config-use.adoc[]
 ** xref:commands:astra-config-path.adoc[]
 ** xref:commands:astra-config-home.adoc[]

modules/commands/pages/astra-config-create.adoc

@@ -25,13 +25,18 @@ Use the ``--token @<file>`` syntax to securely read the token from a file, witho
 `-e`, `--env`:: Astra environment the token targets
 `-d`, `--default`:: Set the created profile as the default profile. Same as 'config use <profile>'
 `--overwrite`:: Overwrite any existing profile with the same name
+
+.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

modules/commands/pages/astra-config-delete.adoc

@@ -20,13 +20,18 @@ Delete an existing configuration profile.
 `NAME`:: Name of the profile to delete
 `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved.
 `--if-exists`:: Do not fail if the profile does not exist
+
+.Common Options
+[%collapsible]
+====
 `-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

modules/commands/pages/astra-config-get.adoc

@@ -24,13 +24,18 @@ Get the configuration of a profile or a specific key.
 `NAME`:: Name of the profile to get
 `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved.
 `-k`, `--key`:: Specific configuration key to retrieve
+
+.Common Options
+[%collapsible]
+====
 `-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

modules/commands/pages/astra-config-home-path.adoc

@@ -26,15 +26,20 @@ By default, shows informational output when running in a TTY (interactive termin
 
 == Options
 
+`-p`, `--plain`:: Print only the path to the home folder, without additional information (always)
+`-i`, `--info`:: Print informational output with context about the path (always)
+
+.Common Options
+[%collapsible]
+====
 `-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
-`-p`, `--plain`:: Print only the path to the home folder, without additional information (always)
-`-i`, `--info`:: Print informational output with context about the path (always)
+====
 
 
 == Examples

modules/commands/pages/astra-config-list.adoc

@@ -21,13 +21,18 @@ List your Astra CLI configurations.
 
 `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved.
 `-e`, `--env`:: Filter by Astra environment
+
+.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

modules/commands/pages/astra-config-path.adoc

@@ -26,15 +26,20 @@ By default, shows informational output when running in a TTY (interactive termin
 
 == Options
 
+`-p`, `--plain`:: Print only the path to the .astrarc file, without additional information (always)
+`-i`, `--info`:: Print informational output with context about the path (always)
+
+.Common Options
+[%collapsible]
+====
 `-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
-`-p`, `--plain`:: Print only the path to the .astrarc file, without additional information (always)
-`-i`, `--info`:: Print informational output with context about the path (always)
+====
 
 
 == Examples

modules/commands/pages/astra-config-rename.adoc

@@ -0,0 +1,46 @@
+= astra config rename
+
+[source,shell]
+----
+astra config rename [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]]
+                    [-cf=PATH] [--color=WHEN] [-o=FORMAT] [NAME] NAME
+
+----
+
+
+Rename an existing configuration profile.
+
+
+
+
+
+== Options
+
+`NAME`:: Name of the profile to rename
+`NAME`:: New name for the profile
+`-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved.
+
+.Common Options
+[%collapsible]
+====
+`-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]
+----
+# Rename a profile from 'old_name' to 'new_name'
+$ astra config rename old_name new_name
+
+# Interactively rename a profile
+$ astra config rename
+----
+
+

modules/commands/pages/astra-config-use.adoc

@@ -18,13 +18,18 @@ Sets an existing profile to be used as the default for all commands. Use the ``-
 
 `NAME`:: Profile to set as default
 `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved.
+
+.Common Options
+[%collapsible]
+====
 `-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

modules/commands/pages/astra-config.adoc

@@ -20,6 +20,7 @@ Manage your Astra CLI configuration profiles
 * xref:astra-config-create.adoc[astra config create]
 * xref:astra-config-get.adoc[astra config get]
 * xref:astra-config-delete.adoc[astra config delete]
+* xref:astra-config-rename.adoc[astra config rename]
 * xref:astra-config-use.adoc[astra config use]
 * xref:astra-config-path.adoc[astra config path]
 * xref:astra-config-home.adoc[astra config home]
@@ -29,13 +30,18 @@ Manage your Astra CLI configuration profiles
 
 `-cf`, `--config-file`:: The .astrarc file to work with. See ``astra config path -h`` for how this is resolved.
 `-e`, `--env`:: Filter by Astra environment
+
+.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

modules/commands/pages/astra-db-cqlsh-exec.adoc

@@ -28,17 +28,27 @@ Execute CQL statements for your db using cqlsh
 `--request-timeout`:: Request timeout in seconds
 `-r`, `--region`:: The region to use. Uses the db's default region if not specified.
 `-f`, `--file`:: Execute commands from a CQL file, then exit
+
+.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
 `--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
+====
 
 
 == Examples

modules/commands/pages/astra-db-cqlsh-path.adoc

@@ -18,17 +18,27 @@ Get the path to the currently installed cqlsh executable
 == Options
 
 `--if-exists`:: Only return path if cqlsh exists, don't install automatically
+
+.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
 `--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
+====
 
 
 == Examples

modules/commands/pages/astra-db-cqlsh-start.adoc

@@ -26,17 +26,27 @@ Connect to your Astra database using cqlsh
 `-k`, `--keyspace`:: Authenticate to the given keyspace
 `--request-timeout`:: Request timeout in seconds
 `-r`, `--region`:: The region to use. Uses the db's default region if not specified.
+
+.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
 `--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
+====
 
 
 == Examples

modules/commands/pages/astra-db-cqlsh-version.adoc

@@ -22,17 +22,27 @@ Display the currently installed cqlsh's version
 `--debug`:: Show additional debugging information
 `--encoding`:: Output encoding (default: utf8)
 `--connect-timeout`:: Connection timeout in seconds
+
+.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
 `--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
+====
 
 
 == Examples

modules/commands/pages/astra-db-create-cdc.adoc

@@ -25,17 +25,27 @@ Create a CDC (Change Data Capture) for a table in a specific keyspace and tenant
 `--tenant`:: The tenant name
 `--topic-partitions`:: Number of topic partitions
 `--if-not-exists`:: Will create a new CDC only if none exists
+
+.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
 `--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
+====
 
 
 == Examples