Kitsune

How Teams Use Kitsune

Kitsune is release hygiene for teams: consistent versioning, better release notes, and safer repos.

• Keep versions in sync across Node/Dart/YAML
• Generate changelogs from git history
• Improve commit quality with local AI summaries (optional)
• Encourage signed commits and block common secrets before push (repo helpers)
• Publish release docs via GitHub Pages (docs folder)

0) Add Your API Key (PAK)

Kitsune requires an API key (PAK) to run most commands.

Get a 30-day trial key: https://app.kitsune-app.com

kitsune license set <PAK>

CI: export KITSUNE_API_KEY=<PAK>

1) Tag + Sync Versions

Run tagging from the repo root. Kitsune creates a semver tag and propagates the version into project files, then writes a machine-readable version file.

# tag HEAD (defaults to patch bump)
kitsune tag

# bump explicitly
kitsune tag patch
kitsune tag minor
kitsune tag major

Kitsune writes .kitsune/version.json for CI and tooling.

2) Generate a Changelog

Generate a full history changelog or a range between two refs.

# full history (first commit -> HEAD)
kitsune changelog

# range
kitsune changelog v1.2.0 HEAD

# write to a file
kitsune changelog --out CHANGELOG.md

3) Optional: AI Release Notes

Kitsune can summarize commit history into cleaner release notes. Local models run on developer machines; pricing is for workflow software and automation.

# list supported local models
kitsune ai models

# install a local GGUF model (recommended)
kitsune ai setup phi3-mini --url "https://huggingface.co/tensorblock/Phi-3-mini-4k-instruct-GGUF/resolve/main/Phi-3-mini-4k-instruct-Q3_K_M.gguf"

# summarize full history
kitsune ai summarize

# summarize a range
kitsune ai summarize --from v1.2.0 --to HEAD

Repo Safety Helpers (Optional)

These helpers are included in this repository source checkout and can be used to harden your workflow:

# install secret-blocking git hooks
./scripts/install-hooks.sh

# configure signed commits for this repo
./scripts/setup-signed-commits.sh

These are optional. Kitsune core versioning + changelog features work without them.

Publishing Release Docs

GitHub Pages can serve the docs/ folder. Kitsune is designed to generate versioned release artifacts you can host under paths like /versions/<version>/.

If you already use GitHub Pages, set Pages source to the docs/ folder.