Skip to main content

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.md and skills under .agents/skills/, readable directly by Cursor, Codex, Cline, Zed, OpenCode, and other standard-compliant agents.
  • A mandatory Spec Loop covering grilling, durable specs, tracer-bullet tickets, implementation, TDD, diagnosis, two-axis review, and architecture cleanup.
  • A lean Default Set: the Spec Loop plus the project’s own architecture and requirements skeletons. Every Enhancement is off by default.
  • 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.md that 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.json only when a selected Enhancement needs it.
  • A generated .env of 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.json stamp recording immutable Base Provenance and current Overlay Currency.

The development workflow you get

Every project carries one method its agent reads from AGENTS.md: grill the request against the project’s own architecture and requirements documents, write a durable spec you approve, cut it into tracer-bullet tickets with declared file footprints, then implement 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

--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; --development-loop names the mandatory loop and --agents independently selects Agent Targets. --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 development loop is always generated
Security security-audit
Quality react-doctor, webapp-testing
Design 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.

License

MIT. Generated projects include third-party content; see THIRD_PARTY_NOTICES.md.

Metadata

Release files for dev-ready 0.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dev-ready 0.10.1
File Size Uploaded Provenance Actions
dev_ready-0.10.1.tar.gz 519.8 kB With provenance Details for dev_ready-0.10.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for dev-ready 0.10.1
File Interpreter ABI Platform Actions
dev_ready-0.10.1-py3-none-any.whl Python 3 none any Details for dev_ready-0.10.1-py3-none-any.whl

Total release size: 727.4 kB

Release files / dev_ready-0.10.1.tar.gz

Download URL dev_ready-0.10.1.tar.gz
Size 519.8 kB
Tags Source
SHA-256 checksum
How to use checksums
d49ff057b5480a413b202c9cfdc9eab84c0f645e3ca0b11839926aefb65838ec
BLAKE2b-256 checksum
How to use checksums
804ea135e4d93998d28a006df55dc124e3b977514117927281c36c04c1000574
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.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 11, 2026.

Transparency log

Release files / dev_ready-0.10.1-py3-none-any.whl

Download URL dev_ready-0.10.1-py3-none-any.whl
Size 207.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a5a7515300e85ec094eb5809fd14c6f01a588de2579667f1c140f0575e6bf022
BLAKE2b-256 checksum
How to use checksums
e8f79fec2a55e4591356b634c258578caa0a680200b0e34147ecfe071b0a1cea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.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 11, 2026.

Transparency log

Security for dev-ready 0.10.1

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.

Select from 2 files

Attestation for dev_ready-0.10.1.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 11, 2026.

Transparency log

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page