Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.macroscope.com/llms.txt

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

​
Install

curl -sSL https://raw.githubusercontent.com/prassoai/macroscope-local/main/install.sh | bash
The installer:
  • Installs macroscope
  • Adds it to your shell PATH
  • Installs the Macroscope plugin for supported local setups of Claude Code, Codex, Cursor, and OpenCode
  • Starts the setup wizard so you can sign in and choose a workspace
If your agent was already open, relaunch it after installation so the Macroscope command appears.

​
Start a Local Review

Use the Macroscope plugin from inside your coding tool: 
Claude Code: /macroscope:codereview
Codex:       /macroscope:codereview
Cursor:      /codereview
OpenCode:    /macroscope-codereview
This is the main local review flow. Your agent will:
  • start a Macroscope review on the current branch
  • watch for findings as they arrive
  • explain each issue in plain language
  • validate whether the issue is real
  • ignore false positives
  • fix confirmed issues one at a time
  • verify the fix and report what it addressed
You can either invoke the command directly or simply ask your agent to use Macroscope on the current branch.

​
Run the Autopilot Loop

If you want a more hands-off pass, use the loop variant: 
Claude Code: /macroscope:autoloop
Codex:       /macroscope:autoloop
Cursor:      /autoloop
OpenCode:    /macroscope-autoloop
Loop mode runs a local-only review-and-fix cycle. Your agent reviews the branch, fixes confirmed issues directly in your working tree, commits the fixes, then re-reviews to catch regressions — up to five iterations or until a clean pass. Loop mode is entirely local. It does not interact with GitHub, open PRs, or wait for remote checks. Use it when you want Macroscope to keep driving instead of stopping after a single review pass.

​
Direct CLI Review

If you prefer to work from the terminal, you can run Macroscope directly: 
macroscope codereview
To compare your branch against a specific base branch: 
macroscope codereview --base <base-branch>
This path is useful when you want to run the review yourself, script around it, or debug outside your editor. For most users, the plugin command is the better default because it gives your agent the full review-and-fix workflow.

​
Isolated Worktree Mode

By default, macroscope codereview runs in an isolated git worktree. Macroscope captures your uncommitted work-in-progress as the review baseline, so you can run reviews without committing or stashing. If there are no diffs to review, the CLI returns an actionable error rather than failing silently.

​
Typical Workflow

  1. Install Macroscope and complete setup.
  2. Open your repo in Claude Code, Codex, Cursor, or OpenCode.
  3. Run the Macroscope command for your host.
  4. Let your agent work through findings locally before you push.
  5. Use loop mode when you want a longer unattended pass.

​
Troubleshooting

IssueWhat to do
command not found: macroscopeRestart your terminal, then check that ~/.local/bin is on your PATH
The Macroscope command does not appear in your agentRelaunch the agent after installation
You need to sign in againRun macroscope and complete setup
You need to switch workspacesRun macroscope and choose the correct workspace
You want to review from the terminal insteadRun macroscope codereview
If you want to completely wipe your local Macroscope install and start over, use the reset script from the macroscope-local repo and reinstall.