Create Workspace, App, and Dashboard via CLI#

In this section, we will guide you through the process of setting up your workspace, app, and dashboard using the Engine AI SDK CLI.

Tip

You can also create the workspace, app and dashboard directly from the Management Portal.

Run the command below to create your workspace:

engineai workspace create <workspace-slug> <workspace-name>

For example:

engineai workspace create my-workspace 'My Workspace'

This will create a new workspace with slug my-workspace and name My Workspace.

Slugs and names are unique

The workspace slug and name must each be unique across the entire platform.

Next, create an app within your workspace:

engineai app create <workspace-slug> <app-slug> <app-name>

For example:

engineai app create my-workspace my-app "My App"

This command creates a new app with slug my-app and name My App under the workspace my-workspace.

Finally, create the dashboard:

engineai dashboard create <workspace-slug> <app-slug> <dashboard-slug> <dashboard-name>

For example:

engineai dashboard create my-workspace my-app first-dashboard "My First Dashboard"

This command creates a new dashboard with slug first-dashboard and name My First Dashboard under the app my-app and workspace my-workspace.

As a final verification, list the dashboards within your app to ensure your new dashboard is present:

engineai dashboard ls <workspace-slug> <app-slug>

Replace <workspace-slug> and <app-slug> with your actual workspace and app slugs. For example:

engineai dashboard ls my-workspace my-app

Head over to the Your First Dashboard section to create your first dashboard using the Engine AI SDK.