Skip to content
Subako Docs
Esc
navigateopen⌘Jpreview
On this page

subako org

The signed-in organization, its members, and its invitations

CLI reference

subako org

The signed-in organization, its members, and its invitations

Usage

Usage: subako org <COMMAND>

Subcommands

Options

--help

Print help

  • Short option: -h.

subako org show

Show the signed-in organization

Usage

Usage: subako org show [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 org rename

Rename the organization, leaving its handle alone

Usage

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

Options

--name <NAME>

New name for the organization

  • 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 org members

List the organization’s members and their roles

Usage

Usage: subako org 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 org set-role

Set a member’s organization role

Usage

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

Arguments

<USER_ID>

Member’s user id, as org members shows them

  • Required.

Options

--role <ROLE>

Role to set. The organization’s last admin cannot be demoted

  • 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 org remove-member

Remove a member, and their workspace memberships in this organization, leaving API keys they minted alone

Usage

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

Arguments

<USER_ID>

Member’s user id, as org 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.

subako org invite

Invite an address to join the organization

Usage

Usage: subako org invite [OPTIONS] --email <EMAIL> --role <ROLE>

Options

--email <EMAIL>

Address to invite. They join by signing in as it through this organization’s provider; there is no link or token to pass on

  • Required.

--role <ROLE>

Role they join at

  • 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 org invitations

List the organization’s invitations, pending and accepted

Usage

Usage: subako org invitations [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 org revoke-invitation

Revoke a pending invitation

Usage

Usage: subako org revoke-invitation [OPTIONS] <INVITATION_ID>

Arguments

<INVITATION_ID>

Invitation id, as org invitations 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?