manage.flexfs

manage.flexfs provides host-level management of flexFS services. Most subcommands require root privileges; init creds, deinit creds, license, and version do not.

Persistent Flags

These flags apply to every subcommand.

Flag	Type	Default	Description	Visibility
--reportErrors	bool	false	Report errors and panics to Paradigm4	Public

Subcommands

Subcommand	Description	Visibility
clean	Remove flexFS temporary files and caches	Public
deinit creds	Remove credentials file	Public
deploy	Deploy mount.flexfs binary to staging/production channels	Public
download [binary...]	Download flexFS binaries to /tmp	Public
init creds	Initialize credentials (custom download server address)	Public
install [binary...]	Install flexFS binaries from /tmp to /sbin	Public
license	Print license information	Public
restart [service...]	Restart services (stop, start)	Public
start [service...]	Start flexFS systemd services	Public
status [service...]	Show status of flexFS services	Public
stop [service...]	Stop flexFS systemd services (reverse order)	Public
upgrade [binary...]	Full upgrade cycle (clean, download, install, restart affected services)	Public
version	Print the build version	Public
watch <service>	Follow journal logs for a flexFS service	Public

Services

When a service argument is omitted, all services are targeted. The available service names are:

Service	Binary	Start Order
error	error.flexfs	1
stat	stat.flexfs	2
admin	admin.flexfs	3
free	free.flexfs	4
proxy	proxy.flexfs	5
meta	meta.flexfs	6

Services are started in the order shown above and stopped in reverse order.

init creds

manage.flexfs init creds --downloadAddr <download-addr> [--credsFile <path>] [--force]

Initializes a credentials file for manage.flexfs with a custom download server address. Commands that download binaries (download, deploy, upgrade, install) read this file to resolve the server address.

Flag	Type	Default	Description	Visibility
--credsFile	string	~/.flexfs/manage/creds	Credentials file path to write	Public
--downloadAddr	string	""	Download server address (required)	Public
--force	bool	false	Overwrite existing credentials file	Public

deinit creds

manage.flexfs deinit creds [--credsFile <path>]

Removes the credentials file. After removal, download commands fall back to the default server (get.flexfs.io).

Flag	Type	Default	Description	Visibility
--credsFile	string	~/.flexfs/manage/creds	Credentials file path	Public

start

manage.flexfs start [--vacuum] [service...]

Starts the specified flexFS systemd services. If no services are named, all installed services are started.

Flag	Type	Default	Description	Visibility
--vacuum	bool	false	Also vacuum system journal logs	Public

stop

manage.flexfs stop [--vacuum] [service...]

Stops the specified services in reverse order to respect dependencies.

Flag	Type	Default	Description	Visibility
--vacuum	bool	false	Also vacuum system journal logs	Public

restart

manage.flexfs restart [--vacuum] [service...]

Stops and starts the specified services.

Flag	Type	Default	Description	Visibility
--vacuum	bool	false	Also vacuum system journal logs	Public

status

manage.flexfs status [service...]

Shows the active state and uptime of each installed service.

clean

manage.flexfs clean [--vacuum]

Removes flexFS temporary files (/tmp/*.flexfs). Optionally vacuums systemd journal logs.

Flag	Type	Default	Description	Visibility
--vacuum	bool	false	Also vacuum system journal logs	Public

download

manage.flexfs download [--version <ver>] [--arch <arch>] [--install] [binary...]

Downloads the specified flexFS binaries to /tmp. Uses the download server address from the credentials file, or get.flexfs.io by default.

Flag	Type	Default	Description	Visibility
--arch	string	host architecture	Architecture to download (e.g. amd64, aarch64)	Public
--credsFile	string	~/.flexfs/manage/creds	Credentials file path	Public
--downloadAddr	string	""	Download server address (overrides credentials file)	Internal
--install	bool	false	Install binaries to /sbin after downloading	Public
--version	string	build version	Version branch to download (e.g. v1.9.x)	Public

install

manage.flexfs install [--version <ver>] [--arch <arch>] [binary...]

Installs flexFS binaries from /tmp to /sbin. When binary names are given, any missing from /tmp are downloaded automatically.

Flag	Type	Default	Description	Visibility
--arch	string	host architecture	Architecture to download for missing binaries	Public
--credsFile	string	~/.flexfs/manage/creds	Credentials file path (used when downloading missing binaries)	Public
--downloadAddr	string	""	Download server address (overrides credentials file)	Internal
--version	string	build version	Version branch for missing binaries	Public

deploy

manage.flexfs deploy [--channel <channel>] [--version <ver>] [--adminPath <path>]

Downloads mount.flexfs for both architectures and places them in the admin server’s deploy directory for auto-update.

Flag	Type	Default	Description	Visibility
--adminPath	string	~/.flexfs/admin	Admin folder path	Public
--channel	string	all	Deployment channel: staging, production, or all	Public
--credsFile	string	~/.flexfs/manage/creds	Credentials file path	Public
--downloadAddr	string	""	Download server address (overrides credentials file)	Internal
--version	string	build version	Version branch to deploy	Public

upgrade

manage.flexfs upgrade [--version <ver>] [--arch <arch>] [--vacuum] [--deploy [--channel <channel>] [--adminPath <path>]] [binary...]

Performs a full upgrade: cleans state, downloads and installs binaries, then restarts only the services whose binaries were upgraded (not all services). When no binary names are given, it upgrades every flexFS binary found in /sbin. With --deploy, it then deploys mount.flexfs for the upgraded version — equivalent to running deploy afterward, reusing the same --version.

Flag	Type	Default	Description	Visibility
--adminPath	string	~/.flexfs/admin	Admin folder path (used with --deploy)	Public
--arch	string	host architecture	Architecture to download	Public
--channel	string	all	Deployment channel for --deploy: staging, production, or all	Public
--credsFile	string	~/.flexfs/manage/creds	Credentials file path	Public
--deploy	bool	false	After upgrading, also deploy mount.flexfs (equivalent to running deploy)	Public
--downloadAddr	string	""	Download server address (overrides credentials file)	Internal
--vacuum	bool	false	Also vacuum system journal logs	Public
--version	string	build version	Version branch to download (and deploy with --deploy)	Public

watch

manage.flexfs watch [--lines <n>] [--cat] <service>

Follows journal logs for a flexFS service using journalctl -f.

Flag	Type	Default	Description	Visibility
--cat	bool	false	Use plain text output (journalctl -o cat)	Public
--lines	int	100	Number of recent log lines to show	Public