Monito CLI

project

Manage projects — list, create, update, delete, run tests, and discover scenarios.

project list

List all projects.

monito project list
monito project ls          # alias
monito project list --json

Displays: ID, Name, URL, Tag, Scenario count, Pass Rate, Last Run status.

project view

View project details.

monito project view <id>
monito project view <id> --json

project create

Create a new project.

monito project create \
  --name "My App" \
  --url "https://myapp.com" \
  --tag production \
  --description "Production app"
FlagRequiredDescription
--name <name>YesProject name
--url <url>YesProject URL
--tag <tag>NoEnvironment tag: development, staging, production, custom. Default: production
--description <desc>NoProject description
--jsonNoOutput as JSON

project update

Update an existing project.

monito project update <id> --name "New Name" --url "https://new-url.com"

All flags are optional — only provided values are updated.

FlagDescription
--name <name>Project name
--url <url>Project URL
--tag <tag>Environment tag
--description <desc>Project description
--jsonOutput as JSON

project delete

Delete a project. Requires --yes to confirm.

monito project delete <id> --yes

Without --yes, the CLI prints a confirmation message and exits.

project run

Run all test scenarios in a project.

monito project run <id>              # waits for completion
monito project run <id> --no-wait    # returns immediately
monito project run <id> --json

By default, the CLI polls until all runs complete and displays a results table. Exit code 1 if any run fails.

With --no-wait, the command returns immediately after triggering the runs and prints the run IDs.

For GitHub Actions results on the pull request:

monito project run <id> --wait --github-summary --github-check --github-comment
FlagBehavior
--github-summaryAppend the results table to the GitHub job summary.
--github-checkCreate an in-progress check named Monito on the head SHA, then complete it with counts and failing tests linked to evidence.
--github-commentCreate or update one failure comment identified by <!-- monito-qa -->. A later pass updates it to All N tests passed; a pass never creates a comment.

The check and comment flags require GitHub Actions, waiting (the default), and GITHUB_TOKEN. Set GITHUB_TOKEN: ${{ github.token }} and grant checks: write and pull-requests: write alongside existing workflow permissions. The generated monito ci blocking workflow includes these settings. With --no-wait, the flags warn and skip reporting.

The repository is read from GITHUB_REPOSITORY. The PR head SHA or deployment SHA is read from GITHUB_EVENT_PATH, falling back to GITHUB_SHA. The PR number is read from the event or pull ref; --pr <number> overrides it. For deployment events without PR context, supply --pr to enable comments.

Checks conclude success for all passes, failure for failing tests, or neutral when every non-passing test has execution status error. Failed or errored tests still produce CLI exit code 1. GitHub API failures only print warnings to stderr; they never change the exit code or JSON output.

project discover

Trigger AI discovery to find test scenarios for a project.

monito project discover <id>              # waits for completion
monito project discover <id> --no-wait    # returns immediately
monito project discover <id> --json

After discovery completes, the CLI shows draft scenarios and a command to accept them:

monito discovery accept <discovery-run-id> --all

On this page