You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The CLI can also be downloaded directly from the [releases page](https://github.com/datastax/astra-cli/releases).
52
55
53
-
Nix, docker, brew, and potentially other installation methods are coming soon. However, the installation script will always be the recommended way to install the Astra CLI.
56
+
Nix, docker, and potentially other installation methods are coming soon.
57
+
58
+
### Migrating from v0.x
59
+
60
+
If you have previously installed Astra CLI v0.x, it is recommended to uninstall that version before installing v1.x to avoid any potential conflicts.
@@ -64,12 +83,14 @@ You can also download a specific version, or the latest prerelease version, usin
64
83
65
84
```bash
66
85
# Upgrade (or downgrade!) to a specific version
67
-
astra upgrade --version 1.0.0-beta.4
86
+
astra upgrade --version 1.0.0-rc-2
68
87
69
88
# Upgrade to the latest prerelease version
70
89
astra upgrade --pre
71
90
```
72
91
92
+
**Note:** If you installed Astra CLI via a package manager (e.g. brew), use that package manager to upgrade instead.
93
+
73
94
### ⚠️ MacOS warning
74
95
75
96
If you are running macOS and run into an error about the app being from an unidentified developer, you can either:
@@ -79,10 +100,6 @@ If you are running macOS and run into an error about the app being from an unide
79
100
xattr -d com.apple.quarantine $(which astra)
80
101
```
81
102
82
-
> [!NOTE]
83
-
> To avoid running into this issue in the first place, **it is heavily recommended that you use the installation script**, which
84
-
> will not trigger this issue.
85
-
86
103
### Uninstalling
87
104
88
105
To uninstall Astra CLI, you can simply delete the binary, either via `rm`, or via the package manager you installed it with.
@@ -96,7 +113,7 @@ astra nuke
96
113
97
114
## Setup
98
115
99
-
After installation, you can run `astra setup` to configure the CLI. This will interactively guide you through setting up your credentials in a central `.astrarc` file.
116
+
After installation, run `astra setup` to interactively set up your credentials in a central `.astrarc` file.
100
117
101
118
```bash
102
119
# You can run the `setup` command any time to add or update your credentials.
@@ -117,8 +134,8 @@ astra db list --token <your_token> [--env <your_env>]
117
134
> It is highly recommended to use the `@file` syntax to avoid exposing your token in your shell history.
118
135
>
119
136
> ```bash
120
-
>#Have a plain-text file containing just your token (the file can be named anything)
121
-
>echo'AstraCS:...'> my_token
137
+
>#Create a plain-text file containing just your token (the file can be named anything)
138
+
>vim my_token
122
139
>
123
140
># Now the token can be passed securely via a file
By default, Astra CLI outputs responses in a human-friendly format. However, you can change this to JSON or CSV if you prefer, via the `--output` (or `-o`) flag.
164
181
@@ -175,7 +192,7 @@ The vast majority of commands will support all three output formats, but if any
175
192
> [!TIP]
176
193
> Generally, for GET requests, the JSON response will be the raw response from the server, while the human-friendly and CSV formats will be a simplified version of the data.
177
194
178
-
### Output level
195
+
### Output style
179
196
180
197
You can control the verbosity and style of the output via a variety of flags.
181
198
@@ -552,21 +569,24 @@ Some commands, namely the ones that build on `cqlsh`, `dsbulk`, and `pulsar-shel
552
569
553
570
### XDG spec compliance
554
571
572
+
The Astra CLI will now respect the `$XDG_DATA_HOME` and `$XDG_CONFIG_HOME` environment variables for determining where to store its home folder and `.astrarc` file respectively.
573
+
555
574
### Misc changes + bug fixes
556
575
557
576
<details>
558
577
<summary>Other minor changes (not exhaustive)</summary>
559
-
automatically patch cqlsh script to work on machines with a newer python version as default by testing for older python versions explicitly
560
-
consistent support of the `--output` flag across all commands–either a format is supported, or the command will error out before doing anything
561
-
removed `astra-init` script in favor of the `astra compgen`command
562
-
removed `astra login` since it was just an alias of `astra setup`
563
-
`setup`command has been completely rewritten and improved to be much more interactive and user-friendly
564
-
fewer API calls will be made due to better internal caching and logic (commands may be much faster now!)
565
-
fixed inconsistent shell coloring in places (--no-color now definitively works everywhere)
566
-
fixed issues with not being able to use IDs in place of names in some places (e.g. `db delete [id]`)
567
-
timeout durations can now be parsed using iso8601 durations or with simple time units (ms, s, m, h)
568
-
.astrarc parsing is stricter now
569
-
improved .env + .ini parsing + printing
578
+
<li> automatically patch cqlsh script to work on machines with a newer python version as default by testing for older python versions explicitly
579
+
<li> consistent support of the `--output` flag across all commands–either a format is supported, or the command will error out before doing anything
580
+
<li> removed `astra-init` script in favor of the `astra compgen`command
581
+
<li> removed `astra login` since it was just an alias of `astra setup`
582
+
<li>`setup`command has been completely rewritten and improved to be much more interactive and user-friendly
583
+
<li> fewer API calls will be made due to better internal caching and logic (commands may be much faster now!)
584
+
<li> fixed inconsistent shell coloring in places (--no-color now definitively works everywhere)
585
+
<li> fixed issues with not being able to use IDs in place of names in some places (e.g. `db delete [id]`)
586
+
<li> timeout durations can now be parsed using iso8601 durations or with simple time units (ms, s, m, h)
0 commit comments