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
Copy file name to clipboardExpand all lines: docs/stackit_config.md
+7-6
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,12 @@ Provides functionality for CLI configuration options
4
4
5
5
### Synopsis
6
6
7
-
Provides functionality for CLI configuration options
8
-
The configuration is stored in a file in the user's config directory, which is OS dependent.
9
-
Windows: %APPDATA%\stackit
10
-
Linux: $XDG_CONFIG_HOME/stackit
11
-
macOS: $HOME/Library/Application Support/stackit
12
-
The configuration file is named `cli-config.json` and is created automatically in your first CLI run.
7
+
Provides functionality for CLI configuration options.
8
+
You can set and unset different configuration options via the "stackit config set" and "stackit config unset" commands.
9
+
10
+
Additionally, you can configure the CLI to use different profiles, each with its own configuration.
11
+
Additional profiles can be configured via the "STACKIT_CLI_PROFILE" environment variable or using the "stackit config profile set PROFILE" and "stackit config profile unset" commands.
12
+
The environment variable takes precedence over what is set via the commands.
13
13
14
14
```
15
15
stackit config [flags]
@@ -35,6 +35,7 @@ stackit config [flags]
35
35
36
36
*[stackit](./stackit.md) - Manage STACKIT resources using the command line
37
37
*[stackit config list](./stackit_config_list.md) - Lists the current CLI configuration values
38
+
*[stackit config profile](./stackit_config_profile.md) - Manage the CLI configuration profiles
The profile to be used can be managed via the "STACKIT_CLI_PROFILE" environment variable or using the "stackit config profile set PROFILE" and "stackit config profile unset" commands.
9
+
The environment variable takes precedence over what is set via the commands.
10
+
When no profile is set, the default profile is used.
11
+
12
+
```
13
+
stackit config profile [flags]
14
+
```
15
+
16
+
### Options
17
+
18
+
```
19
+
-h, --help Help for "stackit config profile"
20
+
```
21
+
22
+
### Options inherited from parent commands
23
+
24
+
```
25
+
-y, --assume-yes If set, skips all confirmation prompts
26
+
--async If set, runs the command asynchronously
27
+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
28
+
-p, --project-id string Project ID
29
+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
30
+
```
31
+
32
+
### SEE ALSO
33
+
34
+
*[stackit config](./stackit_config.md) - Provides functionality for CLI configuration options
35
+
*[stackit config profile create](./stackit_config_profile_create.md) - Creates a CLI configuration profile
36
+
*[stackit config profile delete](./stackit_config_profile_delete.md) - Delete a CLI configuration profile
37
+
*[stackit config profile list](./stackit_config_profile_list.md) - Lists all CLI configuration profiles
38
+
*[stackit config profile set](./stackit_config_profile_set.md) - Set a CLI configuration profile
39
+
*[stackit config profile unset](./stackit_config_profile_unset.md) - Unset the current active CLI configuration profile
Set a CLI configuration profile as the active profile.
8
+
The profile to be used can be managed via the STACKIT_CLI_PROFILE environment variable or using the "stackit config profile set PROFILE" and "stackit config profile unset" commands.
9
+
The environment variable takes precedence over what is set via the commands.
10
+
When no profile is set, the default profile is used.
11
+
12
+
```
13
+
stackit config profile set PROFILE [flags]
14
+
```
15
+
16
+
### Examples
17
+
18
+
```
19
+
Set the configuration profile "my-profile" as the active profile
20
+
$ stackit config profile set my-profile
21
+
```
22
+
23
+
### Options
24
+
25
+
```
26
+
-h, --help Help for "stackit config profile set"
27
+
```
28
+
29
+
### Options inherited from parent commands
30
+
31
+
```
32
+
-y, --assume-yes If set, skips all confirmation prompts
33
+
--async If set, runs the command asynchronously
34
+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
35
+
-p, --project-id string Project ID
36
+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
37
+
```
38
+
39
+
### SEE ALSO
40
+
41
+
*[stackit config profile](./stackit_config_profile.md) - Manage the CLI configuration profiles
"The configuration file is named `cli-config.json` and is created automatically in your first CLI run.",
21
+
Long: fmt.Sprintf("%s\n%s\n\n%s\n%s\n%s",
22
+
"Provides functionality for CLI configuration options.",
23
+
`You can set and unset different configuration options via the "stackit config set" and "stackit config unset" commands.`,
24
+
"Additionally, you can configure the CLI to use different profiles, each with its own configuration.",
25
+
`Additional profiles can be configured via the "STACKIT_CLI_PROFILE" environment variable or using the "stackit config profile set PROFILE" and "stackit config profile unset" commands.`,
26
+
"The environment variable takes precedence over what is set via the commands.",
26
27
),
27
28
Args: args.NoArgs,
28
29
Run: utils.CmdHelp,
@@ -35,4 +36,5 @@ func addSubcommands(cmd *cobra.Command, p *print.Printer) {
0 commit comments