Installation

Get started with Workaholic in your OpenCode setup.

Prerequisites

ℹ️

Workaholic requires OpenCode with plugin support. Make sure you have OpenCode installed before proceeding.

Quick Install

1

Using bunx (Recommended)

The fastest way to install Workaholic is using bunx. Don't have bun? Install it here →

Terminal 
bunx opencode-workaholic@latest install
2

Verify Installation

After installation, you can start using Workaholic immediately:

OpenCode 
/workaholic Test the plugin, for 5 minutes

Manual Installation

1

Clone the Repository

Clone or download the Workaholic plugin to your local machine:

Terminal 
git clone https://github.com/RoderickQiu/opencode-workaholic.git
2

Build the Plugin

Install dependencies and build the plugin:

Terminal 
cd opencode-workaholic
bun install
mise run build
3

Configure OpenCode

Add the plugin to your OpenCode configuration file:

~/.config/opencode/opencode.json 
{
  "plugins": ["opencode-workaholic"]
}

Or use a local path:

~/.config/opencode/opencode.json 
{
  "plugins": ["file:///path/to/opencode-workaholic"]
}

Development

If you want to develop or contribute to Workaholic:

Available Scripts 
mise run build    # Build the plugin
mise run test    # Run tests
mise run lint    # Lint code
mise run format  # Format code
⚠️

If you encounter any issues during installation, please check the GitHub Issues or open a new one for help.