Getting Started
Try it in 60 seconds
Section titled “Try it in 60 seconds”pipx install open-codev-workflow# or: uv tool install open-codev-workflow
codev init --target . --agent-platform allcodev status --target .CoDev 0.5.0 - /path/to/your/repoBundle: healthy (76 managed files, no drift)Adapters: opencodeTasks in progress: 0Commit the installed files as one infrastructure change. That’s the last codev command
you type today — from here, start an AI session in the repository and describe a small bug
or task in plain language. You don’t need to name a skill, and you won’t need to type
another codev command yourself: your agent runs the CLI on your behalf from here on. See
Talking to Your Agent for what that actually looks like,
or jump straight to Tutorial 1, which walks one small
fix from here to a merged pull request with every command and real output shown.
New repository
Section titled “New repository”- Create the repository and its normal build, test, lint, ownership, and CI foundations.
- Run
codev init --target <repo> --agent-platform all. - Add project-specific instructions outside the marked CoDev block in
AGENTS.md. - Configure model/provider choices in the normal platform configuration.
- Run
codev status --target <repo>and the project’s own validation. - Review and commit the installation as one infrastructure change.
Existing repository
Section titled “Existing repository”- Start with a clean branch and inspect existing
AGENTS.md,.agents, and.opencodecontent. - Run
codev init; it will stop rather than replace a different file at a managed path. - Resolve naming collisions deliberately. Rename a project-local skill when it is semantically different; do not blend two authorities into one file.
- Keep product-specific rules outside managed files.
- Run deterministic validation and exercise a representative work item before team-wide adoption.
Team rollout
Section titled “Team rollout”Use one pilot repository and one real, bounded feature. Gather evidence about planning quality, intervention frequency, review findings, lead time, and developer comprehension. Expand only after the team agrees that authority boundaries and handoffs are understandable.
Recommended ownership:
- Developer productivity owns CoDev version policy and installation tooling.
- Product teams own repository-specific instructions and technical authority.
- Security owns organization-wide restrictions and release provenance.
- Each code owner remains accountable for change acceptance and operation.
Updating
Section titled “Updating”Pin a released CoDev version in team automation. Use codev diff before codev update;
inspect the resulting Git diff and changelog; then run the consumer repository’s CI. Never
update from a floating development branch and never auto-merge workflow instruction
changes.
Where to go next
Section titled “Where to go next”| I want to… | Go to |
|---|---|
| Know how to actually talk to my agent | Talking to Your Agent |
| Understand the mental model before doing anything | Onboarding Guide |
| Try it hands-on, one small fix at a time | Tutorial 1 |
| See every command | CLI reference |
| See exactly what gets installed and why | Architecture |
| Understand why a specific mechanism exists | Architecture Decision Records |
| Contribute to CoDev itself | Contributing |