CLI

Usage

joflux [--config PATH] [--log-level LEVEL] <command> [flags]
joflux --version

The global options go before the command; each command’s own flags go after it. A command is required, and running joflux on its own prints usage.

Global options

Flag	Default	Description
--config PATH	joflux.toml	Config file to read. .json is read as JSON, .yaml and .yml as YAML, anything else as TOML.
--log-level LEVEL	None	Override the configured log level for this run: DEBUG, INFO, WARNING, ERROR or CRITICAL.
--version	None	Print the version and exit.
-h--help	None	Show help and exit. Each command takes it too.

Commands

Command	What it does	Reads	Writes
export	Lists the GitHub organization’s repositories	GitHub	repos-inventory.json
migrate	Asks Forgejo to migrate each repository	repos-inventory.json	migration-log.json
monitor	Rechecks migrations Forgejo didn’t answer for	migration-log.json, migration-status.json	migration-status.json
verify	Checks each repository on the target and counts its contents	repos-inventory.json	verification-report.json
archive	Archives the GitHub originals that verify recorded as verified	repos-inventory.json, verification-report.json	archive-log.json

export

joflux export [--exclude-forks] [--exclude-archived]

Flag	Default	Description
--exclude-forks	None	Leave forked repositories out of the inventory.
--exclude-archived	None	Leave repositories already archived on GitHub out of the inventory.

migrate

joflux migrate

No flags.

monitor

joflux monitor [--interval SECONDS]

Flag	Default	Description
--interval SECONDS	None	Seconds between polls for this run. Without it, monitor uses poll_interval from the config, 30 by default.

verify

joflux verify

No flags.

archive

joflux archive [--yes]

Flag	Default	Description
--yes	None	Archive without asking for confirmation.

Logging

Log lines go to standard output in the shape HH:MM:SS - LEVEL - message, with the level coloured when the output is a terminal. A config error is printed to standard error as config error: <reason> instead, because it happens before logging is set up.

Every command exits 0, 1, 2 or 130; Exit codes has what each means.