CosmicAC Logo
CosmicAC CLI commands

Teams

List the teams you belong to, choose which one the CLI acts in, and manage its members. The active team is sent as X-Team-Id on every request and is stored per environment. Administration commands are gated server-side by your role, so a denial means your role lacks the capability.

List the teams you belong to, choose which one the CLI acts in, and manage its members. The active team is sent as X-Team-Id on every request and is stored per environment. Administration commands are gated server-side by your role, so a denial means your role lacks the capability.

Command

cosmicac teams <subcommand> [options]

Subcommands

SubcommandDescription
archiveArchive a team
capacityShow the nodes reserved for a team
createCreate a team
currentShow the active team
listList your teams
membersTeam membership management
permissionsShow what your role allows in a team
storage-volumesTeam storage volume management
updateRename or describe a team
useSelect the active team

teams archive

Archives the active team, or the team named by --team. Archived teams reject every request, so anyone acting in one must switch with "cosmicac teams use". Requires the team.archive capability.

Usage

cosmicac teams archive [options]

Options

OptionDescription
--teamTeam to archive (defaults to the active team)
--yesSkip the confirmation prompt

teams capacity

Lists the GPU nodes a platform admin reserved for the active team, or for the team named by --team. A team with reserved nodes runs only on those nodes; a team with none draws from the shared pool. Requires the dashboard.read capability, so members can see their own team without platform_admin.

Usage

cosmicac teams capacity [options]

Options

OptionDescription
--teamTeam to inspect (defaults to the active team)

teams create

Creates a team. Requires the platform_admin role. The new team is not selected automatically; run "cosmicac teams use <teamId>" afterwards.

Usage

cosmicac teams create <name> [options]

Arguments

ArgumentRequiredDescription
nameYesTeam name

Options

OptionDescription
--descriptionTeam description

teams current

Shows the team the CLI is currently acting in for the active environment.

Usage

cosmicac teams current

teams list

List teams, with your role and membership status. The selected team is marked with an asterisk. Pass --usable to list only teams you can select.

Usage

cosmicac teams list [options]

Options

OptionDescription
--usableList only teams you can select

teams members

List members and pending invites, change roles, suspend or reinstate people, and remove them. Every subcommand acts on the active team unless --team names another.

Usage

cosmicac teams members <subcommand> [options]

Subcommands

SubcommandDescription
activateReinstate a suspended member
addAdd an existing user to a team
listList team members
removeRemove a member from a team
roleChanges the role of a member of the active team, or the team named by --team.
Requires the users.role.change capability.
Roles: teamlead, member, viewer. The platform_admin role is not assignable per team.
suspendSuspend a member

teams members activate

Returns a suspended member of the active team, or the team named by --team, to active. Requires the users.suspend capability, the same one that suspends.

Usage

cosmicac teams members activate <member> [options]

Arguments

ArgumentRequiredDescription
memberYesMember user id or email

Options

OptionDescription
--teamTeam to act in (defaults to the active team)

teams members add

Adds a user who already has an account straight into the team, with no invite to accept. Requires the platform_admin role. Team leads invite by email from the web UI instead. Roles: teamlead, member, viewer.

Usage

cosmicac teams members add <email> [options]

Arguments

ArgumentRequiredDescription
emailYesEmail address of the existing user

Options

OptionDescription
--roleRole to grant: teamlead, member, viewer (default member)
--teamTeam to add into (defaults to the active team)

teams members list

Lists members and pending invites for the active team, or the team named by --team. Requires the users.read capability. Pending invites have no user id until the person signs up.

Usage

cosmicac teams members list [options]

Options

OptionDescription
--teamTeam to list (defaults to the active team)

teams members remove

Removes a member from the active team, or the team named by --team. Requires the users.remove capability. To keep the membership but block access, suspend instead.

Usage

cosmicac teams members remove <member> [options]

Arguments

ArgumentRequiredDescription
memberYesMember user id or email

Options

OptionDescription
--teamTeam to act in (defaults to the active team)
--yesSkip the confirmation prompt

teams members role

Changes the role of a member of the active team, or the team named by --team. Requires the users.role.change capability. Roles: teamlead, member, viewer. The platform_admin role is not assignable per team.

Usage

cosmicac teams members role <member> <role> [options]

Arguments

ArgumentRequiredDescription
memberYesMember user id or email
roleYesNew role: teamlead, member, viewer

Options

OptionDescription
--teamTeam to act in (defaults to the active team)

teams members suspend

Suspends a member of the active team, or the team named by --team. A suspended member keeps their role but every request they make in the team is refused. Requires the users.suspend capability. Reinstate them with "cosmicac teams members activate".

Usage

cosmicac teams members suspend <member> [options]

Arguments

ArgumentRequiredDescription
memberYesMember user id or email

Options

OptionDescription
--teamTeam to act in (defaults to the active team)
--yesSkip the confirmation prompt

teams permissions

Lists the capabilities the server grants you in the active team, or in the team named by --team. The server is authoritative: commands are never hidden, they fail with an explanation.

Usage

cosmicac teams permissions [options]

Options

OptionDescription
--teamTeam to inspect (defaults to the active team)

teams storage-volumes

Create, list and delete the persistent NFS storage a team attaches to GPU container jobs. A volume outlives the jobs using it, and only one job can hold it at a time. Every subcommand acts on the active team unless --team names another. Creating and deleting need a team lead role; listing is open to every member.

Usage

cosmicac teams storage-volumes <subcommand> [options]

Subcommands

SubcommandDescription
createCreate a team storage volume
deleteDelete a team storage volume
listList team storage volumes

teams storage-volumes create

Creates persistent NFS storage the team can attach to GPU container jobs, mounted at /mnt/team-volume. Anything not passed as a flag is asked for. Provisioning the share takes a few minutes, so the volume starts out provisioning and turns available on its own. Pass --wait to watch it. Requires the storage.create capability, which only a team lead has.

Usage

cosmicac teams storage-volumes create [name] [options]

Arguments

ArgumentRequiredDescription
nameNoVolume name: lowercase letters, numbers and hyphens

Options

OptionDescription
--sizeSize in GiB, at least 100
--rackCluster to create the volume on
--locationLocation to create the volume in, when it has one cluster
--teamTeam to create in (defaults to the active team)
--waitWait until the volume is available or failed
--timeoutHow long --wait polls before giving up (default 900)

teams storage-volumes delete

Deletes a storage volume of the active team, or the team named by --team, naming it by id or name. The data on it is destroyed and cannot be recovered. A volume attached to a job cannot be deleted; delete the job first. Requires the storage.delete capability, which only a team lead has.

Usage

cosmicac teams storage-volumes delete <idOrName> [options]

Arguments

ArgumentRequiredDescription
idOrNameYesVolume to delete, by id or name

Options

OptionDescription
--teamTeam to delete from (defaults to the active team)
--yesSkip the confirmation prompt

teams storage-volumes list

Lists the storage volumes of the active team, or the team named by --team. Requires the storage.read capability, which every role has by default. An attached volume is mounted at /mnt/team-volume inside the job.

Usage

cosmicac teams storage-volumes list [options]

Options

OptionDescription
--teamTeam to list (defaults to the active team)

teams update

Updates the active team, or the team named by --team. Requires the team.update capability, which team leads and platform admins have.

Usage

cosmicac teams update [options]

Options

OptionDescription
--nameNew team name
--descriptionNew team description
--teamTeam to update (defaults to the active team)

teams use

Stores the team the CLI acts in for the active environment. Accepts a team ID or an exact team name.

Usage

cosmicac teams use [team] [options]

Arguments

ArgumentRequiredDescription
teamNoTeam ID or name

Options

OptionDescription
--clearClear the active team instead of selecting one

On this page