1. Install

pipx install agents-shipgate

Requires Python 3.12+. If pipx is unavailable, use python -m pip install agents-shipgate.

2. Run the bundled fixture

agents-shipgate fixture run support_refund_agent

This writes agents-shipgate-reports/report.md and report.json for a known refund-support fixture with release-readiness findings.

3. Scan your repository

agents-shipgate init --workspace . --write
agents-shipgate scan -c shipgate.yaml

Replace any CHANGE_ME placeholders in shipgate.yaml before treating the report as release evidence.

4. Add advisory GitHub Actions CI

name: Agents Shipgate
on:
  pull_request:
permissions:
  contents: read
jobs:
  agents-shipgate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      - uses: ThreeMoonsLab/agents-shipgate@v0.8.0
        with:
          config: shipgate.yaml
          ci_mode: advisory

Or have your coding agent run this for you

Steps 2 through 4 above can be delegated to a coding agent that already has the workspace open. agents-shipgate publishes machine-readable entry points so Cursor, Claude Code, Codex, Aider, and Cline can discover the tool and follow the canonical flow without copy-pasting commands from this page.

Cursor

Drop the Cursor rule into your repository. It fires automatically when Cursor opens shipgate.yaml, OpenAPI / MCP / tools JSON, Codex plugin packages, GitHub Actions workflows, prompts, or policies — and the agent will recommend the right agents-shipgate commands with the right flags.

mkdir -p .cursor/rules
curl -fsSL https://raw.githubusercontent.com/ThreeMoonsLab/agents-shipgate/main/.cursor/rules/agents-shipgate.mdc \
  -o .cursor/rules/agents-shipgate.mdc

Claude Code

The /shipgate slash command runs the full bootstrap flow (install → init --write → scan → report) and reads agents-shipgate-reports/report.json directly, not the Markdown. It is not part of pipx install agents-shipgate, so drop the command file into your project first:

mkdir -p .claude/commands
curl -fsSL https://raw.githubusercontent.com/ThreeMoonsLab/agents-shipgate/main/.claude/commands/shipgate.md \
  -o .claude/commands/shipgate.md

Then in any Claude Code session inside the repo:

/shipgate

For projects that want auto-discovery on phrases like "fix shipgate finding" or "add release readiness to my agent", install the optional agents-shipgate skill as well — see docs/agents/use-with-claude-code.md.

Codex, Aider, Cline, and other coding agents

These agents discover Agents Shipgate via canonical entry points the repo publishes. Every link below resolves to raw, machine-fetchable content (not the GitHub HTML wrapper):

AGENTS.md — canonical agent-facing instructions (Markdown).
llms.txt — short index of every machine-readable surface (~3 KB).
llms-full.txt — long-form concatenation of AGENTS.md, recipes, checks, concepts, and autofix policy in one document.
/.well-known/agents-shipgate.json — discovery metadata served from this site at the canonical well-known location: tagline, install commands, schema URLs, gating signal, exit codes. Vendored from the agents-shipgate repo and pinned to the latest released tag, so the github_action pin is always a real released ref.

Point your coding agent at the workspace and ask it to run agents-shipgate. Set AGENTS_SHIPGATE_AGENT_MODE=1 first so CLI errors emit a structured next_action line on stderr.

Next up: bring a real agent. The design partner program gives early teams hands-on help mapping shipgate.yaml, interpreting the first Tool-Use Readiness Report, and rolling out advisory → strict CI.