diff --git a/docs/pages/cli.mdx b/docs/pages/cli.mdx index fbd995ff..b3ac9ab4 100644 --- a/docs/pages/cli.mdx +++ b/docs/pages/cli.mdx @@ -1,3 +1,5 @@ +import { Callout } from "nextra/components"; + # Admyral CLI You can leverage Admyral's CLI to manage your workflows and actions from your commandline, within your scripts, or CI/CD pipelines. @@ -29,7 +31,7 @@ Push a Python action to Admyral: admyral action push -a ``` -where `your_custom_action` is the Python function name and `` is the path to the file where the action is defined. +where `your_custom_action` is the Python function name and `` is the path to the Python file where the action is defined. ## Secrets Management @@ -55,7 +57,11 @@ admyral secret delete ## Workflow Management -Activatesa specific workflow: + + In the following, `` refers to the name of the workflow Python function and `` to the path of the Python file where the workflow function is defined. + + +Activate a specific workflow: ```bash admyral workflow activate @@ -70,10 +76,10 @@ admyral workflow deactivate Push a workflow to Admyral: ```bash -admyral workflow push +admyral workflow push -f # Optional: Activate the workflow on push -admyral workflow push --activate +admyral workflow push -f --activate ``` Trigger the execution of a workflow: