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

Manage vaults and entries

Use devo vault and devo entry to look through your workspace and keep it organized from a terminal or a script: pick the vault you work in, find an entry, create one, update it, move it, or delete it. The commands are the same for every workspace type, but each type allows different changes. The table at the end of this page sums them up.

These commands work on the current context. To check which workspace that is, run devo status. To use another one for a single command, add --context <context-name>. See Switch between workspaces.

See and select workspaces

devo workspace list shows the workspaces you can use, with their name, ID, kind, and whether they're available. The current one is marked with *. devo workspace current shows only the current one.

On a local Devolutions Remote Desktop Manager profile, you can also select, create, and delete workspaces:

TO
RUN

Select the workspace you work in

devo workspace use "<workspace-name>" Use id:<workspace-id> to select it by ID.

Create a SQLite workspace

devo workspace create "<workspace-name>" --passphrase-file <passphrase-file> --yes The database file is <workspace-name>.db in the profile folder, unless you give another file name with --path. The passphrase protects the new workspace; it can also come from an environment variable with --passphrase-env. The new workspace becomes the current one, unless you add --no-set-current.

Delete a workspace

devo workspace delete id:<workspace-id> --yes Use the exact ID that devo workspace list shows. This deletes the workspace database file, and its temporary files, from the profile folder: it can't be undone. Available on Windows only; on macOS and Linux, the command stops with sqliteWorkspaceDeleteUnsupported.

Select the vault you work in

Most entry commands use the current vault. On Devolutions Cloud and Devolutions Server, a command that reads entries needs one: either a current vault, or --vault-name or --vault-id on the command.

  1. List the vaults you can see:

    devo vault list
  2. Make one of them the current vault:

    devo vault use "<vault-name>"
  3. Check which vault is current:

    devo vault current

To work in another vault for one command without changing the current one, add --vault-name "<vault-name>" or --vault-id <vault-id> to that command.

To see the details of one vault, run devo vault get "<vault-name>". On a local profile, devo vault settings get shows the root settings of the current vault (or of the vault you name), and devo vault template list lists the vault templates.

Commands select a vault, entry, user, or group by name by default. When two items share a name, or a name is hard to type, select by ID: write id:<value> or add --id. For example, devo vault use id:<vault-id>.

Find entries

Search the current vault, or another one, by text, type, or folder:

OPTION
WHAT IT DOES

--type

Keeps only one entry type. devo entry types lists the type identifiers.

--group

Keeps only the entries under a folder path.

--limit

Maximum number of entries returned. The default is 100.

--smart-folder

Meant to list the entries of a smart folder, but no workspace type evaluates smart folders: the command stops with smartFolderUnavailable. Filter with --group or --type instead.

To see one entry, use devo entry get "<entry-name>". Neither command shows secret values. To use a secret, find its reference with devo entry references and see Find the reference to a secret.

On a local profile, devo entry sealed list lists the sealed entries, with the same kind of filters (--name, --type, --group, --limit), and devo entry template list lists the entry templates.

Read and change entry details

Besides its secrets, an entry holds details that aren't secret: its host, username, or domain, its attachments, its documentation pages, or its command parameters. These commands read and change them. None of them shows a secret value.

Read or change one field. devo entry field get returns a single value, which is handy in a script:

It reads name, type, group, host, username, domain, port, or another property of the entry, such as a metadata property. On Devolutions Server, only the ID, name, type, folder, and vault come back: host and username are empty. See Entry commands. To change a field, use devo entry field set with the new value in --value, or from --value-env or --value-file:

devo entry field set changes the same fields as devo entry update: host, username, and domain on Devolutions Server and a local profile, and name on a local profile only. It refuses password: to change a password, use devo secret set. See Update a secret from a script.

Other details of an entry, on a local profile:

TO
RUN

List the metadata fields

devo entry metadata list "<entry-name>" You can also select the entry by its path: path:<entry-path>.

List the attachments

devo entry attachment list "<entry-name>"

Read a documentation page

devo entry documentation list <entry-id> devo entry documentation get <entry-id> --title "<page-title>" These commands take the entry ID.

Rename a documentation page

devo entry documentation update <entry-id> --title "<page-title>" --new-title "<new-title>" --yes A local profile can't change the content of a page.

List and change command parameters

devo entry parameter list "<entry-name>" devo entry parameter set "<entry-name>" --label "<label>" --new-label "<new-label>" --yes Select the parameter by --label or --position. You can change its label (--new-label), its type (--type: Text, Secured, EnvironmentVariable, or Unused), or its default value (--value, --value-env, or --value-file). --include-unused also lists the unused parameter slots.

List the items of a Password List entry

devo entry password-list list "<entry-name>" --name "<item-name>" --name filters the items by name. Passwords and sensitive custom fields come back empty.

Create and update vaults

Creating, renaming, and deleting vaults is available on Devolutions Cloud and Devolutions Server.

  1. Create a vault:

    To create several vaults at once, use devo vault create-many "<name-1>" "<name-2>" --yes. Devolutions CLI reports which ones were created and which ones failed.

  2. Rename a vault or change its description:

Create and update entries

Creating entries is available on a local Devolutions Remote Desktop Manager profile.

Both commands below write to the local workspace, so they need its passphrase: pass --passphrase-file <file> or --passphrase-env <VARIABLE_NAME>, or keep it in a <workspace file>.passphrase file in the profile folder. Without one, they stop with missingParameter.

  1. Create the entry. A local profile creates RDP entries only:

    The entry goes to the default vault: a local profile creates entries there only, and another --vault-id stops with sqliteEntryCreateVaultUnsupported.

  2. Set its password from an environment variable or a file, so the value never appears on the command line:

To change an existing entry, use devo entry update with the fields to change:

What you can change depends on the workspace type:

  • Local profile: --new-name, --host, --username, and --domain. --host-port and --password-secret-reference are refused.

  • Devolutions Server: --host, --username, and --domain.

  • Devolutions Cloud: only the password, with devo secret set.

Organize entries

These commands are available on a local profile.

TO
RUN

Move entries to another folder

devo entry move --entry-id <entry-id> --destination-group "<folder>" --yes Repeat --entry-id to move several entries. A local profile moves entries within their vault only: a different --to-vault stops with entryMoveCrossVaultUnsupported. An empty --destination-group moves them to the root of the vault.

Rename a folder

devo entry folder rename "<folder-path>" --new-name "<new-name>" --yes The paths of the entries inside the folder are updated too.

Set the status of an entry

devo entry status set "<entry-name>" --status Locked --message "<reason>" --yes Status values: Archived, Broken, Default, Disabled, Expired, Locked, or Warning. To select the entry by ID with this command and devo entry tag set, add --id: these two commands don't recognize the id: prefix.

Replace the tags of an entry

devo entry tag set "<entry-name>" --tag <tag-1> --tag <tag-2> --yes The tags you pass replace the existing ones. Use --clear to remove them all.

To read them back, use devo entry status get and devo entry tag list. These two commands stop with entryFieldNotFound when the entry has no status or no tags, and always on Devolutions Cloud and Devolutions Server, which don't return them. To see the entries that were deleted, use devo entry trash list, with --before <date> to see only those deleted before a date.

Delete entries and vaults

Deleting entries and vaults is available on Devolutions Cloud and Devolutions Server.

Delete an entry:

On Devolutions Cloud, deleting an entry also deletes the entries under it. Devolutions CLI refuses to do it until you add --acknowledge-recursive-scope, which shows you know.

Delete a vault:

On Devolutions Cloud, select the vault by its ID: a vault name or the current vault isn't accepted. The vault goes to the recycle bin, unless you add --permanently.

What each workspace type can do

TASK
LOCAL PROFILE
DEVOLUTIONS CLOUD
DEVOLUTIONS SERVER

List workspaces, show the current one

Yes

Yes

Yes

Select, create, and delete workspaces

Yes

No

No

List and select vaults

Yes

Yes

Yes

Create, rename, and delete vaults

No

Yes

Yes

List, search, and get entries

Yes

Yes

Yes

Create entries

RDP entries

No

No

Read a field (devo entry field get)

Yes

Yes

ID, name, type, folder, and vault only

Update entries (devo entry update, devo entry field set)

Yes*

No (password with devo secret set)

Host, username, domain

Metadata, attachments, documentation, command parameters, Password List items

Yes*

No

No

Move entries, rename folders

Yes*

No

No

Read and set status and tags

Yes*

No

No

Delete entries

No

Yes, with --acknowledge-recursive-scope

Yes

List deleted entries

Yes

No

No

* When the profile allows it. devo doctor lists the operations the selected workspace supports. If a change isn't available on your profile, make it in Devolutions Remote Desktop Manager.

Good to know

  • --yes confirms the change. Without it, the command changes nothing and stops with confirmationRequired. See Run without prompts.

  • Add --output json to get a result a script can read. See Read results as JSON.

  • A command stops with operationNotSupportedBySource (Devolutions Cloud, Devolutions Server) or another code that says the local profile can't do it? The selected workspace can't make that change. See A command says the workspace doesn't support it.

Next

Last updated

Was this helpful?