Sign-in and context commands
This page lists every argument and option of the commands that save, select, and inspect your workspaces: devo login, devo logout, devo status, devo info, and devo context. For an overview of all commands, see Commands. For step-by-step help, see Sign in to Devolutions Cloud, Sign in to Devolutions Server, Use a local Devolutions Remote Desktop Manager profile and Switch between workspaces.
The options every command accepts, such as --context, --source, or --output json, are in Global options.
devo login
Saves a workspace as a context: signs in to Devolutions Cloud or Devolutions Server, or points at the folder of a local Devolutions Remote Desktop Manager profile. The new context becomes the current one, unless you add --no-set-current.
Workspace: All workspace types
devo login <name> --cloud <url> --oauth
devo login <name> --cloud <url> --application-key <key> --application-secret-env <variable>
devo login <name> --server <url> --api-key-env <variable>
devo login <name> --server <url> --username <username> --password-env <variable>
devo login <name> --sqlite <folder>Pass exactly one of --cloud, --server, or --sqlite. Without any of them, or with more than one, the command stops before contacting anything.
<name>
Name of the context to create. Required. It can't be empty. It can't be a name already used by a context of another kind: choose another name, or delete the other context first.
--cloud <url>
Devolutions Cloud address, for example https://example.devolutions.app. It must be an absolute https address without a username or password in it; plain http is accepted only for a loopback address such as localhost. Signing in again with the name of an existing Devolutions Cloud context replaces it.
--server <url>
Devolutions Server address. Same rules as --cloud: absolute https address, http only for a loopback address, no username or password in it.
--sqlite <folder>
Folder of the local Devolutions Remote Desktop Manager profile that holds the SQLite workspace. Environment variables in the path are expanded. Nothing is signed in: the context only points at the folder. The sign-in options below are ignored with --sqlite.
--oauth
Off
Devolutions Cloud or Devolutions Server: signs in through your browser. Devolutions CLI prints the sign-in address on the error output every time, in case the browser doesn't open. Uses a local browser redirect, unless you add --use-device-code. Can't be combined with the application key options (Devolutions Cloud), or with an API key, username, password, domain, or application-user option (Devolutions Server).
--use-device-code
Off
With --oauth only: signs in with a device code instead of the local browser redirect, for a computer without a browser. Setting the environment variable DEVO_CLI_USE_DEVICE_CODE has the same effect. With Devolutions Cloud, a device-code sign-in gets no account key, so only devo status and devo logout work: sign in without --use-device-code for full access. Refused without --oauth.
--application-key <key> (--app-key)
Devolutions Cloud only: application key. Required for a Devolutions Cloud sign-in without --oauth. It can't contain control characters. Refused with --oauth and with --server.
--application-secret-env <variable> (--app-secret-env)
Devolutions Cloud only: name of the environment variable that holds the application secret. Use this option or --application-secret-file, not both. The variable must exist and its value can't be empty.
--application-secret-file <path> (--app-secret-file)
Devolutions Cloud only: file that holds the application secret. Line breaks at the end of the file are ignored.
--api-key-env <variable>
Devolutions Server only: name of the environment variable that holds the API key. Use this option or --api-key-file, not both. Can't be combined with --username, a password option, --domain-id, or --as-application.
--api-key-file <path>
Devolutions Server only: file that holds the API key.
--username <username>
Devolutions Server only: username, for username and password sign-in. Needs --password-env or --password-file.
--password-env <variable>
Devolutions Server only: name of the environment variable that holds the password. Use this option or --password-file, not both. Needs --username.
--password-file <path>
Devolutions Server only: file that holds the password. Needs --username.
--windows-auth
Off
Devolutions Server only: signs in with Windows authentication. Works on Windows only. Can't be combined with --username, a password option, --domain-id, or --as-application.
--as-application
Off
Devolutions Server only: with --username and a password option, signs in as an application user.
--domain-id <id>
Devolutions Server only: domain ID, for domain authentication with --username and a password option.
--timeout <seconds>
15
Devolutions Cloud and Devolutions Server: timeout of the requests made while signing in, from 3 to 600 seconds. Any other value is refused. The value isn't saved with the context: it applies to this sign-in only.
--no-set-current
Off
Saves the context without making it the current one. For a local profile, the new context still becomes the current one when no context is current yet.
--workspace <name>
Local profile only: default workspace, saved with the context as a hint for people and agents. Refused with --cloud or --server.
--vault <name>
Local profile only: default vault, saved with the context as a hint for people and agents. Refused with --cloud or --server.
--description <text>
Local profile only: description of the context. Refused with --cloud or --server.
--replace
Off
Local profile only: replaces an existing local profile context with the same name. Without it, that name is refused. Refused with --cloud or --server.
Sign-in methods at a glance
Devolutions Cloud
--oauth (optionally with --use-device-code), or --application-key with --application-secret-env or --application-secret-file.
Devolutions Server
--oauth (optionally with --use-device-code), --api-key-env or --api-key-file, --username with --password-env or --password-file (optionally with --domain-id or --as-application), or --windows-auth. Without a sign-in method, or with more than one, the command stops.
Local profile
No sign-in: --sqlite <folder>, optionally with --workspace, --vault, --description, and --replace.
Before it saves a Devolutions Cloud or Devolutions Server context, devo login checks the sign-in with the workspace. If the check fails, nothing is saved. Errors in the options themselves stop the command with exit code 2; a failed sign-in exits with 1. See Exit codes and errors.
devo logout
Clears the stored sign-in of a Devolutions Cloud or Devolutions Server context. The context itself is kept: sign in again with devo login, or delete it with devo context delete.
Workspace: Devolutions Cloud, Devolutions Server
<name>
Current context
Context to sign out of. Without it, the current context is used; if no context is current, the command stops and asks for a name. A local profile context is refused, because it has no sign-in. For a browser sign-in, the session kept in the secure store is deleted too.
devo status
Shows the selected workspace: its context, its kind, and, for Devolutions Cloud or Devolutions Server, whether you're signed in.
Workspace: All workspace types
<name>
Selected workspace
Context to show. Without it, the workspace selected by --source, --context, or the current context is shown. An unknown name is an error. For a local profile, the status shows the context and its profile folder. With --source cloud or --source server and no context name, the current context of that kind is used; if there's none, the status says you're not signed in instead of failing.
--online
Off
Devolutions Cloud and Devolutions Server: contacts the workspace to check that the sign-in still works. If the check fails, the command reports the error and exits with code 1. Without --online, the status comes from what's saved on your computer and nothing is contacted. Has no effect on a local profile.
devo info
Shows information about a Devolutions Cloud or Devolutions Server instance, for a saved context or for an address, without signing in.
Workspace: Devolutions Cloud, Devolutions Server
<name>
Selected workspace
Context to query. Without it and without an address, the selected workspace is used. A local profile is refused: the command works with Devolutions Cloud and Devolutions Server only. Can't be combined with --cloud or --server. With a saved context and without --private, only public information is returned and the context's sign-in isn't used.
--cloud <url>
Devolutions Cloud address to query without a saved context. Same address rules as devo login. Can't be combined with --server or a context name.
--server <url>
Devolutions Server address to query without a saved context. Only public information is returned. Can't be combined with --cloud or a context name.
--private
Off
Devolutions Server only: adds private information, using the sign-in of a saved context. Refused with --server <url>, and refused for Devolutions Cloud.
devo context list
Lists your contexts of every workspace type, sorted by name, and shows which one is current. Alias: devo context ls.
Workspace: All workspace types
This command has no arguments or options of its own.
devo context use
Makes a context the current one. Every later command uses it, until you choose another one or override it for one command with the global option --context <name>.
Workspace: All workspace types
<name>
Context to make current. Required. If the same name exists for more than one kind of context, the command stops and tells you to delete one of them with devo context delete <name> --kind <kind>.
devo context inspect
Shows the details of a context: its kind, its address or profile folder, and, for a local profile, its default workspace, default vault, and description.
Workspace: All workspace types
<name>
Current context
Context to show. Without it, the current context is shown; if no context is current, the command stops and asks for a name.
devo context delete
Removes a context. Alias: devo context rm. If it was the current context, no context is current afterwards.
Workspace: All workspace types
<name>
Context to delete. Required. Deleting a local profile context removes only the context: the profile folder isn't touched.
--kind <kind>
Kind of context to delete, when the same name exists for more than one kind: sqlite (local profile), cloud, or server. Any other value is refused.
--yes (-y, --confirmed)
Off
Confirms deleting a Devolutions Cloud or Devolutions Server context, which also discards its stored sign-in. Without it, such a context isn't deleted. Not needed for a local profile context.
Next
Last updated
Was this helpful?