ocpidev

Command line tool used to perform various operations on OpenCPI assets.

Usage:

$ ocpidev [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:

  • create: Create an OpenCPI asset.

  • delete: Delete an OpenCPI Project.

  • build: Build an OpenCPI asset.

  • show: Show an OpenCPI asset(s).

  • run: Run an OpenCPI Unit Test or Application.

  • clean: Clean an OpenCPI Project.

  • register: Register an OpenCPI Project.

  • unregister: Unregister an OpenCPI Project.

ocpidev create

Create an OpenCPI asset.

Usage:

$ ocpidev create [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • application: Create an OpenCPI Application.

  • component: Create an OpenCPI Component.

  • library: Create an OpenCPI Component Library.

  • project: Create an OpenCPI Project.

  • protocol: Create an OpenCPI Protocol.

  • test: Create an OpenCPI Unit Test.

  • worker: Create an OpenCPI Worker.

  • rcc

  • hdl

ocpidev create application

Create an OpenCPI Application.

Usage:

$ ocpidev create application [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --xml-dir-app: Create the application as an XML file.

  • -X, --xml-app: Specify that the application has its own directory that will contain only an an XML file.

  • --help: Show this message and exit.

ocpidev create component

Create an OpenCPI Component.

Usage:

$ ocpidev create component [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --no-control: Specify that the component has no control interface.

  • --create-test: Create the unit test suite for the component. Can only be used in a Library.

  • --help: Show this message and exit.

ocpidev create library

Create an OpenCPI Component Library.

Usage:

$ ocpidev create library [OPTIONS] [NAME]

Arguments:

  • [NAME]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --package-id TEXT: The package ID. Defaults to <package_prefix>.<package_name>

  • --package-prefix TEXT: The package prefix.

  • --package-name TEXT: The package name. Defaults to <name>.

  • --xml-include TEXT: Directory to search for XML include files. May be used more than once.

  • --include-dir TEXT: Directory to search for include files. May be used more than once.

  • --primitive-library TEXT: Primitive library asset depends on. May be used more than once.

  • --component-library TEXT: Component library asset depends on. May be used more than once.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • --help: Show this message and exit.

ocpidev create project

Create an OpenCPI Project.

Usage:

$ ocpidev create project [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • --register / --no-register: [default: no-register]

  • -D, --depend TEXT: Package-ID of project to depend on. May be used more than once.

  • --package-id TEXT: The package ID. Defaults to <package_prefix>.<package_name>

  • --package-prefix TEXT: The package prefix. [default: local]

  • --package-name TEXT: The package name. Defaults to <name>.

  • --xml-include TEXT: Directory to search for XML include files. May be used more than once.

  • --include-dir TEXT: Directory to search for include files. May be used more than once.

  • --primitive-library TEXT: Primitive library asset depends on. May be used more than once.

  • --component-library TEXT: Component library asset depends on. May be used more than once.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • --help: Show this message and exit.

ocpidev create protocol

Create an OpenCPI Protocol.

Usage:

$ ocpidev create protocol [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev create test

Create an OpenCPI Unit Test.

Usage:

$ ocpidev create test [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -S, --spec Component: Component spec to use.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • --help: Show this message and exit.

ocpidev create worker

Create an OpenCPI Worker.

Usage:

$ ocpidev create worker [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -S, --spec Component: Component spec to use.

  • -L, --language TEXT: Specify the source language for the worker being created.

  • --xml-include TEXT: Directory to search for XML include files. May be used more than once.

  • --include-dir TEXT: Directory to search for include files. May be used more than once.

  • --primitive-library TEXT: Primitive library asset depends on. May be used more than once.

  • --component-library TEXT: Component library asset depends on. May be used more than once.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • -O, --other TEXT: Specify a source code file that is not included by default.

  • --static-prereq TEXT: Specify a prerequisite library to statically link.

  • --dynamic-prereq TEXT: Specify a prerequisite library to dynamically link.

  • --slave-worker TEXT: Create the RCC worker as a proxy for the specified slave worker.

  • --core TEXT: Specify an HDL primitive core on which the worker being created depends.

  • --help: Show this message and exit.

ocpidev create rcc

Usage:

$ ocpidev create rcc [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • worker: Create an OpenCPI RCC Worker.

ocpidev create rcc worker

Create an OpenCPI RCC Worker.

Usage:

$ ocpidev create rcc worker [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -S, --spec Component: Component spec to use.

  • --component-library TEXT: Component library asset depends on. May be used more than once.

  • -L, --language TEXT: Specify the source language for the worker being created.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • -O, --other TEXT: Specify a source code file that is not included by default.

  • --static-prereq TEXT: Specify a prerequisite library to statically link.

  • --dynamic-prereq TEXT: Specify a prerequisite library to dynamically link.

  • --slave-worker TEXT: Create the RCC worker as a proxy for the specified slave worker.

  • --help: Show this message and exit.

ocpidev create hdl

Usage:

$ ocpidev create hdl [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • adapter: Create an OpenCPI HDL Adapter.

  • assembly: Create an OpenCPI HDL Assembly.

  • card: Create an OpenCPI HDL Card.

  • device: Create an OpenCPI HDL Device.

  • platform: Create an OpenCPI HDL Platform.

  • worker: Create an OpenCPI HDL Worker.

  • primitive

ocpidev create hdl adapter

Create an OpenCPI HDL Adapter.

Usage:

$ ocpidev create hdl adapter [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --xml-include TEXT: Directory to search for XML include files. May be used more than once.

  • --include-dir TEXT: Directory to search for include files. May be used more than once.

  • --primitive-library TEXT: Primitive library asset depends on. May be used more than once.

  • --component-library TEXT: Component library asset depends on. May be used more than once.

  • -S, --spec Component: Component spec to use.

  • -L, --language TEXT: Specify the source language for the worker being created.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • -O, --other TEXT: Specify a source code file that is not included by default.

  • --core TEXT: Specify an HDL primitive core on which the worker being created depends.

  • --help: Show this message and exit.

ocpidev create hdl assembly

Create an OpenCPI HDL Assembly.

Usage:

$ ocpidev create hdl assembly [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • --help: Show this message and exit.

ocpidev create hdl card

Create an OpenCPI HDL Card.

Usage:

$ ocpidev create hdl card [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev create hdl device

Create an OpenCPI HDL Device.

Usage:

$ ocpidev create hdl device [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --xml-include TEXT: Directory to search for XML include files. May be used more than once.

  • --include-dir TEXT: Directory to search for include files. May be used more than once.

  • --primitive-library TEXT: Primitive library asset depends on. May be used more than once.

  • --component-library TEXT: Component library asset depends on. May be used more than once.

  • -S, --spec Component: Component spec to use.

  • -L, --language TEXT: Specify the source language for the worker being created.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • -O, --other TEXT: Specify a source code file that is not included by default.

  • --core TEXT: Specify an HDL primitive core on which the worker being created depends.

  • --emulates TEXT: Specify the HDL device worker associated with the device being emulated.

  • --supports TEXT: Specify one of the HDL device workers that the subdevice supports.

  • --help: Show this message and exit.

ocpidev create hdl platform

Create an OpenCPI HDL Platform.

Usage:

$ ocpidev create hdl platform [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --core TEXT: Specify an HDL primitive core on which the worker being created depends.

  • --time-freq TEXT: Specify the time server frequency for the platform. [default: 100e6]

  • --help: Show this message and exit.

ocpidev create hdl worker

Create an OpenCPI HDL Worker.

Usage:

$ ocpidev create hdl worker [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --xml-include TEXT: Directory to search for XML include files. May be used more than once.

  • --include-dir TEXT: Directory to search for include files. May be used more than once.

  • --primitive-library TEXT: Primitive library asset depends on. May be used more than once.

  • --component-library TEXT: Component library asset depends on. May be used more than once.

  • -S, --spec Component: Component spec to use.

  • -L, --language TEXT: Specify the source language for the worker being created.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • -O, --other TEXT: Specify a source code file that is not included by default.

  • --core TEXT: Specify an HDL primitive core on which the worker being created depends.

  • --help: Show this message and exit.

ocpidev create hdl primitive

Usage:

$ ocpidev create hdl primitive [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • core: Create an OpenCPI HDL Primitive Core.

  • library: Create an OpenCPI HDL Primitive Library.

ocpidev create hdl primitive core

Create an OpenCPI HDL Primitive Core.

Usage:

$ ocpidev create hdl primitive core [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • --prebuilt PATH: Create the HDL primitive core from the specified pre-built core file.

  • --module TEXT: Specify the name of the top module of the core. Default is <name>.

  • --help: Show this message and exit.

ocpidev create hdl primitive library

Create an OpenCPI HDL Primitive Library.

Usage:

$ ocpidev create hdl primitive library [OPTIONS] NAME

Arguments:

  • NAME: [required]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --exclude-platform Platform: Do not allow building asset for specified platform. May be used more than once.

  • --only-platform Platform: Only allow building asset for specified platform. May be used more than once.

  • --exclude-target HDL Target: Do not allow building asset for specified HDL target. May be used more than once.

  • --only-target HDL Target: Only allow building asset for specified HDL target. May be used more than once.

  • --no-depend: Specify that the primitive library does not depend on another primitive library.

  • --no-elaborate: Specify that the HDL primitive library being created should not be elaborated when building

  • --help: Show this message and exit.

ocpidev delete

Delete an OpenCPI Project.

Usage:

$ ocpidev delete [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • application: Delete an OpenCPI Application.

  • applications: Delete a Project’s OpenCPI Applications.

  • component: Delete an OpenCPI Component.

  • components: Delete a Library’s OpenCPI Components.

  • library: Delete an OpenCPI Library.

  • libraries: Delete a Project’s OpenCPI Libraries.

  • project: Delete an OpenCPI Project.

  • projects: Delete all OpenCPI Projects in a Registry.

  • protocol: Delete an OpenCPI Protocol.

  • protocols: Delete a Project’s OpenCPI Protocols.

  • test: Delete an OpenCPI Unit Test.

  • tests: Delete a Library’s OpenCPI Tests.

  • worker: Delete an OpenCPI Worker.

  • workers: Delete a Library’s OpenCPI Workers.

  • rcc

  • hdl

ocpidev delete application

Delete an OpenCPI Application.

Usage:

$ ocpidev delete application [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete applications

Delete a Project’s OpenCPI Applications.

Usage:

$ ocpidev delete applications [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete component

Delete an OpenCPI Component.

Usage:

$ ocpidev delete component [OPTIONS] [Component]

Arguments:

  • [Component]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete components

Delete a Library’s OpenCPI Components.

Usage:

$ ocpidev delete components [OPTIONS] [Component]

Arguments:

  • [Component]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete library

Delete an OpenCPI Library.

Usage:

$ ocpidev delete library [OPTIONS] [Library]

Arguments:

  • [Library]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete libraries

Delete a Project’s OpenCPI Libraries.

Usage:

$ ocpidev delete libraries [OPTIONS] [Library]

Arguments:

  • [Library]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete project

Delete an OpenCPI Project.

Usage:

$ ocpidev delete project [OPTIONS] [Project]

Arguments:

  • [Project]

Options:

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete projects

Delete all OpenCPI Projects in a Registry.

Usage:

$ ocpidev delete projects [OPTIONS] [Project]

Arguments:

  • [Project]

Options:

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete protocol

Delete an OpenCPI Protocol.

Usage:

$ ocpidev delete protocol [OPTIONS] [Protocol]

Arguments:

  • [Protocol]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete protocols

Delete a Project’s OpenCPI Protocols.

Usage:

$ ocpidev delete protocols [OPTIONS] [Protocol]

Arguments:

  • [Protocol]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete test

Delete an OpenCPI Unit Test.

Usage:

$ ocpidev delete test [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete tests

Delete a Library’s OpenCPI Tests.

Usage:

$ ocpidev delete tests [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete worker

Delete an OpenCPI Worker.

Usage:

$ ocpidev delete worker [OPTIONS] [Worker]

Arguments:

  • [Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete workers

Delete a Library’s OpenCPI Workers.

Usage:

$ ocpidev delete workers [OPTIONS] [Worker]

Arguments:

  • [Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete rcc

Usage:

$ ocpidev delete rcc [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • worker: Delete an OpenCPI RCC Worker.

  • workers: Delete a Library’s OpenCPI RCC Workers.

ocpidev delete rcc worker

Delete an OpenCPI RCC Worker.

Usage:

$ ocpidev delete rcc worker [OPTIONS] [RCC Worker]

Arguments:

  • [RCC Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete rcc workers

Delete a Library’s OpenCPI RCC Workers.

Usage:

$ ocpidev delete rcc workers [OPTIONS] [RCC Worker]

Arguments:

  • [RCC Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl

Usage:

$ ocpidev delete hdl [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • adapter: Delete an OpenCPI HDL Adapter.

  • adapters: Delete a Library’s OpenCPI HDL Adapters.

  • assembly: Delete an OpenCPI HDL Assembly.

  • assemblies: Delete a Library’s OpenCPI HDL Assemblies.

  • card: Delete an OpenCPI HDL Card.

  • cards: Delete a Library’s OpenCPI HDL Cards.

  • device: Delete an OpenCPI HDL Device.

  • devices: Delete a Project’s OpenCPI HDL Devices.

  • primitive: Delete an OpenCPI HDL Primitive.

  • primitives: Delete a Project’s OpenCPI HDL Primitives.

  • worker: Delete an OpenCPI HDL Worker.

  • workers: Delete a Library’s OpenCPI HDL Workers.

ocpidev delete hdl adapter

Delete an OpenCPI HDL Adapter.

Usage:

$ ocpidev delete hdl adapter [OPTIONS] [HDL Adapter]

Arguments:

  • [HDL Adapter]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl adapters

Delete a Library’s OpenCPI HDL Adapters.

Usage:

$ ocpidev delete hdl adapters [OPTIONS] [HDL Adapter]

Arguments:

  • [HDL Adapter]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl assembly

Delete an OpenCPI HDL Assembly.

Usage:

$ ocpidev delete hdl assembly [OPTIONS] [HDL Assembly]

Arguments:

  • [HDL Assembly]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl assemblies

Delete a Library’s OpenCPI HDL Assemblies.

Usage:

$ ocpidev delete hdl assemblies [OPTIONS] [HDL Assembly]

Arguments:

  • [HDL Assembly]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl card

Delete an OpenCPI HDL Card.

Usage:

$ ocpidev delete hdl card [OPTIONS] [HDL Card]

Arguments:

  • [HDL Card]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl cards

Delete a Library’s OpenCPI HDL Cards.

Usage:

$ ocpidev delete hdl cards [OPTIONS] [HDL Card]

Arguments:

  • [HDL Card]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl device

Delete an OpenCPI HDL Device.

Usage:

$ ocpidev delete hdl device [OPTIONS] [HDL Device]

Arguments:

  • [HDL Device]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl devices

Delete a Project’s OpenCPI HDL Devices.

Usage:

$ ocpidev delete hdl devices [OPTIONS] [HDL Device]

Arguments:

  • [HDL Device]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl primitive

Delete an OpenCPI HDL Primitive.

Usage:

$ ocpidev delete hdl primitive [OPTIONS] [HDL Primitive]

Arguments:

  • [HDL Primitive]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl primitives

Delete a Project’s OpenCPI HDL Primitives.

Usage:

$ ocpidev delete hdl primitives [OPTIONS] [HDL Primitive]

Arguments:

  • [HDL Primitive]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl worker

Delete an OpenCPI HDL Worker.

Usage:

$ ocpidev delete hdl worker [OPTIONS] [HDL Worker]

Arguments:

  • [HDL Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev delete hdl workers

Delete a Library’s OpenCPI HDL Workers.

Usage:

$ ocpidev delete hdl workers [OPTIONS] [HDL Worker]

Arguments:

  • [HDL Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev build

Build an OpenCPI asset.

Usage:

$ ocpidev build [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • project: Build an OpenCPI Project

  • library: Build an OpenCPI Component Library.

  • worker: Build an OpenCPI Worker.

  • application: Build an OpenCPI ACI Application.

  • applications: Build all OpenCPI Applications in a…

  • test: Build an OpenCPI Test.

  • tests: Build all OpenCPI Tests in a Project or…

  • hdl

  • rcc

ocpidev build project

Build an OpenCPI Project

Usage:

$ ocpidev build project [OPTIONS] [Project]

Arguments:

  • [Project]

Options:

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -w, --workers: Also build workers.

  • -t, --tests: Also build tests.

  • -a, --assemblies: Also build assemblies.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --optimize: Build rcc assets with compiler optimization enabled.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --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.

ocpidev build library

Build an OpenCPI Component Library.

Usage:

$ ocpidev build library [OPTIONS] [Library]

Arguments:

  • [Library]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -w, --workers: Also build workers.

  • -t, --tests: Also build tests.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --optimize: Build rcc assets with compiler optimization enabled.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --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.

ocpidev build worker

Build an OpenCPI Worker.

Usage:

$ ocpidev build worker [OPTIONS] [Worker]

Arguments:

  • [Worker]

Options:

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --optimize: Build rcc assets with compiler optimization enabled.

  • --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.

ocpidev build application

Build an OpenCPI ACI Application.

Usage:

$ ocpidev build application [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --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.

ocpidev build applications

Build all OpenCPI Applications in a Project or Library.

Usage:

$ ocpidev build applications [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --accumulate-errors: Do not stop builds after a failure.

  • --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.

ocpidev build test

Build an OpenCPI Test.

Usage:

$ ocpidev build test [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --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.

ocpidev build tests

Build all OpenCPI Tests in a Project or Library.

Usage:

$ ocpidev build tests [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --accumulate-errors: Do not stop builds after a failure.

  • --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.

ocpidev build hdl

Usage:

$ ocpidev build hdl [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • worker: Build an OpenCPI HDL Worker.

  • workers: Build all OpenCPI HDL Workers in a Project…

  • adapter: Build an OpenCPI HDL Adapter.

  • adapters: Build all OpenCPI HDL Adapters in a…

  • assembly: Build an OpenCPI HDL Assembly.

  • assemblies: Build all OpenCPI Hdl Assemblies in a…

  • device: Build an OpenCPI HDL Device.

  • devices: Build all OpenCPI HDL Devices in a Project…

  • platform: Build an OpenCPI HDL Platform.

  • platforms: Build all OpenCPI HDL Platforms in a…

  • primitive: Build an OpenCPI HDL Primitive.

  • primitives: Build all OpenCPI HDL Primitives in a…

ocpidev build hdl worker

Build an OpenCPI HDL Worker.

Usage:

$ ocpidev build hdl worker [OPTIONS] [HDL Worker]

Arguments:

  • [HDL Worker]

Options:

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --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.

ocpidev build hdl workers

Build all OpenCPI HDL Workers in a Project or Library.

Usage:

$ ocpidev build hdl workers [OPTIONS] [HDL Worker]

Arguments:

  • [HDL Worker]

Options:

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --accumulate-errors: Do not stop builds after a failure.

  • --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.

ocpidev build hdl adapter

Build an OpenCPI HDL Adapter.

Usage:

$ ocpidev build hdl adapter [OPTIONS] [HDL Adapter]

Arguments:

  • [HDL Adapter]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --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.

ocpidev build hdl adapters

Build all OpenCPI HDL Adapters in a Project or Library.

Usage:

$ ocpidev build hdl adapters [OPTIONS] [HDL Adapter]

Arguments:

  • [HDL Adapter]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --accumulate-errors: Do not stop builds after a failure.

  • --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.

ocpidev build hdl assembly

Build an OpenCPI HDL Assembly.

Usage:

$ ocpidev build hdl assembly [OPTIONS] [HDL Assembly]

Arguments:

  • [HDL Assembly]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --streamline-build: Skip checkpoints when building assemblies.

  • --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.

ocpidev build hdl assemblies

Build all OpenCPI Hdl Assemblies in a Project or Library.

Usage:

$ ocpidev build hdl assemblies [OPTIONS] [HDL Assembly]

Arguments:

  • [HDL Assembly]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --streamline-build: Skip checkpoints when building assemblies.

  • --accumulate-errors: Do not stop builds after a failure.

  • --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.

ocpidev build hdl device

Build an OpenCPI HDL Device.

Usage:

$ ocpidev build hdl device [OPTIONS] [HDL Device]

Arguments:

  • [HDL Device]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --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.

ocpidev build hdl devices

Build all OpenCPI HDL Devices in a Project or Library.

Usage:

$ ocpidev build hdl devices [OPTIONS] [HDL Device]

Arguments:

  • [HDL Device]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --accumulate-errors: Do not stop builds after a failure.

  • --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.

ocpidev build hdl platform

Build an OpenCPI HDL Platform.

Usage:

$ ocpidev build hdl platform [OPTIONS] [HDL Platform]

Arguments:

  • [HDL Platform]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --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.

ocpidev build hdl platforms

Build all OpenCPI HDL Platforms in a Project or Library.

Usage:

$ ocpidev build hdl platforms [OPTIONS] [HDL Platform]

Arguments:

  • [HDL Platform]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --accumulate-errors: Do not stop builds after a failure.

  • --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.

ocpidev build hdl primitive

Build an OpenCPI HDL Primitive.

Usage:

$ ocpidev build hdl primitive [OPTIONS] [HDL Primitive]

Arguments:

  • [HDL Primitive]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --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.

ocpidev build hdl primitives

Build all OpenCPI HDL Primitives in a Project or Library.

Usage:

$ ocpidev build hdl primitives [OPTIONS] [HDL Primitive]

Arguments:

  • [HDL Primitive]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --accumulate-errors: Do not stop builds after a failure.

  • --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.

ocpidev build rcc

Usage:

$ ocpidev build rcc [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • worker: Build an OpenCPI RCC Worker.

  • workers: Build all OpenCPI RCC Workers in a Project…

ocpidev build rcc worker

Build an OpenCPI RCC Worker.

Usage:

$ ocpidev build rcc worker [OPTIONS] [RCC Worker]

Arguments:

  • [RCC Worker]

Options:

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --optimize: Build rcc assets with compiler optimization enabled.

  • --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.

ocpidev build rcc workers

Build all OpenCPI RCC Workers in a Project or Library.

Usage:

$ ocpidev build rcc workers [OPTIONS] [RCC Worker]

Arguments:

  • [RCC Worker]

Options:

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --doc-only: Only build docs.

  • --no-doc: Do not build docs.

  • --artifacts-only: Clean up intermediate build files.

  • --optimize: Build rcc assets with compiler optimization enabled.

  • -j, --n-jobs INTEGER RANGE: The max number of parallel jobs to allow. [default: 1; 1<=x<=48]

  • --accumulate-errors: Do not stop builds after a failure.

  • --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.

ocpidev show

Show an OpenCPI asset(s).

Usage:

$ ocpidev show [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • application: Show an OpenCPI Application.

  • applications: Show an OpenCPI Project’s Applications.

  • component: Show an OpenCPI Component.

  • components: Show an OpenCPI Library’s Components.

  • library: Show an OpenCPI Library.

  • libraries: Show an OpenCPI Project’s Libraries.

  • platform: Show an OpenCPI Platform.

  • platforms: Show an OpenCPI Library’s Platforms.

  • project: Show an OpenCPI Project.

  • projects: Show all OpenCPI Projects in the current…

  • protocol: Show an OpenCPI Protocol.

  • protocols: Show an OpenCPI Project’s Protocols.

  • test: Show an OpenCPI Unit Test.

  • tests: Show an OpenCPI Project’s Unit Tests.

  • worker: Show an OpenCPI Worker.

  • workers: Show an OpenCPI Library’s Workers.

  • hdl

  • rcc

ocpidev show application

Show an OpenCPI Application.

Usage:

$ ocpidev show application [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show applications

Show an OpenCPI Project’s Applications.

Usage:

$ ocpidev show applications [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show component

Show an OpenCPI Component.

Usage:

$ ocpidev show component [OPTIONS] [Component]

Arguments:

  • [Component]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show components

Show an OpenCPI Library’s Components.

Usage:

$ ocpidev show components [OPTIONS] [Component]

Arguments:

  • [Component]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show library

Show an OpenCPI Library.

Usage:

$ ocpidev show library [OPTIONS] [Library]

Arguments:

  • [Library]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show libraries

Show an OpenCPI Project’s Libraries.

Usage:

$ ocpidev show libraries [OPTIONS] [Library]

Arguments:

  • [Library]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show platform

Show an OpenCPI Platform.

Usage:

$ ocpidev show platform [OPTIONS] [Platform]

Arguments:

  • [Platform]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show platforms

Show an OpenCPI Library’s Platforms.

Usage:

$ ocpidev show platforms [OPTIONS] [Platform]

Arguments:

  • [Platform]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show project

Show an OpenCPI Project.

Usage:

$ ocpidev show project [OPTIONS] [Project]

Arguments:

  • [Project]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --help: Show this message and exit.

ocpidev show projects

Show all OpenCPI Projects in the current registry.

Usage:

$ ocpidev show projects [OPTIONS] [Project]

Arguments:

  • [Project]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --help: Show this message and exit.

ocpidev show protocol

Show an OpenCPI Protocol.

Usage:

$ ocpidev show protocol [OPTIONS] [Protocol]

Arguments:

  • [Protocol]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show protocols

Show an OpenCPI Project’s Protocols.

Usage:

$ ocpidev show protocols [OPTIONS] [Protocol]

Arguments:

  • [Protocol]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show test

Show an OpenCPI Unit Test.

Usage:

$ ocpidev show test [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show tests

Show an OpenCPI Project’s Unit Tests.

Usage:

$ ocpidev show tests [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show worker

Show an OpenCPI Worker.

Usage:

$ ocpidev show worker [OPTIONS] [Worker]

Arguments:

  • [Worker]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show workers

Show an OpenCPI Library’s Workers.

Usage:

$ ocpidev show workers [OPTIONS] [Worker]

Arguments:

  • [Worker]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl

Usage:

$ ocpidev show hdl [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • adapter: Show an OpenCPI HDL Adapter.

  • adapters: Show an OpenCPI Project’s HDL Adapters.

  • assembly: Show an OpenCPI HDL Assembly.

  • assemblies: Show an OpenCPI Project’s HDL Assemblies.

  • card: Show an OpenCPI HDL Card.

  • cards: Show an OpenCPI Project’s HDL Cards.

  • device: Show an OpenCPI HDL Device.

  • devices: Show an OpenCPI Project’s HDL Devices.

  • platform: Show an OpenCPI HDL Platform.

  • platforms: Show an OpenCPI Library’s HDL Platforms.

  • primitive: Show an OpenCPI HDL Primitive.

  • primitives: Show an OpenCPI Project’s HDL Primitives.

  • worker: Show an OpenCPI RCC Worker.

  • workers: Show an OpenCPI Library’s RCC Workers.

  • target: Show an OpenCPI Project’s HDL Targets.

  • targets: Show an OpenCPI Project’s HDL Targets.

ocpidev show hdl adapter

Show an OpenCPI HDL Adapter.

Usage:

$ ocpidev show hdl adapter [OPTIONS] [HDL Adapter]

Arguments:

  • [HDL Adapter]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl adapters

Show an OpenCPI Project’s HDL Adapters.

Usage:

$ ocpidev show hdl adapters [OPTIONS] [HDL Adapter]

Arguments:

  • [HDL Adapter]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl assembly

Show an OpenCPI HDL Assembly.

Usage:

$ ocpidev show hdl assembly [OPTIONS] [HDL Assembly]

Arguments:

  • [HDL Assembly]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl assemblies

Show an OpenCPI Project’s HDL Assemblies.

Usage:

$ ocpidev show hdl assemblies [OPTIONS] [HDL Assembly]

Arguments:

  • [HDL Assembly]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl card

Show an OpenCPI HDL Card.

Usage:

$ ocpidev show hdl card [OPTIONS] [HDL Card]

Arguments:

  • [HDL Card]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl cards

Show an OpenCPI Project’s HDL Cards.

Usage:

$ ocpidev show hdl cards [OPTIONS] [HDL Card]

Arguments:

  • [HDL Card]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl device

Show an OpenCPI HDL Device.

Usage:

$ ocpidev show hdl device [OPTIONS] [HDL Device]

Arguments:

  • [HDL Device]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl devices

Show an OpenCPI Project’s HDL Devices.

Usage:

$ ocpidev show hdl devices [OPTIONS] [HDL Device]

Arguments:

  • [HDL Device]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl platform

Show an OpenCPI HDL Platform.

Usage:

$ ocpidev show hdl platform [OPTIONS] [HDL Platform]

Arguments:

  • [HDL Platform]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl platforms

Show an OpenCPI Library’s HDL Platforms.

Usage:

$ ocpidev show hdl platforms [OPTIONS] [HDL Platform]

Arguments:

  • [HDL Platform]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl primitive

Show an OpenCPI HDL Primitive.

Usage:

$ ocpidev show hdl primitive [OPTIONS] [HDL Primitive]

Arguments:

  • [HDL Primitive]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl primitives

Show an OpenCPI Project’s HDL Primitives.

Usage:

$ ocpidev show hdl primitives [OPTIONS] [HDL Primitive]

Arguments:

  • [HDL Primitive]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl worker

Show an OpenCPI RCC Worker.

Usage:

$ ocpidev show hdl worker [OPTIONS] [HDL Worker]

Arguments:

  • [HDL Worker]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl workers

Show an OpenCPI Library’s RCC Workers.

Usage:

$ ocpidev show hdl workers [OPTIONS] [HDL Worker]

Arguments:

  • [HDL Worker]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show hdl target

Show an OpenCPI Project’s HDL Targets.

Usage:

$ ocpidev show hdl target [OPTIONS] HDL Target

Arguments:

  • HDL Target: [required]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --help: Show this message and exit.

ocpidev show hdl targets

Show an OpenCPI Project’s HDL Targets.

Usage:

$ ocpidev show hdl targets [OPTIONS] [HDL Target]

Arguments:

  • [HDL Target]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --help: Show this message and exit.

ocpidev show rcc

Usage:

$ ocpidev show rcc [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • platform: Show an OpenCPI RCC Platform.

  • platforms: Show an OpenCPI Project’s RCC Platforms.

  • worker: Show an OpenCPI RCC Worker.

  • workers: Show an OpenCPI Library’s RCC Workers.

ocpidev show rcc platform

Show an OpenCPI RCC Platform.

Usage:

$ ocpidev show rcc platform [OPTIONS] [RCC Platform]

Arguments:

  • [RCC Platform]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show rcc platforms

Show an OpenCPI Project’s RCC Platforms.

Usage:

$ ocpidev show rcc platforms [OPTIONS] [RCC Platform]

Arguments:

  • [RCC Platform]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show rcc worker

Show an OpenCPI RCC Worker.

Usage:

$ ocpidev show rcc worker [OPTIONS] [RCC Worker]

Arguments:

  • [RCC Worker]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev show rcc workers

Show an OpenCPI Library’s RCC Workers.

Usage:

$ ocpidev show rcc workers [OPTIONS] [RCC Worker]

Arguments:

  • [RCC Worker]

Options:

  • --format [json|table|simple]: Specify the format to display the asset(s). [default: table]

  • --global: Show assets of specified type for all OpenCPI projects.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -p, --project Project: Specify the Project that the asset resides in.

  • --help: Show this message and exit.

ocpidev run

Run an OpenCPI Unit Test or Application.

Usage:

$ ocpidev run [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • test: Run an OpenCPI Unit Test.

  • tests: Run an OpenCPI Project’s Unit Tests.

  • application: Run an OpenCPI Application.

  • applications: Run an OpenCPI Project’s Applications.

ocpidev run test

Run an OpenCPI Unit Test.

Usage:

$ ocpidev run test [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --exclude-platform Platform: Platform(s) to apply the command for.

  • --only-platform Platform: Platform(s) to apply the command for.

  • --accumulate-errors: Report execution or verification errors as they occur rather than ending the test on the first failure detected.

  • --keep-simulations: Keep HDL simulation files regardless of verification results.

  • --view: Run the view script for the test at the conclusion of the test execution.

  • --case TEXT: Specify the test case(s) to be executed/verified. May be used more than once.

  • --remote TEXT: Specify the remote system to run the tests.

  • --phase [prep|run|verify|prep,run,verify|prep,run|run,verify]: Specify which non-building phase of unit testing to run. [default: prep,run,verify]

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

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

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

  • --help: Show this message and exit.

ocpidev run tests

Run an OpenCPI Project’s Unit Tests.

Usage:

$ ocpidev run tests [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --exclude-platform Platform: Platform(s) to apply the command for.

  • --only-platform Platform: Platform(s) to apply the command for.

  • --accumulate-errors: Report execution or verification errors as they occur rather than ending the test on the first failure detected.

  • --keep-simulations: Keep HDL simulation files regardless of verification results.

  • --view: Run the view script for the test at the conclusion of the test execution.

  • --case TEXT: Specify the test case(s) to be executed/verified. May be used more than once.

  • --remote TEXT: Specify the remote system to run the tests.

  • --phase [prep|run|verify|prep,run,verify|prep,run|run,verify]: Specify which non-building phase of unit testing to run. [default: prep,run,verify]

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

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

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

  • --help: Show this message and exit.

ocpidev run application

Run an OpenCPI Application.

Usage:

$ ocpidev run application [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --after TEXT: Specify the argument to insert at the end of the execution command line. May be used more than once.

  • --before TEXT: Specify the argument to insert before the command. May be used more than once.

  • --run-arg TEXT: Specify the argument(s) to insert immediately after the ACI executable or the ocpirun command.

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

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

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

  • --help: Show this message and exit.

ocpidev run applications

Run an OpenCPI Project’s Applications.

Usage:

$ ocpidev run applications [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --after TEXT: Specify the argument to insert at the end of the execution command line. May be used more than once.

  • --before TEXT: Specify the argument to insert before the command. May be used more than once.

  • --run-arg TEXT: Specify the argument(s) to insert immediately after the ACI executable or the ocpirun command.

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

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

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

  • --help: Show this message and exit.

ocpidev clean

Clean an OpenCPI Project.

Usage:

$ ocpidev clean [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • project: Clean an OpenCPI Project.

  • projects: Clean an OpenCPI Project.

  • library: Clean an OpenCPI Library.

  • libraries: Clean a Project’s OpenCPI Libraries.

  • worker: Clean an OpenCPI Worker.

  • workers: Clean a Library’s OpenCPI Workers.

  • test: Clean an OpenCPI Unit Test.

  • tests: Clean a Library’s OpenCPI Tests.

  • component: Clean an OpenCPI Component.

  • components: Clean a Library’s OpenCPI Components.

  • application: Clean an OpenCPI Application.

  • applications: Clean a Project’s OpenCPI Applications.

  • protocol: Clean an OpenCPI Protocol.

  • protocols: Clean a Project’s OpenCPI Protocols.

  • rcc

  • hdl

ocpidev clean project

Clean an OpenCPI Project.

Usage:

$ ocpidev clean project [OPTIONS] [Project]

Arguments:

  • [Project]

Options:

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean projects

Clean an OpenCPI Project.

Usage:

$ ocpidev clean projects [OPTIONS] [Project]

Arguments:

  • [Project]

Options:

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean library

Clean an OpenCPI Library.

Usage:

$ ocpidev clean library [OPTIONS] [Library]

Arguments:

  • [Library]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean libraries

Clean a Project’s OpenCPI Libraries.

Usage:

$ ocpidev clean libraries [OPTIONS] [Library]

Arguments:

  • [Library]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean worker

Clean an OpenCPI Worker.

Usage:

$ ocpidev clean worker [OPTIONS] [Worker]

Arguments:

  • [Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean workers

Clean a Library’s OpenCPI Workers.

Usage:

$ ocpidev clean workers [OPTIONS] [Worker]

Arguments:

  • [Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean test

Clean an OpenCPI Unit Test.

Usage:

$ ocpidev clean test [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean tests

Clean a Library’s OpenCPI Tests.

Usage:

$ ocpidev clean tests [OPTIONS] [Test]

Arguments:

  • [Test]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean component

Clean an OpenCPI Component.

Usage:

$ ocpidev clean component [OPTIONS] [Component]

Arguments:

  • [Component]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean components

Clean a Library’s OpenCPI Components.

Usage:

$ ocpidev clean components [OPTIONS] [Component]

Arguments:

  • [Component]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean application

Clean an OpenCPI Application.

Usage:

$ ocpidev clean application [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean applications

Clean a Project’s OpenCPI Applications.

Usage:

$ ocpidev clean applications [OPTIONS] [Application]

Arguments:

  • [Application]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean protocol

Clean an OpenCPI Protocol.

Usage:

$ ocpidev clean protocol [OPTIONS] [Protocol]

Arguments:

  • [Protocol]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean protocols

Clean a Project’s OpenCPI Protocols.

Usage:

$ ocpidev clean protocols [OPTIONS] [Protocol]

Arguments:

  • [Protocol]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean rcc

Usage:

$ ocpidev clean rcc [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • worker: Clean an OpenCPI RCC Worker.

  • workers: Clean a Library’s OpenCPI RCC Workers.

ocpidev clean rcc worker

Clean an OpenCPI RCC Worker.

Usage:

$ ocpidev clean rcc worker [OPTIONS] [RCC Worker]

Arguments:

  • [RCC Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean rcc workers

Clean a Library’s OpenCPI RCC Workers.

Usage:

$ ocpidev clean rcc workers [OPTIONS] [RCC Worker]

Arguments:

  • [RCC Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --rcc-platform RCC Platform: RCC Platform(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl

Usage:

$ ocpidev clean hdl [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • adapter: Clean an OpenCPI Adapter.

  • adapters: Clean a Project’s OpenCPI Adapters.

  • assembly: Clean an OpenCPI HDL Assembly.

  • assemblies: Clean a Project’s OpenCPI HDL Assembly.

  • card: Clean an OpenCPI Card.

  • cards: Clean a Project’s OpenCPI Cards.

  • device: Clean an OpenCPI Device.

  • devices: Clean a Project’s OpenCPI Devices.

  • primitive: Clean an OpenCPI Primitive.

  • primitives: Clean a Project’s OpenCPI Pimitives.

  • worker: Clean an OpenCPI Worker.

  • workers: Clean a Library’s OpenCPI Workers.

ocpidev clean hdl adapter

Clean an OpenCPI Adapter.

Usage:

$ ocpidev clean hdl adapter [OPTIONS] [HDL Adapter]

Arguments:

  • [HDL Adapter]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl adapters

Clean a Project’s OpenCPI Adapters.

Usage:

$ ocpidev clean hdl adapters [OPTIONS] [HDL Adapter]

Arguments:

  • [HDL Adapter]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl assembly

Clean an OpenCPI HDL Assembly.

Usage:

$ ocpidev clean hdl assembly [OPTIONS] [HDL Assembly]

Arguments:

  • [HDL Assembly]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl assemblies

Clean a Project’s OpenCPI HDL Assembly.

Usage:

$ ocpidev clean hdl assemblies [OPTIONS] [HDL Assembly]

Arguments:

  • [HDL Assembly]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-platform HDL Platform: HDL Platform(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl card

Clean an OpenCPI Card.

Usage:

$ ocpidev clean hdl card [OPTIONS] [HDL Card]

Arguments:

  • [HDL Card]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl cards

Clean a Project’s OpenCPI Cards.

Usage:

$ ocpidev clean hdl cards [OPTIONS] [HDL Card]

Arguments:

  • [HDL Card]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl device

Clean an OpenCPI Device.

Usage:

$ ocpidev clean hdl device [OPTIONS] [HDL Device]

Arguments:

  • [HDL Device]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl devices

Clean a Project’s OpenCPI Devices.

Usage:

$ ocpidev clean hdl devices [OPTIONS] [HDL Device]

Arguments:

  • [HDL Device]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl primitive

Clean an OpenCPI Primitive.

Usage:

$ ocpidev clean hdl primitive [OPTIONS] [HDL Primitive]

Arguments:

  • [HDL Primitive]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl primitives

Clean a Project’s OpenCPI Pimitives.

Usage:

$ ocpidev clean hdl primitives [OPTIONS] [HDL Primitive]

Arguments:

  • [HDL Primitive]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl worker

Clean an OpenCPI Worker.

Usage:

$ ocpidev clean hdl worker [OPTIONS] [HDL Worker]

Arguments:

  • [HDL Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev clean hdl workers

Clean a Library’s OpenCPI Workers.

Usage:

$ ocpidev clean hdl workers [OPTIONS] [HDL Worker]

Arguments:

  • [HDL Worker]

Options:

  • -p, --project Project: Specify the Project that the asset resides in.

  • -l, --library Library: Specify the Library that the asset resides in.

  • --hdl-target HDL Target: HDL Targets(s) to apply the command for.

  • -f, --force

  • --help: Show this message and exit.

ocpidev register

Register an OpenCPI Project.

Usage:

$ ocpidev register [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • project: Register an OpenCPI Project.

ocpidev register project

Register an OpenCPI Project.

Usage:

$ ocpidev register project [OPTIONS] [NAME]

Arguments:

  • [NAME]: [default: (dynamic)]

Options:

  • -r, --registry-dir PATH: Specify directory containing registry. [default: /home/user/opencpi/project-registry]

  • --help: Show this message and exit.

ocpidev unregister

Unregister an OpenCPI Project.

Usage:

$ ocpidev unregister [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • project: Unregister an OpenCPI Project.

ocpidev unregister project

Unregister an OpenCPI Project.

Usage:

$ ocpidev unregister project [OPTIONS] [Project]

Arguments:

  • [Project]

Options:

  • -f, --force

  • --help: Show this message and exit.