paqad-ai 0.1.4 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -12
- package/dist/cli/index.js +1528 -423
- package/dist/cli/index.js.map +1 -1
- package/dist/index.d.ts +124 -3
- package/dist/index.js +1764 -496
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/runtime/base/rules/constitution.md +1 -0
- package/runtime/base/skills/diff-doc-sync/SKILL.md +2 -2
- package/runtime/hooks/stale-doc-detector.sh +3 -8
- package/runtime/templates/agent-configs/aider.md.hbs +10 -0
- package/runtime/templates/agent-configs/continue.md.hbs +10 -0
- package/runtime/templates/agent-configs/copilot.md.hbs +10 -0
- package/runtime/templates/agent-configs/cursor.md.hbs +10 -0
- package/runtime/templates/agent-configs/windsurf.md.hbs +10 -0
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# paqad-ai
|
|
2
2
|
|
|
3
|
-
🚀 `paqad-ai` is a documentation-first AI workflow framework for capability-driven repositories. It scaffolds project rules, stack-aware docs, MCP configuration, health checks, and agent entry files so teams can work consistently across Claude Code, Codex CLI, Gemini CLI, and
|
|
3
|
+
🚀 `paqad-ai` is a documentation-first AI workflow framework for capability-driven repositories. It scaffolds project rules, stack-aware docs, MCP configuration, health checks, and agent entry files so teams can work consistently across Claude Code, Codex CLI, Gemini CLI, Junie, Cursor, GitHub Copilot, Windsurf, Continue, and Aider.
|
|
4
4
|
|
|
5
5
|
## ✨ What It Solves
|
|
6
6
|
|
|
@@ -16,12 +16,17 @@ With `paqad-ai`, a repo can:
|
|
|
16
16
|
|
|
17
17
|
## 🧩 Supported Adapters
|
|
18
18
|
|
|
19
|
-
| Adapter
|
|
20
|
-
|
|
|
21
|
-
| Claude Code
|
|
22
|
-
| Codex CLI
|
|
23
|
-
| Gemini CLI
|
|
24
|
-
| Junie
|
|
19
|
+
| Adapter | Status | Notes |
|
|
20
|
+
| -------------- | ------------ | ------------------------------------------------------------------ |
|
|
21
|
+
| Claude Code | ✅ Supported | Generates `CLAUDE.md` plus MCP config |
|
|
22
|
+
| Codex CLI | ✅ Supported | Generates `AGENTS.md` plus MCP config |
|
|
23
|
+
| Gemini CLI | ✅ Supported | Generates `GEMINI.md` plus MCP config |
|
|
24
|
+
| Junie | ✅ Supported | Limited to `.junie/AGENTS.md` and `.junie/mcp/mcp.json` |
|
|
25
|
+
| Cursor | ✅ Supported | Generates `.cursor/rules/paqad.mdc` plus MCP, skills, and agents |
|
|
26
|
+
| GitHub Copilot | ✅ Supported | Generates `.github/copilot-instructions.md` and `.vscode/mcp.json` |
|
|
27
|
+
| Windsurf | ✅ Supported | Generates `.windsurfrules` plus MCP, skills, and agents |
|
|
28
|
+
| Continue | ✅ Supported | Generates `.continue/rules/paqad.md` plus MCP and prompts |
|
|
29
|
+
| Aider | ✅ Supported | Config-only — generates `CONVENTIONS.md` |
|
|
25
30
|
|
|
26
31
|
## 🛠️ Installation
|
|
27
32
|
|
|
@@ -68,7 +73,7 @@ paqad-ai update --project-root .
|
|
|
68
73
|
|
|
69
74
|
Depending on detected capabilities, stack packs, and selected providers, `paqad-ai` can generate:
|
|
70
75
|
|
|
71
|
-
- provider entry files such as `CLAUDE.md`, `AGENTS.md`, `GEMINI.md`,
|
|
76
|
+
- provider entry files such as `CLAUDE.md`, `AGENTS.md`, `GEMINI.md`, `.junie/AGENTS.md`, `.cursor/rules/paqad.mdc`, `.github/copilot-instructions.md`, `.windsurfrules`, `.continue/rules/paqad.md`, and `CONVENTIONS.md`
|
|
72
77
|
- framework-managed state under `.paqad/`
|
|
73
78
|
- copied instruction bundles under `docs/instructions/rules/` and `docs/instructions/tools/`
|
|
74
79
|
- stack snapshot docs under `docs/instructions/stack/`
|
|
@@ -133,7 +138,7 @@ paqad-ai onboard --project-root .
|
|
|
133
138
|
|
|
134
139
|
When run without flags in an interactive terminal, `onboard` prompts for:
|
|
135
140
|
|
|
136
|
-
1. **Providers** — multi-select: Codex, Claude Code, Gemini, Junie (one or more required).
|
|
141
|
+
1. **Providers** — multi-select: Codex, Claude Code, Gemini, Junie, Cursor, GitHub Copilot, Windsurf, Continue, Aider (one or more required).
|
|
137
142
|
2. **Manifest-driven stack scan** — `composer.json`, `package.json`, lockfiles, and supported config files are scanned first.
|
|
138
143
|
3. **Stack confirmation checkpoint** — the detected effective stack profile is shown and must be confirmed before onboarding continues in interactive mode.
|
|
139
144
|
4. **Fallback stack details** — only shown when detection is missing, ambiguous, or the user chooses to revise. Laravel asks for Inertia, Frontend (None / React.js / Vue.js), Tailwind, Boost, plus Docker/Compose. React asks for app type, Tailwind, and Docker/Compose. Vue asks for app type, Tailwind, and Docker/Compose. Other coding stacks ask for Docker/Compose when supported.
|
|
@@ -152,6 +157,12 @@ paqad-ai onboard --project-root . --stack react --capability next tailwind
|
|
|
152
157
|
|
|
153
158
|
# Plain Laravel
|
|
154
159
|
paqad-ai onboard --project-root . --stack laravel
|
|
160
|
+
|
|
161
|
+
# Cursor only
|
|
162
|
+
paqad-ai onboard --project-root . --stack laravel --providers cursor
|
|
163
|
+
|
|
164
|
+
# GitHub Copilot only
|
|
165
|
+
paqad-ai onboard --project-root . --stack laravel --providers github-copilot
|
|
155
166
|
```
|
|
156
167
|
|
|
157
168
|
### Options
|
|
@@ -159,7 +170,7 @@ paqad-ai onboard --project-root . --stack laravel
|
|
|
159
170
|
- `--project-root <path>`: target project directory. Defaults to the current working directory.
|
|
160
171
|
- `--stack <stack>`: fallback/manual override for the target stack. Values: `laravel`, `flutter`, `react`, `vue`, `django`, `fastapi`, `rails`, `spring-boot`, `express`, `angular`, `svelte`, `astro`, `go-web`, `rust-web`, `short-video`.
|
|
161
172
|
- `--capability <capability...>`: fallback/manual trait override — `inertia`, `react`, `vue`, `tailwind`, `boost`, `next`, `remix`, `vite-spa`, `gatsby`, `nuxt`, `quasar`, `docker`, `compose`, `sail`, `pest`, `phpunit`.
|
|
162
|
-
- `--providers <provider...>`: one or more providers — `codex-cli`, `claude-code`, `gemini-cli`, `junie`.
|
|
173
|
+
- `--providers <provider...>`: one or more providers — `codex-cli`, `claude-code`, `gemini-cli`, `junie`, `cursor`, `github-copilot`, `windsurf`, `continue`, `aider`.
|
|
163
174
|
|
|
164
175
|
### Stack capability matrix
|
|
165
176
|
|
|
@@ -273,11 +284,11 @@ Use `update` when the package version changes or when framework-managed scaffold
|
|
|
273
284
|
| Feature | What it does |
|
|
274
285
|
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
275
286
|
| 17 built-in stack packs | Ships 14 framework packs (`laravel`, `flutter`, `react`, `vue`, `django`, `fastapi`, `rails`, `spring-boot`, `express`, `angular`, `svelte`, `astro`, `go-web`, `rust-web`) plus 3 archetype packs (`node-cli`, `node-library`, `node-service`) for projects that don't match a framework. |
|
|
276
|
-
| Multi-provider support | Generates repo-managed output for Claude Code, Codex CLI, Gemini CLI, and
|
|
287
|
+
| Multi-provider support | Generates repo-managed output for Claude Code, Codex CLI, Gemini CLI, Junie, Cursor, GitHub Copilot, Windsurf, Continue, and Aider from the same framework state. |
|
|
277
288
|
| Capability-first onboarding | Starts every repo with `content`, activates `coding` and `security` from matched packs or explicit capability changes. |
|
|
278
289
|
| Two-phase stack detection | Framework packs are evaluated first; archetype packs (`node-cli`, `node-library`, `node-service`) activate as a fallback for CLI tools, libraries, and raw services. |
|
|
279
290
|
| Stack Pack architecture | Uses `pack.yaml` manifests to drive detection, resolver behavior, MCP defaults, pentest mappings, and stack docs. Supports `tier: archetype` for fallback detection. |
|
|
280
|
-
| Thin provider entry files | Generates concise `AGENTS.md`, `CLAUDE.md`, `GEMINI.md`,
|
|
291
|
+
| Thin provider entry files | Generates concise `AGENTS.md`, `CLAUDE.md`, `GEMINI.md`, `.junie/AGENTS.md`, `.cursor/rules/paqad.mdc`, `.github/copilot-instructions.md`, `.windsurfrules`, `.continue/rules/paqad.md`, and `CONVENTIONS.md` files that point to project-owned docs. |
|
|
281
292
|
| Project-owned instruction bundles | Copies rules and stack references into `docs/instructions/**` so the repo owns the operational guidance. |
|
|
282
293
|
| Stack snapshot docs | Writes human-readable stack docs under `docs/instructions/stack/**` from detected manifests and lockfiles. |
|
|
283
294
|
| Documentation workflow | Builds architecture docs, design-system docs, and module docs from the real project state after onboarding. |
|