dev

Make it yours

Adapt the seed to your project, from a working installation (Get started). Each step links to the pages that detail it; the Glossary defines the terms. Paths are relative to the host project root; run Task commands there.

1. Replace the application

Replace workspace/src/ with your code. The seed ships the autograph documentation site, a sample Rust API, and a design-system playground. The project layout shows where each part lives and its access level.

2. Adapt containers and tasks

Update workspace/infra/compose.yaml and the Dockerfiles under workspace/infra/docker/. Keep workspace/infra/compose.v1.yaml aligned if you support Compose v1 (Compose runtimes). Adapt Taskfile.d/apps/, included as app by the root Taskfile.yaml, then run task app:start. Use task app:rebuild for a clean image rebuild; Basic tools and practices gives the command for each kind of change.

Behind a corporate network, keep the proxy build arguments of compose.yaml and the CA copy of the app tasks: see Corporate proxy and Custom CA certificates. For dependencies from a private registry, see Private npm registry.

3. Review environment defaults

Review workspace/env.template/.env.augr for new installations. task admin:setup copies it only when env/.env.augr is absent; edit the existing file by hand otherwise (see Configuration and state). The seed has no application env template or automatic collection for one: wire your app's settings into its tasks and containers, and keep secrets out of templates.

The .env.augr settings are detailed in Compose runtimes (Compose command and variant) and Corporate proxy (corporate network block); Platforms covers macOS and WSL2.

4. Give the agent your context

  • Rewrite workspace/AGENTS.md with your project's purpose, structure, commands, and conventions.
  • Add project skills and attitudes in workspace/agent/skills/, with your project's prefix instead of seed-; augr- is reserved for the core packages. The agent does not load this directory automatically yet: only package skills are linked at startup. Agent sessions explains how attitudes and skills are loaded.
  • Create workspace/opencode.jsonc to set the default model; use an identifier from /models. See Providers and models.
  • Keep secrets in env/, never in workspace/: the agent reads and writes the whole workspace. See the access model.

5. Set delivery conventions

Adapt workspace/delivery/DELIVERY_CONTEXT.md to your team's statuses, validation workflow, and commit conventions before tracking work in workspace/delivery/.

Delivery explains the model: epics, tickets and specializations. Exploration covers the exchange zone and the canvas; Dedicated git flow is an optional, experimental branch model.

6. Write your project documentation

Put project knowledge in workspace/docs/ and architecture decisions in workspace/docs/adr/. Start from the ADR template in workspace/docs/adr/README.md; these directories are not the autograph documentation site. The autograph ADRs show the format in use.

7. Package what is reusable

When a capability belongs in several projects, create a project package instead of copying project-specific files between repositories. The core packages are the ones every project starts with. To improve autograph itself, work from the metalab: see Contribute.

Learn more

The project layout and skill system ADRs explain the project boundaries and skill conventions.