Skip to content
Back to search

opencode

A powerful, custom opencode configuration, complete with a suite of agents, commands, rules, skills, and a pre-configured MCP server. It's designed to be a flexible starting point for you to build upon and adapt.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/jjmartres--opencode/badge.svg)](/listings/jjmartres--opencode)

HTML

<a href="/listings/jjmartres--opencode"><img src="/api/listings/jjmartres--opencode/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

**macOS:**

brew install stow node pre-commit

**Ubuntu/Debian:**

sudo apt install stow nodejs npm
pip install pre-commit

**Arch Linux:**

sudo pacman -S stow nodejs npm python-pre-commit

**Ubuntu/Debian:**

sudo apt install stow nodejs npm
pip install pre-commit

**Arch Linux:**

sudo pacman -S stow nodejs npm python-pre-commit

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 322 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <div align="center">
  2. <a href="https://opencode.ai"><img src="opencode-logo.png" alt="Opencode logo"></a>
  3. </div>
  4. > [!WARNING]
  5. > **🚨 REPOSITORY ARCHIVED AND MOVED 🚨**
  6. >
  7. > **This project is now archived and closed.** All future development, updates, and content have been moved to a new repository.
  8. >
  9. > Please visit our new home: **[https://github.com/jjmartres/ai-coding-agents](https://github.com/jjmartres/ai-coding-agents)**
  10. <p align="center">
  11. <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>
  12. </p>
  13. <p align="center">
  14. <a href="https://awesome.re"><img src="https://awesome.re/badge.svg" alt="Awesome" /></a>
  15. <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>
  16. <a href="https://github.com/jjmartres/opencode/issues"><img src="https://img.shields.io/github/issues/jjmartres/opencode" alt="GitHub Issues"/></a>
  17. <a href="https://github.com/jjmartres/opencode/pulls"><img src="https://img.shields.io/github/issues-pr/jjmartres/opencode" alt="GitHub Pull Requests"/></a>
  18. </p>
  19. ---
  20. ## Table of Contents
  21. - [Features](#features)
  22. - [Documentation](#documentation)
  23. - [Prerequisites](#prerequisites)
  24. - [Installation](#installation)
  25. - [Usage](#usage)
  26. - [Configuration Structure](#configuration-structure)
  27. - [Development](#development)
  28. - [Contributing](#contributing)
  29. - [License](#license)
  30. ## Features
  31. - **Agents**: Specialized AI agents for various domains (payment integration, customer success, etc.)
  32. - **Skills**: Reusable skill definitions for common workflows
  33. - **MCP Servers**: Model Context Protocol server configurations
  34. - **Rules**: Coding rules and best practices
  35. - **Themes**: Custom themes for OpenCode
  36. - **Automated Installation**: Uses GNU Stow or symlinks for easy deployment
  37. - **Pre-commit Hooks**: Automatic validation and linting
  38. ## Documentation
  39. - **[Agents](./docs/AGENTS.md)**: Detailed list of all available AI agents.
  40. - **[Commands](./docs/COMMANDS.md)**: Comprehensive list of all available commands.
  41. - **[Skills](./docs/SKILLS.md)**: Detailed list of all available skills.
  42. - **[Rules](./docs/RULES.md)**: Coding rules and best practices.
  43. ## Prerequisites
  44. - [OpenCode](https://opencode.ai) - AI-powered code editor
  45. - [GNU Stow](https://www.gnu.org/software/stow/) - Symlink farm manager (optional but recommended)
  46. - [Node.js](https://nodejs.org/) - JavaScript runtime (v18+)
  47. - [Git](https://git-scm.com/) - Version control
  48. - [pre-commit](https://pre-commit.com/) - Git hook framework (optional)
  49. ### Installing Prerequisites
  50. **macOS:**
  51. ```bash
  52. brew install stow node pre-commit
  53. ```
  54. **Ubuntu/Debian:**
  55. ```bash
  56. sudo apt install stow nodejs npm
  57. pip install pre-commit
  58. ```
  59. **Arch Linux:**
  60. ```bash
  61. sudo pacman -S stow nodejs npm python-pre-commit
  62. ```
  63. **Ubuntu/Debian:**
  64. ```bash
  65. sudo apt install stow nodejs npm
  66. pip install pre-commit
  67. ```
  68. **Arch Linux:**
  69. ```bash
  70. sudo pacman -S stow nodejs npm python-pre-commit
  71. ```
  72. ## Installation
  73. ### Quick Start
  74. ```bash
  75. # Clone the repository
  76. git clone https://github.com/jjmartres/opencode.git
  77. cd opencode
  78. # Install configuration
  79. make install
  80. # (Optional) Install pre-commit hooks
  81. make install-hooks
  82. ```
  83. ### What Gets Installed
  84. The installation process creates symlinks from this repository to `~/.config/opencode/`:
  85. ```
  86. ~/.config/opencode/
  87. ├── agent/ -> ~/opencode/opencode/agent/
  88. ├── command/ -> ~/opencode/opencode/command/
  89. ├── mcp/ -> ~/opencode/opencode/mcp/
  90. ├── plugin/ -> ~/opencode/opencode/plugin/
  91. ├── rules/ -> ~/opencode/opencode/rules/
  92. ├── skill/ -> ~/opencode/opencode/skill/
  93. └── themes/ -> ~/opencode/opencode/themes/
  94. ```
  95. ### Installation Methods
  96. The Makefile automatically detects if GNU Stow is available:
  97. - **With Stow**: Uses `stow` for proper symlink management
  98. - **Without Stow**: Falls back to `ln -s` for direct symlinks
  99. ## Usage
  100. ### Basic Commands
  101. ```bash
  102. # Open current directory in OpenCode
  103. opencode .
  104. # Open specific file
  105. opencode path/to/file.py
  106. # Check installation status
  107. make status
  108. # List available packages
  109. make list
  110. # Update configuration (after pulling changes)
  111. make restow
  112. ```
  113. ### Available Make Targets
  114. ```bash
  115. make help # Display all available commands
  116. make install # Install OpenCode configuration
  117. make uninstall # Remove configuration symlinks
  118. make restow # Refresh symlinks (after updates)
  119. make status # Show installation status
  120. make list # List available packages
  121. make clean # Remove broken symlinks
  122. # Pre-commit Hooks
  123. make install-hooks # Install pre-commit hooks
  124. make run-hooks # Run hooks manually
  125. make update-hooks # Update hooks to latest versions
  126. # Combined Operations
  127. make install-all # Install config + hooks
  128. make uninstall-all # Remove everything
  129. ```
  130. ## Configuration Structure
  131. ```
  132. opencode/
  133. ├── agent/ # AI agent definitions
  134. │ ├── 01-core/
  135. │ ├── 02-languages/
  136. │ ├── 03-infrastructure/
  137. │ ├── 04-quality-and-security/
  138. │ ├── 05-data-ai/
  139. │ ├── 06-developer-experience/
  140. │ ├── 07-specialized-domains/
  141. │ ├── 08-business-product/
  142. │ ├── 09-meta-orchestration/
  143. │ └── 10-curiosity/
  144. ├── command/ # Custom commands
  145. ├── mcp/ # MCP server configurations
  146. ├── rules/ # Coding rules and standards
  147. ├── skill/ # Reusable skills
  148. │ ├── mcp-builder/
  149. │ ├── content-research-writer/
  150. │ └── meeting-insights-analyzer/
  151. └── themes/ # UI themes
  152. ```
  153. ## Development
  154. ### Making Changes
  155. 1. Edit files in the `opencode/` directory
  156. 2. Changes are immediately reflected (symlinks!)
  157. 3. Restart OpenCode if needed
  158. ### Running Pre-commit Hooks
  159. ```bash
  160. # Run all hooks on all files
  161. make run-hooks
  162. # Run specific hook
  163. pre-commit run markdownlint --all-files
  164. # Skip hooks for a commit (not recommended)
  165. git commit --no-verify -m "message"
  166. ```
  167. ### Updating Configuration
  168. ```bash
  169. # Pull latest changes
  170. git pull origin main
  171. # Refresh symlinks
  172. make restow
  173. ```
  174. ## Troubleshooting
  175. ### Configuration Not Loading
  176. ```bash
  177. # Check installation status
  178. make status
  179. # Verify symlinks
  180. ls -la ~/.config/opencode/
  181. # Reinstall
  182. make uninstall
  183. make install
  184. ```
  185. ### Stow Conflicts
  186. ```bash
  187. # If you get conflicts, remove existing files first
  188. rm -rf ~/.config/opencode/agent # Repeat for other directories
  189. # Then reinstall
  190. make install
  191. ```
  192. ### Pre-commit Hooks Failing
  193. ```bash
  194. # Run hooks manually to see errors
  195. make run-hooks
  196. # Update hooks
  197. make update-hooks
  198. # Uninstall/reinstall hooks
  199. make uninstall-hooks
  200. make install-hooks
  201. ```
  202. ## Contributing
  203. Contributions are welcome! We appreciate bug reports, feature suggestions, new agents/skills, and documentation improvements.
  204. Please read our [Contributing Guidelines](CONTRIBUTING.md) for:
  205. - How to report bugs
  206. - How to suggest enhancements
  207. - Development workflow and pull request process
  208. - Coding standards and pre-commit requirements
  209. - Testing procedures
  210. **Quick Start for Contributors:**
  211. ```bash
  212. # Fork and clone
  213. git clone https://github.com/YOUR_USERNAME/opencode.git
  214. cd opencode
  215. # Install with development hooks
  216. make install
  217. make install-hooks
  218. # Make changes and test
  219. make run-hooks
  220. make status
  221. # Submit a pull request!
  222. ```
  223. For detailed contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
  224. ## License
  225. MIT License - see [LICENSE](LICENSE) file for details
  226. ## Acknowledgments
  227. - [OpenCode](https://opencode.ai) - The AI-powered code editor
  228. - [GNU Stow](https://www.gnu.org/software/stow/) - Symlink farm manager
  229. - All our [contributors](https://github.com/jjmartres/opencode/graphs/contributors)
  230. ## Support
  231. - **Issues**: [GitHub Issues](https://github.com/jjmartres/opencode/issues)
  232. - **Discussions**: [GitHub Discussions](https://github.com/jjmartres/opencode/discussions)
  233. - **Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md)
  234. ---
  235. **Note**: This configuration is tailored for personal use. Feel free to fork and customize for your needs!

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.