v0.4.2regionus-east-1builds/7d41pipeline active
FLA / PUBLIC BETA
DOCS / CLI REFERENCE
$flareo --help# 12 commands · 0.4.2

THE FLAREO CLI.
EVERY COMMAND, EVERY FLAG.

Complete reference for the Flareo command line tool. Twelve commands, built on a single binary, roughly 8 MB statically linked. Works on macOS and Linux, x86_64 and arm64. No runtime dependencies beyond a POSIX shell.

§ INSTALL

Get the binary.

Build from source until signed release binaries are published. Requires a Rust toolchain (1.80+).

SOURCE / RECOMMENDED
$ git clone https://github.com/Yolo1105/flareo.git
$ cd flareo/packages/cli
$ cargo build --release
RELEASES

Signed archives will ship once the release workflow runs.

§

Global flags

These flags work on every flareo subcommand. Flag precedence goes command-line > environment variable > config file > default.

FLAG
DESCRIPTION
DEFAULT
--jsonbool
Emit output as line-delimited JSON for scripts and pipelines. Disables color automatically.
false
--no-colorbool
Disable ANSI colors. Respects NO_COLOR env var as an alternative.
false
--configpath
Path to an alternate config file. Useful for CI or multi-account setups.
~/.flareo/config.json
--verbose, -vbool
Verbose output. Stackable (-vv, -vvv) for trace and debug logging.
false
--timeoutduration
Network timeout for any HTTP call. Accepts Go duration strings: 30s, 2m, 1h.
60s
--registryurl
Override the default Flareo registry. Used for self-hosted instances.
ghcr.io/flareo
01flareo init
NO AUTH

Initialize a new Flareo project in the current directory. Creates a flareo.json manifest with sane defaults, detects your Dockerfile, and sets up a .gitignore entry for the build cache.

USAGE
$ flareo init [name] [--force] [--template=<kind>]
FLAGS
--force, -fbool
Overwrite an existing flareo.json.
false
--templatestring
Start from a preset: rust, go, node, python, static. Each writes a matching sample Dockerfile.
none
02flareo login
NO AUTH

Authenticate with Flareo via GitHub OAuth. Opens a browser to the consent page; once approved, drops an encrypted token at ~/.flareo/config.json. Required before publish, deploy, or billing.

USAGE
$ flareo login [--device] [--token=<raw>]
FLAGS
--devicebool
Use device-code flow instead of browser redirect. Useful on headless servers.
false
--tokenstring
Skip OAuth and use a raw personal access token. Not recommended outside CI.
none
04flareo pull
NO AUTH

Pull a verified module and its signed digest. Unlike docker pull, flareo pull runs cosign verify and slsa-verifier before the image lands on disk. If any check fails, nothing is pulled and the command exits non-zero.

USAGE
$ flareo pull <name>[@<version>|@<digest>] [--no-verify] [--platform=<os/arch>]
FLAGS
--no-verifybool
Skip signature and provenance checks. Defeats the purpose of Flareo. Allowed for offline retrieval only.
false
--platformstring
Target platform: linux/amd64, linux/arm64. Defaults to the host platform.
host
05flareo verify
NO AUTH

Run the three-check verification suite against any image reference or digest, without pulling. Useful inside CI pipelines as a gate.

USAGE
$ flareo verify <image|digest> [--strict] [--require-slsa=<level>]
FLAGS
--strictbool
Fail on any non-green finding: LOW CVEs, partial attestations, or missing SBOM.
false
--require-slsaint
Require at least this SLSA level (1, 2, or 3).
1
06flareo compose
NO AUTH

Generate a docker-compose.yaml for a module, with the image pinned to the signed digest. Output goes to stdout by default.

USAGE
$ flareo compose <name>[@<version>] [--env=<key=val>] [--ports=<map>]
07flareo deploy
AUTH

Convenience wrapper around flareo compose + docker compose up -d. For local runs only. Flareo never runs your containers remotely — deploy happens on your machine.

USAGE
$ flareo deploy <name>[@<version>] [--format=compose|helm|kustomize] [--dry-run]
08flareo publish
AUTH

Submit a module to the Flareo pipeline. Reads flareo.json from the current directory, uploads the Dockerfile and build context, and triggers the six-stage pipeline.

USAGE
$ flareo publish [--source=<path>] [--tag=<name:ver>] [--wait]
09flareo inspect
NO AUTH

Show everything Flareo knows about a module: digest, SBOM summary, provenance trail, signature identity, full build record. Read-only.

USAGE
$ flareo inspect <name>[@<version>] [--include=<section,...>]
10flareo tail
AUTH

Stream live pipeline logs for a build or module. Works with a build ID (#0847), a module name, or --pipeline for the global firehose.

USAGE
$ flareo tail <build-id|name> [--follow] [--stage=<name>]
11flareo status
NO AUTH

Print the live Flareo pipeline health: region, version, build count last 7 days, scan pass rate, median stage latency.

USAGE
$ flareo status [--watch] [--interval=<dur>]
12flareo billing
AUTH

Show your current plan, usage in the billing period, and upcoming invoice. During public beta this returns a flat "all features free" response.

USAGE
$ flareo billing [--tier] [--usage] [--history=<months>]
§Exit codes

All Flareo commands return standard POSIX exit codes. Use them with set -e in shell pipelines and CI workflows.

0
OK
Success. Output reliable.
1
GENERAL
Unrecoverable error. Check stderr.
2
USAGE
Invalid flags or arguments.
3
AUTH
Missing or expired token.
4
VERIFY
Signature or provenance failed.
5
NETWORK
Timeout or connection error.