Skip to content

Commit 49f3ad4

Browse files
committed
Update README for cli
Signed-off-by: Luca Carrogu <[email protected]>
1 parent 25b0ba2 commit 49f3ad4

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

cli/README

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
cfncluster is an example framework for launching clusters.
22

3-
usage: cfncluster [-h] [--config CONFIG_FILE] [--region REGION] [--nowait]
4-
{create,update,delete,status,list,instances,version}
3+
usage: cfncluster [-h]
4+
{create,update,delete,start,stop,status,list,instances,ssh,configure,version}
55
...
66

7-
cfncluster is the a tool to launch and manage cluster.
7+
cfncluster is a tool to launch and manage a cluster.
88

99
positional arguments:
10-
{create,update,stop,delete,status,list,instances,sshmaster}
10+
{create,update,delete,start,stop,status,list,instances,ssh,configure,version}
1111
create creates a cluster
1212
update update a running cluster
1313
delete delete a cluster
14+
start start the compute fleet that has been stopped
15+
stop stop the compute fleet, but leave the master server
16+
running for debugging/development
1417
status pull the current status of the cluster
1518
list display a list of stacks associated with cfncluster
1619
instances display a list of all instances in a cluster
17-
version display the version of cfncluster cli
20+
ssh connect to the master server using SSH
21+
configure creating initial cfncluster configuration
22+
version display version of cfncluster
1823

1924
optional arguments:
2025
-h, --help show this help message and exit
21-
--config CONFIG_FILE, -c CONFIG_FILE
22-
specify a alternative config file
23-
--region REGION, -r REGION
24-
specify a specific region to connect to
25-
--nowait, -nw do not wait for stack events, after executing stack
26-
command
26+
27+
For command specific flags run cfncluster [command] --help

0 commit comments

Comments
 (0)