opencode

<div align="center"> <a href="https://opencode.ai"><img src="opencode-logo.png" alt="Opencode logo"></a> </div> > [!WARNING] > **🚨 REPOSITORY ARCHIVED AND MOVED 🚨** > > **This project is now archived and closed.** All future development, updates, and content have been moved to a new repository. > > Please visit our new home: **[https://github.com/jjmartres/ai-coding-agents](https://github.com/jjmartres/ai-coding-agents)** <p align="center"> <strong>Jumpstart your Opencode environment with this pre-built configuration. It includes a variety of agents, commands, skills, themes and MCP servers definitions, all ready for you to use and customize. Spend less time configuring and more time automating.</strong> </p> <p align="center"> <a href="https://awesome.re"><img src="https://awesome.re/badge.svg" alt="Awesome" /></a> <a href="https://github.com/jjmartres/opencode"><img src="https://img.shields.io/github/last-commit/jjmartres/opencode?label=Last%20update&style=flat-square" alt="Last Update" /></a> <a href="https://github.com/jjmartres/opencode/issues"><img src="https://img.shields.io/github/issues/jjmartres/opencode" alt="GitHub Issues"/></a> <a href="https://github.com/jjmartres/opencode/pulls"><img src="https://img.shields.io/github/issues-pr/jjmartres/opencode" alt="GitHub Pull Requests"/></a> </p> --- ## Table of Contents - [Features](#features) - [Documentation](#documentation) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Usage](#usage) - [Configuration Structure](#configuration-structure) - [Development](#development) - [Contributing](#contributing) - [License](#license) ## Features - **Agents**: Specialized AI agents for various domains (payment integration, customer success, etc.) - **Skills**: Reusable skill definitions for common workflows - **MCP Servers**: Model Context Protocol server configurations - **Rules**: Coding rules and best practices - **Themes**: Custom themes for OpenCode - **Automated Installation**: Uses GNU Stow or symlinks for easy deployment - **Pre-commit Hooks**: Automatic validation and linting ## Documentation - **[Agents](./docs/AGENTS.md)**: Detailed list of all available AI agents. - **[Commands](./docs/COMMANDS.md)**: Comprehensive list of all available commands. - **[Skills](./docs/SKILLS.md)**: Detailed list of all available skills. - **[Rules](./docs/RULES.md)**: Coding rules and best practices. ## Prerequisites - [OpenCode](https://opencode.ai) - AI-powered code editor - [GNU Stow](https://www.gnu.org/software/stow/) - Symlink farm manager (optional but recommended) - [Node.js](https://nodejs.org/) - JavaScript runtime (v18+) - [Git](https://git-scm.com/) - Version control - [pre-commit](https://pre-commit.com/) - Git hook framework (optional) ### Installing Prerequisites **macOS:** ```bash brew install stow node pre-commit ``` **Ubuntu/Debian:** ```bash sudo apt install stow nodejs npm pip install pre-commit ``` **Arch Linux:** ```bash sudo pacman -S stow nodejs npm python-pre-commit ``` **Ubuntu/Debian:** ```bash sudo apt install stow nodejs npm pip install pre-commit ``` **Arch Linux:** ```bash sudo pacman -S stow nodejs npm python-pre-commit ``` ## Installation ### Quick Start ```bash # Clone the repository git clone https://github.com/jjmartres/opencode.git cd opencode # Install configuration make install # (Optional) Install pre-commit hooks make install-hooks ``` ### What Gets Installed The installation process creates symlinks from this repository to `~/.config/opencode/`: ``` ~/.config/opencode/ ├── agent/ -> ~/opencode/opencode/agent/ ├── command/ -> ~/opencode/opencode/command/ ├── mcp/ -> ~/opencode/opencode/mcp/ ├── plugin/ -> ~/opencode/opencode/plugin/ ├── rules/ -> ~/opencode/opencode/rules/ ├── skill/ -> ~/opencode/opencode/skill/ └── themes/ -> ~/opencode/opencode/themes/ ``` ### Installation Methods The Makefile automatically detects if GNU Stow is available: - **With Stow**: Uses `stow` for proper symlink management - **Without Stow**: Falls back to `ln -s` for direct symlinks ## Usage ### Basic Commands ```bash # Open current directory in OpenCode opencode . # Open specific file opencode path/to/file.py # Check installation status make status # List available packages make list # Update configuration (after pulling changes) make restow ``` ### Available Make Targets ```bash make help # Display all available commands make install # Install OpenCode configuration make uninstall # Remove configuration symlinks make restow # Refresh symlinks (after updates) make status # Show installation status make list # List available packages make clean # Remove broken symlinks # Pre-commit Hooks make install-hooks # Install pre-commit hooks make run-hooks # Run hooks manually make update-hooks # Update hooks to latest versions # Combined Operations make install-all # Install config + hooks make uninstall-all # Remove everything ``` ## Configuration Structure ``` opencode/ ├── agent/ # AI agent definitions │ ├── 01-core/ │ ├── 02-languages/ │ ├── 03-infrastructure/ │ ├── 04-quality-and-security/ │ ├── 05-data-ai/ │ ├── 06-developer-experience/ │ ├── 07-specialized-domains/ │ ├── 08-business-product/ │ ├── 09-meta-orchestration/ │ └── 10-curiosity/ ├── command/ # Custom commands ├── mcp/ # MCP server configurations ├── rules/ # Coding rules and standards ├── skill/ # Reusable skills │ ├── mcp-builder/ │ ├── content-research-writer/ │ └── meeting-insights-analyzer/ └── themes/ # UI themes ``` ## Development ### Making Changes 1. Edit files in the `opencode/` directory 2. Changes are immediately reflected (symlinks!) 3. Restart OpenCode if needed ### Running Pre-commit Hooks ```bash # Run all hooks on all files make run-hooks # Run specific hook pre-commit run markdownlint --all-files # Skip hooks for a commit (not recommended) git commit --no-verify -m "message" ``` ### Updating Configuration ```bash # Pull latest changes git pull origin main # Refresh symlinks make restow ``` ## Troubleshooting ### Configuration Not Loading ```bash # Check installation status make status # Verify symlinks ls -la ~/.config/opencode/ # Reinstall make uninstall make install ``` ### Stow Conflicts ```bash # If you get conflicts, remove existing files first rm -rf ~/.config/opencode/agent # Repeat for other directories # Then reinstall make install ``` ### Pre-commit Hooks Failing ```bash # Run hooks manually to see errors make run-hooks # Update hooks make update-hooks # Uninstall/reinstall hooks make uninstall-hooks make install-hooks ``` ## Contributing Contributions are welcome! We appreciate bug reports, feature suggestions, new agents/skills, and documentation improvements. Please read our [Contributing Guidelines](CONTRIBUTING.md) for: - How to report bugs - How to suggest enhancements - Development workflow and pull request process - Coding standards and pre-commit requirements - Testing procedures **Quick Start for Contributors:** ```bash # Fork and clone git clone https://github.com/YOUR_USERNAME/opencode.git cd opencode # Install with development hooks make install make install-hooks # Make changes and test make run-hooks make status # Submit a pull request! ``` For detailed contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md). ## License MIT License - see [LICENSE](LICENSE) file for details ## Acknowledgments - [OpenCode](https://opencode.ai) - The AI-powered code editor - [GNU Stow](https://www.gnu.org/software/stow/) - Symlink farm manager - All our [contributors](https://github.com/jjmartres/opencode/graphs/contributors) ## Support - **Issues**: [GitHub Issues](https://github.com/jjmartres/opencode/issues) - **Discussions**: [GitHub Discussions](https://github.com/jjmartres/opencode/discussions) - **Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md) --- **Note**: This configuration is tailored for personal use. Feel free to fork and customize for your needs!