Skip to content

manage.flexfs

manage.flexfs provides host-level management of flexFS services. All subcommands require root privileges. All flags are public.

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

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

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

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

| Flag | Type | Default | Description | |---|---|---|---| | --credsFile | string | ~/.flexfs/manage/creds | Credentials file path | | --downloadAddr | string | | Download server address (overrides creds file) |

Terminal window
manage.flexfs init --downloadAddr <addr> [--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 | |---|---|---|---| | --downloadAddr | string | "" | Download server address (required) | | --force | bool | false | Overwrite existing creds file |

Terminal window
manage.flexfs deinit

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

Terminal window
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 | |---|---|---|---| | --vacuum | bool | false | Also vacuum system journal logs |

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

Stops the specified services in reverse order to respect dependencies.

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

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

Stops, cleans, and starts the specified services.

| Flag | Type | Default | Description | |---|---|---|---| | --vacuum | bool | false | Also vacuum system journal logs during clean |

Terminal window
manage.flexfs status [service...]

Shows the active state and uptime of each installed service.

Terminal window
manage.flexfs clean [--vacuum]

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

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

Terminal window
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 | |---|---|---|---| | --arch | string | host architecture | Architecture to download (e.g. amd64, aarch64) | | --install | bool | false | Install binaries to /usr/sbin after downloading | | --version | string | build version | Version branch to download (e.g. v1.9.x) |

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

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

| Flag | Type | Default | Description | |---|---|---|---| | --arch | string | host architecture | Architecture to download for missing binaries | | --version | string | build version | Version branch for missing binaries |

Terminal window
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 | |---|---|---|---| | --adminPath | string | ~/.flexfs/admin | Admin folder path | | --channel | string | all | Deployment channel: staging, production, or all | | --version | string | build version | Version branch to deploy |

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

Performs a full upgrade: downloads and installs binaries, stops all services, cleans state, then starts services. With --deploy, it then deploys mount.flexfs for the upgraded version — equivalent to running deploy afterward, reusing the same --version.

| Flag | Type | Default | Description | |---|---|---|---| | --adminPath | string | ~/.flexfs/admin | Admin folder path (used with --deploy) | | --arch | string | host architecture | Architecture to download | | --channel | string | all | Deployment channel for --deploy: staging, production, or all | | --deploy | bool | false | After upgrading, also deploy mount.flexfs (equivalent to running deploy) | | --vacuum | bool | false | Vacuum journal logs during clean | | --version | string | build version | Version branch to download (and deploy with --deploy) |

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

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

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