fcli

Install

f needs Node 22.14 or newer.

npm

npm install -g @fcli.dev/f

Verify:

f --version

f --version (or f -V) is answered by core, so it works before the uck store has been populated. f v prints the same string once the default ucks are installed.

The npm package is @fcli.dev/f; the binary it installs is f. The published package trails the source repo by a release — f --version tells you which build you actually have.

Git install (dev)

git clone https://github.com/fclidev/fcli.git
cd fcli
npm i        # builds dist/ via the prepare hook
npm link     # puts the `f` command on your PATH

Uninstall a dev install

npm unlink -g f

(run from the clone), or npm unlink f.

What happens on first run

On first run, f seeds ~/.f/f.config.json with the @fcli.dev/ucks npm package as its only source, installs it into the store (~/.f/ucks/ucks/), and registers the ucks it contains. The package is the published build of the fcli-ucks repo — same ucks, delivered as a versioned npm package instead of a git clone. Override the default source with the F_UCKS_REPO environment variable before the first run (a git URL still works — the clone flow is unchanged). See Builtins for what you get and Config for the full picture.

Documentation for f. This page is built by the site generator.

site source