Name

ocpidev-show — displays information about OpenCPI assets.

Synopsis

ocpidev show [<options>] <noun>

DESCRIPTION

The show verb is slightly different from other verbs since the command currently is not associated with a project, but with the operating environment by default. There are two scoping options to associate with the command. By default, the --global-scope option is set and it will look in all registered projects (and the current project if applicable). The registry used is the one in the OpenCPI installation unless overridden using the OCPI_PROJECT_REGISTRY_DIR environment variable. Use the --local-scope option to run the command in just the current project.

Asset types to be specified in the <noun> argument are:

component
Display information on the specified component.
components
Display all components in registered projects.
libraries
Display information on all the libraries in the current scope.
platforms
Display all platforms that assets can be built for.
project
Display information about a project.
projects
Display all registered projects.
registry
Display information on the registry.
targets
Display all targets that assets can be built for.
tests
Display information on the unit tests in the current scope.
worker
Display information on the specified worker.
workers
Display all workers in registered projects.
prerequisites
Show installed prerequisites.

Use the keywords rcc and hdl to scope what is displayed for the platforms and targets nouns. For example, the command:

ocpidev show hdl platforms

only shows the available HDL platforms.

For HDL platforms shown in the default display format (see the --table option below), an asterisk after the platform name indicates that the platform is registered but has not yet been built. Note that assemblies and tests cannot be built until the platform is built.

OPTIONS

In addition to the options common to all OpenCPI tools (see opencpi(1)), the options described below can be specified for show operations. In the following descriptions, a plus sign (+) after the option indicates that it can be specified more than once on the command line.

-P <hdl-platform-directory>, --platform=<hdl-platform-directory>
Specify the HDL platform subdirectory in which to operate.
-l <library>, --library=<library>
Specify the component library in which this operation will be performed.
--global-scope
Show assets from all registered projects and the current project if applicable. This is the default scope used if -local-scope is not used.
--hdl-library=<hdl-library>
Specify the HDL library in which this operation will be performed.
--json
Format the output in Javascript Object Notation (JSON) format for integration with other software.
--local-scope
Only show assets in the local project.
--simple
Format the output as simply as possible.
--table
Display the output in an easy-to-read table. This is the default display format used if --simple or --json are not used.

EXAMPLES

  1. List all RCC and HDL platforms that assets can be built for: 

    ocpidev show platforms

  2. List all HDL platforms that HDL assets can be built for: 

    ocpidev show hdl platforms

  3. List all components in any registered projects (omits components at the top level of project due to a defect): 

    ocpidev show components

  4. Display a table of the registered projects and their locations: 

    ocpidev show --table registry

BUGS

See https://www.opencpi.org/report-defects

RESOURCES

See the main web site: https://www.opencpi.org

See the OpenCPI Component Development Guide: https://opencpi.gitlab.io/releases/latest/docs/OpenCPI_Component_Development_Guide.pdf

SEE ALSO

ocpidev(1) ocpidev-build(1) ocpidev-clean(1) ocpidev-create(1) ocpidev-delete(1) ocpidev-refresh(1) ocpidev-register(1) ocpidev-run(1) ocpidev-set(1) ocpidev-unregister(1) ocpidev-unset(1) ocpidev-utilization(1)

COPYING

Copyright (C) 2023 OpenCPI www.opencpi.org. OpenCPI is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.