CLI Reference

rap-agent is the command-line interface for the RAPBot Agent service on Windows/Linux deployments. Use it for service control, connecting to Orchestrator, and inspecting tasks and schedules without the desktop UI.

The agent API listens at http://localhost:56473/agent/api when the service is running.

Service Commands

Command	Description
`rap-agent service-start`	Start the agent service
`rap-agent service-stop`	Stop the service (stops running tasks first if needed)
`rap-agent service-restart`	Restart the agent service
`rap-agent status`	Check service health and connection details

Connection Commands

Command	Description
`rap-agent connect`	Interactive connect to Orchestrator (URL, Organization ID, Agent ID, machine description)
`rap-agent disconnect`	Disconnect from Orchestrator (`-f` / `--force` to force)
`rap-agent refresh`	Immediately sync tasks, schedules, and configuration from Orchestrator (same as the Refresh button in the Agent UI)

Connection values come from Connection Details in the Orchestrator agent info dialog.

Example: connect

rap-agent connect
# Enter the orchestrator URL : https://orchestrator-v2.rapidautomation.ai
# Enter the organization Id : <org-id>
# Enter the agent Id : <agent-id>
# Enter the machine description : Finance-PC-01

Example: status

When connected, rap-agent status shows domain, organization, agent name, type, time zone, version, and connected time.

Task Commands

Command	Description
`rap-agent tasks`	List tasks synced from Orchestrator
`rap-agent schedule`	List schedules (optional task ID filter)
`rap-agent running-task`	Show tasks currently executing
`rap-agent start-task`	Start a task by ID
`rap-agent stop-task`	Stop a task by ID

Tasks must be assigned in Orchestrator before they appear in rap-agent tasks. Under normal operation, tasks sync to the agent automatically within 30 seconds without running refresh.

Typical Unattended Setup

Create and deploy agent in Orchestrator
rap-agent service-start
rap-agent connect with copied connection details
Assign and schedule tasks in Orchestrator
Monitor runs in Task Execution Logs