Command Line Interface (CLI)
See the overview of viper's commands for an introduction.
viper
Viper open circuit design environment
Documentation: https://www.cascode-labs.org/viper/
Usage:
viper [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-v, --version |
boolean | Show the version and exit. | False |
--docs |
boolean | show the documentation URL and exit | False |
--help |
boolean | Show this message and exit. | False |
config
Read the Viper environment configuration
Usage:
viper config [OPTIONS] [PARAMETERS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-t, --toml |
boolean | Print the result in TOML format | False |
--sources |
boolean | show the documentation URL and exit | False |
--help |
boolean | Show this message and exit. | False |
open
Opens a Viper circuit design project
Usage:
viper open [OPTIONS] PROJECT
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--dev, -d / --nodev, -o |
boolean | A flag for toggling the development mode | False |
--name, -n |
text | Conda name to activate. prefix and name are mutually exclusive options. | None |
--prefix, -p |
text | Conda Prefix to activate. prefix and name are mutually exclusive options. | None |
--shell, -s |
choice (tcsh | bash) |
The type of shell script specified with the --init or -i options | bash |
--init, -i |
text | Paths to one or more shell initialization scripts which will be sourced, each delimited by a ":", this option can also be specified multiple times to add additional scripts. | None |
--help |
boolean | Show this message and exit. | False |
project
Interact with a project
Usage:
viper project [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
create
Usage:
viper project create [OPTIONS] NAME
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
info
Display the project's configuration
Usage:
viper project info [OPTIONS] [NAME]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
welcome
Display the Viper welcome message
Usage:
viper welcome [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |