CLI (engineai)#

engineai dashboard#

Dashboard commands.

Usage:

engineai dashboard [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`-s`, `--slug`	text	Dashboard slug.	None
`--help`	boolean	Show this message and exit.	`False`

Subcommands

activate: Activate a dashboard manually or interactively.
init: Create a simple and functional dashboard.
ls: List all dashboards.
publish: Log in the user and publish a dashboard into Dashboard API.
versions: Dashboard versions subgroup commands.

engineai dashboard activate#

Activate a dashboard manually or interactively.

Usage:

engineai dashboard activate [OPTIONS]

Options:

Name	Type	Description	Default
`-v`, `--version`	text	Dashboard version.	None
`-r`, `--run`	text	Dashboard run.	None
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard init#

Create a simple and functional dashboard.

Usage:

engineai dashboard init [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard ls#

List all dashboards.

Usage:

engineai dashboard ls [OPTIONS]

Options:

Name	Type	Description	Default
`-a`, `--app-slug`	text	App where to look for dashboards.	None
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard publish#

Log in the user and publish a dashboard into Dashboard API.

Usage:

engineai dashboard publish [OPTIONS]

Options:

Name	Type	Description	Default
`-f`, `--filename`	text	Overwrite default Dashboard file directory.	`main.py`
`-u`, `--url`	text	URL of the EngineAI Platform API. Skipping option in the event you are using DASHBOARD_API_URL environment variable. Default: https://api.engineai.com	None
`--skip-data`	boolean	Skip the data processing and validation. Can only be used after the first complete run. It is useful to increase the dashboard performance.	`False`
`--skip-browser`	boolean	Skip the browser opening after the dashboard is published.	`False`
`--exception-type-detail`	choice (`basic` \| `full`)	If the dashboard raises a type error, and the message comes with triple dots, this flag expands to the full information.	`basic`
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard versions#

Dashboard versions subgroup commands.

Usage:

engineai dashboard versions [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`-v`, `--version`	text	Dashboard version.	None
`--help`	boolean	Show this message and exit.	`False`

Subcommands

ls: List all versions for a given dashboard slug.
runs: Dashboard runs subgroup commands.

engineai dashboard versions ls#

List all versions for a given dashboard slug.

Usage:

engineai dashboard versions ls [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard versions runs#

Dashboard runs subgroup commands.

Usage:

engineai dashboard versions runs [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

ls: List all runs for a given dashboard slug and version.

engineai dashboard versions runs ls#

List all runs for a given dashboard slug and version.

Usage:

engineai dashboard versions runs ls [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`