Skip to content
Download

DOCS

For contributors

Birch’s developer documentation lives in the repository, not on this site. This page is the pointer: the three commands you need, and links to the in-repo guides for architecture, release process, and the roadmap.

You need the .NET 10 SDK (global.json pins 10.0.101, rolling forward to the latest feature band). Then:

terminal
# Build
dotnet build Birch.sln
# Run all tests
dotnet test Birch.sln
# Run the app
dotnet run --project src/Birch.App

Run dotnet tool restore once per checkout before using the pinned dotnet-ef or vpk tools. CI builds and tests on Windows + macOS but is manual-only — run the test suite locally before submitting changes.

  • CLAUDE.md — the architecture and developer guide: layer rules, key services, patterns, and gotchas. Also AGENTS.md.
  • docs/RELEASE.md — the release and rollback process (releases are cut from v*.*.* tags).
  • docs/ROADMAP.md — the live backlog.

Bugs and feature requests go to the issue tracker.

PathWhat it is
src/Birch.AppThe Avalonia desktop app (Views, ViewModels)
src/Birch.CliThe birch command-line tool
src/Birch.ApplicationUse-case services shared by the UI and the CLI
src/Birch.GitGit operations (CLI-based engine)
src/Birch.IntegrationsGitHub / GitLab / Azure DevOps / Jira / Linear / YouTrack providers + the Anthropic AI adapter
src/Birch.PersistenceEF Core + SQLite storage and migrations
integrations/claude-code-pluginThe birch-status plugin for Claude Code
plugins/birch-statusThe birch-status plugin for Codex
tests/xUnit test projects (Application, Git, Integrations, App headless UI, Cli)

The docs site sources live under docs-site/ in the same repository (currently on the claude/app-documentation-structure-x6f7nm branch — the directory has not landed on main yet):

To add a page: create it under docs-site/content/, register it in the navigation per STRUCTURE.md, and follow the rules in CONVENTIONS.md.