Skip to main content
Display the agent-desktop version, target architecture, and operating system.

​
Usage

agent-desktop version [--json]

​
Parameters

​
--json
boolean
default:"false"
Output version information as JSON. Without this flag, the command still returns JSON (all commands return JSON), but this flag is preserved for consistency with other CLI tools.
agent-desktop version --json

​
Response

​
version
string
required
Semantic version string (e.g., "0.1.0")
​
target
string
required
CPU architecture (e.g., "x86_64", "aarch64")
​
os
string
required
Operating system (e.g., "macos", "windows", "linux")

​
Examples

​
Show Version

agent-desktop version

{
  "version": "1.0",
  "ok": true,
  "command": "version",
  "data": {
    "version": "0.1.0",
    "target": "aarch64",
    "os": "macos"
  }
}

​
With —json Flag

agent-desktop version --json

{
  "version": "1.0",
  "ok": true,
  "command": "version",
  "data": {
    "version": "0.1.0",
    "target": "aarch64",
    "os": "macos"
  }
}

​
Use Cases

Verify agent-desktop version before running commands:
VERSION=$(agent-desktop version | jq -r '.data.version')
echo "Using agent-desktop $VERSION"

# Check minimum version
MIN_VERSION="0.1.0"
if [ "$VERSION" \< "$MIN_VERSION" ]; then
  echo "Error: Requires agent-desktop >= $MIN_VERSION"
  exit 1
fi
Detect platform and architecture:
OS=$(agent-desktop version | jq -r '.data.os')
ARCH=$(agent-desktop version | jq -r '.data.target')
echo "Running on $OS ($ARCH)"
Include version information in bug reports:
echo "Environment:"
agent-desktop version | jq '.data'
Log version at the start of CI runs:
# In GitHub Actions
- name: Check agent-desktop version
  run: |
    agent-desktop version
    echo "AGENT_DESKTOP_VERSION=$(agent-desktop version | jq -r '.data.version')" >> $GITHUB_ENV

​
Version Format

Agent-desktop follows Semantic Versioning:
  • Major version (X.0.0): Breaking changes
  • Minor version (0.X.0): New features, backward compatible
  • Patch version (0.0.X): Bug fixes, backward compatible
Example: 0.1.0 means:
  • Pre-1.0 (API may change)
  • First feature release
  • No patches yet

​
Target Architectures

Common target values:
ValueDescription
x86_64Intel/AMD 64-bit
aarch64ARM 64-bit (Apple Silicon)
i686Intel/AMD 32-bit (legacy)

​
Operating Systems

Current and planned os values:
ValueStatus
macos✅ Fully supported (Phase 1)
windows🚧 Planned (Phase 2)
linux🚧 Planned (Phase 2)

​
Extracting Version Components

# Get just the version number
agent-desktop version | jq -r '.data.version'
# Output: 0.1.0

# Get major.minor
agent-desktop version | jq -r '.data.version' | cut -d. -f1-2
# Output: 0.1

# Get OS
agent-desktop version | jq -r '.data.os'
# Output: macos

# Get architecture
agent-desktop version | jq -r '.data.target'
# Output: aarch64
  • status - Show overall system status including version
  • permissions - Check accessibility permission status

Build docs developers (and LLMs) love

Get started for freeTalk to us