Command-line interface reference#

fastrpi#

Client for the Fastr Package Index (FastrPI).

fastrpi [OPTIONS] COMMAND [ARGS]...

create#

Create a FastrPI package.

fastrpi create [OPTIONS] COMMAND [ARGS]...

macronode#

Create a FastrPI MacroNode package for a Fastr Network package in the FastrPI repository.

fastrpi create macronode [OPTIONS]

Options

-n, --name <name>#: Required Name of the Network to use in a MacroNode.

-v, --version <version>#: Required Version of the Network to use in a MacroNode.

network#

Create a FastrPI Network package based on a Fastr Network.

fastrpi create network [OPTIONS] NETWORK_FILE

Arguments

NETWORK_FILE#: Required argument

tool#

Create a FastrPI Tool package based on a (collection of) Fastr Tool definition(s).

fastrpi create tool [OPTIONS] TOOL_FILES...

Arguments

TOOL_FILES#: Required argument(s)

describe#

Describe FastrPI Tools or Networks.

fastrpi describe [OPTIONS] COMMAND [ARGS]...

network#

fastrpi describe network [OPTIONS] NAME

Options

-v, --version <version>#: Required Version of the Network package.

Arguments

NAME#: Required argument

tool#

fastrpi describe tool [OPTIONS] NAME

Options

-v, --version <version>#: Required Version of the Tool package.

-p, --package_version <package_version>#: Required Package version of the Tool package.

Arguments

NAME#: Required argument

edit#

Copy an installed Network or Tool package to your current folder for editing.

fastrpi edit [OPTIONS] COMMAND [ARGS]...

network#

Edit an installed Network.

By running fastrpi edit network network_name -v 1.0.0, the package files for Network package network_name, version 1.0.0 will be copied to the folder network_name-v1.0.0 in the current directory.

fastrpi edit network [OPTIONS] NAME

Options

-v, --version <version>#: Required Version of the Network package.

-s, --sourcesink#: Flag to only copy the Source-Sink file.

Arguments

NAME#: Required argument

tool#

Edit an installed Tool.

By running fastrpi edit tool tool_name -v 1.0 -p 1.0, the package files for Tool package tool_name, version 1.0, package version 1.0, will be copied to the nested folders tools/tool_name/1.0/1.0 in the current directory.

fastrpi edit tool [OPTIONS] NAME

Options

-v, --version <version>#: Required Version of the Tool package.

-p, --package_version <package_version>#: Required Package version of the Tool package.

Arguments

NAME#: Required argument

init#

Initialize the FastrPI setup.

fastrpi init [OPTIONS]

install#

Install a FastrPI package.

fastrpi install [OPTIONS] COMMAND [ARGS]...

network#

Install a Network and the required Tools.

fastrpi install network [OPTIONS] NAME

Options

-v, --version <version>#: Required Version of the Network package.

Arguments

NAME#: Required argument

tool#

Install a Tool and the corresponding container.

fastrpi install tool [OPTIONS] NAME

Options

-v, --version <version>#: Required Version of the Tool package.

-p, --package_version <package_version>#: Required Package version of the Tool package.

Arguments

NAME#: Required argument

list#

List installed or available FastrPI Tools, Networks and Datatypes.

fastrpi list [OPTIONS] COMMAND [ARGS]...

datatypes#

List available Datatypes.

fastrpi list datatypes [OPTIONS]

Options

-v, --verbose#

installed#

List installed Tools and Networks.

fastrpi list installed [OPTIONS]

Options

-v, --verbose#

networks#

List available Network packages on the FastrPI repository.

fastrpi list networks [OPTIONS]

Options

-v, --verbose#

tools#

List available Tool packages on the FastrPI repository.

fastrpi list tools [OPTIONS]

Options

-v, --verbose#

publish#

Publish your Network or Tool package to the FastrPI repository.

fastrpi publish [OPTIONS] COMMAND [ARGS]...

network#

Publish a Network package to the FastrPI repository.

fastrpi publish network [OPTIONS] MANIFEST_FILE

Arguments

MANIFEST_FILE#: Required argument

tool#

Publish a Tool package to the FastrPI repository.

fastrpi publish tool [OPTIONS] MANIFEST_FILE

Arguments

MANIFEST_FILE#: Required argument

run#

Runs an installed network given files containing functions generating Source and Sink data.

fastrpi run [OPTIONS] NAME

Options

-v, --version <version>#: Required Version of an installed network.

--source_sink <source_sink>#: Required Python file containing get_source_data().

--tmp_dir <tmp_dir>#: Directory for temporary files.

-m, --memory_multiplier <memory_multiplier>#: Memory multiplier in Fastr ResourceLimit.

Arguments

NAME#: Required argument

runlocal#

Runs a network file given files containing functions generating Source and Sink data.

fastrpi runlocal [OPTIONS] FILE

Options

--source_sink <source_sink>#: Required Python file containing get_source_data().

--tmp_dir <tmp_dir>#: Directory for temporary files.

Arguments

FILE#: Required argument

fastrpi-server#

Client for the Fastr Package Index (FastrPI).

fastrpi-server [OPTIONS] COMMAND [ARGS]...

cicd-checks#

CLI for tests to run during CI/CD.

param click.Path repository_folder:: Folder for the tool or network repository.
param str commit_message:: Commit message for the commit adding the network or tool.

fastrpi-server cicd-checks [OPTIONS] REPOSITORY_FOLDER COMMIT_MESSAGE

Arguments

REPOSITORY_FOLDER#: Required argument

COMMIT_MESSAGE#: Required argument

copy-reports#

When a new Package is uploaded, read the package list, update it and write it back again.

fastrpi-server copy-reports [OPTIONS] REPOSITORY_FOLDER COMMIT_MESSAGE

Options

--container_scanning <container_scanning>#: Required Gitlab Container Scanning report.

--deps_scanning <deps_scanning>#: Required Gitlab Dependency Scanning report.

Arguments

REPOSITORY_FOLDER#: Required argument

COMMIT_MESSAGE#: Required argument

update-list#

When a new Package is uploaded, read the package list, update it and write it back again.

fastrpi-server update-list [OPTIONS] REPOSITORY_FOLDER COMMIT_MESSAGE

Options

--dockerdigest <dockerdigest>#: Image digest of a Docker image.

Arguments

REPOSITORY_FOLDER#: Required argument

COMMIT_MESSAGE#: Required argument

update-list-format#

When the package list format changes, use this function to update the list to the new format.

fastrpi-server update-list-format [OPTIONS] REPOSITORY_FOLDER REPO_TYPE

Arguments

REPOSITORY_FOLDER#: Required argument

REPO_TYPE#: Required argument