CLI Reference

The oore CLI is a client for interacting with the Oore server.

Installation

cargo build --release -p oore-cli
sudo cp ./target/release/oore /usr/local/bin/

Global Options

Option	Environment	Default	Description
`--server <URL>`	-	`http://localhost:8080`	Server URL
`--admin-token <TOKEN>`	`OORE_ADMIN_TOKEN`	-	Admin token

oore health

Check if the server is running.

oore health
# Server status: ok

oore version

Show version information.

oore version
# CLI version: 0.1.0
# Server version: 0.1.0 (oored)

oore setup

Show setup status.

oore setup --admin-token YOUR_TOKEN

oore repo

Repository management commands.

oore repo list

oore repo list

ID                           PROVIDER   NAME                 ACTIVE
--------------------------------------------------------------------
01HNJX5Q9T3WP2V6Z8K4M7YRBF   github     my-flutter-app       yes
01HNJX7K2N4RM8P3Y5W6T9HSVE   gitlab     backend-api          yes

oore repo add

oore repo add --provider <PROVIDER> --owner <OWNER> --repo <REPO> [OPTIONS]

Required:

Argument	Description
`--provider`	`github` or `gitlab`
`--owner`	Repository owner
`--repo`	Repository name

Optional:

Option	Default	Description
`--name`	`owner/repo`	Display name
`--branch`	`main`	Default branch
`--webhook-secret`	-	GitLab webhook secret
`--github-repo-id`	-	GitHub repository ID
`--github-installation-id`	-	GitHub App installation ID
`--gitlab-project-id`	-	GitLab project ID

GitHub
GitLab

oore repo add --provider github --owner myorg --repo my-app

oore repo add --provider gitlab --owner myuser --repo backend \
  --webhook-secret "secret" --gitlab-project-id 12345678

oore repo show

oore repo show <REPO_ID>

oore repo remove

oore repo remove <REPO_ID>

oore repo webhook-url

oore repo webhook-url <REPO_ID>

oore build

Build management commands.

oore build list

oore build list [--repo <REPO_ID>]

ID                           STATUS    TRIGGER   BRANCH   COMMIT
------------------------------------------------------------------
01HNJX9P2K4TM8Q6V5W3Y7ZRAD   running   webhook   main     abc1234
01HNJXA3N7RP5M2K8T4W6Y9HBC   success   manual    develop  def5678

oore build show

oore build show <BUILD_ID>

oore build trigger

oore build trigger <REPO_ID> [--branch <BRANCH>] [--commit <SHA>]

# Build default branch
oore build trigger 01HNJX5Q9T3WP2V6Z8K4M7YRBF

# Build specific branch
oore build trigger 01HNJX5Q9T3WP2V6Z8K4M7YRBF --branch feature/login

oore build cancel

oore build cancel <BUILD_ID>

oore webhook

oore webhook list

oore webhook list

oore webhook show

oore webhook show <EVENT_ID>

oore github

GitHub App management commands.

oore github setup

Initiate GitHub App setup via manifest flow. Opens a URL to create the GitHub App.

oore github setup --admin-token YOUR_TOKEN

oore github callback

Complete GitHub App setup with the callback URL from GitHub.

oore github callback "<REDIRECT_URL>" --admin-token YOUR_TOKEN

oore github status

Show current GitHub App configuration.

oore github status --admin-token YOUR_TOKEN

oore github installations

List GitHub App installations.

oore github installations --admin-token YOUR_TOKEN

oore github sync

Sync installations and repositories from GitHub.

oore github sync --admin-token YOUR_TOKEN

oore github remove

Remove GitHub App credentials.

oore github remove --force --admin-token YOUR_TOKEN

oore gitlab

GitLab OAuth management commands.

oore gitlab connect

Initiate GitLab OAuth flow.

oore gitlab connect --admin-token YOUR_TOKEN
oore gitlab connect --instance https://gitlab.mycompany.com --admin-token YOUR_TOKEN
oore gitlab connect --instance https://gitlab.com --replace --admin-token YOUR_TOKEN

Option	Default	Description
`--instance`	`https://gitlab.com`	GitLab instance URL
`--replace`	`false`	Replace existing credentials for this instance

oore gitlab callback

Complete GitLab OAuth with the callback URL.

oore gitlab callback "<REDIRECT_URL>" --admin-token YOUR_TOKEN

oore gitlab status

Show current GitLab credentials.

oore gitlab status --admin-token YOUR_TOKEN

oore gitlab projects

List accessible GitLab projects.

oore gitlab projects --admin-token YOUR_TOKEN
oore gitlab projects --instance https://gitlab.mycompany.com --page 2 --per_page 50 --admin-token YOUR_TOKEN

Option	Default	Description
`--instance`	`https://gitlab.com`	GitLab instance URL
`--page`	`1`	Page number
`--per_page`	`20`	Results per page

oore gitlab enable

Enable CI for a GitLab project.

oore gitlab enable <PROJECT_ID> --admin-token YOUR_TOKEN
oore gitlab enable 12345678 --instance https://gitlab.mycompany.com --admin-token YOUR_TOKEN

oore gitlab disable

Disable CI for a GitLab project.

oore gitlab disable <PROJECT_ID> --admin-token YOUR_TOKEN
oore gitlab disable 12345678 --instance https://gitlab.mycompany.com --admin-token YOUR_TOKEN

oore gitlab refresh

Refresh OAuth token for a GitLab instance.

oore gitlab refresh --admin-token YOUR_TOKEN
oore gitlab refresh --instance https://gitlab.mycompany.com --admin-token YOUR_TOKEN

oore gitlab register

oore gitlab register \
  --instance https://gitlab.mycompany.com \
  --client-id YOUR_CLIENT_ID \
  --client-secret YOUR_CLIENT_SECRET \
  --admin-token YOUR_TOKEN

oore gitlab remove

Remove GitLab credentials.

oore gitlab remove <CREDENTIALS_ID> --force --admin-token YOUR_TOKEN

Complete Workflow

# 1. Check server
oore health

# 2. Add repository
oore repo add --provider github --owner myorg --repo my-app

# 3. Get webhook URL
oore repo webhook-url 01HNJX5Q9T3WP2V6Z8K4M7YRBF

# 4. Trigger build
oore build trigger 01HNJX5Q9T3WP2V6Z8K4M7YRBF

# 5. Watch build
oore build list --repo 01HNJX5Q9T3WP2V6Z8K4M7YRBF

Custom Server

oore --server https://ci.example.com repo list

# Or with environment variable
export OORE_ADMIN_TOKEN="your-token"
oore --server https://ci.example.com setup