direnv 项目技术文档

1. 安装指南

前提条件

• 操作系统：Unix-like 系统（如 macOS、Linux 等）
• 支持的 Shell：bash、zsh、tcsh、fish、elvish、powershell、murex、nushell

基本安装步骤

1. direnv 已经在大多数发行版中打包。详细安装步骤请参考 安装文档。
2. 将 direnv 钩子集成到你的 Shell 中，具体步骤请参考 钩子文档。

安装完成后，重启你的 Shell。

2. 项目使用说明

快速演示

1. 创建一个新文件夹用于演示：

   mkdir ~/my-project
   cd ~/my-project
   

2. 显示环境变量 FOO 未加载：

   echo ${FOO-nope}
   

3. 创建一个新的 .envrc 文件，并添加环境变量：

   echo export FOO=foo > .envrc
   

4. 允许 .envrc 文件执行：

   direnv allow .
   

5. 显示环境变量 FOO 已加载：

   echo ${FOO-nope}
   

6. 退出项目目录后，环境变量 FOO 将被卸载。

标准库

direnv 提供了一组实用函数，可以在 .envrc 文件中使用。例如，PATH_add 函数用于将路径添加到 $PATH 环境变量中。详细文档请参考 direnv-stdlib(1) 手册页。

3. 项目 API 使用文档

环境变量加载与卸载

direnv 通过检查当前目录及其父目录中的 .envrc 文件（可选地包括 .env 文件）来加载和卸载环境变量。加载的变量仅在当前 Shell 中有效，退出目录后自动卸载。

自定义扩展

用户可以通过在 ~/.config/direnv/direnvrc 或 ~/.config/direnv/lib/*.sh 中创建 Bash 文件来扩展 direnv 的功能。

4. 项目安装方式

通过包管理器安装

direnv 已经在大多数发行版中打包，用户可以通过包管理器直接安装。具体步骤请参考 安装文档。

手动安装

用户也可以通过源码手动安装 direnv，具体步骤如下：

1. 下载源码：

   git clone https://github.com/direnv/direnv.git
   cd direnv
   

2. 编译并安装：

   make install
   

安装完成后，按照 钩子文档 将 direnv 集成到你的 Shell 中。

总结

direnv 是一个强大的 Shell 扩展工具，能够根据当前目录自动加载和卸载环境变量，适用于多种开发场景。通过本文档，用户可以快速了解并使用 direnv 项目。