Generate runnable AI agent projects from markdown specs in the agent-deployments repo.
Project description
agent-scaffold
agent-scaffold generates runnable AI agent projects from markdown specs. It fetches the agent-deployments catalog at runtime (one URL hardcoded, overridable via --catalog-url) and falls back to an embedded snapshot when offline — pick a recipe, target language, and framework, and the CLI assembles the relevant docs, asks Claude to emit a complete project, validates the response, and writes the files atomically into your destination of choice.
The three-repo ecosystem
agent-blueprints and agent-deployments are the two arms that feed this CLI — the engine that composes a selection into a real, running agent:
agent-blueprints ──────────┐
(design core) │
kernel · patterns · IR ├──> agent-scaffold ──> running agent
│ (composition (code + server,
agent-deployments ─────────┘ engine) live)
(verified options)
adapters · recipes · catalog
- agent-blueprints — the design core: the kernel, framework-agnostic patterns at five levels, and the spec/IR a selection compiles to. What the agent is and how it's shaped.
- agent-deployments — the verified options: a port-typed registry of vetted adapters and production-shaped recipes, indexed by
catalog.yaml. Which concrete options realize each port. - agent-scaffold (this repo) — the composition engine: validates a selection, binds each port to a deployments option, and emits a complete, running project.
Install
The package is published on PyPI as agent-scaffold-cli and installs two equivalent binaries: agent-scaffold (long form) and scaffold (short, claude-style). Bare scaffold (no subcommand) drops you straight into the interactive REPL.
One-line install (recommended). Installs the CLI, adds it to your PATH, and offers to store your Anthropic key:
curl -fsSL https://raw.githubusercontent.com/jagguvarma15/agent-scaffold/main/install.sh | sh
Or install manually. A plain pip install can't put the binaries on your PATH (wheels run no code at install time), so use pipx/uv tool and run their one-time PATH step:
pipx install agent-scaffold-cli && pipx ensurepath
# or
uv tool install agent-scaffold-cli && uv tool update-shell
# or, for one-off use (no install, no PATH change):
uvx --from agent-scaffold-cli scaffold --help
Either way, restart your shell afterward, then store your Anthropic key once with scaffold auth login (the one-line installer prompts for it during setup). scaffold won't start without a key.
Quickstart
export ANTHROPIC_API_KEY=sk-ant-...
agent-scaffold scaffold # interactive shell — recommended
# or, one-shot:
agent-scaffold new
By default the interactive flow chains generation into a running stack: install deps, start docker, run migrations, seed data, launch the frontend, open the browser. See the quickstart guide for the full lifecycle and its escape hatches.
Documentation
The full manual lives at jagguvarma15.github.io/agent-scaffold:
- Installation and quickstart
- Interactive shell — slash commands, free-text refinement, the
/newwizard - Configuration — env vars, TOML fallback, effort presets
- Project lifecycle —
up,update,down,logs,eval - CLI reference and REPL reference
- Recipe format — frontmatter, dependencies, external services
- Credentials and the security model
- Troubleshooting
Contributor docs stay in the repo: CONTRIBUTING.md, SECURITY.md, CHANGELOG.md.
Local development
git clone https://github.com/jagguvarma15/agent-scaffold
cd agent-scaffold
uv sync
make install-dev # exposes `scaffold` + `agent-scaffold` on PATH (editable)
License
MIT (see LICENSE).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agent_scaffold_cli-0.4.576.tar.gz.
File metadata
- Download URL: agent_scaffold_cli-0.4.576.tar.gz
- Upload date:
- Size: 944.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4d80a1f48b2fff0d3b500dbdbd74f53fd723dfc76c479a6e2b19e0771941d31d
|
|
| MD5 |
8f4fcf107007549c254670cd93e56dbf
|
|
| BLAKE2b-256 |
061dc1558d801cbc367d7f4429bdc307cad57f1a998d1f8a5ace6ccd4f07cef2
|
Provenance
The following attestation bundles were made for agent_scaffold_cli-0.4.576.tar.gz:
Publisher:
publish.yml on jagguvarma15/agent-scaffold
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
agent_scaffold_cli-0.4.576.tar.gz -
Subject digest:
4d80a1f48b2fff0d3b500dbdbd74f53fd723dfc76c479a6e2b19e0771941d31d - Sigstore transparency entry: 2213699212
- Sigstore integration time:
-
Permalink:
jagguvarma15/agent-scaffold@4ad52c2b0863ee4b99a833a7573008e9df2d1216 -
Branch / Tag:
refs/tags/v0.4.576 - Owner: https://github.com/jagguvarma15
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@4ad52c2b0863ee4b99a833a7573008e9df2d1216 -
Trigger Event:
release
-
Statement type:
File details
Details for the file agent_scaffold_cli-0.4.576-py3-none-any.whl.
File metadata
- Download URL: agent_scaffold_cli-0.4.576-py3-none-any.whl
- Upload date:
- Size: 518.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
424709819350a7ee58a980f8d300afe5e67fea1bef9438dbf8d2847551947c07
|
|
| MD5 |
df5963ff29955c87e7e4728086b55bf3
|
|
| BLAKE2b-256 |
f2aef32b75d220a0f7efc0a40e322d9c3ad9135783fe0fc7c714dcce36af5255
|
Provenance
The following attestation bundles were made for agent_scaffold_cli-0.4.576-py3-none-any.whl:
Publisher:
publish.yml on jagguvarma15/agent-scaffold
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
agent_scaffold_cli-0.4.576-py3-none-any.whl -
Subject digest:
424709819350a7ee58a980f8d300afe5e67fea1bef9438dbf8d2847551947c07 - Sigstore transparency entry: 2213699365
- Sigstore integration time:
-
Permalink:
jagguvarma15/agent-scaffold@4ad52c2b0863ee4b99a833a7573008e9df2d1216 -
Branch / Tag:
refs/tags/v0.4.576 - Owner: https://github.com/jagguvarma15
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@4ad52c2b0863ee4b99a833a7573008e9df2d1216 -
Trigger Event:
release
-
Statement type: