Skip to main content
RemoteAgent runs as a background process on your machine, listening for Telegram commands and forwarding them to your AI runner. All configuration is stored locally in ~/.remoteagent/ — nothing is ever sent to the RemoteAgent servers except the relay messages.

Commands

remoteagent init

Set up a new agent and pair it with your Telegram bot.
remoteagent init
Launches an interactive wizard that asks for:
  • Runner — which AI engine to use (see Runners)
  • Authentication — API key or OAuth token, depending on the runner
  • Pairing code — generated from the dashboard
Flags:
FlagDescription
--runner <type>Skip runner selection. Options: opencode, claude-sdk, claude-code, gemini, aider, openclaw, custom
--runner-bin <path>Binary path — required when --runner custom is used
remoteagent init --runner opencode
remoteagent init --runner claude-code
remoteagent init --runner custom --runner-bin /usr/local/bin/my-ai-tool

remoteagent start [name] [-f] [-v]

Start an agent. Runs in background by default.
remoteagent start              # start the only configured agent
remoteagent start my-project   # start a specific agent by project name
remoteagent start -f           # run in foreground (keep terminal open)
remoteagent start -v           # run in foreground with verbose logs
FlagDescription
-fForeground mode — process stays attached to the terminal
-vVerbose mode — implies -f, shows detailed logs

remoteagent stop [name]

Stop a running background agent.
remoteagent stop
remoteagent stop my-project

remoteagent logs [name]

Tail the log file of a background agent in real time.
remoteagent logs
remoteagent logs my-project
Logs are stored in ~/.remoteagent/agents/{agentId}.log.

remoteagent config

Interactively update settings: API key, preferred language, and per-agent project path or name.
remoteagent config
You can also pass flags directly:
remoteagent config --api-key sk-ant-...
remoteagent config --language Italian
remoteagent config --agent <agentId> --path /new/path/to/project
remoteagent config --agent <agentId> --name new-project-name

remoteagent set-path [name]

Shortcut to update the project directory for an agent without going through the full config menu.
remoteagent set-path
remoteagent set-path my-project

remoteagent remove [name]

Remove an agent: stops it, deletes its local config, and unregisters it from the server.
remoteagent remove
remoteagent remove my-project
This action is irreversible. The agent will need to be re-paired from scratch if you want to use it again.

remoteagent startall

Start (or restart) all configured agents in background. Useful for reboots or after reinstall.
remoteagent startall

remoteagent reinstall

Download and install the latest version of RemoteAgent, then restart all running agents.
remoteagent reinstall
Equivalent to running the install script again:
curl -fsSL https://remoteagent.chat/install | bash

remoteagent list

Show all configured agents and their current status (online / offline).
remoteagent list

remoteagent help

Show the built-in help message with all available commands.
remoteagent help

Configuration files

All config is stored locally. Nothing is transmitted to RemoteAgent servers except relay messages.
FileContents
~/.remoteagent/config.jsonGlobal settings: API key, preferred language
~/.remoteagent/agents/{agentId}.jsonPer-agent: credentials, project path, runner choice
~/.remoteagent/agents/{agentId}.logRuntime logs for each agent
~/.remoteagent/agents/{agentId}.pidPID file for background process detection