flox/Install Flox
Install Flox on GitHub Actions runners for GNU/Linux and macOS
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | Select a specific version from a channel. | — | "" |
| channel | One of the following: stable, qa, nightly or specify a commit. | — | stable |
| disable-metrics | Disable sending anonymous usage statistics to flox. When unset, honors the FLOX_DISABLE_METRICS env var (or the CLI default if neither is set). | — | "" |
| base-url | Download base URL of flox installer | — | "" |
| retries | Number of retries for downloading and installing Flox | — | 3 |
| github-token | GitHub token for authenticated API requests. Prevents rate limiting when Nix resolves flake inputs from GitHub. | — | ${{ github.token }} |
| trusted-environments | Comma-separated list of FloxHub environments to trust automatically (e.g. owner/env1,owner/env2). | — | "" |
| extra-nix-config | Additional lines to append to /etc/nix/nix.conf. | — | "" |
| extra-substituters | Space-separated Nix binary cache URLs to add as trusted substituters. | — | "" |
| extra-substituter-keys | Space-separated public keys for the extra substituters. | — | "" |
| proxy | HTTP/HTTPS/SOCKS5 proxy URL for network requests. | — | "" |
| disable-upgrade-notifications | Suppress flox upgrade notifications in CI output. | — | true |
| write-summary | Write a Flox installation summary table to the GitHub Actions job summary ($GITHUB_STEP_SUMMARY). Off by default to avoid cluttering summaries used for other output. | — | false |
| extra-flox-config | Additional flox config key=value pairs, one per line (e.g. search_limit=20). Applied via flox config --set for each pair. | — | "" |
| use-cache | Cache the downloaded flox package to speed up subsequent runs | — | true |
Outputs
| name | description |
|---|---|
| flox-version | The installed flox version |
| flox-path | Absolute path to the flox binary |
| nix-detected | Whether Nix was pre-installed (true/false) |