Skip to content

Workspace CLI

Use provon workspace to inspect organizations and projects, invite members, and manage membership roles. These commands operate on the Workspace API and require an authenticated credential.

View as Markdown Open the plain-text version of this page.

Prerequisites#

  • Authenticated CLI (see Authentication).
  • Sufficient permission for the operation: reads generally require workspace:read; writes require the matching organization or project permission held by the current session.

Organizations#

List organizations available to the current credential:

bash
provon workspace organizations list
provon workspace orgs list

Create an organization (name only; the slug is derived server-side):

bash
provon workspace organizations create "My Org"

Inspect and update an organization:

bash
provon workspace organizations get <organization-id>
provon workspace organizations update <organization-id> --name "New Name"
provon workspace organizations update <organization-id> --slug new-slug

Organization Membership#

Invite a user:

bash
provon workspace organizations invite <organization-id> <email> --role MEMBER

Roles (uppercase):

Role Scope
OWNER Full organization control
ADMIN Member and project administration
MEMBER Default access
VIEWER Read-only access

Revoke a pending invitation:

bash
provon workspace organizations revoke-invitation <organization-id> <invitation-id>

Update or remove a member:

bash
provon workspace organizations set-member-role <organization-id> <member-id> --role ADMIN
provon workspace organizations remove-member <organization-id> <member-id>

Projects#

List projects available to the current credential:

bash
provon workspace projects list

Create a project in an organization:

bash
provon workspace projects create "My Project" \
  --organization-id <organization-id> \
  --description "Project description"

Inspect and update a project:

bash
provon workspace projects get <project-id>
provon workspace projects update <project-id> --name "New Name"
provon workspace projects update <project-id> --slug new-slug
provon workspace projects update <project-id> --description "Updated description"

Delete a project:

bash
provon workspace projects delete <project-id>

Project Membership#

Set or remove a project member role override:

bash
provon workspace projects set-member-role <project-id> <user-id> --role ADMIN
provon workspace projects remove-member-role <project-id> <user-id>

Selecting The Active Project#

workspace projects list inventories projects; it does not change the active profile. Switch the active project with the dedicated project command:

bash
provon project use <project-id>
provon project current

Success Check#

bash
provon workspace projects list

A healthy result returns ok: true with project records; the id from this list feeds provon project use <project-id>.

Troubleshooting#

Symptom Likely cause Fix
HTTP_403 on create/update Session lacks the write permission Use an OWNER/ADMIN session
projects.missing_organization --organization-id omitted Pass the organization id from organizations list
Role rejected Lowercase or unknown role value Use OWNER, ADMIN, MEMBER, or VIEWER
New project not selected workspace projects create does not set the active project Run provon project use <project-id> afterward
Invitation not visible Invitation pending or revoked Refresh with organizations get <organization-id>