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

subako org

The signed-in organization: its members, its invitations, and the credit ledger every workspace in it draws on

CLI reference

subako org

The signed-in organization: its members, its invitations, and the credit ledger every workspace in it draws on

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.

subako org credits

Show the credit balance and every lot behind it, oldest first.

Amounts print in SC. A lot’s remaining tells whether it still counts, and a negative one absorbed a shortfall. Needs org.credits.read, which organization admins hold.

Usage

Usage: subako org credits [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 (see a summary with ‘-h’)

  • Short option: -h.

subako org usage

List one page of the usage events that drew on the ledger, across every workspace.

Each line is one event: a model call with its token counts, or an engine interval with its duration, and the SC it cost. cost=- is an event nothing priced, such as a call through the workspace’s own provider. Needs org.usage.read, which organization admins hold.

Usage

Usage: subako org usage [OPTIONS]

Options

--limit <LIMIT>

Events on the page, at most 200. Defaults to 50

--after <AFTER>

Continue past this event id, as the previous page’s next: line names it

--order <ORDER>

Which end to start from: desc prints the newest recorded first

  • Default: desc.
  • Possible values:
    • asc: Oldest recorded first
    • desc: Newest recorded first

--metadata <KEY=VALUE>

Only events whose session metadata holds this pair, as KEY=VALUE. Repeat to require several

  • May be repeated to supply multiple values.

--starting-at <STARTING_AT>

Only events accounted at or after this RFC 3339 instant

--ending-at <ENDING_AT>

Only events accounted before this RFC 3339 instant

--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 (see a summary with ‘-h’)

  • Short option: -h.

Was this page helpful?