Project commands
Find your workspaces, projects and apps, and the environments where they run.
These commands find the workspaces, projects and apps your sign-in can reach. An environment is where an app runs, such as production or staging. You pass these identifiers to other commands as --workspace, --project, --app and --environment. init saves the workspace, project and app for a repository. These commands only read.
rehearsal workspaces list Link to rehearsal workspaces list
List the workspaces this sign-in can reach.
Newest first, and only the workspaces this sign-in may do something in. Pass an ID from this list as --workspace.
rehearsal workspaces list [flags]| Flag | Description |
|---|---|
--limit <count> | How many to return, 1 to 100. The default is 20. |
--cursor <cursor> | Continue from the cursor the last page returned. |
Needs a sign-in with the testing:read scope.
# List workspacesrehearsal workspaces list# Read them in a scriptrehearsal workspaces list --jsonrehearsal workspaces show Link to rehearsal workspaces show
Show one workspace and what you may do in it.
rehearsal workspaces show [workspace-id] [flags]| Argument | Description |
|---|---|
[workspace-id] | The workspace to read. Defaults to the selected one. |
| Flag | Description |
|---|---|
--workspace <workspace-id> | Workspace ID. Defaults to REHEARSAL_WORKSPACE_ID or rehearsal.config.json. |
Needs a sign-in with the testing:read scope and permission to read projects.
# Show the selected workspacerehearsal workspaces show# Show one by identifierrehearsal workspaces show <workspace-id> --jsonrehearsal projects list Link to rehearsal projects list
List the projects in the selected workspace.
Newest first. Pass an ID from this list as --project.
rehearsal projects list [flags]| Flag | Description |
|---|---|
--limit <count> | How many to return, 1 to 100. The default is 20. |
--cursor <cursor> | Continue from the cursor the last page returned. |
--workspace <workspace-id> | Workspace ID. Defaults to REHEARSAL_WORKSPACE_ID or rehearsal.config.json. |
Needs a sign-in with the testing:read scope and permission to read projects.
# List projectsrehearsal projects list --workspace <workspace-id># Read them in a scriptrehearsal projects list --workspace <workspace-id> --jsonrehearsal projects show Link to rehearsal projects show
Show one project with how much is in it.
rehearsal projects show [project-id] [flags]| Argument | Description |
|---|---|
[project-id] | The project to read. Defaults to the selected one. |
| Flag | Description |
|---|---|
--workspace <workspace-id> | Workspace ID. Defaults to REHEARSAL_WORKSPACE_ID or rehearsal.config.json. |
--project <project> | Project ID, slug or name. Defaults to REHEARSAL_PROJECT_ID or rehearsal.config.json. |
Needs a sign-in with the testing:read scope and permission to read projects.
# Show the selected projectrehearsal projects show# Show one by identifierrehearsal projects show <project-id> --jsonrehearsal apps list Link to rehearsal apps list
List the apps in the selected project.
Oldest first, the order they were added in. Each app is a web app, a desktop app, an iPhone app or an Android app. Two apps of different platforms may share a name; add --platform where you name one by --app.
rehearsal apps list [flags]| Flag | Description |
|---|---|
--limit <count> | How many to return, 1 to 100. The default is 20. |
--cursor <cursor> | Continue from the cursor the last page returned. |
--workspace <workspace-id> | Workspace ID. Defaults to REHEARSAL_WORKSPACE_ID or rehearsal.config.json. |
--project <project> | Project ID, slug or name. Defaults to REHEARSAL_PROJECT_ID or rehearsal.config.json. |
Needs a sign-in with the testing:read scope and permission to read projects.
# List appsrehearsal apps list# List them in another projectrehearsal apps list --project <project-id> --jsonrehearsal apps show Link to rehearsal apps show
Show one app, its platform and how many environments it has.
rehearsal apps show [app-id] [flags]| Argument | Description |
|---|---|
[app-id] | The app to read. Defaults to the selected one. |
| Flag | Description |
|---|---|
--workspace <workspace-id> | Workspace ID. Defaults to REHEARSAL_WORKSPACE_ID or rehearsal.config.json. |
--project <project> | Project ID, slug or name. Defaults to REHEARSAL_PROJECT_ID or rehearsal.config.json. |
--app <app> | App ID, name or the host of one of its environments. Defaults to REHEARSAL_APP_ID or rehearsal.config.json. |
--platform <platform> | With --app, which kind of app: web, electron, ios or android. Needed only when two apps share a name. |
Needs a sign-in with the testing:read scope and permission to read projects.
# Show the selected apprehearsal apps show# Show one by identifierrehearsal apps show <app-id> --jsonrehearsal environments list Link to rehearsal environments list
List the environments tests can run on.
Oldest first. A local environment names the computer it is connected from. To see whether that connection is up now, run rehearsal connect list there.
rehearsal environments list [flags]| Flag | Description |
|---|---|
--kind <kind> | Only environments of this kind. One of production, preview, staging or local. |
--limit <count> | How many to return, 1 to 100. The default is 20. |
--cursor <cursor> | Continue from the cursor the last page returned. |
--workspace <workspace-id> | Workspace ID. Defaults to REHEARSAL_WORKSPACE_ID or rehearsal.config.json. |
--project <project> | Project ID, slug or name. Defaults to REHEARSAL_PROJECT_ID or rehearsal.config.json. |
--app <app> | App ID, name or the host of one of its environments. Defaults to REHEARSAL_APP_ID or rehearsal.config.json. |
--platform <platform> | With --app, which kind of app: web, electron, ios or android. Needed only when two apps share a name. |
Needs a sign-in with the testing:read scope and permission to read projects.
# List every environmentrehearsal environments list# List one app's local environmentsrehearsal environments list --app <app-id> --kind local --jsonrehearsal environments show Link to rehearsal environments show
Show one environment.
rehearsal environments show [environment] [flags]| Argument | Description |
|---|---|
[environment] | The environment to read: its ID, a kind such as staging, or a computer name. Left out, it asks which. |
| Flag | Description |
|---|---|
--workspace <workspace-id> | Workspace ID. Defaults to REHEARSAL_WORKSPACE_ID or rehearsal.config.json. |
--project <project> | Project ID, slug or name. Defaults to REHEARSAL_PROJECT_ID or rehearsal.config.json. |
Needs a sign-in with the testing:read scope and permission to read projects.
# Pick an environment to showrehearsal environments show# Read one in a scriptrehearsal environments show staging --json