Skip to content
Orvanta Docs

orvanta workspace

A workspace profile is how the CLI authenticates: a (name, remote URL, workspace id, token) tuple stored under your config directory (default ~/.config, override with OV_CONFIG_DIR). You can keep several profiles and switch between them.

Usage

Section titled “Usage”
Terminal window
orvanta workspace <subcommand> [options]

Getting a token

Section titled “Getting a token”

Create a workspace token from the Orvanta UI under User Settings → Tokens, or from the CLI with orvanta user create-token.

Subcommands

Section titled “Subcommands”

add

Section titled “add”

Add a workspace profile. Run interactively, or pass the values directly.

Terminal window
orvanta workspace add [workspace_name] [workspace_id] [remote]

For a self-hosted instance, point remote at your own URL (e.g. https://orvanta.example.com).

switch

Section titled “switch”

Switch the active workspace profile.

Terminal window
orvanta workspace switch <workspace_name>

list

Section titled “list”

List local workspace profiles. Use list-remote to see workspaces you can access on the server.

Terminal window
orvanta workspace list
orvanta workspace list-remote

whoami

Section titled “whoami”

Show the currently active user.

Terminal window
orvanta workspace whoami

remove

Section titled “remove”

Remove a local workspace profile.

Terminal window
orvanta workspace remove <workspace_name>
Section titled “Related”
  • CLI Overview — Global options and the core loop.
  • Sync — Push and pull changes once a workspace is connected.