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），可改用环境变量方式。

此方法在 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 均能将其准确显示在终端提示符中。

《夸克》非常好用的免费AI浏览器

下载APP查看