Skip to content

Getting Started

Jump to bottom
github-actions[bot] edited this page Jun 29, 2026 · 8 revisions

Getting Started

Five minutes from zero to a markdown review in your browser.

Prerequisites

  • Spec Kit >= 0.2.0 initialized in your project. Verify with: 
    specify --version
ls .specify
  • A Spec Kit-aware assistant that can resolve slash commands.
  • Node.js available on your PATH. The review surface runs with node and has no install step.
  • A feature directory under specs/ with some markdown to review (at least a spec.md).
  • A browser and an internet connection. The renderer loads from a pinned CDN, so the pages need internet; offline, the surface shows a notice.

If you do not have a Spec Kit project yet:

specify init my-project
cd my-project

Step 1: Install the extension

The recommended install resolves a release directly from the download URL. This needs no catalog setup and always works:

specify extension add axi --from \
  https://github.com/d0whc3r/spec-kit-axi/releases/download/v1.1.1/axi-1.1.1.zip

Change the version in the URL to pin a different release.

Prefer to install and update by name with specify extension add axi? That resolves the extension from Spec Kit's community catalog, which ships as discovery only (install_allowed: false). Approve it once:

specify extension catalog add \
  https://raw.githubusercontent.com/github/spec-kit/main/extensions/catalog.community.json \
  --name community --install-allowed
specify extension add axi

See Troubleshooting for the full explanation of the community catalog error.

Confirm install:

cat .specify/extensions/.registry        # 'axi' entry should be present
ls .specify/extensions/axi               # extension files present

Step 2: Have a feature to review

The command reviews whatever markdown a feature directory already holds. If you do not have one yet, create it with the Spec Kit core commands first:

/speckit.specify
/speckit.plan

Any .md under the feature directory is fair game: spec.md, plan.md, tasks.md, and nested files such as contracts/.

Step 3: Open the review surface

Run the command in your assistant. Name the feature directory, or let the agent resolve it from your branch:

/speckit.axi.review specs/001-my-feature

The agent starts a local review server bound to 127.0.0.1, opens your browser, and tells you the surface is ready. Each markdown file shows up as a tab, rendered with tables and mermaid diagrams.

Step 4: Annotate and send

In the browser:

  1. Select any phrase to attach a note. Axi records the file, the nearest heading, and the exact text you picked, so the agent edits the right spot.
  2. Or type a general comment in the composer for feedback that spans documents.
  3. Notes collect in the Notes panel. Edit or remove any before sending.
  4. Click Send. The whole queue goes to the agent.

The agent edits the canonical .md files, posts a one-line summary of what changed, and the document live-reloads in place. Keep reviewing for as many rounds as you need.

Step 5: Finish

End the session from the browser when you are done, or ask the agent to stop. The agent shuts the local server down. Your markdown is updated in place; nothing else is touched.

Targeting a specific feature

Pass the directory as the command argument:

/speckit.axi.review specs/002-some-other-feature

Without an argument the agent picks the directory from your git branch, the one specs/* directory if there is exactly one, or the most recently modified specs/* directory. If it is still unclear, it asks.

What next

  • Read Commands for the full reference of the command and the review server it drives.
  • Read Workflow to see the review loop end to end.
  • Read Examples for a worked session.
  • When something refuses to run, jump to Troubleshooting.

Axi Extension · Spec Kit · MIT License

Axi Extension

Clone this wiki locally