diff --git a/doc/source/developer/webapi/v2.rst b/doc/source/developer/webapi/v2.rst index 3d8b4e11..ac417783 100644 --- a/doc/source/developer/webapi/v2.rst +++ b/doc/source/developer/webapi/v2.rst @@ -154,11 +154,11 @@ Environments ------------ Environment contains a set of variables which can be used in specific workflow. -Using Environment possible to create and map action default values - just provide -'__actions' key in 'variables'. All these variables can be accessed in workflow -DSL by <% $.__env %> expression. +Using an Environment it is possible to create and map action default values - +just provide '__actions' key in 'variables'. All these variables can be +accessed using the Workflow Language with the ``<% $.__env %>`` expression. -Example of using in DSL +Example of usage: .. code-block:: yaml @@ -222,16 +222,16 @@ Validation ---------- Validation endpoints allow to check correctness of workbook, workflow and ad-hoc -action DSL without having to upload them into Mistral. +action Workflow Language without having to upload them into Mistral. **POST /v2/workbooks/validation** - Validate workbook content (DSL grammar and semantics). + Validate workbook content (Workflow Language grammar and semantics). **POST /v2/workflows/validation** - Validate workflow content (DSL grammar and semantics). + Validate workflow content (Workflow Language grammar and semantics). **POST /v2/actions/validation** - Validate ad-hoc action content (DSL grammar and semantics). + Validate ad-hoc action content (Workflow Language grammar and semantics). -These endpoints expect workbook, workflow or ad-hoc action text (DSL) correspondingly +These endpoints expect workbook, workflow or ad-hoc action text (Workflow Language) correspondingly in a request body. diff --git a/doc/source/guides/cli_guide.rst b/doc/source/guides/cli_guide.rst new file mode 100644 index 00000000..985e6789 --- /dev/null +++ b/doc/source/guides/cli_guide.rst @@ -0,0 +1,658 @@ +Mistral Client Commands Guide +============================= + +Workbooks +^^^^^^^^^ + +**workbook-create**: +:: + + mistral workbook-create + +Create new workbook. + +positional arguments: + definition - Workbook definition file. + +**workbook-delete**: +:: + + mistral workbook-delete [ ...] + +Delete workbook. + +positional arguments: + name - Name of workbook(s). + +**workbook-get**: +:: + + mistral workbook-get + +Show specific workbook. + +positional arguments: + name - Workbook name. + +**workbook-get-definition**: +:: + + mistral workbook-get-definition + +Show workbook definition. + +positional arguments: + workbook_identifier - Workbook name or ID. + +**workbook-list**: +:: + + mistral workbook-list + +List all workbooks. + +**workbook-update**: +:: + + mistral workbook-update + +Update workbook. + +positional arguments: + definition - Workbook definition file. + +**workbook-validate**: +:: + + mistral workbook-validate + +Validate workbook. + +positional arguments: + definition - Workbook definition file. + +Workflows +^^^^^^^^^ + +**workflow-create**: +:: + + mistral workflow-create [--public] + +Create new workflow. + +positional arguments: + definition - Workflow definition file. + +optional arguments: + --public - With this flag workflow will be marked as "public". + +**workflow-delete**: +:: + + mistral workflow-delete [ ...] + +Delete workflow. + +positional arguments: + name - Name of workflow(s). + +**workflow-get**: +:: + + mistral workflow-get + +Show specific workflow. + +positional arguments: + name - Workflow name. + +**workflow-get-definition**: +:: + + mistral workflow-get-definition + +Show workflow definition. + +positional arguments: + name - Workflow name. + +**workflow-list**: +:: + + mistral workflow-list + +List all workflows. + +**workflow-update**: +:: + + mistral workflow-update + +Update workflow. + +positional arguments: + definition - Workflow definition. + +**workflow-validate**: +:: + + mistral workflow-validate + +Validate workflow. + +positional arguments: + definition - Workflow definition file. + +Actions +^^^^^^^ + +**action-create**: +:: + + mistral action-create [--public] + +Create new action. + +positional arguments: + definition - Action definition file. + +optional arguments: + --public - With this flag action will be marked as "public". + +**action-delete**: +:: + + mistral action-delete action [action ...] + +Delete action. + +positional arguments: + action - Name or ID of action(s). + +**action-get**: +:: + + mistral action-get + +Show specific action. + +positional arguments: + action - Action (name or ID). + +**action-get-definition**: +:: + + mistral action-get-definition + +Show action definition. + +positional arguments: + name - Action name. + +**action-list**: +:: + + mistral action-list + +List all actions. + +**action-update**: +:: + + mistral action-update [--public] [--id ID] + +Update action. + +positional arguments: + definition - Action definition file. + +optional arguments: + --id ID Action ID. + --public With this flag, action will be marked as "public". + +**action-validate**: +:: + + mistral action-validate + +Validate action. + +positional arguments: + definition - Action definition file. + +Workflow executions +^^^^^^^^^^^^^^^^^^^ + +**execution-create**: +:: + + mistral execution-create [-d DESCRIPTION] + [] [] + +Create a new execution. + +positional arguments: + workflow_identifier - Workflow ID or name. Workflow name has been deprecated + since Mitaka. + workflow_input - Workflow input. + params - Workflow additional parameters. + +optional arguments: + -d DESCRIPTION, --description DESCRIPTION + Execution description + +**execution-delete**: +:: + + mistral execution-delete [ ...] + +Delete execution. + +positional arguments: + execution - Id of execution identifier(s). + +**execution-get**: +:: + + mistral execution-get + +Show specific execution. + +positional arguments: + execution - Execution identifier. + +**execution-get-input**: +:: + + mistral execution-get-input + +Show execution input data. + +positional arguments: + id - Execution ID. + +**execution-get-output**: +:: + + mistral execution-get-output [-h] id + +Show execution output data. + +positional arguments: + id - Execution ID. + +**execution-list**: +:: + + mistral execution-list [--marker [MARKER]] [--limit [LIMIT]] + [--sort_keys [SORT_KEYS]] + [--sort_dirs [SORT_DIRS]] + +List all executions. + +optional arguments: + --marker [MARKER] The last execution uuid of the previous page, displays + list of executions after "marker". + --limit [LIMIT] Maximum number of executions to return in a single + result. + --sort_keys [SORT_KEYS] + Comma-separated list of sort keys to sort results by. + Default: created_at. Example: mistral execution-list + --sort_keys=id,description + --sort_dirs [SORT_DIRS] + Comma-separated list of sort directions. Default: asc. + Example: mistral execution-list + --sort_keys=id,description --sort_dirs=asc,desc + +**execution-update**: +:: + + mistral execution-update [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}] + [-e ENV] [-d DESCRIPTION] + +Update execution. + +positional arguments: + id - Execution identifier. + +optional arguments: + -s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED} + Execution state + -e ENV, --env ENV Environment variables + -d DESCRIPTION, --description DESCRIPTION + Execution description + +Task executions +^^^^^^^^^^^^^^^ + +**task-get**: +:: + + mistral task-get + +Show specific task. + +positional arguments: + id - Task identifier. + +**task-get-published**: +:: + + mistral task-get-published + +Show task published variables. + +positional arguments: + id - Task ID. + +**task-get-result**: +:: + + mistral task-get-result + +Show task output data. + +positional arguments: + id - Task ID. + +**task-list**: +:: + + mistral task-list [] + +List all tasks. + +positional arguments: + workflow_execution - Workflow execution ID associated with list of Tasks. + +**task-rerun**: +:: + + mistral task-rerun [--resume] [-e ENV] + +Rerun an existing task. + +positional arguments: + id - Task identifier. + +optional arguments: + --resume rerun only failed or unstarted action executions for + with-items task. + -e ENV, --env ENV Environment variables. + +Action executions +^^^^^^^^^^^^^^^^^ + +**action-execution-delete**: +:: + + mistral action-execution-delete [ ...] + +Delete action execution. + +positional arguments: + action_execution - Action execution ID. + +**action-execution-get**: +:: + + mistral action-execution-get + +Show specific Action execution. + +positional arguments: + action_execution - Action execution ID. + +**action-execution-get-input**: +:: + + mistral action-execution-get-input + +Show Action execution input data. + +positional arguments: + id - Action execution ID. + +**action-execution-get-output**: +:: + + mistral action-execution-get-output + +Show Action execution output data. + +positional arguments: + id - Action execution ID. + +**action-execution-list**: +:: + + mistral action-execution-list [] + +List all Action executions. + +positional arguments: + task-execution-id - Task execution ID. + +**action-execution-update**: +:: + + mistral action-execution-update [--state {IDLE,RUNNING,SUCCESS,ERROR}] [--output ] + +Update specific Action execution. + +positional arguments: + id - Action execution ID. + +optional arguments: + --state {IDLE,RUNNING,SUCCESS,ERROR} + Action execution state + --output OUTPUT - Action execution output + +**run-action**: +:: + + mistral run-action [] [-t ] + +Create new Action execution or just run specific action. + +positional arguments: + name - Action name to execute. + input - Action input. + +optional arguments: + -s, --save-result - Save the result into DB. + -t TARGET, --target TARGET + Action will be executed on executor. + +Cron-triggers +^^^^^^^^^^^^^ + +**cron-trigger-create**: +:: + + mistral cron-trigger-create [--params ] [--pattern <* * * * *>] + [--first-time ] + [--count ] + [] + +Create new trigger. + +positional arguments: + name - Cron trigger name. + workflow_identifier - Workflow name or ID. + workflow_input - Workflow input. + +optional arguments: + --params PARAMS - Workflow params. + --pattern <* * * * *> + Cron trigger pattern. + --first-time + Date and time of the first execution. + --count Number of wanted executions. + +**cron-trigger-delete**: +:: + + mistral cron-trigger-delete [ ...] + +Delete trigger. + +positional arguments: + name - Name of cron trigger(s). + +**cron-trigger-get**: +:: + + mistral cron-trigger-get + +Show specific cron trigger. + +positional arguments: + name - Cron trigger name. + +**cron-trigger-list**: +:: + + mistral cron-trigger-list + +List all cron triggers. + +Environments +^^^^^^^^^^^^ + +**environment-create**: +:: + + mistral environment-create + +Create new environment. + +positional arguments: + file - Environment configuration file in JSON or YAML. + +**environment-delete**: +:: + + mistral environment-delete [ ...] + +Delete environment. + +positional arguments: + environment - Name of environment(s). + +**environment-get**: +:: + + mistral environment-get + +Show specific environment. + +positional arguments: + name - Environment name. + +**environment-list**: +:: + + mistral environment-list + +List all environments. + +**environment-update**: +:: + + mistral environment-update + +Update environment. + +positional arguments: + file - Environment configuration file in JSON or YAML. + + +Members +^^^^^^^ + +**member-create**: +:: + + mistral member-create + +Shares a resource to another tenant. + +positional arguments: + resource_id - Resource ID to be shared. + resource_type - Resource type. + member_id - Project ID to whom the resource is shared to. + +**member-delete**: +:: + + mistral member-delete + +Delete a resource sharing relationship. + +positional arguments: + resource - Resource ID to be shared. + resource_type - Resource type. + member_id - Project ID to whom the resource is shared to. + +**member-get**: +:: + + mistral member-get [-m MEMBER_ID] + + +Show specific member information. + +positional arguments: + resource - Resource ID to be shared. + resource_type - Resource type. + +optional arguments: + -m MEMBER_ID, --member-id MEMBER_ID + Project ID to whom the resource is shared to. No need + to provide this param if you are the resource member. + +**member-list**: +:: + + mistral member-list + +List all members. + +positional arguments: + resource_id - Resource id to be shared. + resource_type - Resource type. + +**member-update**: +:: + + mistral member-update [-m MEMBER_ID] + [-s {pending,accepted,rejected}] + + +Update resource sharing status. + +positional arguments: + resource_id - Resource ID to be shared. + resource_type - Resource type. + +optional arguments: + -m MEMBER_ID, --member-id MEMBER_ID + Project ID to whom the resource is shared to. No need + to provide this param if you are the resource member. + -s {pending,accepted,rejected}, --status {pending,accepted,rejected} + status of the sharing. + +Services API +^^^^^^^^^^^^ + +**service-list**: +:: + + mistral service-list + +List all services. + +.. seealso:: + `Workflow service command-line client `_. diff --git a/doc/source/guides/configuration_guide.rst b/doc/source/guides/configuration_guide.rst index e1e9eb93..0d9a9c77 100644 --- a/doc/source/guides/configuration_guide.rst +++ b/doc/source/guides/configuration_guide.rst @@ -101,7 +101,7 @@ directory. [executor] host = my_favorite_executor - Then, this executor can be referred in DSL by + Then, this executor can be referred in Workflow Language by .. code-block:: yaml diff --git a/doc/source/guides/mistralclient_guide.rst b/doc/source/guides/mistralclient_guide.rst index f21f00a9..3b2c3059 100644 --- a/doc/source/guides/mistralclient_guide.rst +++ b/doc/source/guides/mistralclient_guide.rst @@ -1,8 +1,5 @@ -Mistral Client / CLI Guide -========================== - -Mistralclient installation --------------------------- +Mistral Client Installation Guide +================================= To install ``python-mistralclient``, it is required to have ``pip`` (in most cases). Make sure that ``pip`` is installed. Then type:: @@ -18,7 +15,7 @@ After ``python-mistralclient`` is installed you will see command ``mistral`` in your environment. Configure authentication against Keystone -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------------------- If Keystone is used for authentication in Mistral, then the environment should have auth variables:: @@ -43,665 +40,6 @@ To make sure Mistral client works, type:: $ mistral workbook-list -Mistralclient commands ----------------------- - -Workbooks -^^^^^^^^^ - -**workbook-create**: -:: - - usage: mistral workbook-create - -Create new workbook. - -positional arguments: - definition - Workbook definition file. - -**workbook-delete**: -:: - - usage: mistral workbook-delete [ ...] - -Delete workbook. - -positional arguments: - name - Name of workbook(s). - -**workbook-get**: -:: - - usage: mistral workbook-get - -Show specific workbook. - -positional arguments: - name - Workbook name. - -**workbook-get-definition**: -:: - - usage: mistral workbook-get-definition - -Show workbook definition. - -positional arguments: - name - Workbook name. - -**workbook-list**: -:: - - usage: mistral workbook-list - -List all workbooks. - -**workbook-update**: -:: - - usage: mistral workbook-update - -Update workbook. - -positional arguments: - definition - Workbook definition file. - -**workbook-validate**: -:: - - usage: mistral workbook-validate - -Validate workbook. - -positional arguments: - definition - Workbook definition file. - -Workflows -^^^^^^^^^ - -**workflow-create**: -:: - - usage: mistral workflow-create [--public] - -Create new workflow. - -positional arguments: - definition - Workflow definition file. - -optional arguments: - --public - With this flag workflow will be marked as "public". - -**workflow-delete**: -:: - - usage: mistral workflow-delete [ ...] - -Delete workflow. - -positional arguments: - name - Name of workflow(s). - -**workflow-get**: -:: - - usage: mistral workflow-get - -Show specific workflow. - -positional arguments: - name - Workflow name. - -**workflow-get-definition**: -:: - - usage: mistral workflow-get-definition - -Show workflow definition. - -positional arguments: - name - Workflow name. - -**workflow-list**: -:: - - usage: mistral workflow-list - -List all workflows. - -**workflow-update**: -:: - - usage: mistral workflow-update - -Update workflow. - -positional arguments: - definition - Workflow definition. - -**workflow-validate**: -:: - - usage: mistral workflow-validate - -Validate workflow. - -positional arguments: - definition - Workflow definition file. - -Actions -^^^^^^^ - -**action-create**: -:: - - usage: mistral action-create [--public] - -Create new action. - -positional arguments: - definition - Action definition file. - -optional arguments: - --public - With this flag action will be marked as "public". - -**action-delete**: -:: - - usage: mistral action-delete action [action ...] - -Delete action. - -positional arguments: - action - Name or ID of action(s). - -**action-get**: -:: - - usage: mistral action-get - -Show specific action. - -positional arguments: - action - Action (name or ID). - -**action-get-definition**: -:: - - usage: mistral action-get-definition - -Show action definition. - -positional arguments: - name - Action name. - -**action-list**: -:: - - usage: mistral action-list - -List all actions. - -**action-update**: -:: - - usage: mistral action-update [--public] [--id ID] - -Update action. - -positional arguments: - definition - Action definition file. - -optional arguments: - --id ID Action ID. - --public With this flag, action will be marked as "public". - -**action-validate**: -:: - - usage: mistral action-validate - -Validate action. - -positional arguments: - definition - Action definition file. - -Workflow executions -^^^^^^^^^^^^^^^^^^^ - -**execution-create**: -:: - - usage: mistral execution-create [-d DESCRIPTION] - [] [] - -Create a new execution. - -positional arguments: - workflow_identifier - Workflow ID or name. Workflow name has been deprecated - since Mitaka. - workflow_input - Workflow input. - params - Workflow additional parameters. - -optional arguments: - -d DESCRIPTION, --description DESCRIPTION - Execution description - -**execution-delete**: -:: - - usage: mistral execution-delete [ ...] - -Delete execution. - -positional arguments: - execution - Id of execution identifier(s). - -**execution-get**: -:: - - usage: mistral execution-get - -Show specific execution. - -positional arguments: - execution - Execution identifier. - -**execution-get-input**: -:: - - usage: mistral execution-get-input - -Show execution input data. - -positional arguments: - id - Execution ID. - -**execution-get-output**: -:: - - usage: mistral execution-get-output [-h] id - -Show execution output data. - -positional arguments: - id - Execution ID. - -**execution-list**: -:: - - usage: mistral execution-list [--marker [MARKER]] [--limit [LIMIT]] - [--sort_keys [SORT_KEYS]] - [--sort_dirs [SORT_DIRS]] - -List all executions. - -optional arguments: - --marker [MARKER] The last execution uuid of the previous page, displays - list of executions after "marker". - --limit [LIMIT] Maximum number of executions to return in a single - result. - --sort_keys [SORT_KEYS] - Comma-separated list of sort keys to sort results by. - Default: created_at. Example: mistral execution-list - --sort_keys=id,description - --sort_dirs [SORT_DIRS] - Comma-separated list of sort directions. Default: asc. - Example: mistral execution-list - --sort_keys=id,description --sort_dirs=asc,desc - -**execution-update**: -:: - - usage: mistral execution-update [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}] - [-e ENV] [-d DESCRIPTION] - -Update execution. - -positional arguments: - id - Execution identifier. - -optional arguments: - -s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED} - Execution state - -e ENV, --env ENV Environment variables - -d DESCRIPTION, --description DESCRIPTION - Execution description - -Task executions -^^^^^^^^^^^^^^^ - -**task-get**: -:: - - usage: mistral task-get - -Show specific task. - -positional arguments: - id - Task identifier. - -**task-get-published**: -:: - - usage: mistral task-get-published - -Show task published variables. - -positional arguments: - id - Task ID. - -**task-get-result**: -:: - - usage: mistral task-get-result - -Show task output data. - -positional arguments: - id - Task ID. - -**task-list**: -:: - - usage: mistral task-list [] - -List all tasks. - -positional arguments: - workflow_execution - Workflow execution ID associated with list of Tasks. - -**task-rerun**: -:: - - usage: mistral task-rerun [--resume] [-e ENV] - -Rerun an existing task. - -positional arguments: - id - Task identifier. - -optional arguments: - --resume rerun only failed or unstarted action executions for - with-items task. - -e ENV, --env ENV Environment variables. - -Action executions -^^^^^^^^^^^^^^^^^ - -**action-execution-delete**: -:: - - usage: mistral action-execution-delete [ ...] - -Delete action execution. - -positional arguments: - action_execution - Action execution ID. - -**action-execution-get**: -:: - - usage: mistral action-execution-get - -Show specific Action execution. - -positional arguments: - action_execution - Action execution ID. - -**action-execution-get-input**: -:: - - usage: mistral action-execution-get-input - -Show Action execution input data. - -positional arguments: - id - Action execution ID. - -**action-execution-get-output**: -:: - - usage: mistral action-execution-get-output - -Show Action execution output data. - -positional arguments: - id - Action execution ID. - -**action-execution-list**: -:: - - usage: mistral action-execution-list [] - -List all Action executions. - -positional arguments: - task-execution-id - Task execution ID. - -**action-execution-update**: -:: - - usage: mistral action-execution-update [--state {IDLE,RUNNING,SUCCESS,ERROR}] [--output ] - -Update specific Action execution. - -positional arguments: - id - Action execution ID. - -optional arguments: - --state {IDLE,RUNNING,SUCCESS,ERROR} - Action execution state - --output OUTPUT - Action execution output - -**run-action**: -:: - - usage: mistral run-action [] [-t ] - -Create new Action execution or just run specific action. - -positional arguments: - name - Action name to execute. - input - Action input. - -optional arguments: - -s, --save-result - Save the result into DB. - -t TARGET, --target TARGET - Action will be executed on executor. - -Cron-triggers -^^^^^^^^^^^^^ - -**cron-trigger-create**: -:: - - usage: mistral cron-trigger-create [--params ] [--pattern <* * * * *>] - [--first-time ] - [--count ] - [] - -Create new trigger. - -positional arguments: - name - Cron trigger name. - workflow_identifier - Workflow name or ID. - workflow_input - Workflow input. - -optional arguments: - --params PARAMS - Workflow params. - --pattern <* * * * *> - Cron trigger pattern. - --first-time - Date and time of the first execution. - --count Number of wanted executions. - -**cron-trigger-delete**: -:: - - usage: mistral cron-trigger-delete [ ...] - -Delete trigger. - -positional arguments: - name - Name of cron trigger(s). - -**cron-trigger-get**: -:: - - usage: mistral cron-trigger-get - -Show specific cron trigger. - -positional arguments: - name - Cron trigger name. - -**cron-trigger-list**: -:: - - usage: mistral cron-trigger-list - -List all cron triggers. - -Environments -^^^^^^^^^^^^ - -**environment-create**: -:: - - usage: mistral environment-create - -Create new environment. - -positional arguments: - file - Environment configuration file in JSON or YAML. - -**environment-delete**: -:: - - usage: mistral environment-delete [ ...] - -Delete environment. - -positional arguments: - environment - Name of environment(s). - -**environment-get**: -:: - - usage: mistral environment-get - -Show specific environment. - -positional arguments: - name - Environment name. - -**environment-list**: -:: - - usage: mistral environment-list - -List all environments. - -**environment-update**: -:: - - usage: mistral environment-update - -Update environment. - -positional arguments: - file - Environment configuration file in JSON or YAML. - - -Members -^^^^^^^ - -**member-create**: -:: - - usage: mistral member-create - -Shares a resource to another tenant. - -positional arguments: - resource_id - Resource ID to be shared. - resource_type - Resource type. - member_id - Project ID to whom the resource is shared to. - -**member-delete**: -:: - - usage: mistral member-delete - -Delete a resource sharing relationship. - -positional arguments: - resource - Resource ID to be shared. - resource_type - Resource type. - member_id - Project ID to whom the resource is shared to. - -**member-get**: -:: - - usage: mistral member-get [-m MEMBER_ID] - - -Show specific member information. - -positional arguments: - resource - Resource ID to be shared. - resource_type - Resource type. - -optional arguments: - -m MEMBER_ID, --member-id MEMBER_ID - Project ID to whom the resource is shared to. No need - to provide this param if you are the resource member. - -**member-list**: -:: - - usage: mistral member-list - -List all members. - -positional arguments: - resource_id - Resource id to be shared. - resource_type - Resource type. - -**member-update**: -:: - - usage: mistral member-update [-m MEMBER_ID] - [-s {pending,accepted,rejected}] - - -Update resource sharing status. - -positional arguments: - resource_id - Resource ID to be shared. - resource_type - Resource type. - -optional arguments: - -m MEMBER_ID, --member-id MEMBER_ID - Project ID to whom the resource is shared to. No need - to provide this param if you are the resource member. - -s {pending,accepted,rejected}, --status {pending,accepted,rejected} - status of the sharing. - -Services API -^^^^^^^^^^^^ - -**service-list**: -:: - - usage: mistral service-list - -List all services. - -.. seealso:: - `Workflow service command-line client `_. - Targeting non-preconfigured clouds ---------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 0a71da70..14fdd413 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,7 +14,6 @@ Overview overview quickstart architecture - Roadmap terminology/index main_features cookbooks @@ -47,6 +46,13 @@ User guide dsl/index +**CLI** + +.. toctree:: + :maxdepth: 1 + + guides/cli_guide + Developer guide --------------- @@ -54,7 +60,6 @@ Developer guide :maxdepth: 2 developer/index - Indices and tables ==================