Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@williambeto/ai-workflow) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

AI Workflow Kit

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.

The central promise is:

"Transform a natural language request into a proportionate, safe, and verifiable software delivery."

The workflow the product guarantees is:

Request: Understand the actual request.
Planning: Select the execution mode and workflow profile.
Branch Gate: Never implement directly on main/master.
Delegation: Atlas routes; Astra implements; Sage validates when appropriate; Phoenix remediates within a defined limit.
Implementation: Deliver useful code, not just reports.
Validation: Run observed validations and relevant tests, blocking false success.
Evidence: Summarize changes, validations, and limitations.

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.

Installation

Current public release

npm install -g @williambeto/ai-workflow@latest

Use latest for the supported public release. Release notes record exact historical versions when needed.

Quick start

mkdir workflow-test && cd workflow-test
npm init -y
ai-workflow init --yes
ai-workflow doctor
ai-workflow execute "Atlas, list all agents, subagents, skills, and commands in the project. Present them in a table with their name, description, and usage examples."

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.

Modes and profiles

Mode	Use for	Primary evidence
`quick`	Small, focused, low-risk work	Concise summary with targeted validation
`standard`	Normal scoped feature or application work	Branch, changed areas, commands/results, limitations
`full`	Broad, risky, architectural, migration, security, or release work	Independent validation and persisted evidence

Execution mode controls artifact depth; workflow profile controls domain guidance.

Examples:

frontend-product for landing pages and public product surfaces;
frontend-utility for validators, search pages, forms, dashboards, and focused tools;
backend-api, refactor, documentation, and security-review for their respective domains.

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.

Consumer files

Initialization creates the managed workflow under .ai-workflow/ and integrates runtime-specific files where requested. Start with:

.ai-workflow/QUICKSTART.md
.ai-workflow/docs/compatibility/runtime-matrix.md
.ai-workflow/docs/compatibility/provider-usage.md
.ai-workflow/AGENTS.md
opencode.jsonc

Optional provider adapters can also generate CLAUDE.md, GEMINI.md, and Codex agent assets.

Documentation

For full guides, tutorials, and specifications, visit the AI Workflow Kit Documentation Website.

Local Consumer Files (created after `init`)

When you initialize the kit in your project with ai-workflow init, the following guides are created locally in your .ai-workflow/ folder:

Getting Started: .ai-workflow/QUICKSTART.md
Architectural Policy: .ai-workflow/docs/architecture-policy.md
Design Conventions: .ai-workflow/docs/design-patterns-policy.md
Visual E2E Validation: .ai-workflow/docs/visual-validation-guide.md
Compatibility Matrix: .ai-workflow/docs/compatibility/runtime-matrix.md
Platform Governance: .ai-workflow/AGENTS.md

Statuses

PASS
PASS_WITH_NOTES
FAIL_QUALITY_GATE
FAIL_DELEGATION_GATE
BLOCKED

The generated consumer quickstart explains the public states COMPLETED, COMPLETED_WITH_NOTES, and BLOCKED.

Repository maintenance

The following paths are internal implementation sources for maintainers and are not consumer paths:

dist-assets/** — files packaged and installed into consumers
src/** — CLI and runtime implementation
internal/** — validators, build, and release tooling

Do not instruct package consumers to edit dist-assets/** directly.

Compatibility

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.

@williambeto/ai-workflow