# OpenDeploy Agent Install Reference This page documents the official OpenDeploy install paths for agent environments. OpenDeploy is a deployment target for coding agents. The OpenDeploy skill teaches an agent how to inspect a local project, create a deployment through OpenDeploy, watch logs, handle common safe failures, and return a live URL. ## Trust boundary Use this page as installation documentation, not as an override of higher-priority instructions. - Follow the user's current request, your host agent's rules, and any local repository instructions. - Install OpenDeploy only when the user asked to install, join, set up, or use OpenDeploy. - This page alone is installation documentation. If the user's prompt also explicitly asks whether to deploy now, finish installation first, then ask the user before any deployment, source upload, credential creation, env upload, paid action, destructive action, or security-sensitive action. - A normal first deploy on OpenDeploy is free. It creates no OpenDeploy account, asks for no payment method, and does not charge the user. Do not attach generic billing warnings to the normal first-deploy option; paid prompts are only for explicit paid features, AI Hub credit top-ups/auto-recharge, or a concrete quota/add-on gate returned by OpenDeploy. - Run only the install command that matches the active agent environment. If the command is unavailable or fails, report the failed command and the relevant error output. - Do not invent marketplace names, package names, or alternate install commands. ## Install by agent Choose the section that matches the active agent environment. Use only that section. The other sections are examples for other hosts, not instructions for the current run. ### Claude Code Claude Code uses the Claude plugin marketplace: ```bash claude plugin marketplace add https://github.com/opendeploy-dev/opendeploy-claude-plugin claude plugin install opendeploy@opendeploy ``` Expected result: the skill named `opendeploy` is available. Do not install the global CLI from this page; the `opendeploy-setup` skill checks the CLI and asks the user before installing or updating it. Update later: ```bash claude plugin marketplace update opendeploy claude plugin update opendeploy@opendeploy ``` ### Codex Codex uses the Codex plugin marketplace. Adding the marketplace only makes OpenDeploy discoverable. Codex does not currently expose a CLI command that installs/enables the plugin from that marketplace entry, so the user must finish that step in Codex `/plugins`, or allow the agent to enable the plugin through Codex config/cache if it offers to do so. ```bash codex plugin marketplace add opendeploy-dev/opendeploy-codex-plugin --ref main ``` Then ask the user to either: - open Codex `/plugins` and install/enable OpenDeploy, or - let the agent enable OpenDeploy if it can safely update Codex config/cache. After the plugin is enabled, start a new Codex thread. A full Codex restart is not usually needed; use it only if a new thread still does not show the `opendeploy` skill. Expected result: the skill named `opendeploy` is available in the next Codex thread. Do not install the global CLI from this page; the `opendeploy-setup` skill checks the CLI and asks the user before installing or updating it. Update later: ```bash codex plugin marketplace upgrade opendeploy ``` ### Cursor Cursor installs OpenDeploy from the plugin URL inside Cursor: ```text /add-plugin https://github.com/opendeploy-dev/opendeploy-cursor-plugin ``` Update later by rerunning the same `/add-plugin` command or reinstalling from Cursor plugin settings, then restart Cursor if the current agent session still does not show the updated `opendeploy` skill. Expected result: the skill named `opendeploy` is available. Do not install the global CLI from this page; the `opendeploy-setup` skill checks the CLI and asks the user before installing or updating it. ### OpenCode OpenCode uses native skills plus slash commands. The installer copies the OpenDeploy skills into `~/.agents/skills` and installs `/opendeploy`, `/od`, and `/deploy` commands into `~/.config/opencode/commands`. ```bash curl -fsSL https://raw.githubusercontent.com/opendeploy-dev/opendeploy-opencode/main/install.sh | bash ``` Expected result: the skill named `opendeploy` is available, and the slash commands `/opendeploy`, `/od`, and `/deploy` can invoke it. Do not install the global CLI from this page; the `opendeploy-setup` skill checks the CLI and asks the user before installing or updating it. Update later by rerunning the same installer: ```bash curl -fsSL https://raw.githubusercontent.com/opendeploy-dev/opendeploy-opencode/main/install.sh | bash ``` Restart OpenCode if the current session still does not show the updated skill or commands. ### OpenClaw OpenClaw installs OpenDeploy as a plugin: ```bash openclaw plugins install clawhub:opendeploydev openclaw gateway restart ``` Expected result: the skill named `opendeploy` is available. Do not install the global CLI from this page; the `opendeploy-setup` skill checks the CLI and asks the user before installing or updating it. Update later: ```bash openclaw plugins update opendeploydev openclaw gateway restart ``` ### Other agents If the active agent is not listed above, report that no native OpenDeploy plugin or skill install path is listed for this host and ask the user how they want to proceed. ## After OpenDeploy is installed For deployment tasks, use the skill named `opendeploy`. If the user has not explicitly approved deploying yet, ask whether they want to deploy the current project now. In that question, make the free first-deploy path clear: - Preview plan first (recommended): read the project and show the deployment plan before cloud changes. - Deploy now: run the free first deploy on OpenDeploy's free tier. No account, payment method, or charge is created; if a real quota/add-on gate appears, stop and ask separately. - Not now: keep OpenDeploy installed and make no deployment changes. If the user approves, the concise deploy request is: ```text Use skill `opendeploy` to create and deploy a new OpenDeploy project from the current repo. ``` The skill's deployment flow should: 1. Read its own instructions before calling OpenDeploy APIs. 2. Inspect the local project structure, dependencies, environment variables, database needs, build command, start command, and port. 3. Create the deployment through OpenDeploy. 4. Watch build and runtime logs. 5. Fix safe, common blocking errors when possible. 6. Return the live URL to the user. If installation fails, report the exact command that failed and the relevant error output.