Skip to main content

Documentation Index

Fetch the complete documentation index at: https://momentic.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

The momentic CLI is the entry point for web testing. Install it as a dev dependency, then invoke commands via npx momentic <command>.

Install

npm install --save-dev momentic
Every command assumes your project has a momentic.config.yaml at the root. Run init to create one.

Commands

init

Scaffold a new Momentic project.

app

Open the local editor.

run

Run tests locally and optionally upload results.

results

Upload, merge, and view local test results.

list

List tests matching a pattern.

queue

Queue a run on Momentic infrastructure (deprecated).

lint

Validate v2 test and module YAML files.

check

Detect duplicate IDs and validate momentic.config.yaml.

import

Import tests from the Momentic dashboard.

apply

Apply patch changes to local tests.

quarantine

Quarantine or unquarantine tests.

ai

AI-assisted classification and authoring.

mcp

Start the MCP server for coding agents.

install-browsers

Install or update headless browsers.

install-skills

Install Momentic skills for editors (deprecated).

Global flags

These flags are accepted by every command that talks to the Momentic API or loads a project. Per-command pages document any other flags they accept.
--api-key <key>
string
Momentic API key. Defaults to the value in ~/.momentic/auth.json. Env: MOMENTIC_API_KEY.
--server <server>
string
Momentic server URL. Defaults to https://api.momentic.ai. Env: MOMENTIC_SERVER.
-c, --config <configPath>
string
Absolute or relative path to a Momentic configuration file. Defaults to momentic.config.yaml in the current directory.
-f, --filter <filter>
string
When using workspaces, load the project whose name matches the filter. Substring matches are allowed.
-y, --yes
boolean
Skip all confirmation prompts. Enabled by default when CI is set.
--verbose
boolean
Enable verbose logging to stderr.

Environment variables

VariablePurpose
MOMENTIC_API_KEYAuth token. Required for any command that talks to the dashboard.
MOMENTIC_SERVEROverride the API host.
See Environment variables for the full list.