Macroscope

https://docs.macroscope.com
Admin
Macroscope connects to your codebase and workflow tools to review code, answer questions, and take...
Tokens:72,520
Snippets:636
Trust Score:7.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Macroscope with curl

Source: https://docs.macroscope.com/cli

Installs macroscope, adds it to the shell PATH, installs the Macroscope plugin for supported local setups of Claude Code, Codex, Cursor, and OpenCode, and starts the setup wizard for signing in and choosing a workspace. Relaunch your agent after installation to use the Macroscope command.

```bash
curl -sSL https://raw.githubusercontent.com/prassoai/macroscope-local/main/install.sh | bash

```

--------------------------------

### Set MACROSCOPE_CREDENTIAL_STORE to file and run macroscope setup

Source: https://docs.macroscope.com/cli

Use on a Linux host without a credential service (server, SSH session, or container) to choose file-based storage up front or for non-interactive setup. The environment variable wins over the saved preference; only accepted values are keyring and file.

```bash
export MACROSCOPE_CREDENTIAL_STORE=file
macroscope setup

```

--------------------------------

### Install Macroscope CLI with curl

Source: https://docs.macroscope.com/setup-instructions

Install the Macroscope CLI locally to review changes before pushing from Claude Code, Codex, Cursor, or OpenCode. Run this command in your terminal after completing the initial setup steps.

```bash
curl -sSL https://raw.githubusercontent.com/prassoai/macroscope-local/main/install.sh | bash
```

--------------------------------

### Run Macroscope with no arguments

Source: https://docs.macroscope.com/cli

Run Macroscope with no arguments to start the guided terminal experience.

```bash
macroscope

```

--------------------------------

### Run macroscope to sign in or switch workspaces

Source: https://docs.macroscope.com/cli

Run the Macroscope CLI to complete setup or choose the correct workspace when you need to sign in again or switch workspaces.

```bash
macroscope
```

--------------------------------

### Agent configuration with input: incremental

Source: https://docs.macroscope.com/check-run-agents

Example agent configuration that sets input to incremental, includes only files under src/**, and uses a neutral conclusion. This is the default input mode when omitted.

```yaml
---
title: Security Review
input: incremental
conclusion: neutral
include:
  - "src/**"
---

```

--------------------------------

### Reinstall Macroscope with macroscope uninstall --reinstall

Source: https://docs.macroscope.com/cli

Wipe your local Macroscope install and start over by running this command.

```bash
macroscope uninstall --reinstall
```

--------------------------------

### Create a check-run agent with frontmatter configuration

Source: https://docs.macroscope.com/check-run-agents

Create a check-run agent by placing a .md file in .macroscope/check-run-agents/ with this frontmatter and instructions. All frontmatter fields are optional; the example shows a security review agent with a title, model, reasoning, effort, input mode, tools, include globs, conclusion, and budget limits. The instructions after the frontmatter define what the agent checks and how it formats output.

```markdown
---
title: Security Review          # Name in GitHub Checks UI (max 60 chars)
model: claude-opus-5-5          # See the Models & Pricing page
reasoning: low                  # off, low, medium, high, xhigh, max (per-model)
effort: low                     # low, medium, high
input: full_diff                # full_diff, incremental, code_object, or pr_metadata
tools:                          # Omit to use defaults
  - browse_code
  - git_tools
include:                        # Glob patterns for files to review
  - "src/**"
conclusion: neutral             # neutral (non-blocking) or failure (blocking)
maxRuns: 5                      # Max runs per PR (omit for no limit)
maxBudgetPerRun: 0.50           # Max spend per run in USD (omit for no limit)
maxBudgetPerPR: 2.00            # Max spend by this agent per PR (omit for no limit)
---

Your instructions here.

```

--------------------------------

### Response payload example

Source: https://docs.macroscope.com/api

Example response payload Macroscope POSTs to your Slack channel or URL when the agent finishes.

```json
{
  "query": "What were the main changes this week?",
  "response": "Here are the main changes...",
  "workflowId": "abc-123-def-456"
}

```

--------------------------------

### Run codereview with --base

Source: https://docs.macroscope.com/cli

Use the codereview command to review the current repository or a specified path. If --base is omitted, the comparison base is auto-detected.

```bash
macroscope codereview --base main
macroscope codereview /path/to/repo --base staging

```

--------------------------------

### Run codereview with --mode

Source: https://docs.macroscope.com/cli

Run a review in a specific Detection Mode. Accepted values are balanced, budget, precise, and ultra. An unrecognized value is rejected before the review starts. Choosing a mode requires Detection Modes to be enabled for your workspace.

```bash
macroscope codereview --mode precise

```

--------------------------------

### Deliver results to Slack

Source: https://docs.macroscope.com/api

Example curl request that delivers the agent's results to a Slack channel by specifying slackChannelId in responseDestination.

```bash
curl -X POST \
  "https://hooks.macroscope.com/api/v1/workspaces/{workspaceType}/{workspaceId}/query-agent-webhook-trigger" \
  -H "Content-Type: application/json" \
  -H "X-Webhook-Secret: your-api-key" \
  -d '{
    "query": "What were the main changes this week?",
    "responseDestination": { "slackChannelId": "C0123456789" },
    "timezone": "America/Los_Angeles"
  }'

```

--------------------------------

### Deliver results to a Slack thread

Source: https://docs.macroscope.com/api

Example curl request that delivers results to a specific Slack thread by including slackThreadTs in responseDestination.

```bash
curl -X POST \
  "https://hooks.macroscope.com/api/v1/workspaces/{workspaceType}/{workspaceId}/query-agent-webhook-trigger" \
  -H "Content-Type: application/json" \
  -H "X-Webhook-Secret: your-api-key" \
  -d '{
    "query": "Investigate this alert and respond in thread",
    "responseDestination": {
      "slackChannelId": "C0123456789",
      "slackThreadTs": "1234567890.123456"
    },
    "timezone": "America/Los_Angeles"
  }'

```

--------------------------------

### GET /v1/jobs/{jobId}

Source: https://docs.macroscope.com/api

Polls the status of a previously submitted query job. Returns the result when the job is finished, or indicates that it is still running.

```APIDOC
## GET /v1/jobs/{jobId}

### Description
Polls the status of a previously submitted query job. Returns the result when the job is finished, or indicates that it is still running.

### Method
GET

### Endpoint
/v1/jobs/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The ID of the job to poll.

### Response
#### Success Response (200)
- **status** (string) - `completed` or `failed`.

#### Success Response (202)
- **status** (string) - `running` - Still running; retry after the `Retry-After` interval.

#### Error Responses
- **401** - Missing or invalid job token.
- **403** - Job token expired, or doesn’t match this workspace.
- **404** - Job not found.

```

--------------------------------

### Web Review check run agent frontmatter and instructions

Source: https://docs.macroscope.com/check-run-agents

Example check run agent saved as `.macroscope/check-run-agents/web-review.md`. It consolidates web team rules (event tracking, accessibility, production errors, labels, notifications) into one agent with frontmatter specifying model, effort, input mode, tools, and include paths.

```markdown
---
title: Web Review
model: claude-opus-5-5
effort: medium
input: full_diff
tools:
  - browse_code
  - git_tools
  - modify_pr
  - slack
  - sentry
include:
  - "targets/app/**"
  - "web-etc/**"
---

Review this PR against our web team's standards:

## Event Tracking
If this PR touches payment flows, signup funnels, analytics calls,
CTA buttons, or redirect logic, check whether it could break event
tracking. Rate each issue: 🔴 will stop firing, 🟡 may fire incorrectly,
🟢 low risk.

## Accessibility
Check new or modified React components for basic accessibility:
- Images must have alt text
- Buttons and links must have accessible labels
- Form inputs must have associated labels

## Production Errors
For each file modified, check Sentry for unresolved issues. If any
active errors exist, list them with frequency and last seen date.

## Labels
Add labels to this PR based on what changed:
- "frontend" if any UI components are modified
- "styles" if CSS or styled-components changed
- "docs" if only markdown files changed

## Notifications
If any 🔴/🟡 event tracking issues or accessibility violations are
found, post a summary to #eng on Slack with the PR link.

If nothing noteworthy is found, report that all checks passed.

```
Tokens:
Raw