Updated August 21, 2026

CLI commands

robotframework-velo-cli is the Robot-native integration. It packages the suite, calls the REST API, streams logs, and exits with a standard Robot exit code. Copado CRT uses this path.

pip install robotframework-velo-cli

The package installs a robot wrapper. Without VELO_REMOTE, robot is local Robot Framework. Some CI tools invoke python -m robot — run velo install after pip so a usercustomize hook intercepts that path (required for Copado CRT).

Commands

CommandPurpose
velo loginStore API key (~/.config/velo/config.yaml, mode 0600)
velo logoutRemove stored key
velo configureUpdate stored api_base / engine / engine_version
velo robot [opts] <suite>Always remote (no VELO_REMOTE needed)
velo installHook for python -m robot in CI

Flags on velo robot: --engine, --engine-version, --api-base, --download-video, plus Robot --include / --exclude / --variable / --outputdir.

velo login --api-base https://api.velo.aster.pro --engine robot-sap
velo robot ./tests
velo robot --engine robot-web --include smoke ./tests

Settings resolve flags → env → config file → defaults.

Execution modes

InvocationBehaviour
velo robot …Remote
VELO_REMOTE=1 robot …Remote via the robot wrapper
robot … (no remote flag)Local Robot Framework
VELO_DEBUG=1 robot …Local debug: Windows GUI on win32, Docker Java elsewhere

Environment

VariableDefaultDescription
VELO_API_KEY—Workspace key, or store via velo login
VELO_API_BASEhttps://api.velo.aster.proAPI origin. Local: http://localhost:8000
VELO_ENGINErobot-sapImage ID (robot-sap, robot-web, …)
VELO_ENGINE_VERSIONengine defaultPin image version
VELO_REMOTE01 for remote when using robot
VELO_DOWNLOAD_VIDEO0Download video.mp4
VELO_DEBUG0Local debug
VELO_SAP_CLIENTautoauto, java, or windows

Remote flow

  1. Scan the working directory (.veloignore, or built-in excludes).
  2. Zip and POST /suites with the engine.
  3. POST /executions with strategy=batched.
  4. Stream the child run via SSE.
  5. Download output.xml, log.html, report.html to --outputdir (default ./results/).

Exit codes match Robot Framework (0 pass, 1 failures, 253 platform error).

Related