Documentation Index
Fetch the complete documentation index at: https://docs.getmonocle.sh/llms.txt
Use this file to discover all available pages before exploring further.
These commands are used by agents — via installed skills, MCP tools, or directly from the command line — to communicate with a running monocle session.
When registered in MCP tools mode, agents call these operations as MCP tools (review_status, get_feedback, send_artifact, add_files) instead of CLI commands. The behavior is identical — the MCP server connects to the same Unix socket internally.
When registered in skills mode, agents invoke the corresponding CLI commands below.
When the agent’s working directory differs from monocle’s, use --workdir (-C) to point commands at the correct repository. Alternatively, set MONOCLE_SOCKET or MONOCLE_WORKDIR to achieve the same effect via environment variables. Without one of these, commands look for a socket based on the current directory and may not find a running session. Press I in the monocle TUI to see the active socket path.
monocle review status
Check the current review status of the running monocle session.
monocle review status [--json] [--workdir PATH] [--socket PATH]
Flags
| Flag | Short | Description |
|---|
--json | | Output the result as structured JSON instead of plain text. |
--workdir PATH | -C | Override the working directory. Also reads from MONOCLE_WORKDIR. |
--socket PATH | | Override the Unix socket path. Also reads from MONOCLE_SOCKET. |
Output
Without --json, prints a status string or summary. The status reflects whether feedback is pending, a pause has been requested, or the session is idle.
In MCP tools mode, call the review_status tool with no parameters.
monocle review get-feedback
Retrieve pending review feedback from the queue.
monocle review get-feedback [--wait] [--json] [--workdir PATH] [--socket PATH]
--wait, the command returns immediately. If no feedback is pending it prints No feedback pending. and exits.
Flags
| Flag | Short | Description |
|---|
--wait | | Block until feedback is available. The command does not return until the reviewer submits a review. Used by the /review-plan-wait skill. |
--json | | Output the result as structured JSON. |
--workdir PATH | -C | Override the working directory. Also reads from MONOCLE_WORKDIR. |
--socket PATH | | Override the Unix socket path. Also reads from MONOCLE_SOCKET. |
get_feedback tool:
| Parameter | Type | Required | Description |
|---|
wait | boolean | No | When true, blocks until feedback is available. |
monocle review send-artifact
Send content to the reviewer — a plan, architecture document, summary, or any other text — so it appears in the monocle sidebar alongside file diffs.
monocle review send-artifact --title TEXT [--file PATH] [--id ID] [--type EXT] [--wait] [--json] [--workdir PATH] [--socket PATH]
--id, monocle updates the existing entry and shows a diff between the old and new versions.
When --file is not provided, the command reads content from stdin.
Flags
| Flag | Short | Description |
|---|
--title TEXT | | (Required) Title displayed in the monocle sidebar. |
--file PATH | | Path to the file to submit. When omitted, reads from stdin. |
--id ID | | Identifier for the artifact. Use the same ID on subsequent calls to update the content in place. Defaults to the filename when --file is used. |
--type EXT | | File extension used for syntax highlighting (e.g. md, go, py, ts). |
--wait | | Block until the reviewer responds with feedback. Used by the /review-plan-wait skill. |
--json | | Output the result as structured JSON. |
--workdir PATH | -C | Override the working directory. Also reads from MONOCLE_WORKDIR. |
--socket PATH | | Override the Unix socket path. Also reads from MONOCLE_SOCKET. |
Reading from stdin
echo "## Plan\n- Step 1\n- Step 2" | monocle review send-artifact --title "My plan" --type md
Reading from a file
monocle review send-artifact --title "Architecture" --file docs/architecture.md --id architecture.md
send_artifact tool accepts these parameters:
| Parameter | Type | Required | Description |
|---|
id | string | No | Identifier for the artifact. Use the same ID on subsequent calls to update the content in place. Defaults to the filename when file_path is provided. |
title | string | Yes | Title displayed in the monocle sidebar. |
content | string | No | The artifact content. Either content or file_path must be provided. |
file_path | string | No | Absolute path to a file to read as the artifact content. If id is empty, defaults to the filename. |
content_type | string | No | File extension for syntax highlighting (e.g. md, go, py). |
monocle review add-files
Add one or more files or directories to the current review session so they appear in the monocle diff viewer.
monocle review add-files <paths...> [--json] [--workdir PATH] [--socket PATH]
Arguments
| Argument | Description |
|---|
paths | (Required) One or more file or directory paths to add. Paths are resolved to absolute paths before being sent to monocle. |
Flags
| Flag | Short | Description |
|---|
--json | | Output the result as structured JSON. |
--workdir PATH | -C | Override the working directory. Also reads from MONOCLE_WORKDIR. |
--socket PATH | | Override the Unix socket path. Also reads from MONOCLE_SOCKET. |
add_files tool:
| Parameter | Type | Required | Description |
|---|
paths | string array | Yes | File or directory paths to add to the session. |
Example
monocle review add-files src/feature.go tests/