CLI reference

Use OpenCI from your terminal. Commands for installation, login, and switching teams.

Install

Install the CLI with Dart 3.11.5 or later.

dart install openci_cli_plus
openci --help

If the command is not found, check the Dart PATH configuration.

Use the same email address and password as the dashboard. Enter your password in the interactive prompt.

openci login

To use another server, specify its HTTPS URL.

openci login --server https://ci.example.com

For a self-hosted Firebase project, also provide its Web API key with --firebase-api-key.

View your current profile, server, and team.

openci status

Select a team interactively. Use the arrow keys to move, Enter to select, and Esc to cancel.

openci switch team

Secret commands will then operate on the newly selected team.

Command	Purpose
`openci login`	Log in to a remote environment
`openci status`	Check your current profile and team
`openci switch team`	Switch the active team
`openci list secrets`	List secret names
`openci register secret`	Register or update a secret
`openci register secretFile`	Register a file as Base64
`openci sync`	Generate secret definitions and workspace paths
`openci sync --secrets`	Generate secret definitions only
`openci sync --paths`	Generate workspace paths only; no login required
`openci update`	Update the CLI

Files generated by sync are saved under openci/generated/. Import generated/secrets.g.dart and generated/paths.g.dart in your workflows.

Switch CLI messages between Japanese and English.

openci use japanese
openci use english

To update to the latest stable release, run:

openci update