ocpiadmin

Usage:

$ ocpiadmin [OPTIONS] COMMAND [ARGS]...

Options:

  • --log-level INTEGER RANGE: Set the logging level. Uses OCPI_LOG_LEVEL env var as default. [default: 4; 0<=x<=20]

  • --color / --no-color: Allow rich coloring of logs. [default: color]

  • --quiet: Set log level to 0.

  • --error: Set log level to 1.

  • --warn: Set log level to 4.

  • -v, --verbose: Set log level to 8.

  • --debug: Set log level to 10.

  • -d, --directory PATH: Specify directory to execute command within. [default: /home/user/opencpi]

  • --dry-run / --no-dry-run: [default: no-dry-run]

  • --install-completion: Install completion for the current shell.

  • --show-completion: Show completion for the current shell, to copy it or customize the installation.

  • --help: Show this message and exit.

Commands:

  • install: Install an OpenCPI platform or target

  • deploy: Deploy an OpenCPI platform or target

ocpiadmin install

Install an OpenCPI platform or target

Usage:

$ ocpiadmin install [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • target: Prepare the OpenCPI installation for using…

  • platform: Prepare the OpenCPI installation for using…

ocpiadmin install target

Prepare the OpenCPI installation for using the specified HDL target.

Usage:

$ ocpiadmin install target [OPTIONS] HDL Target

Arguments:

  • HDL Target: [required]

Options:

  • -w, --workers: Whether to build workers for the installation target.

  • -r, --artifacts-only: Whether to clean intermediate build files.

  • -j, --n-jobs INTEGER: Max number of parallel builds [default: 1]

  • -p, --package-id TEXT: Package ID of platform/target to install.

  • -u, --project-url TEXT: URL to the platform/target’s project.

  • -g, --git-revision TEXT: Git revision to checkout before installation.

  • --report-format [junit]: Format of report(s). [default: junit]

  • --report-path FILE: Path of file to write report(s) to.

  • --builder [make]: Specify the Builder to use to run the asset(s). [default: make]

  • --help: Show this message and exit.

ocpiadmin install platform

Prepare the OpenCPI installation for using the specified RCC or HDL platform.

Usage:

$ ocpiadmin install platform [OPTIONS] Platform

Arguments:

  • Platform: [required]

Options:

  • --install-target / --no-install-target: Whether to also install the platform’s HDL target. [default: install-target]

  • -w, --workers: Whether to build workers for the installation target.

  • -t, --tests: Whether to build unit tests for the installation target.

  • -a, --assemblies: Whether to build assemblies for the installation target.

  • -r, --artifacts-only: Whether to clean intermediate build files.

  • -s, --streamline-build: Whether to skip checkpoints when building assemblies.

  • -o, --optimize: For RCC platforms only. Install platform and workers with optimization enabled.

  • -j, --n-jobs INTEGER: Max number of parallel builds [default: 1]

  • -p, --package-id TEXT: Package ID of platform/target to install.

  • -u, --project-url TEXT: URL to the platform/target’s project.

  • -g, --git-revision TEXT: Git revision to checkout before installation.

  • --report-format [junit]: Format of report(s). [default: junit]

  • --report-path FILE: Path of file to write report(s) to.

  • --builder [make]: Specify the Builder to use to run the asset(s). [default: make]

  • --help: Show this message and exit.

ocpiadmin deploy

Deploy an OpenCPI platform or target

Usage:

$ ocpiadmin deploy [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • platform: Create a bootable media directory tree for…

ocpiadmin deploy platform

Create a bootable media directory tree for the named RCC platform on the named HDL platform.

The specified platforms must have been previously built.

Usage:

$ ocpiadmin deploy platform [OPTIONS] RCC Platform HDL Platform

Arguments:

  • RCC Platform: RCC platform to deploy. [required]

  • HDL Platform: HDL platform to deploy. [required]

Options:

  • --help: Show this message and exit.