Skip to main content

GetApp Agent CLI

getapp is the command-line interface for the GetApp Agent — manage device updates, configuration, and software delivery from a terminal, either as one-shot commands for scripting or as an interactive shell with history and tab completion.

Key features​

  • Dual modes — one-shot commands and an interactive REPL
  • Tab completion — commands, subcommands, and flags
  • Command abbreviations — dev g → device get
  • Smart retry — exponential backoff for failed requests
  • Multiple output formats — JSON, YAML, table, plain text

Installation​

The getapp CLI ships bundled with the agent installation — no separate install step needed on a managed device.

To build it from source (contributors):

# from the agent/ repository root
cargo build --bin getapp --release

# binary location
target/release/getapp # Linux/macOS
target/release/getapp.exe # Windows

Defaults: URL http://localhost:2220 · timeout 30s · format json · no retries.

Usage modes​

One-shot — run a single command:

getapp device get
getapp --retry 3 discover --discovery-type get-app

Interactive — start the REPL:

getapp
getapp> dev g # abbreviated: device get
getapp> conf s --deploy-timeout 120
getapp> exit

See Interactive Mode for tab completion, history, and keyboard shortcuts.

note

Global flags must come before the command name: getapp --port 8080 device get, not getapp device get --port 8080.

Global flags​

FlagDescriptionDefault
-u, --url <URL>Agent base URLhttp://localhost:2220
-p, --port <PORT>Override port2220
-t, --timeout <SEC>Request timeout30
-o, --output <FMT>Format: json, yaml, table, plainjson
-c, --no-color, --ncDisable colorsEnabled
-r, --retry <N>Retry attempts (0–5)0
-v, --versionShow version—
-h, --helpShow help—
getapp --url http://remote:8080 device get
getapp --timeout 120 --retry 3 discover --discovery-type get-app
getapp --output yaml --no-color config get > config.yaml

Set NO_COLOR=1 to disable colors globally.

Retry behavior​

Exponential backoff with --retry:

RetryDelayCumulative
1st1s1s
2nd2s3s
3rd4s7s
4th8s15s
5th16s31s
getapp --retry 3 --timeout 120 discover --discovery-type get-app

Commands​

  • Device — device information and enrollment
  • Config — read and update runtime settings
  • Offering — query available offerings
  • Discover — trigger component discovery
  • Other — about / status

Quick reference​

# Build
cargo build --bin getapp --release

# Basic commands
getapp device get
getapp config set --deploy-timeout 120
getapp discover --discovery-type get-app

# With flags
getapp --url http://remote:8080 --retry 3 device get
getapp --output yaml --no-color config get

# Interactive
getapp # start REPL
getapp> dev g # abbreviated: device get
getapp> help # show help
getapp> exit # exit