skills.rest
fx
fxCOMMUNITY
Explore all skills by this author →
GitHub

fx-setup

Scaffolds docs/ structure and canonical AI instruction files for spec-driven development.

Updated Nov 2, 2025
Search Tags:#documentation#scaffolding#project setup#coderabbit#spec-driven development#agents.md#instruction files
One-click install
npx skills add https://github.com/fx/skills --skill fx-setup-fx
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: fx-setup
Source: https://github.com/fx/skills/tree/main/skills/fx-setup
Command: npx skills add https://github.com/fx/skills --skill fx-setup-fx

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? New projects lack the documentation layout and AI instruction files that spec-driven development workflows depend on, and manually creating AGENTS.md, REVIEW.md, CLAUDE.md, and .coderabbit.yaml consistently is error-prone. ## Core Features & Use Cases - Docs scaffolding: Creates docs/specs/, docs/changes/, docs/tasks.md, docs/index.yml, and docs/index.md only when missing, never overwriting existing content. - Instruction file setup: Seeds AGENTS.md with a task-tracking pointer, REVIEW.md with PR review rules, a CLAUDE.md @AGENTS.md import, and a .coderabbit.yaml that points CodeRabbit at REVIEW.md. - Legacy detection without migration: Detects symlinks, obsolete .github/copilot-instructions.md, and stale task-tracking language, then reports them and defers migration to /fx-upgrade. - Use Case: When /spec-writer or /project-management runs on a fresh repository, this skill runs automatically as a prerequisite to guarantee the docs structure and instruction files exist before any spec or task work begins. ## Quick Start Ask the agent to set up the docs structure and project instruction files for spec-driven development in this repository.

Frequently Asked Questions about fx-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up AGENTS.md and REVIEW.md for a project?▼

Run this skill to create AGENTS.md with a task-tracking pointer to /project-management and REVIEW.md with PR review rules at the repository root. It also creates a CLAUDE.md containing an @AGENTS.md import and configures .coderabbit.yaml so CodeRabbit reads REVIEW.md.

What docs folder structure does spec-driven development need?▼

The skill creates docs/specs/ for living specifications, docs/changes/ for change documents with task tracking, docs/tasks.md as a catch-all task list, plus docs/index.yml and docs/index.md as machine-readable and human-readable indexes.

Does this skill overwrite existing configuration files?▼

No. It follows a strict create-only contract: it creates missing files and appends missing marker blocks, but never overwrites content, flips existing config values, resolves symlinks, or merges files. Anything needing migration is reported and deferred to /fx-upgrade.

Why does CodeRabbit not read REVIEW.md by default?▼

CodeRabbit's default knowledge_base filePatterns cover **/AGENTS.md and **/CLAUDE.md but not **/REVIEW.md. The skill adds "**/REVIEW.md" to code_guidelines.filePatterns in .coderabbit.yaml, which appends to the defaults rather than replacing them.

What happens when a legacy CLAUDE.md or symlink is detected?▼

The skill detects symlinks, content-bearing CLAUDE.md files, and obsolete .github/copilot-instructions.md during preflight, then skips the affected write steps and reports the findings. Migration of that content is handled by running /fx-upgrade.

Related Skills

Explore More Software Engineering Skills→
21StarkCom21StarkCom

stark-init-docs

Scaffold, backfill, migrate, and clean standardized developer documentation structures in git repositories.

Official
Advanced
oporpinooporpino

br4zz4:spec

Guides structured dialogue to write and approve technical specification documents.

Community
Advanced
nanocoainanocoai
30.7k

migrate-memory

Migrate legacy NanoClaw and Claude memory files into the shared memory tree.

Official
Advanced
david-nossebrodavid-nossebro

agents-md

Generates or updates repository AGENTS.md from existing files and project signals.

Community
Intermediate