Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

flox-hello-script

Canonical script-kind reference extension for flox.

This repo is the minimum viable shape of a flox extension: a flox-extension.toml manifest declaring kind = "script", plus an executable flox-<name> script at the repo root, where <name> is the repo name with the flox- prefix stripped — so this repo (flox-hello-script) installs as extension name hello-script and ships an executable named flox-hello-script. Cloning this repo is enough for flox extension install to resolve it.

Install

flox extension install flox/flox-hello-script
flox hello-script world
# Hello from hello v<commit>
# args: world

Upgrade

flox extension upgrade hello

Remove

flox extension remove hello

What it demonstrates

  • 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 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.

About

Canonical script-kind reference extension for flox

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages