CLI Reference

This page provides documentation for our command line tools.

hades

Usage:

 [OPTIONS] COMMAND [ARGS]...

Options:

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

generate

Main command. Run the flow until convergence using design_yaml. The design can be stopped at a specific step using the stop option.

Usage:

 generate [OPTIONS]

Options:

  --design-yaml PATH  [default: ./design.yml]
  --stop TEXT         [default: full]

new

Create a template directory called project_name. TODO: Re-write with cookiecutter

Usage:

 new [OPTIONS]

Options:

  --project-name PATH  [default: ./working_dir]

pdk

Usage:

 pdk [OPTIONS] COMMAND [ARGS]...

install

install the pdk_name technology in its default location.

Usage:

 pdk install [OPTIONS] PDK_NAME

Options:

  PDK_NAME  [required]

list

Display the list of available PDK.

Usage:

 pdk list [OPTIONS]

sim

Usage:

 sim [OPTIONS] COMMAND [ARGS]...

config

Set up the simulator and write all configuration in a config.yml file at hades root. :return:

Usage:

 sim config [OPTIONS] SIMULATOR

Options:

  SIMULATOR        [required]
  --base-dir PATH  [required]
  --name TEXT      [required]
  --option TEXT    [required]