How AIConfig Works

    From a single configuration file to synchronized AI assistants across your entire workflow.

    Quick Start Guide

    01

    Install AIConfig

    Get started with a single npm command.

    npm install -g aiconfig-cli
    02

    Initialize Your Config

    Create your .aiconfig file interactively or from scratch.

    aiconfig init
    03

    Define Your Rules

    Write your AI assistant instructions in plain YAML.

    04

    Generate Configs

    Automatically create configs for all your AI tools.

    aiconfig generate --all

    The Translation Process

    AIConfig uses specialized adapters to translate your universal config into tool-specific formats.

    Your .aiconfig File

    .aiconfig
    # .aiconfig
version: 1.0
assistant:
  name: "E-commerce API"
  context:
    - "RESTful API using Express and TypeScript"
    - "PostgreSQL database with Prisma ORM"
    - "Jest for unit tests, Supertest for integration"
  rules:
    - "Validate all inputs with Zod schemas"
    - "Use async/await for all database operations"
    - "Include error handling in all endpoints"
  style: "professional"

    Generated Config (Copilot)

    .copilot/instructions.md
    // .copilot/instructions.md (auto-generated)
You are an assistant for an E-commerce API project.

Context:
- RESTful API using Express and TypeScript
- PostgreSQL database with Prisma ORM
- Jest for unit tests, Supertest for integration

Rules:
- Validate all inputs with Zod schemas
- Use async/await for all database operations
- Include error handling in all endpoints

Style: professional

    What Happens Behind The Scenes

    • AIConfig parses your YAML and validates the schema
    • Each adapter transforms the config to match the target tool's format
    • Files are written to the correct locations (.copilot, .cursor, etc.)
    • Watch mode keeps everything in sync as you edit .aiconfig

    Architecture Overview

    1

    Core Engine

    Parses .aiconfig, validates schema, and manages the configuration state.

    2

    Adapter System

    Plugin architecture with adapters for each AI tool. Extensible and testable.

    3

    File Watcher

    Monitors .aiconfig for changes and triggers regeneration automatically.

    Ready to Get Started?

    Install AIConfig now and unify your AI workflow in minutes.

    View on GitHub →See Integrations