fractal workflow¶

usage: fractal workflow [-h]
                        {list,new,show,edit,delete,add-task,edit-task,rm-task,import,export,import-from-template}
                        ...

Workflow commands.

options:
  -h, --help            show this help message and exit

Valid sub-commands:
  {list,new,show,edit,delete,add-task,edit-task,rm-task,import,export,import-from-template}

usage: fractal workflow list [-h] project_id

List workflows for given project.

positional arguments:
  project_id  Project ID.

options:
  -h, --help  show this help message and exit

usage: fractal workflow new [-h] name project_id

Create new workflow.

positional arguments:
  name        Workflow name (must be unique, and not only made of numbers
              only).
  project_id  Project ID.

options:
  -h, --help  show this help message and exit

usage: fractal workflow show [-h] project_id workflow_id

Show workflow.

positional arguments:
  project_id   Project ID.
  workflow_id  Workflow ID.

options:
  -h, --help   show this help message and exit

usage: fractal workflow edit [-h] --new-name NEW_NAME project_id workflow_id

Edit workflow.

positional arguments:
  project_id           Project ID.
  workflow_id          Workflow ID.

options:
  -h, --help           show this help message and exit
  --new-name NEW_NAME  New workflow name.

usage: fractal workflow delete [-h] project_id workflow_id

Delete workflow.

positional arguments:
  project_id   Project ID.
  workflow_id  Workflow ID.

options:
  -h, --help   show this help message and exit

usage: fractal workflow add-task [-h]
                                 (--task-id TASK_ID | --task-name TASK_NAME)
                                 [--task-version TASK_VERSION]
                                 [--args-non-parallel ARGS_NON_PARALLEL]
                                 [--args-parallel ARGS_PARALLEL]
                                 [--meta-non-parallel META_NON_PARALLEL]
                                 [--meta-parallel META_PARALLEL]
                                 [--type-filters TYPE_FILTERS]
                                 project_id workflow_id

Append a single task to the task list of a workflow.

positional arguments:
  project_id            Project ID.
  workflow_id           Workflow ID.

options:
  -h, --help            show this help message and exit
  --task-id TASK_ID     ID of the task to add.
  --task-name TASK_NAME
                        Name of the task to add.
  --task-version TASK_VERSION
                        Version of task to add (only accepted in combination
                        with --task-name).
  --args-non-parallel ARGS_NON_PARALLEL
                        Args for non parallel tasks
  --args-parallel ARGS_PARALLEL
                        Args for parallel tasks
  --meta-non-parallel META_NON_PARALLEL
                        Metadata file for non-parallel tasks
  --meta-parallel META_PARALLEL
                        Metadata file for parallel tasks
  --type-filters TYPE_FILTERS
                        Path to JSON file with type filters.

usage: fractal workflow edit-task [-h] [--type-filters TYPE_FILTERS]
                                  [--args-non-parallel ARGS_NON_PARALLEL]
                                  [--args-parallel ARGS_PARALLEL]
                                  [--meta-non-parallel META_NON_PARALLEL]
                                  [--meta-parallel META_PARALLEL]
                                  project_id workflow_id workflow_task_id

Edit task within specific workflow.

positional arguments:
  project_id            Project ID.
  workflow_id           Workflow ID.
  workflow_task_id      Workflow task ID, the ID of a task inside the list of
                        tasks.

options:
  -h, --help            show this help message and exit
  --type-filters TYPE_FILTERS
                        Path to JSON file containing the type filters of this
                        workflow task.
  --args-non-parallel ARGS_NON_PARALLEL
                        Args for non parallel tasks
  --args-parallel ARGS_PARALLEL
                        Args for parallel tasks
  --meta-non-parallel META_NON_PARALLEL
                        Metadata file fornon parallel tasks
  --meta-parallel META_PARALLEL
                        Metadata file for parallel tasks

usage: fractal workflow rm-task [-h] project_id workflow_id workflow_task_id

Remove task from a specific workflow.

positional arguments:
  project_id        Project ID.
  workflow_id       Workflow ID.
  workflow_task_id  Workflow task ID (the ID of a task inside the list of
                    tasks).

options:
  -h, --help        show this help message and exit

usage: fractal workflow import [-h] --project-id PROJECT_ID --json-file
                               JSON_FILE [--workflow-name WORKFLOW_NAME]

Import workflow to project from file.

options:
  -h, --help            show this help message and exit
  --project-id PROJECT_ID
                        ID of the project where the workflow will be imported.
  --json-file JSON_FILE
                        Path to a JSON file with the workflow to be imported.
  --workflow-name WORKFLOW_NAME
                        Name of the new workflow (if set, overrides the one in
                        JSON file)

usage: fractal workflow export [-h] --json-file JSON_FILE
                               project_id workflow_id

Export workflow to file.

positional arguments:
  project_id            Project ID.
  workflow_id           Workflow ID.

options:
  -h, --help            show this help message and exit
  --json-file JSON_FILE
                        Path to the JSON file where the workflow will be
                        exported.

usage: fractal workflow import-from-template [-h] [--name NAME]
                                             project_id template_id

Import workflow to project from template.

positional arguments:
  project_id   ID of the project where the workflow will be imported.
  template_id  ID of the template from which the workflow will be imported.

options:
  -h, --help   show this help message and exit
  --name NAME  Name of the new workflow (if set, overrides the one in the
               template).