Skip to content

Commit c31dd87

Browse files
docs: Add guide to install the STACKIT CLI as homebrew cask (#879)
* Docs: Add guide to uninstall the deprecated formula and reinstall it as cask Co-authored-by: Ruben Hönle <Ruben.Hoenle@stackit.cloud>
1 parent c43de4c commit c31dd87

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

INSTALLATION.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,47 @@ brew tap stackitcloud/tap
1717
2. You can then install the CLI via:
1818

1919
```shell
20-
brew install stackit
20+
brew install --cask stackit
21+
```
22+
23+
#### Formula deprecated
24+
25+
The homebrew formula is deprecated, will no longer be updated and will be removed after 2026-01-22.
26+
You need to install the STACKIT CLI as cask.
27+
Therefor you need to uninstall the formula and reinstall it as cask.
28+
29+
Your profiles should normally remain. To ensure that nothing will be gone, you should backup them.
30+
31+
1. Export your existing profiles. This will create a json file in your current directory.
32+
```shell
33+
stackit config profile export default
34+
```
35+
36+
2. If you have multiple profiles, then execute the export command for each of them. You can find your profiles via:
37+
38+
```shell
39+
stackit config profile list
40+
stackit config profile export <profile-name>
41+
```
42+
43+
3. Uninstall the formula.
44+
```shell
45+
brew uninstall stackit
46+
```
47+
48+
4. Install the STACKIT CLI as cask.
49+
```shell
50+
brew install --cask stackit
51+
```
52+
53+
5. Check if your configs are still stored.
54+
```shell
55+
stackit config profile list
56+
```
57+
58+
6. In case the profiles are gone, import your profiles via:
59+
```shell
60+
$ stackit config profile import -c @default.json --name myProfile
2161
```
2262

2363
### Linux

0 commit comments

Comments
 (0)