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

The CLI is installed as epinterface or epi in your environment.

epi

CLI for epinterface.

Usage:

epi [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.

epi components

Commands for working with components

Usage:

epi components [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

• check: Check if all semantic field combinations resolve to a valid zone component. Will randomly sample the semantic fields as listed in the semantic fields file.
• template: Create a yaml template file for entering component maps.

epi components check

Check if all semantic field combinations resolve to a valid zone component. Will randomly sample the semantic fields as listed in the semantic fields file.

Usage:

epi components check [OPTIONS]

Options:

  --component-map-path PATH
  --semantic-fields-path PATH
  --db-path PATH
  --max-tests INTEGER
  --help                       Show this message and exit.

epi components template

Create a yaml template file for entering component maps.

Usage:

epi components template [OPTIONS]

Options:

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

epi db

Commands for working with epinterface databases.

Usage:

epi 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.

epi db convert

Convert an excel file to a database file.

Usage:

epi 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.

epi db make

Create a new database file at the given path.

Usage:

epi 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.

epi prisma

Commands related to Prisma ORM for epinterface.

Usage:

epi 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>.

epi prisma generate

Generate the prisma client for epinterface.

Usage:

epi prisma generate [OPTIONS]

Options:

  --help  Show this message and exit.

epi prisma partials-path

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

Usage:

epi prisma partials-path [OPTIONS]

Options:

  --help  Show this message and exit.

epi prisma schemapath

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

Usage:

epi prisma schemapath [OPTIONS]

Options:

  --help  Show this message and exit.