\r\n\r\n\r\nA lightweight spec-driven framework for AI development.\r\n\r\n[](https://github.com/AsiaInfo/AISpec/stargazers)\r\n[](https://www.npmjs.com/package/@asiainfo/asiainfospec)\r\n[](https://github.com/AsiaInfo/AISpec/graphs/contributors)\r\n\r\n\r\n\r\nOur philosophy:\r\n\r\n```text\r\n→ fluid not rigid\r\n→ iterative not waterfall\r\n→ easy not complex\r\n→ built for brownfield not just greenfield\r\n→ scalable from personal projects to enterprises\r\n```\r\n\r\n> [!TIP]\r\n> **New workflow now available!** We've rebuilt AISpec with a new artifact-guided workflow.\r\n>\r\n> Run `/aisx:propose \"your idea\"` to get started. → [Learn more here](docs/aisx.md)\r\n\r\n\r\n\r\n## See it in action\r\n\r\n```text\r\nYou: /aisx:propose add-dark-mode\r\nAI: Created asiainfospec/changes/add-dark-mode/\r\n ✓ proposal.md — why we're doing this, what's changing\r\n ✓ specs/ — requirements and scenarios\r\n ✓ design.md — technical approach\r\n ✓ tasks.md — implementation checklist\r\n Ready for implementation!\r\n\r\nYou: /aisx:apply\r\nAI: Implementing tasks...\r\n ✓ 1.1 Add theme context provider\r\n ✓ 1.2 Create toggle component\r\n ✓ 2.1 Add CSS variables\r\n ✓ 2.2 Wire up localStorage\r\n All tasks complete!\r\n\r\nYou: /aisx:archive\r\nAI: Archived to asiainfospec/changes/archive/2025-01-23-add-dark-mode/\r\n Specs updated. Ready for the next feature.\r\n```\r\n\r\n\r\nAISpec Dashboard\r\n\r\n
\r\n \r\n
\r\n\r\n\r\n\r\n## Quick Start\r\n\r\n**Requires Node.js 20.19.0 or higher.**\r\n\r\nInstall AISpec globally:\r\n\r\n```bash\r\nnpm install -g @asiainfo/asiainfospec@latest\r\n```\r\n\r\nThen navigate to your project directory and initialize:\r\n\r\n```bash\r\ncd your-project\r\naispec init\r\n```\r\n\r\nNow tell your AI: `/aisx:propose `\r\n\r\nIf you want the expanded workflow (`/aisx:new`, `/aisx:continue`, `/aisx:ff`, `/aisx:verify`, `/aisx:sync`, `/aisx:bulk-archive`, `/aisx:onboard`), select it with `aispec config profile` and apply with `aispec update`.\r\n\r\n> [!NOTE]\r\n> Not sure if your tool is supported? [View the full list](docs/supported-tools.md) – we support 25+ tools and growing.\r\n>\r\n> Also works with pnpm, yarn, bun, and nix. [See installation options](docs/installation.md).\r\n\r\n## Docs\r\n\r\n→ **[Getting Started](docs/getting-started.md)**: first steps \r\n→ **[Workflows](docs/workflows.md)**: combos and patterns \r\n→ **[Commands](docs/commands.md)**: slash commands & skills \r\n→ **[CLI](docs/cli.md)**: terminal reference \r\n→ **[Supported Tools](docs/supported-tools.md)**: tool integrations & install paths \r\n→ **[Concepts](docs/concepts.md)**: how it all fits \r\n→ **[Multi-Language](docs/multi-language.md)**: multi-language support \r\n→ **[Customization](docs/customization.md)**: make it yours\r\n\r\n\r\n## Why AISpec?\r\n\r\nAI coding assistants are powerful but unpredictable when requirements live only in chat history. AISpec adds a lightweight spec layer so you agree on what to build before any code is written.\r\n\r\n- **Agree before you build** — human and AI align on specs before code gets written\r\n- **Stay organized** — each change gets its own folder with proposal, specs, design, and tasks\r\n- **Work fluidly** — update any artifact anytime, no rigid phase gates\r\n- **Use your tools** — works with 20+ AI assistants via slash commands\r\n\r\n## Updating AISpec\r\n\r\n**Upgrade the package**\r\n\r\n```bash\r\nnpm install -g @asiainfo/asiainfospec@latest\r\n```\r\n\r\n**Refresh agent instructions**\r\n\r\nRun this inside each project to regenerate AI guidance and ensure the latest slash commands are active:\r\n\r\n```bash\r\naispec update\r\n```\r\n\r\n## Usage Notes\r\n\r\n**Model selection**: AISpec works best with high-reasoning models. We recommend Opus 4.5 and GPT 5.2 for both planning and implementation.\r\n\r\n**Context hygiene**: AISpec benefits from a clean context window. Clear your context before starting implementation and maintain good context hygiene throughout your session.\r\n\r\n## Contributing\r\n\r\n**Small fixes** — Bug fixes, typo corrections, and minor improvements can be submitted directly as PRs.\r\n\r\n**Larger changes** — For new features, significant refactors, or architectural changes, please submit an AISpec change proposal first so we can align on intent and goals before implementation begins.\r\n\r\nWhen writing proposals, keep the AISpec philosophy in mind: we serve a wide variety of users across different coding agents, models, and use cases. Changes should work well for everyone.\r\n\r\n**AI-generated code is welcome** — as long as it's been tested and verified. PRs containing AI-generated code should mention the coding agent and model used (e.g., \"Generated with Claude Code using claude-opus-4-5-20251101\").\r\n\r\n### Development\r\n\r\n- Install dependencies: `pnpm install`\r\n- Build: `pnpm run build`\r\n- Test: `pnpm test`\r\n- Develop CLI locally: `pnpm run dev` or `pnpm run dev:cli`\r\n- Conventional commits (one-line): `type(scope): subject`\r\n\r\n## Other\r\n\r\n\r\nTelemetry\r\n\r\nAISpec collects anonymous usage stats.\r\n\r\nWe collect only command names and version to understand usage patterns. No arguments, paths, content, or PII. Automatically disabled in CI.\r\n\r\n**Opt-out:** `export AISPEC_TELEMETRY=0` or `export DO_NOT_TRACK=1`\r\n\r\n\r\n\r\n\r\nMaintainers & Advisors\r\n\r\nSee [MAINTAINERS.md](MAINTAINERS.md) for the list of core maintainers and advisors who help guide the project.\r\n\r\n\r\n\r\n\r\n\r\n## License\r\n\r\nMIT","readmeFilename":"README.md","_rev":"1-9cbab9f1e979cf12ad5303bbd111fdc8"}
![\"AISpec](\"assets/aispec_bg.png\")
\r\n ![\"CI\"](\"https://github.com/AsiaInfo/AISpec/actions/workflows/ci.yml/badge.svg\"){kind=icon}
\r\n ![\"npm](\"https://img.shields.io/npm/v/@asiainfo/asiainfospec?style=flat-square\")
![\"License:](\"https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square\"){kind=icon}
\r\n![\"AISpec](\"assets/aispec_dashboard.png\")
\r\n