new-adapter

Solid

Add support for a new AI tool with adapters, CLI, completion, and tests.

AI & Automation 35 stars 1 forks Updated yesterday Unlicense

Install

View on GitHub

Quality Score: 82/100

Stars 20%
52
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# New Adapter ## Instructions Complete workflow for adding support for a new AI tool to AIS. ### Prerequisites Before starting, gather this information: - Tool name (e.g., "windsurf", "mcp") - Rule/config types supported (e.g., rules, commands, skills) - Default source directory (e.g., `.windsurf/rules/`) - Target directory (usually same as source) - File mode: `file` or `directory` ### Steps #### 1. Create Adapter File Create `src/adapters/<tool>-<type>.ts`: ```typescript import { createBaseAdapter } from './base.js'; export const myToolAdapter = createBaseAdapter({ name: '<tool>-<type>', tool: '<tool>', subtype: '<type>', configPath: ['<tool>', '<type>'], defaultSourceDir: '.<tool>/<type>', targetDir: '.<tool>/<type>', mode: 'directory', // or 'file' }); ``` #### 2. Register Adapter In `src/adapters/index.ts`: - Import the new adapter - Register in `DefaultAdapterRegistry` constructor #### 3. Update Project Config In `src/project-config.ts`: - Add tool section to `ProjectConfig` interface - Add tool to `SourceDirConfig` interface if needed #### 4. Wire CLI Commands In `src/cli/register.ts`: - Add tool subcommand group - Register add/remove/install/import commands #### 5. Update Completion In `src/completion.ts`: - Add tool to completion types - Add subtype completions In `src/completion/scripts.ts`: - Update bash/zsh/fish completion scripts #### 6. Add Tests Create `src/__tests__/<tool>-<type>.test.ts`: - Test adapter properties - Test add/...

Details

Author
lbb00
Repository
lbb00/ai-rules-sync
Created
7 months ago
Last Updated
yesterday
Language
TypeScript
License
Unlicense

Similar Skills

Semantically similar based on skill content — not just same category