Get started

Start with the local CLI preview. It reads the checkout's tags and conventional commits, writes evidence under .landmark/run/, and produces static release artifacts under docs/releases/.

Local CLI preview

cargo run --locked -p landmark -- run --provider local --repo-root .

This is the README's first-run command for a source checkout. It requires no GitHub token and no LLM provider key.

Executable quickstart oracle

cargo run --locked -p landmark -- replay-action --scenario first_run_local_preview

Use the replay when you want a repeatable check that the local preview path still works.

GitHub Action adoption

name: Release

on:
  workflow_run:
    workflows:
      - CI
    types:
      - completed
    branches:
      - main
      - master
  workflow_dispatch:

jobs:
  release:
    if: github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success'
    runs-on: ubuntu-latest
    permissions:
      contents: write
      issues: write
      pull-requests: write
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
          persist-credentials: false
      - uses: misty-step/landmark@v1
        with:
          github-token: ${{ secrets.GH_RELEASE_TOKEN }}
          llm-api-key: ${{ secrets.OPENROUTER_API_KEY }}

Full mode wraps semantic-release, then Landmark synthesizes and publishes the user-facing release body.

Agent surface

landmark describe --json

Agents should start with the self-description contract instead of scraping README prose.