Skip to main content

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:

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_scaffold_cli-0.4.576.tar.gz (944.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agent_scaffold_cli-0.4.576-py3-none-any.whl (518.0 kB view details)

Uploaded Python 3

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

Hashes for agent_scaffold_cli-0.4.576.tar.gz
Algorithm Hash digest
SHA256 4d80a1f48b2fff0d3b500dbdbd74f53fd723dfc76c479a6e2b19e0771941d31d
MD5 8f4fcf107007549c254670cd93e56dbf
BLAKE2b-256 061dc1558d801cbc367d7f4429bdc307cad57f1a998d1f8a5ace6ccd4f07cef2

See more details on using hashes here.

Provenance

The following attestation bundles were made for agent_scaffold_cli-0.4.576.tar.gz:

Publisher: publish.yml on jagguvarma15/agent-scaffold

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file agent_scaffold_cli-0.4.576-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_scaffold_cli-0.4.576-py3-none-any.whl
Algorithm Hash digest
SHA256 424709819350a7ee58a980f8d300afe5e67fea1bef9438dbf8d2847551947c07
MD5 df5963ff29955c87e7e4728086b55bf3
BLAKE2b-256 f2aef32b75d220a0f7efc0a40e322d9c3ad9135783fe0fc7c714dcce36af5255

See more details on using hashes here.

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

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page