Command line interface¶

The command line interface (CLI) is invokec by typing either python -m caliber, py -m caliber or simply caliber in your terminal. The CLI is self-documented by appending the -h or --help flag to a call. The various commands of the CLI are documented below for convenience.

caliber¶

Caliber v2.0.0.

caliber [OPTIONS] COMMAND [ARGS]...

pinion¶

Work with pinions.

caliber pinion [OPTIONS] COMMAND [ARGS]...

init¶

Initialize a pinion.

Start checking for workflows to run.

By default, the pinion looks for workflows in a local queue. If a Speckle host is specified in the environment variables, the looks for a queue on a model on a project on the Speckle server. If no token is provided in the environment variables, Caliber looks for a relevant account in your Speckle Manager.

The pinion attempts to find a relevant workload a given number of times and waits a given period of time between the attempts.

caliber pinion init [OPTIONS] PINION_NAME

Options

--project <project>¶: The ID of the Speckle project.

--model <model_name>¶: The model name.

-a, --attempts <attempts>¶

Attempts before shutdown.

Default:: 10

-w, --wait <wait>¶

Wait time [s] between attempts.

Default:: 5

--bell¶

Play the console bell when a workflow is completed.

Default:: False

-e, --exit¶

Automatically close the TUI after the final attempt.

Default:: False

Arguments

PINION_NAME¶

Required argument

The name of the pinion.

project¶

Work on projects.

caliber project [OPTIONS] COMMAND [ARGS]...

init¶

Initialize a project.

This function will create necessary files to get started with Caliber.

caliber project init [OPTIONS]

Options

--force¶

Overwrite existing files without asking for confirmation

Default:: False

zip¶

Store the tracked and/or staged project files in a Zip file.

Note that this command uses git to get a list of all the files that are tracked and/or staged. Make sure that you have git installed on your system.

Caliber will store the files with the contents representing the ones in the working tree, i.e. including changes that are not staged for commit, and files that are staged, but not previously tracked. Files that are neither tracked nor staged will not be stored.

caliber project zip [OPTIONS]

Options

-f, --filename <filename>¶

The name of the Zip file to create.

Default:: 'project.zip'

queue¶

Work with a queue.

caliber queue [OPTIONS] COMMAND [ARGS]...

delete¶

Delete a workload from the queue.

This function will find a WorkflowQueue, search for a Workload that matches the ID and delete it.

caliber queue delete [OPTIONS] WORKLOAD_ID

Options

--project <project>¶: The ID of the Speckle project.

--model <model_name>¶: The model name.

--force¶

Delete the workload without asking for confirmation

Default:: False

Arguments

WORKLOAD_ID¶

Required argument

The ID of the workload to delete.

list¶

List the queue.

This function will find a WorkflowQueue, and list it.

caliber queue list [OPTIONS]

Options

--project <project>¶: The ID of the Speckle project.

--model <model_name>¶: The model name.

-ic, --ignore-completed¶

Do not list workloads that are completed

Default:: False

-inc, --ignore-not-completed¶

Do not list workloads that are not completed

Default:: False

resetsecret¶

Reset the run secret of a workload in a queue.

This function will find a WorkflowQueue, search for a Workload that matches the ID and reset the run secret. Note that this function is only relevant when a remote queue is used.

caliber queue resetsecret [OPTIONS] WORKLOAD_ID

Options

--project <project>¶: The ID of the Speckle project.

--model <model_name>¶: The model name.

--force¶

Reset the run secret without asking for confirmation

Default:: False

Arguments

WORKLOAD_ID¶

Required argument

The ID of the workload.

view¶

View a workload in a queue.

This function will find a WorkflowQueue, and print details about a given Workload.

caliber queue view [OPTIONS] WORKLOAD_ID

Options

--project <project>¶: The ID of the Speckle project.

--model <model_name>¶: The model name.

Arguments

WORKLOAD_ID¶

Required argument

The ID of the workload to view.

transport¶

Work with transports.

caliber transport [OPTIONS] COMMAND [ARGS]...

listfiles¶

List the files that could be tracked by a transport.

This function will browse the current directory as if a workflow was run and report all files that could be tracked by a transport.

You can specify files and folders to be left out in the ‘.caliberignore’ file.

caliber transport listfiles [OPTIONS]

restore¶

Restore data from a storage layer.

caliber transport restore [OPTIONS] COMMAND [ARGS]...

infiles¶

Restore infiles from a storage layer.

caliber transport restore infiles [OPTIONS]

Options

-f, --format <storage_format>¶: Required The storage format, e.g. Zip

--force-overwrite¶

Overwrite existing files without notice

Default:: False

outfiles¶

Restore outfiles from a storage layer.

caliber transport restore outfiles [OPTIONS]

Options

-f, --format <storage_format>¶: Required The storage format, e.g. Zip

--force-overwrite¶

Overwrite existing files without notice

Default:: False

workflow¶

Work on workflows.

caliber workflow [OPTIONS] COMMAND [ARGS]...

queue¶

Put a workflow in a queue.

By default, the workflow is put in a local queue. If a Speckle host is specified in the environment variables, the data exchange is done through a model on a project on the Speckle server. If no token is provided in the environment variables, Caliber looks for a relevant account in your Speckle Manager.

caliber workflow queue [OPTIONS] JSONFILE

Options

-p, --pinion <pinion>¶: Required The name of the Pinion.

--project <project>¶: The ID of the Speckle project.

--model <model_name>¶: The model name.

Arguments

JSONFILE¶

Required argument

A .json-file with a description of the workflow.

run¶

Run a workflow.

caliber workflow run [OPTIONS] JSONFILE

Options

--bell¶

Play the console bell when the workflow is completed.

Default:: False

-e, --exit¶

Automatically exit the TUI when the workflow is completed.

Default:: False

Arguments

JSONFILE¶

Required argument

A .json-file with a description of the workflow.

show¶

Show a workflow.

caliber workflow show [OPTIONS] JSONFILE

Options

-t, --tree¶

Show tree structure in terminal.

Default:: False

Arguments

JSONFILE¶

Required argument

A .json-file with a description of the workflow.