← Reference

AI agent context

Help your AI coding agent understand gittan.

Add gittan context to your project so AI agents (Claude Code, Cursor, Copilot, etc.) understand how gittan works — no PRs, gated commits, trunk-based development, the CLI, pipelines.

Append to your CLAUDE.md

curl -fsSL https://gittan.eu/claude.md >> CLAUDE.md

What's included

The file covers everything an AI agent needs to work effectively with gittan:

  • Core model — organizations, teams, repositories
  • Gated commits — no PRs, push to main, pipeline is the gate
  • Pipeline output — feedback streams during git push
  • CLI commands — auth, repos, teams, secrets, pipelines
  • Pipeline YAML — .gittan.yaml configuration
  • Secrets management — org/team/repo scopes
  • Common tasks — push, create repos, manage secrets
  • Anti-patterns — what agents should avoid (branches, PRs, GitHub assumptions)

Why this matters

AI coding agents default to GitHub/GitLab workflows — they'll try to create branches, open PRs, and use platform-specific commands. The context file teaches them that gittan works differently: push to main, read pipeline output, fix and push again.

Without it, agents waste time on workflows that don't exist in gittan. With it, they push code correctly, read pipeline failures, and use the CLI.

All agents

The file is plain markdown — same content works everywhere. Download it once and append to the right file for your agent:

AgentFile
Claude CodeCLAUDE.md
Cursor.cursorrules
Windsurf.windsurfrules
GitHub Copilot.github/copilot-instructions.md
OpenAI CodexAGENTS.md
Cline.clinerules
curl -fsSL https://gittan.eu/claude.md >> CLAUDE.md      # Claude Code
curl -fsSL https://gittan.eu/claude.md >> .cursorrules    # Cursor
curl -fsSL https://gittan.eu/claude.md >> .windsurfrules  # Windsurf
curl -fsSL https://gittan.eu/claude.md >> .github/copilot-instructions.md  # Copilot
curl -fsSL https://gittan.eu/claude.md >> AGENTS.md       # Codex
curl -fsSL https://gittan.eu/claude.md >> .clinerules     # Cline