aimds
v0.0.1
Published
Symlink one AI Agent configuration to the rest of them
Maintainers
Readme
AI MDs
Each AI Agent looks in a different spot for its configuration file. This tool lets you write that configuration once and symlink it to the rest of the locations so that they stay in sync.
Installation
# This package depends on bun being installed globally
# See: https://bun.sh/docs/installation
npm i -g bun
# Creates a global `aimds` cli command
npm i -g aimdsUsage
cd /my/project
# Create the AI agent config files and symlinks
aimds
# Display help
aimds --helpOptions:
| Option | Default | Description |
| ----------------- | ------- | ------------------------- |
| -v, --verbose | false | Show more detailed output |
| -h, --help | - | Display usage guide |
Currently Supported Config Files
AGENTS.md- general purpose, used by OpenAI Codex - docs, codex docsCLAUDE.md- used by Claude - docs.github/copilot-instructions.md- used by GitHub Copilot - docs
How It Works
If one of the supported config files already exists, it uses that as the "hero" file. Otherwise, it creates AGENTS.md with a helpful template.
It then creates symlinks for the other files, pointing to the hero file. This ensures all AI tools have access to the same configuration, even though they look in different locations.
Development
# Clone the repo
git clone https://github.com/0livare/aimds.git
cd aimds
# Install dependencies
bun install
# Run the CLI directly
bun aimdsNote: The code does not need to be built for production. Bun will execute the source TypeScript code directly.
