Skip to Content

AlignTrue

Instantly sync rules across agents, people, projects and teams. Start in 60 seconds.

Write rules once in markdown. Sync everywhere. Stay aligned.

  • Solo developers: Keep your personal AI rules consistent across projects and machines.
  • Teams: Shared rule sets with version control, CI validation, and drift detection.

npm version Tests License: MIT

Why AlignTrue

  • Write once, sync everywhere - One markdown file generates agent-specific formats for 28+ AI coding tools
  • 60-second setup - Auto-detects your agents and creates starter rules in under a minute
  • Two-way sync - In solo mode, auto-pull keeps IR and agent files in sync. Manually pull changes in team mode to keep collaborators aligned.

Quickstart

1. Initialize

npx aligntrue init

→ Auto-detects agents, imports rules, or creates AGENTS.md starter template

2. Align

aligntrue sync

→ Pushes rules to all configured agents (Cursor, AGENTS.md, VS Code, etc.)

Result: .cursor/rules/aligntrue.mdc, AGENTS.md, .vscode/mcp.json, and more - all from one source.

Read the Quickstart Guide for detailed instructions.

Features

  • Auto-detection - Finds Cursor, Copilot, Claude, VS Code, and 25+ other agents automatically
  • Two-way sync - Edit markdown or agent files; AlignTrue keeps them aligned
  • 28+ agents supported - Comprehensive coverage through 43 specialized exporters
  • Agent-optimized formats - Native .mdc for Cursor, AGENTS.md for universals, MCP configs, and more
  • Local-first - No cloud required; works offline and in CI
  • Team mode - Optional lockfiles, bundles, and drift detection for teams

Broad agent support

AlignTrue supports 28+ AI coding agents through 43 specialized exporters:

Popular agents:

  • Cursor (.mdc files)
  • GitHub Copilot (AGENTS.md)
  • Claude (AGENTS.md + CLAUDE.md)
  • Aider (AGENTS.md + .aider.conf.yml)
  • Windsurf (AGENTS.md + MCP config)
  • VS Code MCP agents
  • Amazon Q, Firebase Studio, OpenHands, Zed, and 20+ more

Coverage:

  • 43 total exporters supporting 28+ agents
  • 8 MCP configurations for protocol-based agents
  • 15 unique format exporters for agent-specific formats
  • 11 universal format agents using AGENTS.md
  • 9 dual-output agents with both universal + specific formats

View full agent compatibility matrix →

How it works

  1. Write rules in AGENTS.md or any agent format (no YAML required)
  2. Run sync - AlignTrue updates internal IR and syncs to all configured agents
  3. Agent-specific exports - Each agent gets its native format (.mdc, .json, .yml, etc.)
  4. Stay aligned - Edit agent files; sync keeps everything consistent

Common workflows

Solo developer (default):

aligntrue init    # One-time setup
aligntrue sync    # Update agents when rules change

Team mode (opt-in):

aligntrue lock    # Pin rule versions
aligntrue check   # Validate in CI

Two-way sync:

  • Edit AGENTS.md or agent files → sync to other agents (default)
  • Auto-pull enabled for primary_agent by default

See workflows guide for details.

Optional verification:

aligntrue sync --dry-run       # Preview changes
aligntrue sync --no-auto-pull  # Disable auto-pull for this sync
aligntrue check                # Validate rules (great for CI)

Who is this for?

Solo developers: Keep your personal AI rules consistent across projects and machines

Teams: Shared rule sets with version control, CI validation, and drift detection

Key concepts

Reference

Contributing

Want to contribute? Check out the guides:

Development

Setting up AlignTrue for local development:

  • Setup - Prerequisites and installation
  • Workspace - Monorepo structure and packages
  • Commands - Development commands and scripts
  • Architecture - Key architectural concepts

Learn more

Support

License

MIT (see LICENSE )

Last updated on
Quickstart