Skip to main content

​
login

Authenticate the CLI with your Synthetiq account:
Opens your default browser for OAuth authentication. Once authenticated, the CLI establishes the organization context and determines the workspace directory at ~/.synthetiq/<userId>/<orgId>/.

​
logout

Clear stored credentials:

​
whoami

Display the current authenticated user, organization, role, and the scopes you hold in that organization:
The role and scopes reflect the organization you are currently in (switch with org switch). In a personal workspace there is no org role and no scopes. They are fetched from the API rather than read out of your access token, so they are always current — if someone changes your role or edits your role’s scopes, whoami shows the change immediately, without waiting for your token to refresh. This does mean the command needs network access.

​
org list

List the organizations you belong to. The current organization is flagged in the CURRENT column:

​
org switch

Switch the active organization context:
[name] can be an organization’s name, slug, or ID. Omit it to choose interactively from the organizations you belong to. Switching re-establishes the org context and updates the workspace directory used by subsequent commands.

​
org get

Show details for a specific organization: