ai-rules-cli_skill

This skill helps you manage and synchronize AI coding rules across multiple assistants using ai-rules, ensuring a single source of truth.

TypeScript

6

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill lambda-curry/devagent --skill ai-rules-cli

SKILL.md9.3 KB

Overview

This skill uses the ai-rules CLI to manage and synchronize AI coding rules across multiple AI assistants from a single source of truth. It helps generate platform-specific rule files, verify sync status, and keep multi-agent guidelines consistent. The workflow centers on an ai-rules/ directory and a small config file to control generation and targets.

How this skill works

You maintain canonical rule files in the ai-rules/ directory and run ai-rules commands to produce agent-specific outputs (CLAUDE.md, .cursor rules, copilot instructions, etc.). The CLI inspects source markdown and frontmatter, applies configured agents and options, writes generated artifacts, and reports sync status. Use status checks in CI or pre-commit hooks to ensure generated files match source.

When to use it

Initializing ai-rules in a new repository to create baseline agent files
Updating or adding coding guidelines and producing platform-specific outputs
Verifying generated files are in sync with source before merging or CI
Maintaining consistent rules across multiple AI assistants (Cursor, Claude, Copilot, Opencode, Gemini)
Automating generation and checks in pre-commit hooks or CI pipelines

Best practices

Always edit source files inside ai-rules/ and avoid editing generated files directly
Commit both source and generated files so teammates get consistent artifacts
Run ai-rules generate after any change, then verify with ai-rules status
Include ai-rules status in CI to fail builds when generated files are out of sync
Use descriptive filenames and a 00-project-context.md for project-wide context

Example use cases

Create ai-rules/00-project-context.md and generate CLAUDE.md and .cursor rules for a new project
Add ai-rules/my-new-rule.md with frontmatter to target TypeScript files, then run ai-rules generate
Run ai-rules status in CI to block merges when generated files diverge from source
Switch on Claude skills mode in config to emit separate .claude/skills for contextual rules
Clean up generated artifacts with ai-rules clean before large restructuring

FAQ

Run ai-rules generate to regenerate platform files from the ai-rules/ source, then re-run ai-rules status to confirm sync.

Where should I edit rules and configuration?

Edit markdown rule files inside the ai-rules/ directory and the ai-rules-config.yaml there; generated files are overwritten on generate.