Skip to Content
04 ReferenceExamples

Examples

Learn by example with working demonstrations and 11 curated rule packs.

Working examples (GitHub)

Complete, runnable examples in the AlignTrue repository:

Golden repository

Full-featured demo with multiple agents, scopes, and team mode.

  • Multiple exporters (Cursor, AGENTS.md, VS Code MCP)
  • Hierarchical scopes for monorepo structure
  • Team mode with lockfile and allow list
  • Overlay customizations
  • Test scripts for validation

View golden-repo on GitHub → 

When to use: Learning AlignTrue basics, solo developer workflow

Files: YAML format (.aligntrue.yaml, .aligntrue.lock.json)

Overlays demo

Fork-safe customization without forking upstream packs.

  • Severity remapping (warn → error)
  • Adding check inputs (threshold adjustments)
  • Removing autofix
  • Temporary overrides with comments
  • Overlay status and diff commands

View overlays-demo on GitHub → 

When to use: Customizing third-party packs, team severity preferences

Files: YAML format with overlays section

Monorepo scopes

Path-based rule application for monorepos with different tech stacks.

  • Different rules per directory (Next.js, Node.js, Python)
  • Team boundaries with scope ownership
  • Include/exclude patterns
  • Hierarchical merge order
  • Scope validation

View monorepo-scopes on GitHub → 

When to use: Monorepos, multiple tech stacks, team boundaries

Files: YAML format with scopes section, multiple directories

Multi-agent workflows

Same rules, multiple agents - sync to Cursor, Copilot, Claude Code, and more.

  • Multiple exporters (4+ agents)
  • Vendor bags for agent-specific hints
  • Same core rules, different agent optimizations
  • Fidelity notes per agent
  • Content hash verification

View multi-agent on GitHub → 

When to use: Using 2+ AI agents, agent-specific customization

Files: YAML format with vendor bags, multiple agent outputs

Markdown authoring examples

Literate markdown examples showing fenced code block syntax.

  • Simple rules with inline documentation
  • Multi-block validation examples
  • Round-trip markdown ↔ YAML workflows

View markdown examples on GitHub → 

When to use: Prefer markdown over YAML, documentation-heavy rules

Files: Markdown format (.md with ```aligntrue blocks)

Team repository example

Team collaboration setup with vendored packs.

  • Vendored pack management
  • Team approval workflows
  • Git submodule integration
  • Lockfile and drift detection
  • CI/CD integration

View team-repo on GitHub → 

When to use: Team workflows, lockfile enforcement, drift detection

Files: YAML format with vendor directory


Curated rule packs

11 production-ready rule packs maintained by AlignTrue. All packs are CC0-licensed (public domain).

Foundation packs

  • Base Global  - Essential baseline rules for all AI coding agents. Ensures deterministic behavior, clear output formatting, and consistent code quality practices.

  • Base Documentation  - Docs-as-code baseline enforcing readme-first development, CI-enforced quality, and behavior-synced documentation updates.

  • TypeScript Standards  - TypeScript development standards for correctness, safety, and maintainability. Enforces strict compiler settings and no ‘any’ types.

  • Testing Baseline  - Testing baseline ensuring fast, deterministic, useful tests with clear strategy. Emphasizes test pyramid balance and speed requirements.

  • TDD Workflow  - Test-Driven Development workflow implementing red-green-refactor cycle. Enforces writing tests before implementation.

  • Debugging Workflow  - Systematic debugging workflow ensuring reproduce-before-fix discipline. Covers reproduce, reduce, root-cause, fix, and prevent cycles.

  • Security and Compliance  - Security and compliance baseline covering secrets management, supply chain security, and dependency auditing.

  • Rule Authoring Guide  - Meta-guide for authoring AlignTrue rules with clear scope, actionable directives, and explicit precedence.

Framework & Stack Packs

  • Next.js App Router  - Best practices for Next.js App Router covering server/client boundaries, caching strategies, and data fetching patterns.

  • Vercel Deployments  - Vercel deployment best practices covering environment tiers, runtime selection, and preview hygiene.

  • Web Quality Standards  - Core Web Vitals targets, performance budgets, and accessibility standards. Enforces LCP under 2.5s and WCAG 2.0 AA compliance.

Pack details

View as table

PackIDDescriptionCategoriesCompatible Tools
Base Globalpacks/base/base-globalEssential baseline rules for all AI coding agents. Ensures deterministic behavior, clear output formatting, and consistent code quality practices.foundations, code-qualityCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf, Aider
Base Documentationpacks/base/base-docsDocs-as-code baseline enforcing readme-first development, CI-enforced quality, and behavior-synced documentation updates.foundations, development-workflowCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf, Aider
TypeScript Standardspacks/base/base-typescriptTypeScript development standards for correctness, safety, and maintainability. Enforces strict compiler settings and no ‘any’ types.code-qualityCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf
Testing Baselinepacks/base/base-testingTesting baseline ensuring fast, deterministic, useful tests with clear strategy. Emphasizes test pyramid balance and speed requirements.code-quality, development-workflowCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf, Aider
TDD Workflowpacks/base/base-tddTest-Driven Development workflow implementing red-green-refactor cycle. Enforces writing tests before implementation.development-workflow, code-qualityCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf
Debugging Workflowpacks/base/base-debuggingSystematic debugging workflow ensuring reproduce-before-fix discipline. Covers reproduce, reduce, root-cause, fix, and prevent cycles.development-workflowCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf, Aider
Security and Compliancepacks/base/base-securitySecurity and compliance baseline covering secrets management, supply chain security, and dependency auditing.security, code-qualityCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf, Aider
Rule Authoring Guidepacks/base/base-rule-authoringMeta-guide for authoring AlignTrue rules with clear scope, actionable directives, and explicit precedence.development-workflow, foundationsCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf, Aider
Next.js App Routerpacks/frameworks/nextjs-appBest practices for Next.js App Router covering server/client boundaries, caching strategies, and data fetching patterns.frameworks, webCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf
Vercel Deploymentspacks/platforms/vercelVercel deployment best practices covering environment tiers, runtime selection, and preview hygiene.platforms, webCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf
Web Quality Standardspacks/base/base-web-qualityCore Web Vitals targets, performance budgets, and accessibility standards. Enforces LCP under 2.5s and WCAG 2.0 AA compliance.web, code-qualityCursor, Claude Code, GitHub Copilot, Cody, Continue, Windsurf

Using packs

Quick install

# Add a pack to your project aligntrue add packs/base/base-global # Sync to your agents aligntrue sync

Browse on GitHub

All pack YAML files are available in the AlignTrue repository .

Customize with overlays

Need to adjust a pack for your project? Use overlays:

# Remap severity aligntrue override add rule-id --set severity=warning # Disable a rule aligntrue override add rule-id --set enabled=false

See Overlays Guide for details.

Contributing packs

Want to share your rules with the community? See Creating Packs for guidelines.


Note: All packs are CC0-licensed (public domain) and maintained by AlignTrue. Community contributions welcome!

Last updated on