status

read onlyrepeatableno sign-in

What the next command will do before you run it: which credential answers, which team it acts on, and which of the several ways of choosing a team actually won.

It is a report rather than an assertion, so it exits 0 even when nothing is configured and the findings are in the fields. whoami is the one that fails when there is no credential.

Usage

outplane status

Output

Field	Type	Description
`signedIn`	`bool`	A credential was resolved.
`teamSlug`	`string \| null`
`teamId`	`string \| null`
`teamSource`	`string \| null`	Which of the five places the team came from. One of `flag`, `environment`, `link file`, `config file`, `token claim`.
`tokenSource`	`string \| null`	Where the credential came from. keychain means the operating system's own secret store; credential file means a plaintext copy on disk, which is what a machine with no keychain falls back to. One of `flag`, `environment`, `keychain`, `credential file`.
`expiresAt`	`string \| null`	RFC 3339, read from the token.
`daysLeft`	`int \| null`	Null when the token never expires, negative once it has passed.
`expired`	`bool`
`problem`	`string \| null`	What is wrong, in one sentence, when something is.
`linkedDirectory`	`string \| null`	Path of the link file in effect.
`configDirectory`	`string`
`version`	`string`

Examples

See what the next command will act on

outplane status

Find out why a command used the wrong team

outplane status --json --fields teamSlug,teamSource

{
  "teamSlug": "acme",
  "teamSource": "link file"
}

Decide in a script whether to sign in

outplane status --json --fields signedIn,expired

{
  "expired": false,
  "signedIn": true
}

What to Know

This command exits 0 even when nothing is configured. It is a report, not an assertion: the findings are in the fields. Use outplane whoami, which exits 3, to assert that a credential exists.
teamSource names the winner of the resolution chain. The order is: --token, OUTPLANE_TOKEN, --team, OUTPLANE_TEAM_ID, the directory link, then the team set by outplane team use.
No network request is made. expired is decoded from the token, so a token revoked in the console still reads as fine here and only fails on the next real command.
problem is a sentence for a human. Branch on the typed fields instead: signedIn, expired, teamSource.