CLI Reference

All Commands:

+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| COMMAND | SUB-COMMAND | USAGE |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| get | | Get your workflows, projects, and more. |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | workflows | Manage the workflow engine |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | values | look up all globally available values in your project. |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | value | search for a single variable available in your project. |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | engines | List the remote engines you have registered with your project |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | functions | list all available yaml functions that apptree provides |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | users | get users for given project |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | queue | search the workflow queue |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | logs | view logs for workflow job |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | history | View the job history for a workflow |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | config | Get information about your environment |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| add | | |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | user | give a user access to a project |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | engine | Register or update a registered engine with your project. |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| create | | Create a new workflow, step, project value and more. |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | project | create a new project |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | workflow | create a new workflow |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | value | set a globally available variable to use in your projects workflows. |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | package | Create a step package |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | step | Create a step |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| update | | Update a workflow, step, project value and more. |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | default_project | set a default project to your settings |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | engine | update a remote engine if it needs to be updated |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | workflow | enable or disable a workflow |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | enable | enable a workflow to start scheduling it again |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| remove | | remove items from your project |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | jobs | cancel running or pending workflows by job id or by run state |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | engine | remove a remote engine from a your project |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | value | deletes a project value by a key |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | workflow | remove or delete a workflow |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| run | | trigger a workflow, run steps locally, and more |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | apiserver | Run the API server |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | workflow | Run a workflow |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | trigger | Manage the workflow engine |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | healthcheck | Run a health check on a remote engine |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | remote_engine | Start a remote workflow engine instance |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | host_engine | Start a host workflow engine instance |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | scheduler | queue the next scheduled workflow |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| search | | Search for steps and packages |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | yaml | generate the yaml for a step |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | steps | Search the step library |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| publish | | publish workflows and packages |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | workflow | publish a workflow |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | package | publish a step package to your project making it available to a workflow |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| install | | |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | engine | install the remote engine as a service |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| migrate | | A toolset for migrating from legacy AppTree builder to YAML |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | connector | Convert a connector data definition to YAML |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| handle_restart | | clean up queues after engine is restarted |
+----------------+ +------------------------------------------------------------------------------------------------------------------+
| superuser | | manage super users, only available to existing super users |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | add | grant a user super user privileges |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| engine | | Install a remote engine. |
+ +-----------------+------------------------------------------------------------------------------------------------------------------+
| | install | install the remote engine as a service |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+
| login | | Login or Create an account with AppTree |
+----------------+ +------------------------------------------------------------------------------------------------------------------+
| version | | outputs the version of the binary |
+----------------+ +------------------------------------------------------------------------------------------------------------------+
| upgrade | | updates the cli to the most recent version blindly. It does not check if it needs to be updated, it just updates |
+----------------+ +------------------------------------------------------------------------------------------------------------------+
| verbose_help | | a verbose list of all cli commands |
+----------------+ +------------------------------------------------------------------------------------------------------------------+
| help | | Shows a list of commands or help for one command |
+----------------+-----------------+------------------------------------------------------------------------------------------------------------------+