npm install -g kontrua

npm install -D kontrua

export KONTRUA_TOKEN=<your repo API token>
kontrua context pull                # write artifacts into the current directory
kontrua context pull --dry-run      # preview without writing
kontrua context pull --include-docs # also pull the human documents

{
  "mcpServers": {
    "kontrua": {
      "type": "http",
      "url": "https://kontrua.com/api/mcp",
      "headers": { "Authorization": "Bearer <your repo API token>" }
    }
  }
}

# Kontrua - local configuration.
#
# The verdict (the deterministic audit of supported command and path
# references in selected context files) runs on the server at connect, push and pull request.
# It is free, unlimited, involves no model, and reads nothing from this file.
#
# This file drives the local correction lane only: "kontrua update" reads it,
# calls the Anthropic API with your own key, and generates enabled missing
# outputs or regenerates delegated outputs in your working tree. Existing
# README files are not regenerated. It does not run the web targeted-edit flow.

version: 1

ai:
  model: claude-sonnet-4-6
  # apiKey: ${ANTHROPIC_API_KEY}  # or set ANTHROPIC_API_KEY env var

# The context layer: machine-first artifacts for AI coding agents.
# These values are the defaults; they are written out so the file says what
# the run will actually do.
context:
  agentsMd:
    enabled: true
    output: AGENTS.md
  conventions:
    enabled: true
    output: docs/CONVENTIONS.md
  # Off by default: a repository overview is the one artifact class measured
  # not to help an agent, so it does not cost every user tokens.
  codemap:
    enabled: false
    output: docs/CODEMAP.md
  # Off by default until a consumer (MCP, CLI) needs the JSON.
  architectureFacts:
    enabled: false
    output: docs/architecture.facts.json

docs:
  readme:
    enabled: true
    output: README.md

  # Generation of an API reference is retired: the pipeline refuses it at plan
  # time, so turning this on buys a skip line and nothing else. An existing
  # docs/API.md is still audited like every other document, and the globs below
  # keep their other job - they define what counts as a source file, which is
  # how the run decides whether your conventions need regenerating.
  api:
    enabled: false
    output: docs/API.md
    include:
      - "src/**/*.ts"
      - "src/**/*.js"

  architecture:
    enabled: true
    output: docs/ARCHITECTURE.md

  changelog:
    enabled: true
    output: CHANGELOG.md
    format: keepachangelog  # or: conventional

output:
  mode: file-only  # file-only | commit | pr
  commitMessage: "docs: auto-update documentation"
  prBranch: docs/auto-update

exclude:
  - "node_modules/**"
  - "dist/**"
  - "**/*.test.ts"
  - "**/*.spec.ts"