flox-hello-local

Canonical local-authoring reference extension for flox.

This repo is the minimum viable shape of a flox extension intended to be cloned locally and installed directly from the working tree via flox extension install --from-path. It exercises the P02 local dev loop without hitting GitHub at install time.

Cloning this repo and running flox extension install --from-path . is enough for flox extension install to resolve and register the extension; flox hello-local then dispatches to the script in this repo.

Install (local)

git clone https://github.com/flox/flox-hello-local
cd flox-hello-local
flox extension install --from-path .
flox hello-local world
# Hello from hello-local v<commit>
# args: world

Iterate

Edit the script and re-install in place with --force:

flox extension install --from-path . --force

Or, for a pure script extension, remove and reinstall:

flox extension remove hello-local
flox extension install --from-path .

Remove

flox extension remove hello-local

What it demonstrates

• Local-authoring via flox extension install --from-path. GitHub is not consulted; the installer reads flox-extension.toml from the working tree.
• Script-kind extensions — no binary build pipeline required.
• The default activation mode (Inherit): this repo's flox-extension.toml has no [environment] block, so flox hello-local inherits whatever flox environment the user is currently in.
• The bookkeeping env vars injected by flox extension dispatch: FLOX_EXTENSION_NAME, FLOX_EXTENSION_VERSION, FLOX_EXTENSION_PATH, FLOX_BIN.

Authoring your own

See the flox author guide for the full flox-extension.toml schema, repo-naming conventions (flox-<name>), and the three extension kinds (script, git, binary).

License

Apache-2.0. See LICENSE.