team
The team commands.
A team owns applications, databases, disks and domains, and a credential belongs to exactly one of them. These commands list the teams this machine has signed in to and choose which one is the default.
The choice is a preference on this machine. To act on another team once, pass
--team to that command instead, and in a pipeline let OUTPLANE_TOKEN name the
team.
team list
List the teams this machine is signed in to.
Usage
outplane team listAlso available as outplane teams.
Output
| Field | Type | Description |
|---|---|---|
slug | string | The value to pass to --team. |
teamId | string | |
active | bool | True for the team this invocation would use, which is not always the one team use selected. |
tokenName | string | null | The label shown in the console. |
expiresAt | string | null | RFC 3339. |
daysLeft | int | null | Null when the token never expires, negative once it has passed. |
expired | bool | Read from the token, not confirmed with the server. |
Examples
List the teams signed in on this machine
outplane team listFind the active team's slug, for a script
outplane team list --json --fields slug,active{
"items": [
{
"active": true,
"slug": "acme"
},
{
"active": false,
"slug": "beta"
}
],
"total": 2,
"truncated": false
}See when each credential expires
outplane team list -o textWhat to Know
- This lists teams with a stored credential, not teams you belong to. A team missing from this list has not been signed in to on this machine; it does not mean the team does not exist.
- An empty list is a normal result, not an error. It means nobody has signed in on this machine.
- With OUTPLANE_TOKEN set, the active team is the token's own team, and it may not appear in this list at all. The token wins over everything stored.
- expired is decoded from the token and is not a check with the server. A token revoked in the console still reads as valid here.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
team use
Choose the team commands act on by default.
Usage
outplane team use <TEAM>Arguments
| Argument | Type | Description |
|---|---|---|
TEAM | string | Team slug or id, as shown by outplane team list. Required. |
Flags
This command does not accept --team. Every other global flag applies.
Output
| Field | Type | Description |
|---|---|---|
slug | string | |
teamId | string | |
changed | bool | False when this team was already active. |
effective | bool | False when something outranks this choice, such as OUTPLANE_TOKEN or a linked directory. |
Examples
Switch to another team
outplane team use acmeSwitch and confirm it in a script
outplane team use acme --json --fields team,changedSee which teams can be switched to
outplane team use --jsonWhat to Know
- This writes a preference to this machine's config. In CI, do not use it: set OUTPLANE_TOKEN, which names its own team, or pass --team per command.
- To act on another team once without switching, pass --team to that command instead of running this one.
- Selecting a team the CLI holds no credential for fails. Signing in is what adds one, and the team is chosen in the console while doing so.
- An effective value of false means the choice was saved but something outranks it right now. The command still succeeds, because the preference is real and will apply once the thing outranking it is gone.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
3 | auth | Not authenticated, token revoked or expired, or forbidden for this team. |
The code on the error object is one of auth.team_not_signed_in. Branch on that, or on the exit status. The message is prose and changes.