Skip to main content

Cmdra Documentation

Cmdra is a long-running Go daemon that exposes a gRPC API over mutual TLS for remote process execution and file transfer.

Use this site to:

  • install cmdrad on Linux, macOS, and Windows
  • configure mTLS and CN-based client authorization
  • operate the daemon with cmdractl or cmdraui
  • build against the Go and Python SDKs
  • integrate the Python client with Robot Framework and Ansible

What the daemon provides​

cmdrad supports:

  • argv command execution
  • shell command execution
  • persistent shell sessions with attach/reconnect
  • optional PTY-backed shell commands and shell sessions, including Windows ConPTY support
  • stdout and stderr replay from persisted history
  • file upload, file download, and archive download
  • execution and transfer metadata retention in SQLite under -data-dir
  • deletion of one finished execution or transfer from history
  • clearing finished history for the authenticated identity
  • foreground mode and service mode on Linux, macOS, and Windows
  1. Generate development certificates
  2. Install on Linux, macOS, or Windows
  3. Use cmdractl or use cmdraui
  4. Use the Go SDK or Python SDK
  5. Integrate Robot Framework or Ansible

Repository commands​

Build the binaries from the repository root:

go build ./cmd/cmdrad
go build ./cmd/cmdractl
go build ./cmd/cmdraui
./cmdractl version
./cmdraui version

Generate protobuf stubs:

./scripts/gen-proto.sh

Build release artifacts:

./scripts/build-release.sh
./scripts/build-python-package.sh