A CLI is provided to assist with dev workflows as well as component library database creation and more.

epinterface

CLI for epinterface.

Usage:

epinterface [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

• components: Commands for working with components
• db: Commands for working with epinterface databases.
• prisma: Commands related to Prisma ORM for epinterface.

epinterface components

Commands for working with components

Usage:

epinterface components [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

• template: Create a yaml template file for entering component maps.

epinterface components template

Create a yaml template file for entering component maps.

Usage:

epinterface components template [OPTIONS]

Options:

  --path PATH
  --help       Show this message and exit.

epinterface db

Commands for working with epinterface databases.

Usage:

epinterface db [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

• convert: Convert an excel file to a database file.
• make: Create a new database file at the given path.

epinterface db convert

Convert an excel file to a database file.

Usage:

epinterface db convert [OPTIONS]

Options:

  --excel-path PATH  The excel file should be a
                     template excel file.  See https://
                     github.com/mitsustainabledesignlab
                     /epinterface for more info.
  --db-path PATH     The database file will be created
                     at the given path.  If the file
                     already exists, an error will be
                     raised.
  --help             Show this message and exit.

epinterface db make

Create a new database file at the given path.

Usage:

epinterface db make [OPTIONS]

Options:

  --path PATH
  --if-exists [raise|overwrite|ignore]
                                  What to do if the
                                  database file already
                                  exists. 'raise' will
                                  raise an error,
                                  'overwrite' will
                                  create a new empty
                                  database, 'migrate'
                                  will preserve the
                                  data and apply any
                                  schema changes,
                                  'ignore' will use the
                                  existing database as-
                                  is.
  --help                          Show this message and
                                  exit.

epinterface prisma

Commands related to Prisma ORM for epinterface.

Usage:

epinterface prisma [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

• generate: Generate the prisma client for epinterface.
• partials-path: Return the path to the prisma partials file. This is useful for passing the --partials flag to prisma <subcommand>.
• schemapath: Return the path to the prisma schema file. This is useful for passing the --schema flag to prisma <subcommand>.

epinterface prisma generate

Generate the prisma client for epinterface.

Usage:

epinterface prisma generate [OPTIONS]

Options:

  --help  Show this message and exit.

epinterface prisma partials-path

Return the path to the prisma partials file. This is useful for passing the --partials flag to prisma <subcommand>.

Usage:

epinterface prisma partials-path [OPTIONS]

Options:

  --help  Show this message and exit.

epinterface prisma schemapath

Return the path to the prisma schema file. This is useful for passing the --schema flag to prisma <subcommand>.

Usage:

epinterface prisma schemapath [OPTIONS]

Options:

  --help  Show this message and exit.