flox-environments

Flox 环境

Flox 创建由单个 TOML 清单定义的可复现开发环境。团队中的每个开发者都能获得相同的包、工具和配置——跨 macOS 和 Linux——无需容器或虚拟机。基于 Nix 构建，可访问超过 150,000 个包。

何时激活

当用户有环境管理问题时使用此技能——即使他们没有提到 Flox。Flox 在以下情况是正确的工具：

• 项目需要系统级包（编译器、数据库、CLI 工具）以及语言特定的依赖
• 可复现性很重要——设置应该在队友的机器、CI 或新笔记本上一致工作
• 用户需要多个工具共存——例如 Python 3.11 + PostgreSQL 16 + Redis + Node.js 在一个环境中
• 需要跨平台支持（从相同配置支持 macOS 和 Linux）
• AI 智能体需要安装工具——Flox 让智能体无需 sudo、系统污染或沙盒限制就能向项目范围环境添加包

如果用户只需要单一语言运行时且无系统依赖，标准工具（nvm、pyenv、rustup 单独使用）可能足够。如果需要完整的操作系统级隔离，容器可能更合适。Flox 处于最佳位置：声明式的、可复现的环境，没有容器开销。

前提条件： 必须先安装 Flox——参见 flox.dev/docs 获取 macOS、Linux 和 Docker 的安装说明。

核心概念

Flox 环境在 .flox/env/manifest.toml 中定义，使用 flox activate 激活。清单声明包、环境变量、设置钩子和 shell 配置——在任何地方复现环境所需的一切。

关键路径：

• .flox/env/manifest.toml — 环境定义（提交此文件）
• $FLOX_ENV — 已安装包的运行时路径（类似 /usr——包含 bin/、lib/、include/）
• $FLOX_ENV_CACHE — 缓存、虚拟环境、数据的持久本地存储（在重建后保留）
• $FLOX_ENV_PROJECT — 项目根目录（.flox/ 所在位置）

基本命令

flox init                       # 创建新环境
flox search <package> [--all]   # 搜索包
flox show <package>             # 显示可用版本
flox install <package>          # 添加包
flox list                       # 列出已安装的包
flox activate                   # 进入环境
flox activate -- <cmd>          # 在环境中运行命令而不创建子 shell
flox edit                       # 交互式编辑清单

清单结构

# .flox/env/manifest.toml

[install]
# 要安装的包——环境的核心
ripgrep.pkg-path = "ripgrep"
jq.pkg-path = "jq"

[vars]
# 静态环境变量
DATABASE_URL = "postgres://localhost:5432/myapp"

[hook]
# 非交互式设置脚本（每次激活时运行）
on-activate = """
  echo "环境就绪"
"""

[profile]
# Shell 函数和别名（在交互式 shell 中可用）
common = """
  alias dev="npm run dev"
"""

[options]
# 支持的平台
systems = ["x86_64-linux", "aarch64-linux", "x86_64-darwin", "aarch64-darwin"]

包安装模式

基本安装

[install]
nodejs.pkg-path = "nodejs"
python.pkg-path = "python311"
rustup.pkg-path = "rustup"

版本固定

[install]
nodejs.pkg-path = "nodejs"
nodejs.version = "^20.0"          # Semver 范围：最新的 20.x

postgres.pkg-path = "postgresql"
postgres.version = "16.2"         # 精确版本

平台特定包

[install]
# 仅 Linux 工具
valgrind.pkg-path = "valgrind"
valgrind.systems = ["x86_64-linux", "aarch64-linux"]

# macOS 框架
Security.pkg-path = "darwin.apple_sdk.frameworks.Security"
Security.systems = ["x86_64-darwin", "aarch64-darwin"]

# macOS 上的 GNU 工具（BSD 默认值不同）
coreutils.pkg-path = "coreutils"
coreutils.systems = ["x86_64-darwin", "aarch64-darwin"]

解决包冲突

当两个包安装相同二进制文件时，使用 priority（数字越小优先级越高）：

[install]
gcc.pkg-path = "gcc12"
gcc.priority = 3

clang.pkg-path = "clang_18"
clang.priority = 5               # gcc 在文件冲突中获胜

使用 pkg-group 将应一起解析版本的包分组：

[install]
python.pkg-path = "python311"
python.pkg-group = "python-stack"

pip.pkg-path = "python311Packages.pip"
pip.pkg-group = "python-stack"    # 与 python 一起解析

语言特定方案

Python 配合 uv

[install]
python.pkg-path = "python311"
uv.pkg-path = "uv"

[vars]
UV_CACHE_DIR = "$FLOX_ENV_CACHE/uv-cache"
PIP_CACHE_DIR = "$FLOX_ENV_CACHE/pip-cache"

[hook]
on-activate = """
  venv="$FLOX_ENV_CACHE/venv"
  if [ ! -d "$venv" ]; then
    uv venv "$venv" --python python3
  fi
  if [ -f "$venv/bin/activate" ]; then
    source "$venv/bin/activate"
  fi

  if [ -f requirements.txt ] && [ ! -f "$FLOX_ENV_CACHE/.deps_installed" ]; then
    uv pip install --python "$venv/bin/python" -r requirements.txt --quiet
    touch "$FLOX_ENV_CACHE/.deps_installed"
  fi
"""

Node.js

[install]
nodejs.pkg-path = "nodejs"
nodejs.version = "^20.0"

[hook]
on-activate = """
  if [ -f package.json ] && [ ! -d node_modules ]; then
    npm install --silent
  fi
"""

Rust

[install]
rustup.pkg-path = "rustup"
pkg-config.pkg-path = "pkg-config"
openssl.pkg-path = "openssl"

[vars]
RUSTUP_HOME = "$FLOX_ENV_CACHE/rustup"
CARGO_HOME = "$FLOX_ENV_CACHE/cargo"

[profile]
common = """
  export PATH="$CARGO_HOME/bin:$PATH"
"""

Go

[install]
go.pkg-path = "go"
gopls.pkg-path = "gopls"
delve.pkg-path = "delve"

[vars]
GOPATH = "$FLOX_ENV_CACHE/go"
GOBIN = "$FLOX_ENV_CACHE/go/bin"

[profile]
common = """
  export PATH="$GOBIN:$PATH"
"""

C/C++

[install]
gcc.pkg-path = "gcc13"
gcc.pkg-group = "compilers"

# 重要：仅 gcc 不暴露 libstdc++ 头文件——需要 gcc-unwrapped
gcc-unwrapped.pkg-path = "gcc-unwrapped"
gcc-unwrapped.pkg-group = "libraries"

cmake.pkg-path = "cmake"
cmake.pkg-group = "build"

gnumake.pkg-path = "gnumake"
gnumake.pkg-group = "build"

gdb.pkg-path = "gdb"
gdb.systems = ["x86_64-linux", "aarch64-linux"]

钩子和 Profile

钩子——非交互式设置

钩子在每次激活时运行。保持快速和幂等。经验法则：如果应该自动发生，放在 [hook] 中；如果用户应该能输入它，放在 [profile] 中。

[hook]
on-activate = """
  setup_database() {
    if [ ! -d "$FLOX_ENV_CACHE/pgdata" ]; then
      initdb -D "$FLOX_ENV_CACHE/pgdata" --no-locale --encoding=UTF8
    fi
  }
  setup_database
"""

Profile——交互式 Shell 配置

Profile 代码在用户的 shell 会话中可用。

[profile]
common = """
  dev() { npm run dev; }
  test() { npm run test -- "$@"; }
"""

反模式

绝对路径

# 错误——在其他机器上会失败
[vars]
PROJECT_DIR = "/home/alice/projects/myapp"

# 正确——使用 Flox 环境变量
[vars]
PROJECT_DIR = "$FLOX_ENV_PROJECT"

在钩子中使用 exit

# 错误——会终止 shell
[hook]
on-activate = """
  if [ ! -f config.json ]; then
    echo "缺少配置"
    exit 1
  fi
"""

# 正确——从钩子返回，不要退出
[hook]
on-activate = """
  if [ ! -f config.json ]; then
    echo "缺少配置——先运行设置"
    return 1
  fi
"""

在清单中存储密钥

# 错误——清单会提交到 git
[vars]
API_KEY = "<set-at-runtime>"

# 正确——引用外部配置或在运行时传递
# 使用：API_KEY="<your-api-key>" flox activate
[vars]
API_KEY = "${API_KEY:-}"

没有幂等保护的慢钩子

# 错误——每次激活都重新安装
[hook]
on-activate = """
  pip install -r requirements.txt
"""

# 正确——如果已安装则跳过
[hook]
on-activate = """
  if [ ! -f "$FLOX_ENV_CACHE/.deps_installed" ]; then
    uv pip install -r requirements.txt --quiet
    touch "$FLOX_ENV_CACHE/.deps_installed"
  fi
"""

将用户命令放在钩子中

# 错误——钩子函数在交互式 shell 中不可用
[hook]
on-activate = """
  deploy() { kubectl apply -f k8s/; }
"""

# 正确——使用 [profile] 存放用户可调用的函数
[profile]
common = """
  deploy() { kubectl apply -f k8s/; }
"""

全栈示例

一个包含 PostgreSQL 的 Python API 完整环境：

[install]
python.pkg-path = "python311"
uv.pkg-path = "uv"
postgresql.pkg-path = "postgresql_16"
redis.pkg-path = "redis"
jq.pkg-path = "jq"
curl.pkg-path = "curl"

[vars]
UV_CACHE_DIR = "$FLOX_ENV_CACHE/uv-cache"
DATABASE_URL = "postgres://localhost:5432/myapp"
REDIS_URL = "redis://localhost:6379"

[hook]
on-activate = """
  if [ ! -d "$FLOX_ENV_CACHE/pgdata" ]; then
    initdb -D "$FLOX_ENV_CACHE/pgdata" --no-locale --encoding=UTF8
  fi

  venv="$FLOX_ENV_CACHE/venv"
  if [ ! -d "$venv" ]; then
    uv venv "$venv" --python python3
  fi
  if [ -f "$venv/bin/activate" ]; then
    source "$venv/bin/activate"
  fi

  if [ -f requirements.txt ] && [ ! -f "$FLOX_ENV_CACHE/.deps_installed" ]; then
    uv pip install --python "$venv/bin/python" -r requirements.txt --quiet
    touch "$FLOX_ENV_CACHE/.deps_installed"
  fi
"""

[profile]
common = """
  serve() { uvicorn app.main:app --reload --host 0.0.0.0 --port 8000; }
  migrate() { alembic upgrade head; }
"""

[services]
postgres.command = "postgres -D $FLOX_ENV_CACHE/pgdata -k $FLOX_ENV_CACHE"
redis.command = "redis-server --port 6379 --daemonize no"

[options]
systems = ["x86_64-linux", "aarch64-linux", "x86_64-darwin", "aarch64-darwin"]

带服务激活：flox activate --start-services

环境共享

Flox 环境是 git 原生的。提交 .flox/ 目录，每个协作者都能获得相同的环境：

git add .flox/
git commit -m "添加 Flox 环境"
# 团队成员只需运行：
git clone <repo> && cd <repo> && flox activate

对于跨项目的可复用基础环境，推送到 FloxHub：

flox push                         # 推送环境到 FloxHub
flox activate -r owner/env-name   # 在任何地方激活远程环境

使用 [include] 组合环境：

[include]
base.floxhub = "myorg/python-base"

[install]
# 基础之上的项目特定添加
fastapi.pkg-path = "python311Packages.fastapi"

AI 辅助和氛围编码

Flox 非常适合 AI 辅助开发和氛围编码工作流。当 AI 智能体需要当前环境中不可用的工具——编译器、数据库、linter、CLI 工具——它可以添加到项目的 Flox 清单中，无需 sudo 访问、污染系统包或遇到沙盒限制。

这对智能体为何重要：

• 无需 sudo——flox install 完全在用户空间工作，智能体无需提升权限即可添加包
• 项目范围——包仅安装到项目环境中，而非全局，因此不同项目可以有不同版本而不冲突
• 沙盒友好——在沙盒或受限环境中运行的智能体仍可通过 Flox 安装所需工具
• 可逆——每项更改都记录在 manifest.toml 中，不需要的包可以干净地移除，无系统残留
• 可复现——当智能体设置环境时，该确切设置提交到 git 后对所有人都有效

智能体工作流模式：

# 智能体发现需要某个工具（例如 jq 用于 JSON 处理）
flox search jq                    # 验证包是否存在
flox install jq                   # 安装到项目环境

# 或为获得更多控制，直接编辑清单
tmp_manifest="$(mktemp)"
flox list -c > "$tmp_manifest"
# 将包添加到 [install] 部分，然后应用
flox edit -f "$tmp_manifest"

# 运行带可用工具的命令
flox activate -- jq '.results[]' data.json

这使 Flox 成为 Claude Code 或其他 AI 智能体需要即时引导项目工具的任何工作流的自然选择。

调试

flox list -c                      # 显示原始清单
flox activate -- which python     # 检查哪个二进制文件被解析
flox activate -- env | grep FLOX  # 查看 Flox 环境变量
flox search <package> --all       # 更广泛的包搜索（区分大小写）

常见问题：

• 找不到包： 搜索区分大小写——尝试 flox search --all
• 包之间的文件冲突： 给应获胜的包添加 priority
• 钩子失败： 使用 return 而非 exit；用 ${FLOX_ENV_CACHE:-} 保护
• 过时的依赖： 删除 $FLOX_ENV_CACHE/.deps_installed 标记文件

相关技能

以下技能作为 Flox Claude Code 插件 的一部分可用于更深入的集成：

• flox-services — 服务管理、数据库设置、后台进程
• flox-builds — 使用 Flox 进行可复现的构建和打包
• flox-containers — 从 Flox 环境创建 Docker/OCI 容器
• flox-sharing — 环境组合、远程环境、团队模式
• flox-cuda — CUDA 和 GPU 开发环境

了解更多并在 flox.dev/docs 安装