Starship如何配置Terraform工作区显示_Starship Terraform工作区显示配置思路

Starship 可通过启用内置 terraform 模块、依赖 TF_WORKSPACE 环境变量或自定义命令钩子三种方式显示 Terraform 工作区信息，需分别配置 starship.toml 并确保检测条件匹配。

用 Starship 美化终端提示符，却看不到当前的 Terraform 工作区？这确实有点扫兴。问题通常出在几个地方：要么是 Terraform 模块没启用，要么是 Starship 没找对检测路径，再不然就是环境变量没被正确识别。别急，下面这几种配置思路，总有一款能帮你搞定。

一、启用并配置内置 terraform 模块

最直接的方法，就是启用 Starship 自带的 Terraform 模块。这个模块很聪明，它会自动扫描当前目录下是否存在 .terraform/ 子目录或者 terraform.tfstate 文件，然后从中读取活跃工作区的名称。当然，你得先在配置文件里把它打开，并按照自己的喜好打扮一下。

首先，找到（或创建）Starship 的配置文件：~/.config/starship.toml。

然后，加入下面这段 Terraform 模块的配置：

[terraform]
disabled = false
format = 'on [$symbol$workspace]($style) '
symbol = '? '
style = 'bold cyan'

保存文件之后，在终端里执行一下 starship reload，或者干脆新开一个 shell 会话，配置就生效了。

二、强制通过 TF_WORKSPACE 环境变量识别工作区

有些情况下，工作区信息并不直接写在本地文件里。比如你用了远程后端，但最近没执行过 terraform workspace show 命令。这时候，Starship 可以换个思路，去读取一个叫 TF_WORKSPACE 的环境变量。这个方法在 CI/CD 流水线或者用脚本切换工作区的场景里特别管用。

第一步，是在你的 shell 启动文件（比如 ~/.bashrc 或 ~/.zshrc）里设置这个变量，举个例子：

export TF_WORKSPACE="staging"

第二步，需要在 starship.toml 里告诉 Terraform 模块，可以把这个环境变量作为备选信息来源（这需要 Starship v1.18.0 或更高版本）：

[terraform]
disabled = false
detect_env_vars = ["TF_WORKSPACE"]
format = 'via $symbol$workspace '

最后，重新加载一下 shell 配置，看看 Starship 是不是已经能正确读取到 TF_WORKSPACE 了。

三、自定义命令钩子注入 workspace 名称

如果你的工作流比较复杂，比如同时存在多个后端，或者工作区是动态切换的，那么上面两种标准方法可能就不够用了。好在 Starship 还留了一手“大招”：通过 custom 模块调用外部命令来获取动态值。这个方法跳过了内置的检测逻辑，让你拥有完全的控制权。

首先，写一个小脚本（比如放在 ~/bin/terraform-workspace-name），内容如下：

#!/bin/bash
cd "$(git rev-parse --show-toplevel 2>/dev/null || pwd)" 2>/dev/null
terraform workspace show 2>/dev/null | tr -d '\n' || echo "default"

记得给它加上执行权限：chmod +x ~/bin/terraform-workspace-name。

接着，在 starship.toml 里添加一个 custom 模块来调用这个脚本：

[custom.terraform_workspace]
command = "~/bin/terraform-workspace-name"
when = """test -f "./terraform.tfstate" || test -d ".terraform" || [ -n "$TF_WORKSPACE" ]"""
format = 'on [$symbol$output]($style) '
symbol = '? '
style = 'bold yellow'

这样一来，无论你的 Terraform 工作区藏在多么隐蔽的角落，Starship 都能把它揪出来，漂亮地展示在你的提示符上了。