@aircury/ai-framework

中文文档
2.8.0发布于 2026/11/05构建来源已验证近 30 天下载 2728

Aircury AI Framework installer — sets up selectable architecture standards, testing, and AI agent configs in any project

原始使用文档
文档目录7 节
  1. Why Aircury
  2. Quick Install
  3. Update A Project
  4. Install From A Local Branch
  5. What It Installs
  6. Walking Skeleton
  7. Documentation

Aircury AI Framework

npm

The Aircury AI Framework is a meta-routing framework for AI-assisted software engineering. Its main job is to decide which workflow an AI agent should use for each request.

You normally do not choose a mode. Ask for the work you need, and the framework tells the agent whether to use plan-build, Spec Kit, or a direct implementation flow. Only specify a mode when you explicitly want to force that workflow.

It also installs project rules, agent entrypoints, living specification folders, mandatory engineering non-negotiables, optional standards, greenfield bootstrap guidance, and curated skills while separating a shared workflow constitution from installable capabilities.

Why Aircury

Aircury gives agents enough structure to work consistently without forcing every change through a heavy process. The default behavior is automatic routing:

  • Use plan-build for clear day-to-day changes.
  • Use Spec Kit when requirements need formal clarification and planning before code.
  • Keep durable behavior knowledge in specs/features/.

Quick Install

Run the installer from any project directory (or your home directory for a global setup):

bunx @aircury/ai-framework
# or
npx @aircury/ai-framework

The TUI asks for:

  1. Scope — Local to configure the current project, Global to configure your machine.
  2. AI tools — select the tool-specific integrations you want.
  3. Language preference — for local installs, optionally enforce British English and include the language capability.
  4. Capabilities — choose the workflows and standards this installation should include.

Rerunning the installer updates a project without asking: files carrying the framework-maintained notice are replaced by the current version, AGENTS.md and CLAUDE.md keep their content and gain the framework section, the project's own files (FRAMEWORK.local.md, the specs/ guides) are never overwritten, and framework capability documents the profile no longer installs are removed. The installed version is recorded as frameworkVersion in .aircury/framework.config.json. Skills are installed through the skills ecosystem with npx or bunx, so they can be updated later. When a project keeps .agents/skills as a git submodule (a shared skills repository), the installer installs no skills there: that repository owns them, and the installer lists the selected skills it already provides and the ones to add to it.

Every local installation includes non-negotiable engineering rules in FRAMEWORK.md: TDD where automated testing is feasible, SOLID design constraints, Clean Code, explicit architecture boundaries, and justified tradeoffs for any exception.

Update A Project

To bring an installed project to the latest framework without prompts (for example from an automated agent), run from the project root:

npx @aircury/ai-framework@latest --update
# or preview the plan without writing anything
npx @aircury/ai-framework@latest --update --dry-run

It reads the saved .aircury/framework.config.json and applies the same plan as the interactive installer: framework-maintained files refreshed, the project's own files kept, AGENTS.md/CLAUDE.md merged, dropped capability documents removed, skills installed (none into a .agents/skills submodule).

Install From A Local Branch

To test an unpublished branch, build the CLI from your local checkout:

bun install
bun run build

Then run the built installer from the project you want to configure:

node /absolute/path/to/ai-framework/dist/cli.js

Use a throwaway project first if you want to verify the generated files before installing into a real repository.

What It Installs

ScopeOutputs
LocalFRAMEWORK.md, AGENTS.md, .aircury/framework.config.json, starter specs/ folders, optional tool files, selected skills, and a .gitignore entry for specs/changes/.
GlobalSelected skills for the chosen global agent integrations.

Walking Skeleton

For greenfield projects, Aircury can install the external aircury/walking-skeleton skill as an optional capability.

It is recommended when a team wants to start from reviewed ADRs, define a tiny end-to-end slice, and build a runnable baseline before normal feature delivery begins.

The skill stays in its own repository. This framework only references and installs it through skills add; it does not vendor the ADR catalogue or generated example code.

Use the workflow in order:

/walking-skeleton plan
/walking-skeleton spec
/walking-skeleton build

Documentation

DocumentPurpose
docs/concepts.mdConceptual model: why the framework exists, workflow routing, capabilities, and canonical specs.
docs/implementation.mdInstaller flow, generated files, capabilities, skill installation, and conflict handling.
docs/playbook.mdWorkflow selection guide, examples, and operating rules for installed projects.
docs/contribution.mdHow to contribute modules, templates, skills, and installer wiring.
docs/improvements.mdPrioritised framework improvements from the June 2026 feedback synthesis.

版本与发布记录

@aircury/ai-framework 共发布 78 个版本,首次发布于 2026/04/07;过去 12 个月发布了 78 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.8.0latest2026/11/052 天前
2.7.12026/10/308 天前
2.7.02026/10/2711 天前
2.6.12026/10/2514 天前
2.6.02026/10/2514 天前
2.5.02026/10/2514 天前

关于 @aircury/ai-framework 的常见问题

@aircury/ai-framework 是什么?

Aircury AI Framework installer — sets up selectable architecture standards, testing, and AI agent configs in any project

如何安装 @aircury/ai-framework?

在项目目录运行 npm install @aircury/ai-framework,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ai-framework,可以用 npx ai-framework 直接运行。

@aircury/ai-framework 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/aircury__ai-framework 是否存在。

@aircury/ai-framework 可以商用吗?

@aircury/ai-framework 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@aircury/ai-framework 的下载量有多少?

根据 npm 官方下载统计,@aircury/ai-framework 在 2026/10/05 – 2026/11/03 这 30 天内被下载 2,728 次,日均约 91 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@aircury/ai-framework 还在维护吗?

最新版本 2.8.0 发布于 2026/11/05(2 天前);至今共发布 78 个版本,其中过去 12 个月发布了 78 个;首次发布于 2026/04/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。