Basic Commands
get
Retrieve environments residing on applications.
arguments
You can supply the environment id as an argument on the command to fetch details of that specific environment. Like,
$ zocli env get 1
You can also search environment by name but, for that application must be provided, either by context or by flags.
$ zocli env get name
If no any argument is supplied then, all the environments of the default or the context application will be fetched, if set and if no any application is set on the context then Help menu will be printed.
$ zocli env get
overview
Get the usage overview of the environment using,
$ zocli env overview [envID | envName]
arguments
There are two arguments that can be supplied on this command i.e. environment ID or Name. Note: The name argument is still under development.
flags
This flag is available for every commands and sub-commands and this prints the help menu for that specific command, and this flag can be used as,
$ zocli env overview [--help | -h]
Note: If help flag is supplied then, any other flags or arguments will be ignored
If you are not providing environment id from the arguments then, you can start the --id flag, and provide the environment id to fetch overview details about that specific one. And this exactly works as same as while provided from argument.
Example:
$ zocli env overview [--id | -i] 2454
If you are not providing environment name from the arguments then, you can start the --name flag, and provide the environment name to fetch details about that specific environment. And this exactly works as same as while provided from argument.
Example:
$ zocli env overview [--name | -n] test
Output flag with format, will trigger the zocli to print the output in the desired format like, JSON and this flag can be used in combination with any other flags. This can be helpful if you want to automate works in 01cloud using any other 3rd party tools (like, jq). And as of right now, zocli supports 2 formats i.e. JSON and YAML. And you can utilize this output for using as manifest or resource file while performing actions using cli commannd apply.
You can use the output flag as,
$ zocli env overview -o [json | yaml]
start
This command can be used to start any environment which has stopped status on the 01cloud console. NOTE: If name will be supplied on the arguments to start the environment, then application name or id must be provided or available on the context value.
$ zocli env start [envID | envName]
argument
The arguemnts that can be supplied in this command are, environment ID or name.
NOTE: the name feature as an argument is under development.
flags
This flag is available for every commands and sub-commands and this prints the help menu for that specific command, and this flag can be used as,
$ zocli env start [--help | -h]
Note: If help flag is supplied then, any other flags or arguments will be ignored
If you are not providing environment id from the arguments then, you can start the --id flag, and provide the environment id to start that specific one. And this exactly works as same as while provided from argument.
Example:
$ zocli env start [--id | -i] 2454
If you are not providing environment name from the arguments then, you can start the --name flag, and provide the environment name to start that specific environment. And this exactly works as same as while provided from argument.
Example:
$ zocli env start [--name | -n] test
stop
This command can be used to stop any environment which has running or started status on the 01cloud console. NOTE: If name will be supplied on the arguments to start the environment, then application name or id must be provided or available on the context value.
$ zocli env stop [envID | envName]
argument
The arguemnts that can be supplied in this command are, environment ID or name.
NOTE: the name feature as an argument is under development.
flags
This flag is available for every commands and sub-commands and this prints the help menu for that specific command, and this flag can be used as,
$ zocli env stop [--help | -h]
Note: If help flag is supplied then, any other flags or arguments will be ignored
If you are not providing environment id from the arguments then, you can stop the --id flag, and provide the environment id to stop that specific one. And this exactly works as same as while provided from argument.
Example:
$ zocli env stop [--id | -i] 2454
If you are not providing environment name from the arguments then, you can stop the --name flag, and provide the environment name to stop that specific environment. And this exactly works as same as while provided from argument.
Example:
$ zocli env stop [--name | -n] test
delete
This command can be used to delete any environment which has running or even stopped status on the 01cloud console. NOTE: If name will be supplied on the arguments to delete the environment, then application name or id must be provided or available on the context value.
$ zocli env delete [envID | envName]
argument
The arguemnts that can be supplied in this command are, environment ID or name.
NOTE: the name feature as an argument is under development.
flags
This flag is available for every commands and sub-commands and this prints the help menu for that specific command, and this flag can be used as,
$ zocli env delete [--help | -h]
Note: If help flag is supplied then, any other flags or arguments will be ignored
If you are not providing environment id from the arguments then, you can delete the --id flag, and provide the environment id to delete that specific one. And this exactly works as same as while provided from argument.
Example:
$ zocli env delete [--id | -i] 2454
If you are not providing environment name from the arguments then, you can delete the --name flag, and provide the environment name to delete that specific environment. And this exactly works as same as while provided from argument.
Example:
$ zocli env delete [--name | -n] test
rename
This command can be used to rename any environment which has running or even stopped status on the 01cloud console. NOTE: If name will be supplied on the arguments to rename the environment, then application name or id must be provided or available on the context value.
$ zocli env rename [envID | envName]
argument
The arguemnts that can be supplied in this command are, environment ID or name.
NOTE: the name feature as an argument is under development.
flags
This flag is available for every commands and sub-commands and this prints the help menu for that specific command, and this flag can be used as,
$ zocli env rename [--help | -h]
Note: If help flag is supplied then, any other flags or arguments will be ignored
If you are not providing environment id from the arguments then, you can rename the --id flag, and provide the environment id to rename that specific one. And this exactly works as same as while provided from argument.
Example:
$ zocli env rename [--id | -i] 2454
you can use --name flag, and provide the environment name to provide new updated name for that specific environment.
Example:
$ zocli env rename [--name | -n] test