README
¶
Seed
A tiny CLI scaffolding tool that "seeds" a directory with a useful set of documentation files (human and agent-friendly) and other minimally opinionated structures to support a proof-of-concept build.
Quick start
curl -fsSL https://raw.githubusercontent.com/justinphilpott/seed/main/install.sh | sh && export PATH="$HOME/.local/bin:$PATH" && seed myproject
What you get
- Agent-ready docs — AGENTS.md, TODO.md, DECISIONS.md, LEARNINGS.md pre-wired for AI-assisted development
- Optional dev container — language-specific base image with
ghCLI (via devcontainer feature), authenticated via host token - AI chat continuity — setup script persists conversation context across container rebuilds
- Agent skills — reusable markdown procedures (
doc-health-check,entropy-guard, ...) installed intoskills/ - No bloat — just enough structure to grow into
myproject/
├── README.md Human entry point — what this project is and how to run it
├── AGENTS.md Context and constraints for AI agents working in the repo
├── DECISIONS.md Lightweight architectural decision log
├── TODO.md Active work items and next steps
├── LEARNINGS.md Validated discoveries worth preserving
├── .gitignore Git ignore rules (language-aware)
├── .editorconfig Editor formatting defaults
├── LICENSE Open-source license (optional)
├── skills/ Reusable agent skill files
├── .vscode/ (optional, with devcontainer + extensions)
│ └── extensions.json Prompts VS Code to install recommended extensions
└── .devcontainer/ (optional)
├── Dockerfile Language-specific base image
├── devcontainer.json
└── setup.sh AI chat continuity (optional, with chat continuity)
Every file is a starting point, not a finished document. Fill them in as you build.
Install
Quick install (Linux/macOS)
curl -fsSL https://raw.githubusercontent.com/justinphilpott/seed/main/install.sh | sh && export PATH="$HOME/.local/bin:$PATH"
Install to a custom directory:
curl -fsSL https://raw.githubusercontent.com/justinphilpott/seed/main/install.sh | INSTALL_DIR=/usr/local/bin sh
From source
go install github.com/justinphilpott/seed@latest
From release binaries
Download the binary for your platform from GitHub Releases, then:
chmod +x seed-linux-amd64
mv seed-linux-amd64 ~/.local/bin/seed
seed --version
Available binaries: linux-amd64, linux-arm64, darwin-amd64, darwin-arm64, windows-amd64.
Usage
seed myproject # Scaffold a new project
seed ~/dev/myapp # Absolute paths work too
seed . # Use current directory (prompts if non-empty)
Dev containers
Pick a language stack during the wizard and Seed generates a .devcontainer/ config using Microsoft Container Registry base images. gh CLI is included via a devcontainer feature and authenticated via your host token — before opening the container, run:
export GH_TOKEN=$(gh auth token)
If you enable AI chat continuity, a setup script auto-detects Claude Code and Codex and wires up conversation persistence so you keep your context across container rebuilds.
Skills
Skills are markdown files that define reusable procedures your AI agent can follow. They are installed automatically into skills/ when you scaffold a project.
Currently ships with:
doc-health-check— an audit that reviews your project's documentation coverage and flags gapsentropy-guard— checks that docs remain coherent and self-consistent before committingseed-ux-eval— first-5-minutes evaluation of scaffolding quality from a fresh agent's perspectiveseed-feedback— an optional channel for agents to submit suggestions back to seed when they notice gaps in the scaffolding
Contributing
See CONTRIBUTING.md for development setup, architecture, and how to extend seed.
License
MIT — see LICENSE for details.
Documentation
¶
There is no documentation for this package.