Skip to content

fractal job

usage: fractal job [-h] {list,show,download-logs,stop,submit} ...

Job commands.

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

Valid sub-commands:
  {list,show,download-logs,stop,submit}

fractal job list

usage: fractal job list [-h] project_id

List jobs for given project.

positional arguments:
  project_id  Project ID.

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

fractal job show

usage: fractal job show [-h] project_id job_id

Query status of workflow-execution job.

positional arguments:
  project_id  Project ID.
  job_id      Job ID.

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

fractal job download-logs

usage: fractal job download-logs [-h] --output OUTPUT_FOLDER project_id job_id

Download full folder of workflow-execution job.

positional arguments:
  project_id            Project ID.
  job_id                Job ID.

options:
  -h, --help            show this help message and exit
  --output OUTPUT_FOLDER
                        Path of the output folder.

fractal job stop

usage: fractal job stop [-h] project_id job_id

Stop workflow-execution job.

positional arguments:
  project_id  Project ID.
  job_id      Job ID.

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

fractal job submit

usage: fractal job submit [-h] [--start FIRST_TASK_INDEX]
                          [--end LAST_TASK_INDEX] [-w WORKER_INIT]
                          [--attribute-filters-json ATTRIBUTE_FILTERS_JSON]
                          [--type-filters-json TYPE_FILTERS_JSON]
                          project_id workflow_id dataset_id

Submit a job.

positional arguments:
  project_id
  workflow_id
  dataset_id

options:
  -h, --help            show this help message and exit
  --start FIRST_TASK_INDEX
                        Positional index of the first task to be executed
                        (starting from 0).
  --end LAST_TASK_INDEX
                        Positional index of the last task to be executed
                        (starting from 0).
  -w WORKER_INIT, --worker-init WORKER_INIT
                        Command to be run before starting a worker.
  --attribute-filters-json ATTRIBUTE_FILTERS_JSON
                        Path to JSON file with the attribute filters for this
                        job submission.
  --type-filters-json TYPE_FILTERS_JSON
                        Path to JSON file with the type filters for this job
                        submission.