Skip to main content

​
Requirements

Before installing, make sure the machine where the agent will run meets these requirements:
RequirementMinimum versionHow to check
Node.js20.x or laternode --version
npm9.x or laternpm --version
OSLinux, macOS, Windows (WSL)—
On Windows, RemoteAgent is supported and tested inside WSL 2 (Windows Subsystem for Linux). Native Windows support via PowerShell or CMD is not guaranteed.
If you need to install or upgrade Node.js, the recommended approach is using a version manager: 
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
nvm install 20
nvm use 20

​
Install RemoteAgent

Install the package globally so the remoteagent command is available from any directory: 
npm install -g remoteagent

​
Verify the installation

remoteagent --version
Expected output: 
remoteagent/x.y.z linux-x64 node-v20.x.x
If you see command not found, your npm global bin directory is not on your PATH. Fix it by adding the output of npm config get prefix followed by /bin to your shell profile: 
# Find the global bin path
npm config get prefix
# Example output: /home/youruser/.npm-global

# Add to ~/.bashrc or ~/.zshrc
export PATH="$HOME/.npm-global/bin:$PATH"

# Reload
source ~/.bashrc

​
Runner prerequisites

The remoteagent package itself has no runtime dependencies beyond Node.js. However, the AI runner you choose requires its own tooling installed separately.

​
claude-sdk (default)

No additional binary needed. The runner uses the @anthropic-ai/claude-code SDK in-process. You will need an Anthropic API key, which you provide during remoteagent init and is stored locally in ~/.remoteagent/config.json.

​
claude-code

Requires the claude CLI binary: 
npm install -g @anthropic-ai/claude-code
claude --version
You also need an Anthropic API key. The claude binary reads it from the same local config.

​
gemini

Requires the Google Gemini CLI: 
npm install -g @google/gemini-cli
gemini --version
A Google account is sufficient for the free tier. No credit card required.

​
aider

Requires Python 3.9+ and pip: 
pip install aider-chat
aider --version
Aider works with OpenAI, Anthropic, Ollama, and many other model providers. You configure the model and API key separately via aider’s own config or environment variables.

​
openclaw

Requires the OpenClaw gateway to be running locally on port 18789 before starting the agent. Refer to the OpenClaw runner documentation for setup details.

​
custom

No specific prerequisites — any binary that reads from stdin and writes to stdout will work. See Custom runner for examples.

​
Updating

To update to the latest version of RemoteAgent: 
npm update -g remoteagent
remoteagent --version

​
Uninstalling

npm uninstall -g remoteagent
This removes the binary. Local configuration stored in ~/.remoteagent/ is not deleted automatically. Remove it manually if needed: 
rm -rf ~/.remoteagent