NAME

fjctl —

Maintain repository settings in a Forgejo instance

SYNOPSIS

fjctl [option...] [OWNER/NAME...]

DESCRIPTION

fjctl is an “infrastructure as code” tool used for maintaining repositories on a Forgejo instance.

Repository settings are defined in a configuration file. fjctl reads this file, reports differences between configured and actual state, and (optionally) applies the necessary updates to make the actual state match configured.

The options are as follows:

--apply: Apply changes instead of just printing them
--config-file=FILE_PATH: Path to the configuration file
--create-via-migrate: Create repositories by migrating
--doc=man1|man5|schema: Output documentation for an item and exit
--fail-on-diff-exit-code=NUMBER: Exit code for --fail-on-diff
--host=https://<host>[/<base>]: Forgejo host to connect to
--no-fail-on-diff: Don't fail for un-applied differences

OWNER/NAME: Limit processing to the given repositories

ENVIRONMENT

FJCTL_CONFIG_FILE=FILE_PATH: Path to the configuration file
FJCTL_HOST=https://<host>[/<base>]: Forgejo host to connect to
FJCTL_TOKEN=TOKEN: Forgejo token to use
GITHUB_TOKEN=TOKEN, GH_TOKEN=TOKEN: Token for authentication when migrating repositories

FILES

~/.config/fjctl/config.yaml: Default configuration file path. See fjctl(5).

EXIT STATUS

228: Exit status when differences exist between configured and actual state. Configurable by --fail-on-diff-exit-code. Can be disabled by --no-fail-on-diff.