Axon Shaft docs

Settings reference

Every review setting and Code review option: its type, default, allowed values and who can change it.

Review settings

An account sets these for all its projects, and a project can set its own. A run uses the project's value, else the account's, else the default. Rules are the exception: the account's and the project's are added together. Clearing a value goes back to the account's or the default.

The same fields as a JSON schema: /docs/schema/settings.json.

model

The Claude model a run uses. auto picks one by the size of the change, a family name takes its newest model, or give a full model ID.

  • Type: String
  • Default: auto
  • Allowed: Matches ^(auto|opus|sonnet|haiku|claude-[a-z0-9.-]+)$, up to 100 characters
  • Set on: The account, or a project
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

effort

How hard the model thinks. auto picks by the size of the change.

  • Type: One of
  • Default: auto
  • Allowed: auto, low, medium, high, xhigh, max
  • Set on: The account, or a project
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

rules

The repo's own review rules, in plain words. A project's rules are added after the account's.

  • Type: String
  • Default: None
  • Allowed: Up to 10,000 characters
  • Set on: The account, or a project
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

skip

Globs of files the review leaves out.

  • Type: List of strings
  • Default: **/*.lock, **/package-lock.json, **/pnpm-lock.yaml, **/dist/**, **/*.min.js, **/*.snap
  • Allowed: Up to 100, each up to 500 characters
  • Set on: The account, or a project
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

focus

Globs of files the review looks at most closely.

  • Type: List of strings
  • Default: None
  • Allowed: Up to 100, each up to 500 characters
  • Set on: The account, or a project
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

pushMode

Where /fix and /axonshaft may push: disabled nowhere, restricted only to the pull request's own branch, enabled any branch but the default one.

  • Type: One of
  • Default: restricted
  • Allowed: disabled, restricted, enabled
  • Set on: The account, or a project
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

env

Names of the runner's environment variables the model gets on top of its own short list.

  • Type: List of strings
  • Default: None
  • Allowed: Up to 50, each Matches ^(?!ACTIONS_|INPUT_|ANTHROPIC_|CLAUDE_|GITHUB_TOKEN$)[A-Za-z_][A-Za-z0-9_]{0,99}$
  • Set on: The account, or a project
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

gates

Merge gates: plain-language requirements, such as "A migration has a rollback". Each review reports each gate, and the Axon Shaft / gates check fails when one isn't met. A project's own list replaces the account's, and an empty one turns the account's off.

  • Type: List of strings
  • Default: None
  • Allowed: Up to 10, each up to 200 characters
  • Set on: The account, or a project
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

monthlyCap

The most a month's runs may cost, in whole US dollars. Only runs on an API key count. Once it's reached, runs end with the spending_cap notice until the 1st (UTC). Empty means no cap.

  • Type: One of
  • Default: None
  • Allowed: undefined, undefined
  • Set on: The account, or a project
  • Who can change it: The account's admin

advisories

Which repos' blocking security findings go into a private draft security advisory instead of the public comment: off, public repos, or all repos.

  • Type: One of
  • Default: public
  • Allowed: off, public, all
  • Set on: The account, or a project
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

maxTurns

The most turns a review may take before it stops.

  • Type: One of
  • Default: 30
  • Allowed: undefined, undefined
  • Set on: The account only
  • Who can change it: The account's admin

timeLimit

The most minutes a run may take before it stops.

  • Type: One of
  • Default: 15
  • Allowed: undefined, undefined
  • Set on: The account only
  • Who can change it: The account's admin

Code review options

Each project's Code review automation has these, under When it runs, What it looks for and What it posts.

on

When it runs. The pull request events that start a review.

  • Type: Any of the choices
  • Default: opened, push, ready
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo
ValueIn the dashboardWhat it does
openedPull request openedReviews each pull request when it is opened.
pushEvery pushReviews again each time new commits are pushed to the pull request.
readyReady for reviewReviews a draft pull request when it is marked ready for review.

depth

Depth. How far it reads beyond the diff.

  • Type: One of the choices
  • Default: standard
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo
ValueIn the dashboardWhat it does
standardStandardThe diff and the code it touches.
deepDeepReads further. Slower, and uses more of your Claude plan.

nits

Small suggestions. Where minor style points go.

  • Type: One of the choices
  • Default: summary
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo
ValueIn the dashboardWhat it does
summaryIn the summaryLists small style points in the summary comment.
inlineAs inline commentsPosts each small style point as a comment on its line.
offDon't post themLeaves small style points out of the review.

walkthrough

Walkthrough in the summary. A folded table in the summary comment of the changed files by area, with a flow diagram when the pull request changes how its parts call each other.

  • Type: One of the choices
  • Default: on
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo
ValueIn the dashboardWhat it does
onOnAdds the walkthrough to a pull request that changes three or more files.
offOffLeaves it out.

forks

Pull requests from forks. Whether a pull request from a fork of the repo is reviewed without a maintainer asking.

  • Type: One of the choices
  • Default: auto
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo
ValueIn the dashboardWhat it does
autoReview automaticallyReviews it like any other pull request.
askAsk a maintainer firstComments on the pull request that someone with write access can start the review with /review.
mentionOnly when a maintainer comments /reviewPosts nothing, and reviews it once someone with write access comments /review.

outside

Pull requests from outside contributors. Pull requests from people who aren't owners, members or collaborators of the repo and can't push to it.

  • Type: One of the choices
  • Default: skip
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo
ValueIn the dashboardWhat it does
skipDon't review themSomeone with write access can still start a review by commenting /review.
reviewReview themReviews them like any other pull request.

bots

Pull requests opened by bots. Pull requests from accounts such as Dependabot and Renovate.

  • Type: One of the choices
  • Default: skip
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo
ValueIn the dashboardWhat it does
skipDon't review themSomeone with write access can still start a review by commenting /review.
reviewReview themReviews them like any other pull request.

own

Axon Shaft's own pull requests. Pull requests that Axon Shaft opened, such as the one that adds its workflow.

  • Type: One of the choices
  • Default: skip
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo
ValueIn the dashboardWhat it does
skipDon't review themSomeone with write access can still start a review by commenting /review.
reviewReview themReviews them like any other pull request.

branches

Target branches. Reviews only pull requests into these branches. A * matches any text between slashes, as in release/*. Leave it empty to review pull requests into any branch.

  • Type: A list of your own values
  • Default: None
  • When empty: Any branch
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

labels

Skip pull requests with these labels. Skips a pull request that has any of these labels, whatever their case. Someone with write access can still start a review by commenting /review. Leave it empty to review pull requests with any labels.

  • Type: A list of your own values
  • Default: skip-review, no-review, skip-ai-review, do-not-review
  • When empty: No labels
  • Who can change it: The account's admin, or someone with the Admin or Maintain role on the repo

Last updated on