JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 92
  • Score
    100M100P100Q91101F
  • License MIT

Discord bot for remote OpenCode CLI access

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remote-opencode) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    remote-opencode

    Control your AI coding assistant from anywhere β€” your phone, tablet, or another computer.

    npm πŸ“¦ Used by developers worldwide β€” 800+ weekly downloads on npm

    Gemini_Generated_Image_47d5gq47d5gq47d5

    remote-opencode is a Discord bot that bridges your local OpenCode CLI to Discord, enabling you to interact with your AI coding assistant remotely. Perfect for developers who want to:

    • πŸ“± Code from mobile β€” Send coding tasks from your phone while away from your desk
    • πŸ’» Access from any device β€” Use your powerful dev machine from a laptop or tablet
    • 🌍 Work remotely β€” Control your home/office workstation from anywhere
    • πŸ‘₯ Collaborate β€” Share AI coding sessions with team members in Discord
    • πŸ€– Automated Workflows β€” Queue up multiple tasks and let the bot process them sequentially

    How It Works

    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    Discord API    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
    β”‚  Your Phone /   β”‚ ◄──────────────► β”‚  Discord Bot    β”‚
    β”‚  Other Device   β”‚                   β”‚  (this project) β”‚
    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜                   β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                                                   β”‚
                                                   β–Ό
                                          β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
                                          β”‚  OpenCode CLI   β”‚
                                          β”‚  (your machine) β”‚
                                          β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                                                   β”‚
                                                   β–Ό
                                          β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
                                          β”‚  Your Codebase  β”‚
                                          β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

    The bot runs on your development machine alongside OpenCode. When you send a command via Discord, it's forwarded to OpenCode, and the output streams back to you in real-time.


    Table of Contents


    Installation

    Prerequisites

    • Node.js 22+ β€” Download
    • OpenCode CLI β€” Must be installed and working on your machine
    • Discord Account β€” With a server where you have admin permissions

    Install via npm

    # Global installation (recommended)
    npm install -g remote-opencode
    
    # Or run directly with npx
    npx remote-opencode

    Install from source

    git clone https://github.com/RoundTable02/remote-opencode.git
    cd remote-opencode
    npm install
    npm run build
    npm link  # Makes 'remote-opencode' available globally

    Quick Start

    # Step 1: Run the interactive setup wizard
    remote-opencode setup
    
    # Step 2: Start the Discord bot
    remote-opencode start

    That's it! Now use Discord slash commands to interact with OpenCode.


    Discord Bot Setup

    The setup wizard (remote-opencode setup) guides you through the entire process interactively:

    1. Opens Discord Developer Portal in your browser
    2. Walks you through creating an application, enabling intents, and getting your bot token
    3. Generates the invite link automatically and opens it in your browser
    4. Deploys slash commands to your server

    Just run remote-opencode setup and follow the prompts β€” no manual URL copying needed!

    πŸ“– Manual setup reference (click to expand)

    If you prefer manual setup or need to troubleshoot:

    1. Create Application: Go to Discord Developer Portal, create a new application
    2. Enable Intents: In "Bot" section, enable SERVER MEMBERS INTENT and MESSAGE CONTENT INTENT
    3. Get Bot Token: In "Bot" section, reset/view token and copy it
    4. Get Guild ID: Enable Developer Mode in Discord settings, right-click your server β†’ Copy Server ID
    5. Invite Bot: Use this URL format:
      https://discord.com/api/oauth2/authorize?client_id=YOUR_CLIENT_ID&permissions=2147534848&scope=bot+applications.commands

    CLI Commands

    Command Description
    remote-opencode Start the bot (shows setup guide if not configured)
    remote-opencode setup Interactive setup wizard β€” configures bot token, IDs
    remote-opencode start Start the Discord bot
    remote-opencode deploy Deploy/update slash commands to Discord
    remote-opencode config Display current configuration info

    Discord Slash Commands

    Once the bot is running, use these commands in your Discord server:

    /setpath β€” Register a Project

    Register a local project path with an alias for easy reference.

    /setpath alias:myapp path:/Users/you/projects/my-app
    Parameter Description
    alias Short name for the project (e.g., myapp, backend)
    path Absolute path to the project on your machine

    /projects β€” List Registered Projects

    View all registered project paths and their aliases.

    /projects

    /use β€” Bind Project to Channel

    Set which project a Discord channel should interact with.

    /use alias:myapp

    After binding, all /opencode commands in that channel will work on the specified project.

    /opencode β€” Send Command to AI

    The main command β€” sends a prompt to OpenCode and streams the response.

    /opencode prompt:Add a dark mode toggle to the settings page

    Features:

    • 🧡 Auto-creates a thread for each conversation
    • ⚑ Real-time streaming β€” see output as it's generated (1-second updates)
    • ⏸️ Interrupt button β€” stop the current task if needed
    • πŸ“ Session persistence β€” continue conversations in the same thread

    /work β€” Create a Git Worktree

    Start isolated work on a new branch with its own worktree.

    /work branch:feature/dark-mode description:Implement dark mode toggle
    Parameter Description
    branch Git branch name (will be sanitized)
    description Brief description of the work

    Features:

    • 🌳 Creates a new git worktree for isolated work
    • 🧡 Opens a dedicated thread for the task
    • πŸ—‘οΈ Delete button β€” removes worktree and archives thread
    • πŸš€ Create PR button β€” automatically creates a pull request

    This is perfect for working on multiple features simultaneously without branch switching.

    /code β€” Toggle Passthrough Mode

    Enable passthrough mode in a thread to send messages directly to OpenCode without slash commands.

    /code

    How it works:

    1. Run /code in any thread to enable passthrough mode
    2. Type messages naturally β€” they're sent directly to OpenCode
    3. Run /code again to disable

    Example:

    You: /code
    Bot: βœ… Passthrough mode enabled for this thread.
         Your messages will be sent directly to OpenCode.
    
    You: Add a dark mode toggle to settings
    Bot: πŸ“Œ Prompt: Add a dark mode toggle to settings
         [streaming response...]
    
    You: Now add a keyboard shortcut for it
    Bot: πŸ“Œ Prompt: Now add a keyboard shortcut for it
         [streaming response...]
    
    You: /code
    Bot: ❌ Passthrough mode disabled.

    Features:

    • πŸ“± Mobile-friendly β€” no more typing slash commands on phone
    • 🧡 Thread-scoped β€” only affects the specific thread, not the whole channel
    • ⏳ Busy indicator β€” shows ⏳ reaction if previous task is still running
    • πŸ”’ Safe β€” ignores bot messages (no infinite loops)

    /autowork β€” Toggle Automatic Worktree Creation

    Enable automatic worktree creation for a project. When enabled, new /opencode sessions will automatically create isolated git worktrees.

    /autowork

    How it works:

    1. Run /autowork in a channel bound to a project
    2. The setting toggles on/off for that project
    3. When enabled, new sessions automatically create worktrees with branch names like auto/abc12345-1738600000000

    Features:

    • 🌳 Automatic isolation β€” each session gets its own branch and worktree
    • πŸ“± Mobile-friendly β€” no need to type /work with branch names
    • πŸ—‘οΈ Delete button β€” removes worktree when done
    • πŸš€ Create PR button β€” easily create pull requests from worktree
    • ⚑ Per-project setting β€” enable/disable independently for each project

    /queue β€” Manage Message Queue

    Control the automated job queue for the current thread.

    /queue list
    /queue clear
    /queue pause
    /queue resume
    /queue settings continue_on_failure:True fresh_context:True

    How it works:

    1. Send multiple messages to a thread (or use /opencode multiple times)
    2. If the bot is busy, it reacts with πŸ“₯ and adds the task to the queue
    3. Once the current job is done, the bot automatically picks up the next one

    Settings:

    • continue_on_failure: If True, the bot moves to the next task even if the current one fails.
    • fresh_context: If True (default), the AI forgets previous chat history for each new queued task to improve performance, while maintaining the same code state.

    Usage Workflow

    Basic Workflow

    1. Register your project:

      /setpath alias:webapp path:/home/user/my-webapp
    2. Bind to a channel:

      /use alias:webapp
    3. Start coding remotely:

      /opencode prompt:Refactor the authentication module to use JWT
    4. Continue the conversation in the created thread:

      /opencode prompt:Now add refresh token support

    Mobile Workflow

    Perfect for when you're away from your desk:

    1. πŸ“± Open Discord on your phone
    2. Navigate to your bound channel
    3. Use /opencode to send tasks
    4. Watch real-time progress
    5. Use the Interrupt button if needed

    Pro tip: Enable passthrough mode with /code in a thread for an even smoother mobile experience β€” just type messages directly without slash commands!

    Team Collaboration Workflow

    Share AI coding sessions with your team:

    1. Create a dedicated Discord channel for your project
    2. Bind the project: /use alias:team-project
    3. Team members can watch sessions in real-time
    4. Discuss in threads while AI works

    Automated Iteration Workflow

    Perfect for "setting and forgetting" several tasks:

    1. Send multiple instructions:

      You: Refactor the API
      Bot: [Starts working]
      You: Add documentation to the new methods
      Bot: πŸ“₯ [Queued]
      You: Run tests and fix any issues
      Bot: πŸ“₯ [Queued]
    2. The bot will finish the API refactor, then automatically start the documentation task, then run the tests.

    3. Monitor progress: Use /queue list to see pending tasks.


    Configuration

    All configuration is stored in ~/.remote-opencode/:

    File Purpose
    config.json Bot credentials (token, client ID, guild ID)
    data.json Project paths, channel bindings, session data

    config.json Structure

    {
      "discordToken": "your-bot-token",
      "clientId": "your-application-id",
      "guildId": "your-server-id"
    }

    data.json Structure

    {
      "projects": [
        { "alias": "myapp", "path": "/Users/you/projects/my-app", "autoWorktree": true }
      ],
      "bindings": [
        { "channelId": "channel-id", "projectAlias": "myapp" }
      ],
      "threadSessions": [ ... ],
      "worktreeMappings": [ ... ]
    }
    Field Description
    projects[].autoWorktree Optional. When true, new sessions auto-create worktrees

    Troubleshooting

    Bot doesn't respond to commands

    1. Check bot is online: Look for the bot in your server's member list
    2. Verify permissions: Bot needs these permissions:
      • Send Messages
      • Create Public Threads
      • Send Messages in Threads
      • Embed Links
      • Read Message History
    3. Redeploy commands:
      remote-opencode deploy

    "No project set for this channel"

    You need to bind a project to the channel:

    /setpath alias:myproject path:/path/to/project
    /use alias:myproject

    Commands not appearing in Discord

    Slash commands can take up to an hour to propagate globally. For faster updates:

    1. Kick the bot from your server
    2. Re-invite it
    3. Run remote-opencode deploy

    OpenCode server errors

    1. Verify OpenCode is installed:
      opencode --version
    2. Check if another process is using the port
    3. Ensure the project path exists and is accessible

    Session connection issues

    The bot maintains persistent sessions. If you encounter issues:

    1. Start a new thread with /opencode instead of continuing in an old one
    2. Restart the bot: remote-opencode start

    Bot crashes on startup

    1. Check Node.js version:
      node --version  # Should be 22+
    2. Verify configuration:
      remote-opencode config
    3. Re-run setup:
      remote-opencode setup

    Development

    Run from source

    git clone https://github.com/RoundTable02/remote-opencode.git
    cd remote-opencode
    npm install
    
    # Development mode (with ts-node)
    npm run dev setup   # Run setup
    npm run dev start   # Start bot
    
    # Build and run production
    npm run build
    npm start

    Run tests

    npm test

    Project Structure

    src/
    β”œβ”€β”€ cli.ts                 # CLI entry point
    β”œβ”€β”€ bot.ts                 # Discord client initialization
    β”œβ”€β”€ commands/              # Slash command definitions
    β”‚   β”œβ”€β”€ opencode.ts        # Main AI interaction command
    β”‚   β”œβ”€β”€ code.ts            # Passthrough mode toggle
    β”‚   β”œβ”€β”€ work.ts            # Worktree management
    β”‚   β”œβ”€β”€ setpath.ts         # Project registration
    β”‚   β”œβ”€β”€ projects.ts        # List projects
    β”‚   └── use.ts             # Channel binding
    β”œβ”€β”€ handlers/              # Interaction handlers
    β”‚   β”œβ”€β”€ interactionHandler.ts
    β”‚   β”œβ”€β”€ buttonHandler.ts
    β”‚   └── messageHandler.ts  # Passthrough message handling
    β”œβ”€β”€ services/              # Core business logic
    β”‚   β”œβ”€β”€ serveManager.ts    # OpenCode process management
    β”‚   β”œβ”€β”€ sessionManager.ts  # Session state management
    β”‚   β”œβ”€β”€ queueManager.ts    # Automated job queuing
    β”‚   β”œβ”€β”€ executionService.ts # Core prompt execution logic
    β”‚   β”œβ”€β”€ sseClient.ts       # Real-time event streaming
    
    β”‚   β”œβ”€β”€ dataStore.ts       # Persistent storage
    β”‚   β”œβ”€β”€ configStore.ts     # Bot configuration
    β”‚   └── worktreeManager.ts # Git worktree operations
    β”œβ”€β”€ setup/                 # Setup wizard
    β”‚   β”œβ”€β”€ wizard.ts          # Interactive setup
    β”‚   └── deploy.ts          # Command deployment
    └── utils/                 # Utilities
        β”œβ”€β”€ messageFormatter.ts
        └── threadHelper.ts

    Changelog

    See CHANGELOG.md for a full history of changes.

    [1.1.0] - 2026-02-05

    Added

    • Automated Message Queuing: Added a new system to queue multiple prompts in a thread. If the bot is busy, new messages are automatically queued and processed sequentially.
    • Queue Management: New /queue slash command suite to list, clear, pause, resume, and configure queue settings.

    [1.0.10] - 2026-02-04

    Added

    • New /setports slash command to configure the port range for OpenCode server instances.

    Fixed

    • Fixed Windows-specific spawning issue (targeting opencode.cmd).
    • Resolved spawn EINVAL errors on Windows.
    • Improved server reliability and suppressed DEP0190 security warnings.

    [1.0.9] - 2026-02-04

    Added

    • New /model slash command to set AI models per channel.
    • Support for --model flag in OpenCode server instances.

    Fixed

    • Fixed connection timeout issues.
    • Standardized internal communication to use 127.0.0.1.

    License

    MIT


    Contributing

    Contributions are welcome! Please read our Contributing Guide before submitting a Pull Request.