Skip to content

Commit e48aaa3

Browse files
committed
Reorder CLI commands
1 parent 9d097db commit e48aaa3

File tree

2 files changed

+49
-49
lines changed

2 files changed

+49
-49
lines changed

cli/cmd/root.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,16 +100,16 @@ func Execute() {
100100
rootCmd.AddCommand(deployCmd)
101101
rootCmd.AddCommand(getCmd)
102102
rootCmd.AddCommand(logsCmd)
103-
rootCmd.AddCommand(refreshCmd)
104103
rootCmd.AddCommand(predictCmd)
104+
rootCmd.AddCommand(refreshCmd)
105105
rootCmd.AddCommand(deleteCmd)
106106

107-
rootCmd.AddCommand(configureCmd)
108107
rootCmd.AddCommand(clusterCmd)
108+
rootCmd.AddCommand(versionCmd)
109109

110-
rootCmd.AddCommand(completionCmd)
110+
rootCmd.AddCommand(configureCmd)
111111
rootCmd.AddCommand(supportCmd)
112-
rootCmd.AddCommand(versionCmd)
112+
rootCmd.AddCommand(completionCmd)
113113

114114
printLeadingNewLine()
115115
rootCmd.Execute()

docs/cluster/cli.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,6 @@ Flags:
4747
-h, --help help for logs
4848
```
4949

50-
## refresh
51-
52-
```text
53-
This command sends all project configuration and code to Cortex.
54-
If validations pass, Cortex will attempt to create the desired state,
55-
and override the existing deployment.
56-
57-
Usage:
58-
cortex refresh [flags]
59-
60-
Flags:
61-
-e, --env string environment (default "default")
62-
-f, --force stop all running jobs
63-
-h, --help help for refresh
64-
```
65-
6650
## predict
6751

6852
```text
@@ -79,34 +63,34 @@ Flags:
7963
-h, --help help for predict
8064
```
8165

82-
## delete
66+
## refresh
8367

8468
```text
85-
This command deletes a deployment from the cluster.
69+
This command sends all project configuration and code to Cortex.
70+
If validations pass, Cortex will attempt to create the desired state,
71+
and override the existing deployment.
8672
8773
Usage:
88-
cortex delete [DEPLOYMENT_NAME] [flags]
74+
cortex refresh [flags]
8975
9076
Flags:
9177
-e, --env string environment (default "default")
92-
-h, --help help for delete
93-
-c, --keep-cache keep cached data for the deployment
78+
-f, --force stop all running jobs
79+
-h, --help help for refresh
9480
```
9581

96-
## configure
82+
## delete
9783

9884
```text
99-
This command configures the Cortex URL and AWS credentials
100-
in order to authenticate and send requests to Cortex.
101-
The configuration is stored in ~/.cortex.
85+
This command deletes a deployment from the cluster.
10286
10387
Usage:
104-
cortex configure [flags]
88+
cortex delete [DEPLOYMENT_NAME] [flags]
10589
10690
Flags:
10791
-e, --env string environment (default "default")
108-
-h, --help help for configure
109-
-p, --print print the configuration
92+
-h, --help help for delete
93+
-c, --keep-cache keep cached data for the deployment
11094
```
11195

11296
## cluster up
@@ -161,25 +145,31 @@ Flags:
161145
-h, --help help for down
162146
```
163147

164-
## completion
148+
## version
165149

166-
```text
167-
Generate bash completion scripts.
150+
This command prints the version of the CLI and cluster
168151

169-
Add this to your bashrc or bash profile:
170-
source <(cortex completion)
171-
Or run:
172-
echo 'source <(cortex completion)' >> ~/.bash_profile # Mac
173-
echo 'source <(cortex completion)' >> ~/.bashrc # Linux
152+
Usage:
153+
cortex version [flags]
174154

175-
This will also add the "cx" alias.
176-
Note: Cortex CLI completion requires the bash_completion package to be installed on your system.
155+
Flags:
156+
-e, --env string environment (default "default")
157+
-h, --help help for version
158+
159+
## configure
160+
161+
```text
162+
This command configures the Cortex URL and AWS credentials
163+
in order to authenticate and send requests to Cortex.
164+
The configuration is stored in ~/.cortex.
177165
178166
Usage:
179-
cortex completion [flags]
167+
cortex configure [flags]
180168
181169
Flags:
182-
-h, --help help for completion
170+
-e, --env string environment (default "default")
171+
-h, --help help for configure
172+
-p, --print print the configuration
183173
```
184174

185175
## support
@@ -194,13 +184,23 @@ Flags:
194184
-h, --help help for support
195185
```
196186

197-
## version
187+
## completion
198188

199-
This command prints the version of the CLI and cluster
189+
```text
190+
Generate bash completion scripts.
191+
192+
Add this to your bashrc or bash profile:
193+
source <(cortex completion)
194+
Or run:
195+
echo 'source <(cortex completion)' >> ~/.bash_profile # Mac
196+
echo 'source <(cortex completion)' >> ~/.bashrc # Linux
197+
198+
This will also add the "cx" alias.
199+
Note: Cortex CLI completion requires the bash_completion package to be installed on your system.
200200
201201
Usage:
202-
cortex version [flags]
202+
cortex completion [flags]
203203
204204
Flags:
205-
-e, --env string environment (default "default")
206-
-h, --help help for version
205+
-h, --help help for completion
206+
```

0 commit comments

Comments
 (0)