|
1 | | -# OpenCode Template Repository |
| 1 | +# OpenCode |
2 | 2 |
|
3 | 3 | <div align="center"> |
4 | 4 |
|
5 | 5 | [](https://github.com/apiad/opencode/releases) |
6 | 6 | [](LICENSE) |
7 | | -[](https://github.com/apiad/opencode/generate) |
8 | 7 |
|
9 | | -**Template repository for OpenCode-powered projects.** |
| 8 | +**An intelligent, multi-agent CLI framework for software engineering automation.** |
10 | 9 |
|
11 | | -*This repository provides templates and configuration for bootstrapping new projects with the OpenCode framework.* |
12 | | - |
13 | | -#### [View opencode-core for the framework implementation](https://github.com/apiad/opencode-core) |
| 10 | +*This repository provides the installer, templates, and documentation. The actual framework lives in [opencode-core](https://github.com/apiad/opencode-core).* |
14 | 11 |
|
15 | 12 | </div> |
16 | 13 |
|
17 | 14 | --- |
18 | 15 |
|
19 | | -## Architecture |
20 | | - |
21 | | -OpenCode uses a two-repository architecture: |
22 | | - |
23 | | -| Repository | Purpose | |
24 | | -|------------|---------| |
25 | | -| [opencode-core](https://github.com/apiad/opencode-core) | Core framework, agents, and commands | |
26 | | -| This repository (opencode) | Templates, configuration, and project bootstrap | |
| 16 | +## Quick Start |
27 | 17 |
|
28 | | -When you initialize a new project, the installation script pulls templates from this repository and links them with the core framework. |
| 18 | +```bash |
| 19 | +curl -fsSL https://apiad.github.io/opencode/install.sh | bash |
| 20 | +``` |
29 | 21 |
|
30 | | ---- |
| 22 | +## Installation Modes |
31 | 23 |
|
32 | | -## Quick Start |
| 24 | +The installer supports two modes: |
33 | 25 |
|
34 | | -The fastest way to bootstrap a new project: |
| 26 | +| Mode | Description | Use Case | |
| 27 | +|------|-------------|----------| |
| 28 | +| `--mode=copy` | Copy framework files into your project | Self-contained, no external dependencies | |
| 29 | +| `--mode=link` | Link to opencode-core as a git submodule | Auto-updates with the framework | |
35 | 30 |
|
36 | 31 | ```bash |
| 32 | +# Interactive mode (prompts for mode selection) |
37 | 33 | curl -fsSL https://apiad.github.io/opencode/install.sh | bash |
38 | | -``` |
39 | 34 |
|
40 | | -### Installation Modes |
| 35 | +# Explicit copy mode |
| 36 | +curl -fsSL https://apiad.github.io/opencode/install.sh | bash -s -- --mode=copy |
41 | 37 |
|
42 | | -The installer supports two modes: |
| 38 | +# Explicit link mode |
| 39 | +curl -fsSL https://apiad.github.io/opencode/install.sh | bash -s -- --mode=link |
| 40 | +``` |
43 | 41 |
|
44 | | -| Mode | Description | |
45 | | -|------|-------------| |
46 | | -| `--mode=copy` | Copy framework files (updates require manual sync) | |
47 | | -| `--mode=link` | Symlink to opencode-core (auto-updates with the framework) | |
| 42 | +Run `--help` for all options. |
48 | 43 |
|
49 | | -Run `curl -fsSL https://apiad.github.io/opencode/install.sh | bash -s -- --help` for options. |
| 44 | +## Architecture |
50 | 45 |
|
51 | | ---- |
| 46 | +OpenCode uses a two-repository architecture: |
52 | 47 |
|
53 | | -## Directory Structure |
| 48 | +| Repository | Purpose | |
| 49 | +|------------|---------| |
| 50 | +| [opencode](https://github.com/apiad/opencode) (this repo) | Installer, templates, documentation | |
| 51 | +| [opencode-core](https://github.com/apiad/opencode-core) | Framework runtime, agents, commands | |
54 | 52 |
|
55 | | -``` |
56 | | -. |
57 | | -├── templates/ # Project templates |
58 | | -│ ├── .gitignore |
59 | | -│ ├── CHANGELOG.md |
60 | | -│ ├── README.md |
61 | | -│ ├── makefile |
62 | | -│ └── tasks.yaml |
63 | | -├── .knowledge/ # Agent knowledge base |
64 | | -│ ├── drafts/ |
65 | | -│ ├── log/ |
66 | | -│ ├── notes/ |
67 | | -│ └── plans/ |
68 | | -└── .opencode/ # Framework configuration (installed) |
69 | | -``` |
| 53 | +When you install OpenCode, the script pulls templates from this repository and links them with the core framework. |
70 | 54 |
|
71 | | ---- |
| 55 | +## Features |
72 | 56 |
|
73 | | -## For Framework Development |
| 57 | +- **Disciplined Workflows** — Agents follow structured phases: discovery → planning → execution → verification |
| 58 | +- **Test-Commit-Revert (TCR)** — Built-in TDD discipline for all code changes |
| 59 | +- **Evidence-Based** — Every claim cites specific sources |
| 60 | +- **Configurable** — Customize agents, commands, and style guidelines |
74 | 61 |
|
75 | | -If you're developing the framework itself, see [opencode-core](https://github.com/apiad/opencode-core) for: |
76 | | -- Core agent implementations |
77 | | -- Command definitions |
78 | | -- Framework utilities |
| 62 | +## Documentation |
79 | 63 |
|
80 | | ---- |
| 64 | +- [User Guide](docs/user-guide.md) — Getting started and usage |
| 65 | +- [Developer Guide](docs/develop.md) — Contributing and development |
| 66 | +- [Deployment](docs/deploy.md) — Installation modes and hosting |
| 67 | +- [Updating](docs/updating.md) — Keeping your installation up-to-date |
81 | 68 |
|
82 | | -## License & Contribution |
| 69 | +## License |
83 | 70 |
|
84 | | -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 71 | +MIT License - see [LICENSE](LICENSE) file for details. |
0 commit comments