@lajin.m/ai-scaffold
v0.11.0
Published
Reusable AI engineering scaffold with CLI distribution
Maintainers
Readme
AI Scaffold Platform Documentation
Purpose
AI Scaffold is a reusable AI engineering scaffold and CLI platform published as @lajin.m/ai-scaffold with the ais command. It provides:
- Governance rules for AI-assisted delivery.
- Agent and command prompts for planning, architecture, review, QA, and release workflows.
- Template profiles for new or existing application repositories.
- CLI commands for creating, installing, diagnosing, and eventually updating scaffold-managed files.
Documentation Split
This file documents the scaffold platform itself. Generated projects receive their own README.md from the active profile's README.template.md during CLI installation.
| Documentation | Source | Output |
|---|---|---|
| Scaffold platform README | README.md | Repo root |
| Detailed scaffold docs | README.scaffold.md | Repo root |
| Generated project README | templates/<profile>/README.template.md | Target README.md |
Release Checklist
Before promoting a CLI release:
- Confirm the worktree contains only intended tracked changes.
- Run
npm test. - Run
npm run typecheck. - Create a temporary project with
node bin/ai-scaffold.js create <tmp> --yes. - Run
node bin/ai-scaffold.js doctor <tmp>. - Confirm generated files include
.ai-scaffold.json,.claude/MEMORY.md,.claude/settings-overrides.json, andREADME.md. - Confirm generated project README content has no unresolved project identity placeholders.
- Update docs/compliance/third-party-attributions.md when dependencies, adapted materials, snippets, or templates are added.
Template Hygiene
- Do not commit generated local files such as
.claude/MEMORY.mdor.claude/settings-overrides.json. - Do not put generated project placeholder content in the scaffold platform
README.md. - Keep template README content in
README.template.md. - Keep attribution, license, and source-origin records current.
