CLI Reference

The CLI installs and manages GitHub Actions workflows from any repository.

Installation

Run directly with npx — no global install required:

Commands

add

Install a workflow from a GitHub repository:

<source> — GitHub owner/repo, git URL, or local path
--workflow <name> — select a specific workflow file (stem name, no extension)
--force — overwrite an existing workflow without prompting
--dry-run — print what would be written without writing files
--yes — non-interactive mode, skip all prompts
--verbose — show detailed output during install

list

Show all workflows installed via OpenCI in the current repo:

status

Check the health of installed workflows. Reports drift between the local file and the recorded source:

update

Pull the latest version of installed workflows from their source repos. Pass one or more names to update specific workflows:

[workflows...] — optional list of workflow names to update
--force — overwrite even if local changes are detected

remove

Remove an installed workflow and its sidecar metadata:

doctor

Run diagnostics on your OpenCI setup. Checks for missing sidecar files, orphaned metadata, and configuration issues:

Sources

The add command accepts multiple source forms:

GitHub shorthand: owner/repo
Git URL: git@github.com:owner/repo.git, https://github.com/owner/repo.git
Local path: ./workflows, ../shared-workflows

Non-interactive mode

In --yes mode, the CLI never prompts. Successful add prints only the created workflow path to stdout. Warnings and secret setup hints go to stderr.