create-ai-workflow
v0.1.4
Published
Scaffold the agent-driven development workflow into a project
Downloads
497
Readme
AI Workflow Scaffold
A language-agnostic scaffold for an agent-driven development workflow. Copy these files into any new project (TypeScript, Python, anything else) and run the same ticket → spec → branch → PR → review → merge loop on every change.
This scaffold has no application code. It ships the workflow rules, the agent skills, the pull-request template, the secret scan, and example artifacts in the exact formats the workflow produces.
Quick start
Run the scaffold inside your project directory:
npx create-ai-workflowThis copies AGENTS.md, CONTEXT.md, the examples/ artifacts, the .github/ workflow and
PR template, and skills-lock.json, creates the .plan/ structure, excludes
.plan/ from git, and installs the skills for the universal and Claude Code
agents.
Usage:
npx create-ai-workflow [target-dir] [options]Options:
[target-dir]— directory to scaffold into. Defaults to the current directory. Example:npx create-ai-workflow ./my-project.--force— overwrite existing files (AGENTS.md,CONTEXT.md,examples/, etc.) if they already exist.--no-skills— skip installing skills withnpx skillsand do not copyskills-lock.json. Useful if you manage skills manually.--no-git— do not touch.git/info/exclude..plan/will not be auto-excluded.--no-examples/--without-examples— do not copy theexamples/folder.--agent <universal|claude|both>— which agent surface to install skills for. Default isboth. Also supports--agent=universal.-y/--yes— skip confirmation prompts when installing skills (passed through tonpx skills add).
Examples:
npx create-ai-workflow # scaffold into current directory
npx create-ai-workflow ./my-project # scaffold into a new folder
npx create-ai-workflow --force # overwrite existing scaffold files
npx create-ai-workflow --agent universal --no-examples # minimal install
npx create-ai-workflow --no-skills --no-git -y # copy files onlyThe workflow at a glance
- Spec. When an idea or issue needs shaping,
/to-specturns the conversation into a spec under.plan/spec/<branch>/<NN>-<summary>.mdwhere<branch>is the current branch with/replaced by-and<NN>is a zero-padded sequence per branch. - Tickets.
/to-ticketsbreaks the spec into one ticket per file under.plan/tickets/<branch>/<NN>-<summary>/, each declaring what to build and what it is blocked by. - Branch + implementation. Create a branch named after the ticket
(for example
feat/PF-12-api-contract), implement, and keep the PR focused on one result. - Pull request. Write the PR body under
.plan/pull-requests/<branch-with-hyphens>.mdfollowing.github/pull_request_template.md. Proof of execution is mandatory. - Review. Reviewer comments go under
.plan/review-replies/<branch>/with one numbered file per review round. Reply in the reserved sections once the resolving ticket is implemented. - Merge. Merge only after checks, review approval and the agreed merge authorization.
Planning artifacts stay local: .plan/ and AGENTS.md are not part of the
codebase and are not committed. Everything an agent may read or write inside
.plan/ is defined in AGENTS.md; the examples/ folder ships the exact
formats.
Skills
The skills the workflow relies on are installed and managed with the
Skills CLI (npx skills). They are committed in
.agents/skills/ (universal format) and symlinked under .claude/skills/ for
Claude Code, so anyone who clones this repo has them. skills-lock.json
records each skill's source and pinned version, and npx skills update
refreshes them.
| Skill | Purpose |
|---|---|
| to-spec | Turn the current conversation into a spec |
| to-tickets | Break a plan or spec into tickets declaring their blocking edges |
| unslop | Remove AI writing patterns from human-facing text |
| code-review | Review changes since a fixed point along standards and spec |
| codebase-design | Design and deepen module interfaces |
| domain-modeling | Build and sharpen a project's domain model |
| find-skills | Discover and install additional agent skills |
| grill-with-docs | Stress-test a plan while recording ADRs and a glossary |
| grilling | Grill the user about a plan, decision, or idea |
| implement | Implement a piece of work from a spec or tickets |
| improve-codebase-architecture | Scan for deepening opportunities and grill through them |
| tdd | Test-driven development |
Managing the skills
Install, update, or add skills from this project's root:
npx skills add <owner/repo@skill> # add a skill (installs into .agents/skills)
npx skills update # refresh installed skills from the lock file
npx skills find <query> # search the ecosystemThe installed skills come from mattpocock/skills, vercel-labs/skills,
and poteto/noodle. skills-lock.json pins what is installed, so a clone
gets the same versions and npx skills update bumps them in one go.
Bootstrapping a new project
The scaffold itself is a template you run with
create-ai-workflow. To set up a project without the CLI,
copy the files manually:
Copy the scaffold into the new project directory (or use it as a GitHub template).
Keep
AGENTS.mdand create the local planning structure:mkdir -p .plan/tickets .plan/spec .plan/pull-requests .plan/review-replies .plan/incoming-prs .plan/outgoing-reviews .plan/blogIf you keep
AGENTS.mdand.plan/out of git, exclude them from version control (for example in.git/info/exclude). Do not commit planning artifacts as product code. Theexamples/folder shows the exact formats these artifacts use.Add your CI workflow(s) under
.github/workflows/. Thesecret-scanworkflow is included and runs gitleaks on pushes and pull requests.Write the team conventions (branch naming, who merges, definition of done) where your team reads them.
AGENTS.mdalready pins the agent-side workflow.Start with
/to-spec, then/to-tickets, then pick a ticket and create your branch.
Skills ship with the repo. If you only copied the workflow files, not the
skill folders, run npx skills add for each skill in the
Skills section. skills-lock.json lists the exact sources. The
create-ai-workflow CLI does all of this for you.
Structure
package.json npm package: npx create-ai-workflow
bin/
create-ai-workflow.mjs CLI that scaffolds the workflow into a project
AGENTS.md Agent workflow rules (tickets, specs, PR bodies, review replies)
CONTEXT.md Domain glossary template (local-only, maintained by domain-modeling)
.github/
pull_request_template.md Pull request body format
workflows/
secret-scan.yml Gitleaks secret scan
.agents/skills/ Skills, universal format, managed via npx (12)
.claude/skills/ Symlinks to .agents/skills for Claude Code
skills-lock.json Pinned skill sources and versions
examples/ Example artifacts showing the exact formats
tickets/ One ticket per file
spec/ Spec format
pull-requests/ PR body format
review-replies/ Review iteration format
blog/ Blog draft template and sample
.plan/ Local-only planning artifacts (not committed)
tickets/
spec/
pull-requests/
review-replies/
incoming-prs/
outgoing-reviews/
blog/Contributing to this scaffold
If the workflow changes, update AGENTS.md, the PR template and the example
artifacts together, then refresh the skills with npx skills update. Apply
the unslop skill to any human-facing text.
