Skip to content

config-overview.md

Latest commit

 

History

History
88 lines (63 loc) · 2.69 KB

config-overview.md

File metadata and controls

88 lines (63 loc) · 2.69 KB

Config Overview

This repository now ships a fuller set of templates because the current stack is meant to be usable, not just described.

The files are still intended to be adapted, not copied blindly.

Template tree

config/
├── opencode.template.json
├── AGENTS.template.md
├── ROUTING_POLICY.template.md          # legacy / optional
├── ENV_SELF_CHECK_POLICY.template.md   # legacy / optional
├── agents/
│   └── reviewer.template.md
├── commands/
│   ├── plan.template.md
│   ├── spec.template.md
│   ├── implement.template.md
│   ├── review.template.md
│   ├── verify.template.md
│   └── release.template.md
└── plugins/
    ├── smart-compaction.template.ts
    └── verify-gate.template.ts

File responsibilities

config/opencode.template.json

Defines the runtime baseline:

  • providers and model routing
  • primary agents and subagents
  • variants and compaction
  • plugin loading
  • MCP servers
  • instruction file paths

This template intentionally uses JSONC-style comments because OpenCode accepts commented .json config files. If you run strict JSON tooling against it, remove the comments first.

config/AGENTS.template.md

Defines durable rules that should travel with a repo:

  • safety boundaries
  • code quality expectations
  • planning and acceptance-criteria discipline
  • verification and review habits

config/agents/reviewer.template.md

Defines a review-only subagent with a stricter output contract.

config/commands/*.template.md

Package the day-to-day workflow:

  • /plan for interactive planning and PLAN.md
  • /spec for test skeleton generation from acceptance criteria
  • /implement for execution against the plan
  • /review for review feedback
  • /verify for test/lint/type-check analysis
  • /release for pre-release checks

config/plugins/*.template.ts

Provide lightweight behavior that should happen automatically:

  • preserve useful state across compaction
  • nudge the workflow toward verification before git commit or git push

Legacy templates

ROUTING_POLICY.template.md and ENV_SELF_CHECK_POLICY.template.md are kept as historical references from the earlier five-tool stack. You do not need them to reproduce the current native-first baseline.

What you must customize

  • provider authentication and model availability
  • cost-sensitive model choices
  • bash permission rules
  • absolute paths or instruction globs
  • project-specific instruction files
  • optional skills and MCP integrations

The safest way to adapt these templates is to preserve the structure first, then shrink or expand only after you have used the workflow for a real task.