Getting started

​
auth

This page is the command reference for @orchestor-inc/cli.

orc login and orc logout are shortcuts for orc auth login and orc auth logout.

​
Commands

  • orc auth login — Authenticate with the Orchestor API
  • orc auth status — Verify the active credential
  • orc auth logout — Remove stored API credentials
  • orc auth credential — 標準出力へ現在の資格情報を明示的に出す（秘密情報）

​
orc auth login

Authenticate with the Orchestor API

​
Usage

orc auth login [flags]

​
Authorize in the browser

orc auth login opens Orchestor. Check that its confirmation code matches your terminal. If you are signed out, complete the normal login and setup in the new tab, then return to authorize the CLI. An existing web session is reused.

The CLI receives an independent session. orc auth logout revokes it. Authorization requests expire after 10 minutes. Credentials are saved only after a successful workspace read.

​
Flags

FlagTypeRequiredDescription
--api-keystringNoAPI key (deprecated; pipe via standard input instead)
--profilestringNoNamed credential profile to activate
--scopestringNoCredential scope: org:admin
--webbooleanNoOrchestor browser authorization (explicit alias)

See global flags for output and request options. Use --help to check the flags supported by this command.

​
Help

orc auth login --help

​
orc auth status

Verify the active credential

​
Usage

orc auth status [flags]

See global flags for output and request options. Use --help to check the flags supported by this command.

​
Compatibility aliases

  • orc auth status get
  • orc auth validate

​
Help

orc auth status --help

​
orc auth logout

Remove stored API credentials

​
Usage

orc auth logout [flags]

See global flags for output and request options. Use --help to check the flags supported by this command.

​
Help

orc auth logout --help

​
orc auth credential

標準出力へ現在の資格情報を明示的に出す（秘密情報）

This command writes a secret credential to standard output. Do not run it in shared terminals, logs, or recordings.

​
Usage

orc auth credential [flags]

See global flags for output and request options. Use --help to check the flags supported by this command.

​
Help

orc auth credential --help