@williambeto/ai-workflow 2.4.9 → 2.6.3

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.
Files changed (104) hide show
  1. package/bin/ai-workflow.d.ts +3 -0
  2. package/bin/ai-workflow.js +2669 -1
  3. package/bin/ai-workflow.js.map +1 -0
  4. package/chunk-2AOV2ATY.js +749 -0
  5. package/chunk-5WRI5ZAA.js +31 -0
  6. package/chunk-6EMG6FAO.js +734 -0
  7. package/chunk-UHLZX2EG.js +1827 -0
  8. package/core/index.d.ts +440 -0
  9. package/core/index.js +32 -0
  10. package/core/index.js.map +1 -0
  11. package/dist-assets/AGENTS.md +23 -6
  12. package/dist-assets/agents/atlas.md +8 -8
  13. package/dist-assets/agents/nexus.md +4 -4
  14. package/dist-assets/agents/orion.md +1 -1
  15. package/dist-assets/agents/phoenix.md +1 -1
  16. package/dist-assets/agents/sage.md +1 -1
  17. package/dist-assets/commands/implement.md +1 -1
  18. package/dist-assets/docs/QUICKSTART.md +8 -8
  19. package/dist-assets/docs/cli-reference.md +7 -7
  20. package/dist-assets/docs/compatibility/provider-usage.md +1 -9
  21. package/dist-assets/docs/compatibility/runtime-matrix.md +5 -6
  22. package/dist-assets/docs/consumer-onboarding.md +2 -2
  23. package/dist-assets/docs/design-patterns-policy.md +1 -1
  24. package/dist-assets/docs/npm-consumer-quickstart.md +70 -109
  25. package/dist-assets/docs/policies/01-BRANCH_GATE.md +1 -1
  26. package/dist-assets/docs/policies/06-FINAL_EVIDENCE_CONTRACT.md +2 -2
  27. package/dist-assets/docs/policies/08-PRODUCT_TRUTHFULNESS_AND_PROJECT_DOCS.md +1 -1
  28. package/dist-assets/docs/policies/10-BEHAVIORAL_CONTRACT_HARDENING.md +1 -1
  29. package/dist-assets/docs/policies/ORCHESTRATION_PROTOCOL.md +8 -9
  30. package/dist-assets/docs/policies/PROCEDURE_DELIVERY_ARTIFACTS.md +4 -10
  31. package/dist-assets/docs/policies/SKILLS_COMMON_GOVERNANCE.md +1 -1
  32. package/dist-assets/docs/profiles/README.md +2 -2
  33. package/dist-assets/docs/specs/runtime-operational-contract.md +12 -12
  34. package/dist-assets/docs/troubleshooting-guide.md +2 -2
  35. package/dist-assets/docs/visual-validation-guide.md +3 -3
  36. package/dist-assets/schemas/evidence.schema.json +109 -0
  37. package/dist-assets/templates/ANTIGRAVITY.md.template +7 -5
  38. package/dist-assets/templates/CLAUDE.md.template +7 -5
  39. package/dist-assets/templates/CODEX.md.template +7 -5
  40. package/evidence-validator-76ZQQYDU.js +6661 -0
  41. package/package.json +7 -64
  42. package/{src/core/workspace/read-only-workspace.js → read-only-workspace-PZBE7KAX.js} +14 -31
  43. package/{src/commands/validate.js → validate-Q2NLLQ5G.js} +30 -22
  44. package/AGENTS.md +0 -34
  45. package/CHANGELOG.md +0 -259
  46. package/LICENSE +0 -21
  47. package/PUBLISH_MANIFEST.json +0 -34
  48. package/README.md +0 -129
  49. package/dist-assets/templates/.geminiignore.template +0 -8
  50. package/dist-assets/templates/GEMINI.md.template +0 -20
  51. package/docs/compatibility/provider-usage.md +0 -46
  52. package/docs/compatibility/runtime-matrix.md +0 -31
  53. package/docs/getting-started/DESKTOP_PROMPT.md +0 -52
  54. package/docs/getting-started/authoring-custom-skills.md +0 -80
  55. package/docs/getting-started/quickstart.md +0 -117
  56. package/docs/getting-started/troubleshooting.md +0 -123
  57. package/docs/getting-started/upgrading-to-v2.md +0 -62
  58. package/src/adapters/index.js +0 -4
  59. package/src/adapters/platforms/antigravity.js +0 -382
  60. package/src/adapters/platforms/claude.js +0 -126
  61. package/src/adapters/platforms/codex.js +0 -113
  62. package/src/adapters/platforms/gemini.js +0 -245
  63. package/src/cli.js +0 -155
  64. package/src/commands/clean.js +0 -106
  65. package/src/commands/collect-evidence.js +0 -25
  66. package/src/commands/doctor.js +0 -202
  67. package/src/commands/execute.js +0 -382
  68. package/src/commands/init.js +0 -359
  69. package/src/commands/run.js +0 -112
  70. package/src/core/backup.js +0 -65
  71. package/src/core/completion-contract.js +0 -35
  72. package/src/core/delegation-controller.js +0 -193
  73. package/src/core/evidence/evidence-ledger.js +0 -98
  74. package/src/core/execution-planner.js +0 -62
  75. package/src/core/filesystem.js +0 -141
  76. package/src/core/finalization/finalizer.js +0 -165
  77. package/src/core/finalization/workspace-snapshot.js +0 -110
  78. package/src/core/gates/branch-gate.js +0 -134
  79. package/src/core/gates/merge-gate.js +0 -74
  80. package/src/core/handoff/handoff-engine.js +0 -104
  81. package/src/core/healing/cli-remediation-executor.js +0 -153
  82. package/src/core/healing/healer-engine.js +0 -212
  83. package/src/core/healing/runtime-remediation-executor.js +0 -136
  84. package/src/core/identity.js +0 -43
  85. package/src/core/install-plan.js +0 -34
  86. package/src/core/opencode-merge.js +0 -150
  87. package/src/core/package-assets.js +0 -141
  88. package/src/core/request-classifier.js +0 -73
  89. package/src/core/request-router.js +0 -289
  90. package/src/core/runtime/opencode-adapter.js +0 -202
  91. package/src/core/sdd/validator.js +0 -67
  92. package/src/core/statuses.js +0 -29
  93. package/src/core/symlink-layout.js +0 -93
  94. package/src/core/templates.js +0 -229
  95. package/src/core/validation/artifact-fidelity-gate.js +0 -445
  96. package/src/core/validation/canonical-finalization.js +0 -43
  97. package/src/core/validation/delivery-decision-engine.js +0 -344
  98. package/src/core/validation/evidence-collector.js +0 -245
  99. package/src/core/validation/quality-guard.js +0 -251
  100. package/src/core/validation/stack-detector.js +0 -65
  101. package/src/core/validation/validation-planner.js +0 -134
  102. package/src/core/validation/visual-verifier.js +0 -175
  103. package/src/core/workflow-profiles.js +0 -107
  104. package/src/core/workflow-state-machine.js +0 -46
package/README.md DELETED
@@ -1,129 +0,0 @@
1
- # AI Workflow Kit
2
-
3
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
4
- [![npm version](https://img.shields.io/npm/v/@williambeto/ai-workflow)](https://www.npmjs.com/package/@williambeto/ai-workflow)
5
-
6
- The AI Workflow Kit is an npm/CLI package that installs a suite of agents, commands, skills, policies, and templates to guide a coding agent inside a project.
7
-
8
- The central promise is:
9
-
10
- > "Transform a natural language request into a proportionate, safe, and verifiable software delivery."
11
-
12
- The workflow the product guarantees is:
13
-
14
- 1. **Request**: Understand the actual request.
15
- 2. **Planning**: Select the execution mode and workflow profile.
16
- 3. **Branch Gate**: Never implement directly on main/master.
17
- 4. **Delegation**: Atlas routes; Astra implements; Sage validates when appropriate; Phoenix remediates within a defined limit.
18
- 5. **Implementation**: Deliver useful code, not just reports.
19
- 6. **Validation**: Run observed validations and relevant tests, blocking false success.
20
- 7. **Evidence**: Summarize changes, validations, and limitations.
21
-
22
- In practice, the kit is neither a frontend framework nor a UI library. It is an operational layer for software agents: it installs instructions and guardrails so that the agent can work more effectively inside the user's repository.
23
-
24
- ## Installation and Usage
25
-
26
- ### First-time usage
27
-
28
- Use the full package command when running the kit before it is installed in a project:
29
-
30
- ```bash
31
- npx @williambeto/ai-workflow init
32
- ```
33
-
34
- ### Short alias after installation
35
-
36
- After installing AI Workflow Kit in a project, the shorter `aw` binary is available through `node_modules/.bin`:
37
-
38
- ```bash
39
- npm install -D @williambeto/ai-workflow
40
-
41
- npx aw init
42
- npx aw doctor
43
- npx aw run "Atlas, list all agents, subagents, skills, and commands in the project. Present them in a table with their name, description, and usage examples."
44
- ```
45
-
46
- The `aw` binary is an alias for the same CLI entrypoint as `ai-workflow`.
47
-
48
- The CLI receives the natural request, classifies the intent, plans the workflow, switch/creates branch safely, delegates coding tasks to the OpenCode runtime adapter, validates changes, and runs bounded remediation if necessary before outputting the handoff summary.
49
-
50
- ### Visual & Accessibility (A11y) Requirements
51
-
52
- For projects utilizing visual validation (screenshots) or accessibility audits (Axe-core), ensure you have:
53
- - `playwright` (or `@playwright/test`) and `axe-core` installed under `devDependencies`.
54
- - Browser binaries installed on the host machine by running `npx playwright install` (specifically Chromium).
55
-
56
- If these dependencies or browser binaries are missing, the visual and accessibility validations will fail gracefully with warning logs or block depending on CLI validation options.
57
-
58
- ## Modes and profiles
59
-
60
- | Mode | Use for | Primary evidence |
61
- | --- | --- | --- |
62
- | `quick` | Small, focused, low-risk work | Concise summary with targeted validation |
63
- | `standard` | Normal scoped feature or application work | Branch, changed areas, commands/results, limitations |
64
- | `full` | Broad, risky, architectural, migration, security, or release work | Independent validation and persisted evidence |
65
-
66
- Execution mode controls artifact depth; workflow profile controls domain guidance.
67
-
68
- Examples:
69
-
70
- - `frontend-product` for landing pages and public product surfaces;
71
- - `frontend-utility` for validators, search pages, forms, dashboards, and focused tools;
72
- - `backend-api`, `refactor`, `documentation`, and `security-review` for their respective domains.
73
-
74
- Profiles select relevant skills and objective checks. They do not force a fixed page structure, pricing, testimonials, or subjective visual style. See `.ai-workflow/docs/profiles/` after initialization.
75
-
76
- ## Consumer files
77
-
78
- Initialization creates the managed workflow under `.ai-workflow/` and integrates runtime-specific files where requested. Start with:
79
-
80
- - `.ai-workflow/QUICKSTART.md`
81
- - `.ai-workflow/docs/compatibility/runtime-matrix.md`
82
- - `.ai-workflow/docs/compatibility/provider-usage.md`
83
- - `.ai-workflow/AGENTS.md`
84
- - `opencode.jsonc`
85
-
86
- Optional provider adapters can also generate `CLAUDE.md`, `GEMINI.md`, and Codex agent assets.
87
-
88
- ## Documentation
89
-
90
- For full guides, tutorials, and specifications, visit the [AI Workflow Kit Documentation Website](https://ai-workflow-kit-site.pages.dev/).
91
-
92
- ### Local Consumer Files (created after `init`)
93
-
94
- When you initialize the kit in your project with `ai-workflow init`, the following guides are created locally in your `.ai-workflow/` folder:
95
-
96
- - **Getting Started**: `.ai-workflow/QUICKSTART.md`
97
- - **Architectural Policy**: `.ai-workflow/docs/architecture-policy.md`
98
- - **Design Conventions**: `.ai-workflow/docs/design-patterns-policy.md`
99
- - **Visual E2E Validation**: `.ai-workflow/docs/visual-validation-guide.md`
100
- - **Compatibility Matrix**: `.ai-workflow/docs/compatibility/runtime-matrix.md`
101
- - **Platform Governance**: `.ai-workflow/AGENTS.md`
102
-
103
- ## Statuses
104
-
105
- - `PASS`
106
- - `PASS_WITH_NOTES`
107
- - `FAIL_QUALITY_GATE`
108
- - `FAIL_DELEGATION_GATE`
109
- - `BLOCKED`
110
-
111
- The generated consumer quickstart explains the public states `COMPLETED`, `COMPLETED_WITH_NOTES`, and `BLOCKED`.
112
-
113
- ## Repository maintenance
114
-
115
- The following paths are internal implementation sources for maintainers and are not consumer paths:
116
-
117
- - `dist-assets/**` — files packaged and installed into consumers
118
- - `src/**` — CLI and runtime implementation
119
- - `internal/**` — validators, build, and release tooling
120
-
121
- Do not instruct package consumers to edit `dist-assets/**` directly.
122
-
123
- ## Compatibility
124
-
125
- OpenCode is the primary runtime. Codex and Claude Code are supported with documented limitations. Gemini CLI is experimental. Adapter generation does not guarantee identical runtime behavior.
126
-
127
- ## License
128
-
129
- [MIT](LICENSE) — © José Willams.
@@ -1,8 +0,0 @@
1
- .ai-workflow/
2
- .ai-workflow-backups/
3
- node_modules/
4
- .git/
5
- EVIDENCE.json
6
- *.tgz
7
- *.zip
8
- *.tar
@@ -1,20 +0,0 @@
1
- # Gemini Instructions — AI Workflow Kit
2
-
3
- Use AGENTS.md and the relevant contracts.
4
-
5
- ```txt
6
- readonly → Inspect → Report → Recommendation
7
- quick → Branch recovery/check → Implement → Document if behavior or usage changed → Test/Validate → Evidence
8
- standard → Mini spec → Mini review → Mini plan → Scoped PR plan → Implement → Document → Test/Validate → Evidence
9
- full → Spec draft → Spec review → Technical plan → PR breakdown → Implementation → Documentation → Test/Validate → Evidence report
10
- ```
11
-
12
- Use professional taxonomy: Primary Agents, Skill-backed Specialist Roles, Skills, Commands.
13
-
14
-
15
- ## Documentation, UI, security, and delivery artifact gates
16
-
17
- - Explicit requirements, clean code, generated specs, and inline comments do not replace documentation.
18
- - For user-facing UI, rendered or visual evidence is required when the runtime can inspect it; raw/default browser UI is `FAIL_QUALITY_GATE`.
19
- - High/Critical security findings must be classified in evidence.
20
- - Implementation work must create delivery artifacts proportional to mode: quick uses compact evidence, standard uses compact workflow artifacts, and full uses the complete 01..07 set.
@@ -1,46 +0,0 @@
1
- # Provider Usage
2
-
3
- ## OpenCode
4
-
5
- ```bash
6
- npx @williambeto/ai-workflow init --yes
7
- npx @williambeto/ai-workflow doctor
8
- ```
9
-
10
- Use `opencode.jsonc` and the generated OpenCode assets as the primary workflow interface.
11
-
12
- ## Codex
13
-
14
- ```bash
15
- npx @williambeto/ai-workflow init --yes --codex
16
- ```
17
-
18
- Review generated `.github/agents/`, `.agents/skills/`, and `.codex/prompts/`. Preserve the repository's existing `AGENTS.md`; do not assume Codex reproduces OpenCode delegation semantics.
19
-
20
- ## Claude Code
21
-
22
- ```bash
23
- npx @williambeto/ai-workflow init --yes --claude
24
- ```
25
-
26
- Review `CLAUDE.md` and `.claude/rules/`. Existing user-authored instructions must not be overwritten without backup and explicit intent.
27
-
28
- ## Gemini CLI
29
-
30
- ```bash
31
- npx @williambeto/ai-workflow init --yes --gemini
32
- ```
33
-
34
- Review `GEMINI.md` and `.gemini/`. Gemini support remains experimental until real-runtime scenario evidence is recorded.
35
-
36
- ## Antigravity
37
-
38
- ```bash
39
- npx @williambeto/ai-workflow init --yes --antigravity
40
- ```
41
-
42
- Review `ANTIGRAVITY.md` and `.agents/`. Antigravity support remains experimental until real-runtime scenario evidence is recorded.
43
-
44
- ## Multiple adapters
45
-
46
- Flags may be combined, but each generated runtime increases maintenance surface. Generate only the integrations the consumer project actually uses.
@@ -1,31 +0,0 @@
1
- # Runtime Compatibility Matrix
2
-
3
- ## Compatibility levels
4
-
5
- - **Primary:** native project target and most thoroughly exercised path.
6
- - **Supported:** generated integration and package-level smoke coverage exist; runtime limitations are documented.
7
- - **Supported with limitations:** assets are generated, but behavior is not equivalent to the primary runtime.
8
- - **Experimental:** adapter exists, but real-runtime evidence is insufficient for a stronger claim.
9
-
10
- | Runtime | Level | Generated integration | Current evidence | Known limitations |
11
- | --- | --- | --- | --- | --- |
12
- | OpenCode | Primary | `opencode.jsonc`, OpenCode agents, commands, and skills | init, doctor, package smoke, generated-file checks | Model may bypass canonical commands in direct conversation |
13
- | Codex | Supported with limitations | `.github/agents/`, `.agents/skills/`, `.codex/prompts/` | adapter/unit/structural checks and generated asset inspection | No claim of identical multi-agent execution; `.codex/` output is optional and only generated with `--codex` |
14
- | Claude Code | Supported with limitations | `CLAUDE.md`, `.claude/rules/` | adapter/unit/structural checks and generated asset inspection | Rule loading and tool permissions depend on Claude Code configuration |
15
- | Gemini CLI | Experimental | `GEMINI.md`, `.gemini/agents/`, `.gemini/skills/`, `.gemini/commands/` | adapter/unit/structural checks and generated asset inspection | Native discovery and command behavior require real Gemini CLI validation before `Supported` |
16
- | Antigravity | Supported | `ANTIGRAVITY.md`, `.agents/agents/`, `.agents/skills/`, `.agents/commands/` | unit tests, validation suite, and WSL/Desktop consumer validation | Agents are only listed under `/agents` when actively running (instantiated via `invoke_subagent`) |
17
-
18
- ## Claim policy
19
-
20
- Compatibility levels must be based on evidence available in the release. Adapter code or generated files alone are not proof of full behavioral parity.
21
-
22
- ## Promotion requirements
23
-
24
- A runtime may be promoted only after a clean consumer test records:
25
-
26
- 1. package installation;
27
- 2. `init` with the runtime flag;
28
- 3. expected generated assets;
29
- 4. runtime startup or configuration validation;
30
- 5. at least one quick workflow scenario;
31
- 6. known limitations and failures.
@@ -1,52 +0,0 @@
1
- # Antigravity Desktop System Prompt
2
-
3
- Este documento fornece as instruções de sistema (System Prompt) prontas para serem utilizadas no **Antigravity Desktop** (no Windows). Ele configura o agente desktop para carregar, entender e respeitar os contratos de agentes, comandos, habilidades (skills) e validações do **AI Workflow Kit** localizados no WSL, direcionando execuções de comandos de forma consistente e prevenindo dogfooding recursivo.
4
-
5
- ---
6
-
7
- ## Prompt de Integração
8
-
9
- Copie e cole as instruções abaixo na configuração de **System Prompt** (ou como a primeira mensagem da sessão) do seu Antigravity Desktop no Windows:
10
-
11
- ```markdown
12
- Você é o Antigravity atuando sob o protocolo do **AI Workflow Kit** configurado para este workspace. Seu objetivo é guiar o desenvolvimento de software respeitando as diretrizes, papéis e validações definidos no framework.
13
-
14
- ---
15
-
16
- ### 1. Localização do Framework
17
- O repositório do **AI Workflow Kit** está localizado no caminho de rede WSL:
18
- `\\wsl.localhost\Ubuntu\home\williambeto\Development\dev-kit`
19
-
20
- Antes de iniciar qualquer tarefa conceitual ou de implementação, leia e entenda as regras e definições contidas em:
21
- - O contrato de contribuição: [AGENTS.md](file:///wsl.localhost/Ubuntu/home/williambeto/Development/dev-kit/AGENTS.md)
22
- - Os agentes e papéis disponíveis em: `\\wsl.localhost\Ubuntu\home\williambeto\Development\dev-kit\dist-assets\agents\`
23
- - Os comandos e fluxo de trabalho em: `\\wsl.localhost\Ubuntu\home\williambeto\Development\dev-kit\dist-assets\commands\`
24
- - As habilidades (skills) de governança em: `\\wsl.localhost\Ubuntu\home\williambeto\Development\dev-kit\dist-assets\skills\`
25
-
26
- ---
27
-
28
- ### 2. Diretrizes de Comportamento e Não-Dogfooding
29
- - **Foco no Projeto Consumidor**: Você está desenvolvendo o código deste workspace específico (e não o próprio AI Workflow Kit). Use as regras de validação para garantir a qualidade do projeto atual.
30
- - **Evite Dogfooding Recursivo**: Não tente executar scripts de validação de forma aninhada ou recursiva na pasta do próprio framework `dev-kit`, a menos que seja explicitamente solicitado pelo usuário. O foco das execuções e comandos é o diretório de trabalho atual do seu workspace.
31
- - **Preservação de Estado**: Nunca altere branches protegidas (`main`/`master`) e preserve estados não rastreados que o usuário tenha deixado no repositório.
32
-
33
- ---
34
-
35
- ### 3. Execução de Comandos em Ambiente WSL
36
- Como você está rodando no Windows Host e o projeto está no WSL, sempre que precisar rodar comandos do Git, Node, ou os próprios scripts do CLI do AI Workflow Kit, execute-os através do wrapper do WSL para garantir consistência de ambiente.
37
- Exemplos de execução:
38
- - Em vez de rodar direto no CMD, use: `wsl -d Ubuntu -- npm test` ou `wsl -d Ubuntu -- npm run validate`.
39
- - Para invocar o CLI local do projeto: `wsl -d Ubuntu -- ./node_modules/.bin/ai-workflow doctor`.
40
-
41
- ---
42
-
43
- ### 4. Divisão de Papéis (Routing & Delegation)
44
- Assuma o papel correto dependendo da fase da tarefa solicitada pelo usuário:
45
- - **Nexus**: Para levantamento de requisitos, refinamento de ideias e escrita de especificações funcionais e técnicas (`SPEC.template.md`).
46
- - **Orion**: Para planejamento técnico de tarefas, criação de planos de testes e sequenciamento de Pull Requests.
47
- - **Astra**: Para a implementação de código funcional e modificação de arquivos de comportamento.
48
- - **Sage**: Para validação independente, testes de regressão e garantia de qualidade (nunca declare sucesso sem validação comprovada).
49
- - **Phoenix**: Para remediação rápida de falhas apontadas pelos validadores de qualidade.
50
-
51
- Por favor, confirme que leu os arquivos do framework no caminho indicado e que está pronto para atuar sob este protocolo.
52
- ```
@@ -1,80 +0,0 @@
1
- # Authoring Custom Skills
2
-
3
- This guide explains how to author and integrate custom, project-specific capability skills to guide AI agents working inside your repository.
4
-
5
- ---
6
-
7
- ## 1. What is a Skill?
8
-
9
- A **Skill** is a specialized folder containing structured instructions, examples, configurations, and scripts that extend an AI agent's capability for a specific task or technology.
10
-
11
- By default, the AI Workflow Kit automatically discovers skills placed inside the project configuration directory.
12
-
13
- ### Recommended Directory Structure
14
- ```text
15
- my-custom-skill/
16
- ├── SKILL.md # Primary instructions (with YAML frontmatter)
17
- ├── examples/ # Reference implementations and coding patterns (optional)
18
- ├── scripts/ # Helper validation or build scripts (optional)
19
- └── references/ # Detailed background specifications and policies (optional)
20
- ```
21
-
22
- ---
23
-
24
- ## 2. The `SKILL.md` Specification
25
-
26
- The only strictly required file is `SKILL.md`. It must contain a YAML frontmatter section at the very top, containing the skill's name and description.
27
-
28
- ```markdown
29
- ---
30
- name: security-pci-dss
31
- description: Strict guidelines for PCI-DSS compliance, credit card hashing, and secure payment processing.
32
- ---
33
-
34
- # PCI-DSS Secure Coding Skill
35
-
36
- ## Context
37
- Use this skill when implementing payment forms, logging mechanisms, or credit card handling modules.
38
-
39
- ## Non-negotiable Rules
40
- 1. **Never Log PAN:** The Primary Account Number (PAN) must never be written to application logs, crash reports, or stdout.
41
- 2. **Use Strong Encryption:** All cardholder data must be encrypted in transit (TLS 1.3) and at rest (AES-256-GCM).
42
- 3. **No Inline Card Formatting:** Use the custom secure tokenization library. Do not write custom Regex for credit card validation.
43
- ```
44
-
45
- ### Frontmatter Fields
46
- * **`name`**: The unique identifier of the skill. Agents will request this name using the `load_skill` or `load_profile` context directives.
47
- * **`description`**: A concise, search-friendly summary of the skill's purpose. The classifier uses this description to automatically match the skill to natural language developer requests.
48
-
49
- ---
50
-
51
- ## 3. Registering Your Skills
52
-
53
- The AI Workflow Kit supports two discovery mechanisms:
54
-
55
- ### Option A: Automatic Discovery (Default)
56
- Place your skill folder inside the standard project customizations root directory:
57
- * `.agents/skills/my-custom-skill/`
58
-
59
- The CLI dynamically loads and indexes all skills in this folder on initialization and execution. No manual registration is required.
60
-
61
- ### Option B: Shared Customs JSON (`skills.json`)
62
- If you store your custom skills in a shared or non-standard directory (e.g. to share them across multiple corporate microservices), create a `skills.json` file in your project customizations root:
63
-
64
- ```json
65
- {
66
- "entries": [
67
- { "path": "node_modules/@corporate/shared-skills/dist" },
68
- { "path": "infrastructure/shared-skills" }
69
- ],
70
- "exclude": ["legacy-v1-tester-skill"]
71
- }
72
- ```
73
-
74
- ---
75
-
76
- ## 4. Best Practices for Skill Design
77
-
78
- 1. **Keep Instructions Under 500 Lines:** If your skill requires extensive documentation, store the bulk in the `references/` subdirectory and link to it. Keep the primary `SKILL.md` focused on actionable rules and constraints.
79
- 2. **Prioritize Capability over Roles:** Name your skills after capabilities (e.g., `performance-tuning`, `database-migrations`) rather than roles (e.g., `tech-lead`, `senior-dev`).
80
- 3. **Add Validation Scripts:** If a skill enforces a pattern, write a small shell validator script under `scripts/validate.sh` and list it as a requirement in the `validation` section of the functional specifications.
@@ -1,117 +0,0 @@
1
- # Quickstart — 5-Minute Guide
2
-
3
- Get AI Workflow Kit running in your project in under 5 minutes.
4
-
5
- ## Prerequisites
6
-
7
- - **Node.js** ≥ 18 (LTS recommended)
8
- - **npm** ≥ 9
9
- - **Git** initialized repository
10
- - **OpenCode** runtime installed ([opencode.ai](https://opencode.ai)) — required for `aw run` and `aw execute`
11
-
12
- ## Step 1: Install
13
-
14
- ```bash
15
- npm install -g @williambeto/ai-workflow
16
- ```
17
-
18
- Verify the installation:
19
-
20
- ```bash
21
- ai-workflow doctor
22
- ```
23
-
24
- Expected output:
25
-
26
- ```
27
- ✔ ai-workflow CLI found
28
- ✔ Node.js version compatible
29
- ✔ Git repository detected
30
- ```
31
-
32
- ## Step 2: Initialize your project
33
-
34
- Navigate to your project root and run:
35
-
36
- ```bash
37
- cd your-project
38
- ai-workflow init
39
- ```
40
-
41
- This installs the workflow assets into your project:
42
-
43
- ```
44
- ✔ Created .ai-workflow/
45
- ✔ Created opencode.jsonc
46
- ✔ Updated .gitignore
47
- ✔ Installed 6 agents, 25 skills, 14 commands, 11 policies
48
- ```
49
-
50
- ### Init options
51
-
52
- | Flag | Description |
53
- | --- | --- |
54
- | `--yes` | Auto-approve all confirmations |
55
- | `--dry-run` | Preview changes without writing files |
56
- | `--profile=full` | Install with examples (default: `standard`) |
57
- | `--gemini` | Also install Gemini adapter config |
58
- | `--claude` | Also install Claude adapter config |
59
- | `--antigravity` | Also install Antigravity adapter config |
60
-
61
- ## Step 3: Make a request
62
-
63
- With OpenCode running, ask Atlas for a natural software outcome:
64
-
65
- ```bash
66
- ai-workflow execute "Add a health check endpoint to the Express API"
67
- ```
68
-
69
- Atlas will:
70
- 1. Classify the request intent
71
- 2. Select the appropriate mode (`quick`, `standard`, or `full`)
72
- 3. Create a safe branch (never writes to `main`)
73
- 4. Delegate to the right agent (e.g., Astra for implementation)
74
- 5. Run observed validation (tests, lint, build)
75
- 6. Return a structured delivery summary
76
-
77
- ## Step 4: Collect evidence
78
-
79
- After work is complete, collect validation evidence:
80
-
81
- ```bash
82
- ai-workflow collect-evidence --mode=standard
83
- ```
84
-
85
- Expected output:
86
-
87
- ```
88
- --- Delivery Summary ---
89
- Status: COMPLETED
90
- Branch: feat/health-check
91
- Changes: src/routes/health.js, tests/health.test.js
92
- Validation: npm,test: PASS
93
- Known limitations: None recorded
94
- ```
95
-
96
- ## Completion statuses
97
-
98
- | Status | Meaning |
99
- | --- | --- |
100
- | `COMPLETED` | All validation passed |
101
- | `COMPLETED_WITH_NOTES` | Passed with recorded limitations |
102
- | `BLOCKED` | Validation failed or approval missing |
103
-
104
- ## Visual & accessibility evidence
105
-
106
- If your project uses visual validation or accessibility audits, install the required dependencies:
107
-
108
- ```bash
109
- npm install -D playwright @playwright/test axe-core
110
- npx playwright install chromium
111
- ```
112
-
113
- ## Next steps
114
-
115
- - [CLI Reference](../../dist-assets/docs/cli-reference.md) — all commands, flags, and examples
116
- - [Troubleshooting](./troubleshooting.md) — common errors and FAQ
117
- - [Upgrading to v2](./upgrading-to-v2.md) — migration guide from v1
@@ -1,123 +0,0 @@
1
- # Troubleshooting
2
-
3
- Common issues, solutions, and frequently asked questions for AI Workflow Kit.
4
-
5
- ## Common Errors
6
-
7
- ### `Error: Not a git repository`
8
-
9
- **Cause:** `ai-workflow` requires a Git-initialized project directory.
10
-
11
- **Solution:**
12
- ```bash
13
- git init
14
- ai-workflow init
15
- ```
16
-
17
- ### `Error: ai-workflow must not run init inside its own repository`
18
-
19
- **Cause:** You are running `ai-workflow init` inside the AI Workflow Kit source repository itself.
20
-
21
- **Solution:** Navigate to your consumer project directory before running `init`.
22
-
23
- ### `Error: Current branch is protected (main/master)`
24
-
25
- **Cause:** The Branch Gate prevents writing directly to protected branches.
26
-
27
- **Solution:** The workflow will automatically create a feature branch. If on a dirty working tree, commit or stash changes first:
28
- ```bash
29
- git stash
30
- ai-workflow execute "your request"
31
- ```
32
-
33
- ### `Status: BLOCKED — FAIL_QUALITY_GATE`
34
-
35
- **Cause:** Validation commands (`npm test`, `npm run lint`, `npm run build`) failed.
36
-
37
- **Solution:**
38
- 1. Check the delivery summary for which command failed
39
- 2. Fix the failing tests or lint errors
40
- 3. Re-run: `ai-workflow collect-evidence --mode=standard`
41
-
42
- ### `Error: opencode not found` or `ENOENT: opencode`
43
-
44
- **Cause:** The OpenCode runtime is not installed or not in your PATH.
45
-
46
- **Solution:**
47
- 1. Install OpenCode from [opencode.ai](https://opencode.ai)
48
- 2. Verify: `which opencode`
49
- 3. If installed but not found, add it to your PATH
50
-
51
- ### `BLOCKED — Delivery decision is blocking: BLOCK_STACK_CONFLICT`
52
-
53
- **Cause:** The request asks for a framework or stack that conflicts with the existing project setup.
54
-
55
- **Solution:** Be explicit about the target stack in your request, or use the `explicitApprovals` mechanism to override.
56
-
57
- ### `Fidelity Violation: Design System token mismatch`
58
-
59
- **Cause:** CSS files with more than 200 characters of rules were detected without CSS custom properties (`var(--...)`), and the `frontend-design-system` skill is installed.
60
-
61
- **Solution:**
62
- - Add CSS custom properties to your stylesheets, or
63
- - Add explicit approval `no-css-vars` to bypass for simple/legacy stylesheets
64
-
65
- ## Frequently Asked Questions
66
-
67
- ### 1. Can I use AI Workflow Kit without OpenCode?
68
-
69
- The `init`, `doctor`, `clean`, `validate`, and `collect-evidence` commands work without OpenCode. However, `run` and `execute` require the OpenCode runtime to orchestrate agent workflows.
70
-
71
- ### 2. Does `aw init` modify my existing code?
72
-
73
- No. It only creates workflow configuration files (`.ai-workflow/`, `opencode.jsonc`, symlinks) and appends entries to `.gitignore`. Your source code is never modified by `init`.
74
-
75
- ### 3. How do I uninstall AI Workflow Kit from a project?
76
-
77
- ```bash
78
- ai-workflow clean --yes
79
- ```
80
-
81
- This removes `.ai-workflow/`, `opencode.jsonc`, `.workflow-state.json`, and the `opencode` symlink. Add `--purge-agents` to also remove `.agents/`. Use `--dry-run` to preview what will be deleted.
82
-
83
- > [!WARNING]
84
- > **Limitations:** `clean` deletes `opencode.jsonc` entirely. If you had pre-existing configurations or custom additions merged into `opencode.jsonc` before or during initialization, they will not be restored to their original state. Back up any custom `opencode.jsonc` configs before cleaning.
85
-
86
- ### 4. Which AI platforms are supported?
87
-
88
- AI Workflow Kit includes adapters for:
89
- - **Gemini** (`--gemini`)
90
- - **Claude** (`--claude`)
91
- - **Codex** (`--codex`)
92
- - **Antigravity** (`--antigravity`)
93
-
94
- ### 5. What is the difference between `standard` and `full` profiles?
95
-
96
- | Feature | `standard` | `full` |
97
- | --- | --- | --- |
98
- | Agents, skills, commands, policies | ✅ | ✅ |
99
- | Example specs and templates | ❌ | ✅ |
100
- | Default | ✅ | ❌ |
101
-
102
- ### 6. Can agents push directly to `main`?
103
-
104
- No. The Branch Gate policy enforces that all write operations happen on feature branches (`feat/*`, `fix/*`, `chore/*`, `docs/*`). Direct pushes to `main` or `master` are blocked.
105
-
106
- ### 7. How do I update to a newer version?
107
-
108
- ```bash
109
- npm install -g @williambeto/ai-workflow@latest
110
- ai-workflow init --force
111
- ```
112
-
113
- See [Upgrading to v2](./upgrading-to-v2.md) for detailed migration instructions.
114
-
115
- ## Reporting Issues
116
-
117
- - **Security vulnerabilities:** Follow the process in [SECURITY.md](../../.github/SECURITY.md)
118
- - **Bug reports:** Open an issue in the project's GitHub repository with:
119
- - AI Workflow Kit version (`ai-workflow --version`)
120
- - Node.js version (`node --version`)
121
- - Operating system
122
- - Steps to reproduce
123
- - Expected vs actual behavior
@@ -1,62 +0,0 @@
1
- # Upgrading to version 2
2
-
3
- Version `2.x` is a breaking public line from the previous `1.x` line. Test upgrades in a disposable or non-critical consumer before replacing an existing installation.
4
-
5
- ## Upgrade path
6
-
7
- 1. Record the installed version and back up project-level runtime files.
8
- 2. Remove the global package when applicable:
9
-
10
- ```bash
11
- npm uninstall -g @williambeto/ai-workflow
12
- ```
13
-
14
- 3. Install the current public release:
15
-
16
- ```bash
17
- npm install -g @williambeto/ai-workflow@latest
18
- ```
19
-
20
- 4. Inspect initialization before applying it:
21
-
22
- For first-time or pre-installation usage:
23
- ```bash
24
- npx @williambeto/ai-workflow init --dry-run
25
- npx @williambeto/ai-workflow init --yes
26
- ```
27
-
28
- After installing AI Workflow Kit locally in your project:
29
- ```bash
30
- npx aw init --dry-run
31
- npx aw init --yes
32
- npx aw doctor
33
- ```
34
-
35
- ## Main changes in version 2
36
-
37
- - OpenCode-first runtime with six primary ownership roles.
38
- - Proportional `quick`, `standard`, and `full` modes.
39
- - Observed validation, false-success prevention, and bounded remediation.
40
- - Concise quick/standard summaries without mandatory owner JSON, fixed delivery filenames, or `EVIDENCE.json`.
41
- - Full/release/audit/security workflows may persist structured evidence when traceability is required.
42
- - Semantic Product Truthfulness guidance without keyword-only enforcement.
43
- - Consumer files managed under `.ai-workflow/`.
44
- - Optional Codex, Claude Code, and Gemini adapter assets with documented limitations.
45
-
46
- ## Breaking changes
47
-
48
- - Generated assets and configuration may differ substantially from `1.x`.
49
- - Legacy paths, taxonomies, aliases, and obsolete documentation are not retained as active sources.
50
- - Consumer-managed files should be reviewed before accepting initialization changes.
51
- - Direct prompts and provider behavior remain subject to the documented known limitations.
52
-
53
- ## Rollback
54
-
55
- If you need to return to the previous public line during migration testing, install the known `1.x` version explicitly:
56
-
57
- ```bash
58
- npm uninstall -g @williambeto/ai-workflow
59
- npm install -g @williambeto/ai-workflow@1.19.1
60
- ```
61
-
62
- Restore backed-up project files when initialization changed consumer integrations.
@@ -1,4 +0,0 @@
1
- export { GeminiAdapter } from "./platforms/gemini.js";
2
- export { ClaudeAdapter } from "./platforms/claude.js";
3
- export { CodexAdapter } from "./platforms/codex.js";
4
- export { AntigravityAdapter } from "./platforms/antigravity.js";