Comment on page
CLI commands
Interacting with the Hadean Platform
hadean <SUBCOMMAND>Flags | |
--help | -h | Prints help information |
--version | -V | Prints version information |
--log_level <LOG_LEVEL> | Set logging levels for requests made to the portal, gateway, and analytics. Possible values are INFO and DEBUG. Defaults to INFO. |
--simple | Don't print fancy logs, just print the logs alone (no colour / levels / time). |
--no-parse-logs | Don't parse out the messages from our JSON log format, instead just print the JSON. |
--mappings | -m | Used with the run and cluster deploy commands, specifies mappings of files and directories to make available to the simulation program. For example, -m /file1=~/files/file1 will make the local file ~/files/file1 available as /file1 to the simulation program. -m can be passed multiple times to specify multiple mappings. |
--runtime | -r | Advanced option used with the cluster deploy command to override the default Ubuntu runtime bundle used to run your simulation program on. |
Subcommands | |
help | Prints help message or the help for a given subcommand |
login | Authenticates the CLI with the Hadean authentication service |
run | Runs an application on your local machine |
cluster | Create, manage and use remote clusters to run your application |
config | Adjust configuration values for the CLI |
tags --tags <TAGS> | Add tags to clusters created in the future. Tags are supplied in the format key1=value1 key2=value2
This command will overwrite any previously defined tags. |
debug <SUBCOMMAND> | Manages debugging of a locally running application. See below for usage |
The
debug subcommand requires further subcommands to perform the desired operation as listed below.Debug Subcommand | |
connect-to-process <PID> | Attach to a running process with the specified PID |
continue-all | Continue any currently paused processes that do not have a debugger attached |
list-paused-processes | List the currently paused processes which can be debugged |
When using the
cluster subcommand, the CLI takes further subcommands to interact with remote clusters, and a cluster name to specify which cluster to interact with:hadean cluster [--name <name>] <SUBCOMMAND>Subcommands | |
help | Prints help message or the help for a given subcommand |
create | Create a cluster to run applications in the cloud |
list | List available clusters |
deploy | Deploy your application to a cluster |
run | Run your application on a remote cluster |
status | Get the status of the application on a remote cluster |
logs | Get the logs from the currently running, or last run application on the remote cluster |
stop | Stop your application when running on a remote cluster |
clean-up | Remove dynamic resources (standby machines) from a cluster that is not currently running any application |
destroy | Destroy the cluster and its resources - this action is not reversible. |
Note that while
hadean cluster destroy removes almost all resources, some terraform state files and associated storage is not removed. This can be cleaned up manually.Note that for self-managed clusters, the
status subcommand will show the IP address of imported machines in the "Public" column, even if the IP address is private. This is an aesthetic issue that will be addressed in a future release and does not imply that the machines are publicly accessible.
Last modified 10mo ago