Axon Shaft docs

Overview

What Axon Shaft does, what it posts on a pull request, and how a run goes.

Axon Shaft reviews pull requests with Claude. The review runs as a GitHub Action on your own runners, with your Claude token, and you manage its settings on the dashboard.

On each pull request it posts:

  • one summary comment, with the verdict, the findings and a chip for each check, which it edits on every push;
  • one review with an inline comment on each line it flags;
  • a check run for each checklist, such as Axon Shaft / security, which branch protection can require.

In a comment, /review starts a review, /ask answers a question about the code, and /fix makes a change and pushes it to the pull request.

How a run goes

  1. A pull request is opened or pushed to, or someone comments a command. GitHub starts the Axon Shaft workflow in the repo.
  2. The action asks the Axon Shaft API for its run, signing in with the job's OIDC token. The workflow holds no secrets.
  3. The API checks that the repo is a project, that the automation is on for this event, and that the pull request passes its filters. It answers with a GitHub token for this repo only, the Claude token, the settings and the review's checklists.
  4. The action checks out the pull request's head commit, runs the checklists' scripts, and runs Claude on the runner to read the change. The pull request's code is never run.
  5. The action posts the summary comment, the inline comments and the check runs, and sends the result to the run's page on the dashboard.

The code stays on the runner. The API gets the pull request's number, title, branch and author, and the review's result. The vulnerability lookups get only public package names and versions.

Where to start

Last updated on