Skip to content

Commit dda5715

Browse files
committed
Update CLI docs
1 parent cfb7c49 commit dda5715

File tree

2 files changed

+62
-37
lines changed

2 files changed

+62
-37
lines changed

cli/cmd/configure.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func init() {
4545
}
4646

4747
var _configureCmd = &cobra.Command{
48-
Use: "configure",
48+
Use: "configure [--profile=PROFIE_NAME]",
4949
Short: "configure a cli profile",
5050
Args: cobra.NoArgs,
5151
Run: func(cmd *cobra.Command, args []string) {
@@ -122,7 +122,7 @@ var _configureListCmd = &cobra.Command{
122122
}
123123

124124
var _configureRemoveCmd = &cobra.Command{
125-
Use: "remove",
125+
Use: "remove PROFILE_NAME",
126126
Short: "remove a configured profile",
127127
Args: cobra.ExactArgs(1),
128128
Run: func(cmd *cobra.Command, args []string) {

docs/cluster-management/cli.md

Lines changed: 60 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Usage:
1111
cortex deploy [CONFIG_FILE] [flags]
1212
1313
Flags:
14-
-e, --env string environment (default "default")
15-
-f, --force override the in-progress api update
16-
-h, --help help for deploy
17-
-y, --yes skip prompts
14+
-f, --force override the in-progress api update
15+
-h, --help help for deploy
16+
-p, --profile string profile (default "local")
17+
-y, --yes skip prompts
1818
```
1919

2020
## get
@@ -26,9 +26,9 @@ Usage:
2626
cortex get [API_NAME] [flags]
2727
2828
Flags:
29-
-e, --env string environment (default "default")
30-
-h, --help help for get
31-
-w, --watch re-run the command every second
29+
-h, --help help for get
30+
-p, --profile string profile (default "local")
31+
-w, --watch re-run the command every second
3232
```
3333

3434
## logs
@@ -40,8 +40,8 @@ Usage:
4040
cortex logs API_NAME [flags]
4141
4242
Flags:
43-
-e, --env string environment (default "default")
44-
-h, --help help for logs
43+
-h, --help help for logs
44+
-p, --profile string profile (default "local")
4545
```
4646

4747
## refresh
@@ -53,9 +53,9 @@ Usage:
5353
cortex refresh API_NAME [flags]
5454
5555
Flags:
56-
-e, --env string environment (default "default")
57-
-f, --force override the in-progress api update
58-
-h, --help help for refresh
56+
-f, --force override the in-progress api update
57+
-h, --help help for refresh
58+
-p, --profile string profile (default "local")
5959
```
6060

6161
## predict
@@ -67,9 +67,9 @@ Usage:
6767
cortex predict API_NAME JSON_FILE [flags]
6868
6969
Flags:
70-
--debug predict with debug mode
71-
-e, --env string environment (default "default")
72-
-h, --help help for predict
70+
--debug predict with debug mode
71+
-h, --help help for predict
72+
-p, --profile string profile (default "local")
7373
```
7474

7575
## delete
@@ -81,10 +81,10 @@ Usage:
8181
cortex delete API_NAME [flags]
8282
8383
Flags:
84-
-e, --env string environment (default "default")
85-
-f, --force delete the api without confirmation
86-
-h, --help help for delete
87-
-c, --keep-cache keep cached data for the api
84+
-f, --force delete the api without confirmation
85+
-h, --help help for delete
86+
-c, --keep-cache keep cached data for the api
87+
-p, --profile string profile (default "local")
8888
```
8989

9090
## cluster up
@@ -96,9 +96,9 @@ Usage:
9696
cortex cluster up [flags]
9797
9898
Flags:
99-
-c, --config string path to a cluster configuration file
100-
-e, --env string environment (default "default")
101-
-h, --help help for up
99+
-c, --config string path to a cluster configuration file
100+
-h, --help help for up
101+
-p, --profile string profile (default "aws")
102102
```
103103

104104
## cluster info
@@ -110,10 +110,11 @@ Usage:
110110
cortex cluster info [flags]
111111
112112
Flags:
113-
-c, --config string path to a cluster configuration file
114-
-d, --debug save the current cluster state to a file
115-
-e, --env string environment (default "default")
116-
-h, --help help for info
113+
-c, --config string path to a cluster configuration file
114+
-d, --debug save the current cluster state to a file
115+
-h, --help help for info
116+
-p, --profile string profile (default "aws")
117+
117118
```
118119

119120
## cluster update
@@ -125,9 +126,9 @@ Usage:
125126
cortex cluster update [flags]
126127
127128
Flags:
128-
-c, --config string path to a cluster configuration file
129-
-e, --env string environment (default "default")
130-
-h, --help help for update
129+
-c, --config string path to a cluster configuration file
130+
-h, --help help for update
131+
-p, --profile string profile (default "aws")
131132
```
132133

133134
## cluster down
@@ -152,25 +153,49 @@ Usage:
152153
cortex version [flags]
153154
154155
Flags:
155-
-e, --env string environment (default "default")
156-
-h, --help help for version
156+
-h, --help help for version
157+
-p, --profile string profile (default "local")
157158
```
158159

159160
## configure
160161

161162
```text
162-
configure the cli
163+
configure a cli profile
163164
164165
Usage:
165-
cortex configure [flags]
166+
cortex configure [--profile=PROFIE_NAME] [flags]
166167
167168
Flags:
168169
-k, --aws-access-key-id string set the aws access key id without prompting
169170
-s, --aws-secret-access-key string set the aws secret access key without prompting
170-
-e, --env string environment (default "default")
171171
-h, --help help for configure
172172
-o, --operator-endpoint string set the operator endpoint without prompting
173-
-p, --print print the configuration
173+
-p, --profile string profile (default "local")
174+
-v, --provider string set the provider without prompting
175+
```
176+
177+
## configure list
178+
179+
```text
180+
list all configured profiles
181+
182+
Usage:
183+
cortex configure list [flags]
184+
185+
Flags:
186+
-h, --help help for list
187+
```
188+
189+
## configure remove
190+
191+
```text
192+
remove a configured profile
193+
194+
Usage:
195+
cortex configure remove PROFILE_NAME [flags]
196+
197+
Flags:
198+
-h, --help help for remove
174199
```
175200

176201
## completion

0 commit comments

Comments
 (0)