For the complete documentation index, see llms.txt. This page is also available as Markdown.

Global options

These options work with every devo command, before or after the command name. For example, devo --json context list and devo context list --json do the same thing.

Output

OPTION
DEFAULT
WHAT IT DOES

--output <format>

text

Output format: text, json, or yaml. JSON and YAML return the result in an envelope that scripts can read. See Read results as JSON.

--json

Off

Same as --output json.

--yaml

Off

Same as --output yaml.

--quiet

Off

Hides the notices that aren't part of the result, such as a message saying the background process was started.

--verbose

Off

Writes those notices to the error output, even with --output json or --output yaml. Without --verbose, they only appear in text output.

Workspace selection

By default, a command uses the current context, the one you last signed in to or selected with devo context use. These options pick another workspace for one command only. See Switch between workspaces.

OPTION
DEFAULT
WHAT IT DOES

--context <name>

Current context

Uses the context <name>: a local Devolutions Remote Desktop Manager profile, or a Devolutions Cloud or Devolutions Server sign-in. Takes priority over the DEVO_CONTEXT environment variable.

--source <source>

Uses a workspace type: sqlite for the local profile, cloud or cloud:<context> for Devolutions Cloud, server or server:<context> for Devolutions Server. Takes priority over --context and the DEVO_RDM_SOURCE environment variable.

Background process

Most commands that read your workspace go through a background process that devo starts on its own. See How Devolutions CLI works.

OPTION
DEFAULT
WHAT IT DOES

--daemon <policy>

auto

auto starts the background process when it's needed. require uses one that's already running and never starts one. never fails instead of contacting it. Takes priority over the DEVO_DAEMON_MODE environment variable.

--no-daemon-autostart

Off

Doesn't start the background process automatically.

Prompts

OPTION
DEFAULT
WHAT IT DOES

--non-interactive

Off

Fails instead of asking for missing input. Also on when the DEVO_NON_INTERACTIVE environment variable is turned on (any value except 0, false, or no), or when the standard input is redirected, for example in a pipeline.

--answer <answer>

Answers a prompt in advance. Repeat for several prompts: answers are used in order. For a choice, give the label of the option or its number, starting at 0. Answers from the DEVO_PROMPT_ANSWERS environment variable come after these.

Help and version

OPTION
WHAT IT DOES

--help

Shows the help of the command: its description, subcommands, arguments, and options. Works at every level, such as devo --help or devo secret run --help.

--version

Shows the version of Devolutions CLI. Use it with devo alone.

Options that can't be combined

These combinations stop the command before it runs, with the error code conflictingOptions and exit code 2:

COMBINATION
MESSAGE

--json with --yaml

"Use only one output selector: --json, --yaml, or --output."

--json with --output text or --output yaml

"Use either --json or --output with a matching format, not both."

--yaml with --output text or --output json

"Use either --yaml or --output with a matching format, not both."

--quiet with --verbose

"Use either --quiet or --verbose, not both."

An unknown --source value fails with the code invalidSource and exit code 2. An unknown --output or --daemon value is rejected like any other invalid argument, with exit code 2. See Exit codes and errors.

Last updated

Was this helpful?