okibi workspaces · Okibi docs

Generated from okibi 0.2.4. Every command also takes the global flag --agent.

Usage

okibi workspaces [flags]
okibi workspaces [command]

Commands

create	Create a workspace (plan allowances apply)
delete	delete a workspace (owner and unrestricted key required)
invitations	List pending invitations, invite members, and cancel invitations
members	List members and manage workspace roles
rename	Change the display name, preserving the workspace URL
reset	reset a workspace (owner and unrestricted key required)
switch	Set the workspace commands target by default on this machine

Flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces create

Create a workspace (plan allowances apply)

Usage

okibi workspaces create <slug> [flags]

Flags

Flag	Type	Description
--name	string	workspace display name (default: slug)

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces delete

delete a workspace (owner and unrestricted key required)

Usage

okibi workspaces delete <slug> [flags]

Flags

Flag	Type	Description
--yes	bool	confirm permanent removal of workspace content

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces invitations

List pending invitations, invite members, and cancel invitations

Usage

okibi workspaces invitations [flags]
okibi workspaces invitations [command]

Commands

cancel	Cancel a pending invitation
invite	Send a workspace invitation

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces invitations cancel

Cancel a pending invitation

Usage

okibi workspaces invitations cancel <invitation-id> [flags]

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces invitations invite

Send a workspace invitation

Usage

okibi workspaces invitations invite <email> [flags]

Flags

Flag	Type	Description
--role	string	invited role: admin, builder, or testerdefault builder

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces members

List members and manage workspace roles

Usage

okibi workspaces members [flags]
okibi workspaces members [command]

Commands

remove	Remove a workspace member
role	Change a member's role

Flags

Flag	Type	Description
--limit	int	maximum members to return (1–1000)default 100
--offset	int	number of members to skip

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces members remove

Remove a workspace member

Usage

okibi workspaces members remove <member-id> [flags]

Flags

Flag	Type	Description
--yes	bool	confirm removal of this member

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces members role

Change a member's role

Usage

okibi workspaces members role <member-id> <admin|builder|tester> [flags]

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces rename

Change the display name, preserving the workspace URL

Usage

okibi workspaces rename <slug> <name> [flags]

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces reset

reset a workspace (owner and unrestricted key required)

Usage

okibi workspaces reset <slug> [flags]

Flags

Flag	Type	Description
--yes	bool	confirm permanent removal of workspace content

Inherited flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)

okibi workspaces switch

Set the workspace commands target by default on this machine. --workspace and OKIBI_WORKSPACE still override it per command. The default belongs to the key stored by `okibi auth login` and to the server it was chosen on; a key passed through OKIBI_API_KEY keeps targeting its own home workspace.

Usage

okibi workspaces switch <slug> [flags]

Flags

Flag	Type	Description
--api-url	string	Okibi API base URLdefault https://okibi.ai

Inherited flags

Flag	Type	Description
--json	bool	emit JSON
--workspace	string	workspace slug (or OKIBI_WORKSPACE; default: this machine's default workspace)