Skip to content
Subako Docs
Esc
↑↓navigate↵open⌘Jpreview
On this page

subako workspace

Workspaces: the scope every unit of work belongs to

CLI reference

subako workspace

Workspaces: the scope every unit of work belongs to

Usage

Usage: subako workspace <COMMAND>

Subcommands

Options

--help

Print help

  • Short option: -h.

subako workspace create

Create a workspace in the signed-in organization

Usage

Usage: subako workspace create [OPTIONS] --name <NAME>

Options

--name <NAME>

Name for the new workspace

  • Required.

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako workspace list

List the organization’s workspaces, * marking the selected one

Usage

Usage: subako workspace list [OPTIONS]

Options

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako workspace show

Read one workspace: its name and when it was made

Usage

Usage: subako workspace show [OPTIONS] <WORKSPACE>

Arguments

<WORKSPACE>

Workspace name or id, as workspace list shows them

  • Required.

Options

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako workspace rename

Rename a workspace, leaving everything in it alone

Usage

Usage: subako workspace rename [OPTIONS] --name <NAME> <WORKSPACE>

Arguments

<WORKSPACE>

Workspace name or id, as workspace list shows them

  • Required.

Options

--name <NAME>

New name for the workspace

  • Required.

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako workspace delete

Permanently delete a workspace and all its contents

Usage

Usage: subako workspace delete [OPTIONS] <WORKSPACE>

Arguments

<WORKSPACE>

Workspace name or id, as workspace list shows them

  • Required.

Options

--yes

Skip the typed confirmation. For scripts that have already asked

  • Default: false.

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako workspace use

Choose the workspace this profile’s commands act in

Usage

Usage: subako workspace use [OPTIONS] <WORKSPACE>

Arguments

<WORKSPACE>

Workspace name or id, as workspace list shows them. A name several workspaces share is rejected in favor of an id

  • Required.

Options

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako workspace add-member

Add an organization member to the selected workspace

Usage

Usage: subako workspace add-member [OPTIONS] --role <ROLE> <USER_ID>

Arguments

<USER_ID>

User id, as org members shows them. A user who is not an organization member is refused

  • Required.

Options

--role <ROLE>

Role they hold in this workspace

  • Required.
  • Possible values:
    • admin
    • member

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako workspace members

List the selected workspace’s members and their roles

Usage

Usage: subako workspace members [OPTIONS]

Options

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako workspace set-member-role

Set a member’s role in the selected workspace

Usage

Usage: subako workspace set-member-role [OPTIONS] --role <ROLE> <USER_ID>

Arguments

<USER_ID>

Member’s user id, as workspace members shows them

  • Required.

Options

--role <ROLE>

Role to set

  • Required.
  • Possible values:
    • admin
    • member

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

subako workspace remove-member

Remove a member from the selected workspace, leaving their organization membership alone

Usage

Usage: subako workspace remove-member [OPTIONS] <USER_ID>

Arguments

<USER_ID>

Member’s user id, as workspace members shows them

  • Required.

Options

--profile <PROFILE>

Credential profile to act as. Defaults to the current one

--credentials-file <CREDENTIALS_FILE>

Path to the credentials file. Defaults to SUBAKO_CREDENTIALS_FILE, then ~/.config/subako/credentials.json.

--help

Print help

  • Short option: -h.

Was this page helpful?