Orbit is the package manager for Hardware Description Languages (HDL).
Orbit provides a complete frontend package management solution to HDL projects, while allowing users to implement custom backend workflows through the design of a plugin system. Orbit provides commands for every stage of the development cycle, in areas such as exploration, integration, and automation.
Orbit is pre-built through GitHub Actions for 64-bit macOs, Windows, and Ubuntu. See the releases page to grab the latest release, or you can build with source through cargo
. See the full installation instructions for complete details here.
Read the Book of Orbit.
Orbit is a tool for hdl package management.
Usage:
orbit [options] [command]
Commands:
new create a new ip
init initialize an ip from an existing project
edit open an ip in a text editor
probe access information about an ip
read inspect hdl design unit source code
get fetch an entity
tree view the dependency graph
plan generate a blueprint file
build, b execute a plugin
launch release a new ip version
search browse the ip catalog
install store an immutable reference to an ip
env print Orbit environment information
config modify configuration values
uninstall remove an ip from the catalog
Options:
--version print version information and exit
--upgrade check for the latest orbit binary
--force bypass interactive prompts
--color <when> coloring: auto, always, never
--help, -h print help information
Use 'orbit help <command>' for more information about a command.
See CONTRIBUTING.
This project, which refers to all source code files created under this repository, is currently licensed under the open-source copyleft GPL-3.0 license. See LICENSE.