dev-ready
繁體中文導覽:https://github.com/MoofonLi/dev-ready/blob/main/README.zh-TW.md
Scaffold a production-grade, AI-development-ready FastAPI + React project in one command:
uvx dev-ready init my-app
The upstream template is pinned to a CI-verified commit, never an untested “latest.” Generation is all-or-nothing: failures never expose a partial target.
What you get
A generated project based on fastapi/full-stack-fastapi-template (FastAPI, React, SQLModel, PostgreSQL, and Docker Compose), plus:
- Canonical project instructions in
AGENTS.mdand skills under.agents/skills/, readable directly by Cursor, Codex, Cline, Zed, OpenCode, and other standard-compliant agents. - A named Engineering Flow, chosen first — today Matt Pocock’s — covering grilling, durable specs, tracer-bullet tickets, implementation, TDD, diagnosis, two-axis review, and architecture cleanup.
- A lean Default Set: that Engineering Flow plus the project’s own architecture and requirements skeletons. Every Enhancement is off by default.
- A setup step in every project, so the login, email, and error reporting can
be configured without reading
.envby hand. - Optional Enhancements selected through Dev, Security, Quality, Design, and Token Optimize Categories. A selected Enhancement adds its guidance inside the loop step that acts on it.
- An
AGENTS.mdthat is the project’s standards source: its stack, the exact test, lint, format, and type-check commands, and the rules no tool enforces. - Optional Agent Targets. dev-ready declares one for every coding agent that its pinned reference list gives a project-level directory of its own, held to that list by CI. Each selected target is rendered as Pointer Stubs over the one Canonical Content copy—not symbolic links or content copies.
- Project-level
.mcp.jsononly when a selected Enhancement needs it. - A generated
.envof per-project random secrets that git ignores, and a project that tells you its default administrator login and where that password lives. - A
.dev-ready.jsonstamp recording immutable Base Provenance and current Overlay Currency.
The development workflow you get
Every project is built around a named Engineering Flow. setup-project
configures the login and email first, then the agent grills the request against
the project’s own architecture and requirements documents, writes a durable spec
you approve, cuts it into tracer-bullet tickets with declared file footprints,
and implements one ticket at a time test-first, ending in a review against both
the project’s standards and the spec. Each step leaves a committed artifact
behind. Full description:
https://github.com/MoofonLi/dev-ready#the-development-workflow-you-get.
Requirements
- Python 3.12 or newer
- git
- Network access to github.com during generation
- Docker only to run the generated project, not to generate it
Installation
No installation is needed with uv:
uvx dev-ready init my-app
Or install with pip:
pip install dev-ready
dev-ready init my-app
Install the agent skill
npx skills add MoofonLi/dev-ready --skill dev-ready
The source is skills/dev-ready/SKILL.md. Inspect the repository’s discoverable skills before installing with:
npx skills add MoofonLi/dev-ready --list
The skill resolves Category selections, runs one non-interactive initialization command, and verifies the generated stamp.
Then ask your agent: “Scaffold a FastAPI project with dev-ready named my-app.”
For installation or generation problems, open an issue.
Usage
uvx dev-ready init
uvx dev-ready init my-app --yes
uvx dev-ready init my-app --yes --categories dev,token-optimize --dev none --token-optimize caveman,code-memory --agents claude,windsurf
Interactive init asks the Engineering Flow first, then each optional
Category, then Agent Targets. Enter through all of them gives the Default Set.
--yes accepts the lean Default Set. Use --categories all for every
Enhancement. Category selection accepts all, none, or comma-separated
identifiers through --categories, --dev, --security, --quality,
--design, and --token-optimize; --flow names the mandatory Engineering
Flow (currently mattpocock) and --agents independently selects Agent
Targets. --development-loop is a permanently accepted alias for --flow. --agents defaults to claude,
as does --yes; --agents all selects every declared target and writes a
great many Pointer Stub files.
| Category | Enhancement identifiers |
|---|---|
| Dev | none currently; the Engineering Flow is always generated |
| Security | security-audit |
| Quality | react-doctor, webapp-testing |
| Design | comma-separated ids, all, or none (e.g. frontend-design, design-stripe, design-linear) |
| Token Optimize | caveman, code-memory |
The previous Component-shaped flags (--skills, --no-skills, --mcp,
--no-mcp, and --no-docs) now exit 2 and name their Category-shaped
replacement. --no-handoff and --no-agents exit 2 because the generated
Handoff Protocol was removed.
uvx dev-ready check path/to/project
uvx dev-ready check path/to/project --json
uvx dev-ready upgrade path/to/project --dry-run
uvx dev-ready upgrade path/to/project
check is read-only and offline. upgrade preserves immutable Base Provenance
and upstream application content while advancing Overlay Currency. A v0.8
project migrates to stamp version 5 without new input: untouched retired managed
files are deleted transactionally, edited files are preserved and reported,
failures roll back, and a repeat upgrade is a no-op.
During init, stderr reports fetch → overlay → verify → finalize progress;
stdout retains the final report. Finalization uses a same-filesystem atomic
directory rename, so failure never exposes a partial target.
Exit codes: 0 success; 1 unexpected error or user abort; 2 invalid arguments; 3 network/fetch failure; 4 target conflict; 5 structural verification failure; 6 stamp missing or invalid; 7 drift detected; 8 pre-v3 upgrade unsupported; 9 upgrade failed and rolled back.
Links
- Source and issues: https://github.com/MoofonLi/dev-ready
- CLI spec, architecture, and ADRs: https://github.com/MoofonLi/dev-ready/tree/main/docs
- v0.11 overview: https://github.com/MoofonLi/dev-ready/blob/main/docs/version_overview/v0.11-overview.md
License
MIT. Generated projects include third-party content; see THIRD_PARTY_NOTICES.md.
Metadata
Release files for dev-ready 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dev_ready-0.11.0.tar.gz | 1.2 MB | With provenance | Details for dev_ready-0.11.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| dev_ready-0.11.0-py3-none-any.whl | Python 3 | none | any | Details for dev_ready-0.11.0-py3-none-any.whl |
Total release size: 2.0 MB
Release files / dev_ready-0.11.0.tar.gz
| Download URL | dev_ready-0.11.0.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
71e72b6a3f36587859b807d584bc07d85cfa4574de8f1a1087ea8281bd37d3a3
|
|
BLAKE2b-256 checksum How to use checksums |
12ff2e022cd17fe6d7160dff5037655a93eeaa5d5f8ce2d66b3f75adff6b0b6f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.
Transparency logRelease files / dev_ready-0.11.0-py3-none-any.whl
| Download URL | dev_ready-0.11.0-py3-none-any.whl |
|---|---|
| Size | 878.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ba9990546e85dcdcb82ff198b8f62811ea6d135918fd738df49b7e1ab536ddf3
|
|
BLAKE2b-256 checksum How to use checksums |
a724643522ba94cb578be00f32097f80663ddb32c391b894a69ec647ce2109f0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.
Transparency logSecurity for dev-ready 0.11.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for dev_ready-0.11.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.