Connecting an Agent
Command reference
Every mapwright command, for whenever you want to look something up.
You won't need most of this. Once your AI assistant is connected (see getting started), it runs these commands on your behalf, you don't have to type them yourself. This page is here for whenever you're curious what it's actually doing, or want to try something directly.
Every command also works with a --json flag at the end, which prints the result in a format built for programs rather than people. You can safely ignore that unless you're scripting something yourself.
Getting connected
| Command | What it does |
|---|---|
mapwright auth login | Connects using a key from your account's API Keys page |
mapwright auth logout | Disconnects this device |
mapwright auth whoami | Shows which account you're connected as |
mapwright init --project "<name>" | Links the current folder to an existing project |
mapwright project create "<name>" | Creates a brand new project, with its starting map already in place, and links to it |
mapwright projects | Lists every project on your account |
mapwright status | Checks that everything is connected properly |
Working with the map
| Command | What it does |
|---|---|
mapwright map | Shows the full map as a tree |
mapwright search "<query>" | Finds anything on the map matching your search, including inside specs |
mapwright feature create "<title>" --category features | Adds a new card to the map, the same as clicking "+ Add Card" in the app |
mapwright feature update <card-id> --summary "..." | Updates an existing card's summary or notes |
Working with specs
| Command | What it does |
|---|---|
mapwright prd <feature-id> | Reads an existing spec for a feature |
mapwright prds | Lists every spec across the whole project |
mapwright prd sync <spec-id> --file <path> | Replaces a spec's content with an edited version from a file |
Generating a brand new spec isn't on this list on purpose. That's a browser-only action, explained in getting started.
Working with the task list
| Command | What it does |
|---|---|
mapwright tasks | Lists every task in the project, in build order |
mapwright task next | Shows the single next task to work on |
mapwright task update <task-id> --status in_progress | Updates a task's status, priority, or estimate |