Starship配置Terraform工作区显示方法

想让 Starship 终端提示符智能显示当前 Terraform 工作区（workspace）？本文详解三种灵活可靠的实现方式：启用内置 terraform 模块自动识别本地状态、通过 TF_WORKSPACE 环境变量在 CI/CD 或远程后端场景中精准回退、以及利用自定义命令钩子动态执行 terraform workspace show 获取实时结果——无论你使用本地 state、远程后端还是多环境切换，都能一键配置、即刻生效，让工作区信息清晰可见、所见即所得。

如果您在终端中使用 Starship 作为提示符，并希望其显示当前 Terraform 工作区（workspace）信息，但默认未启用或显示异常，则可能是由于 Terraform 模块未启用、工作区检测路径不匹配或环境变量未正确识别。以下是实现该功能的多种配置方法：

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

Starship 自带 terraform 模块，可自动检测当前目录下是否存在 .terraform/ 子目录或 terraform.tfstate 文件，并读取 active workspace 名称。需在配置文件中显式启用并定制格式。

1、打开或创建 Starship 配置文件：~/.config/starship.toml。

2、添加以下 terraform 模块配置段：

```toml

[terraform]

disabled = false

format = 'on [$symbol$workspace]($style) '

symbol = '? '

style = 'bold cyan'

```

3、保存文件后，在终端中执行 starship reload 或新开一个 shell 会话使配置生效。

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

当 Terraform 工作区未通过本地状态文件体现（例如使用远程后端且未执行 terraform workspace show），Starship 可依赖环境变量 TF_WORKSPACE 进行识别。此方式适用于 CI/CD 或脚本化切换场景。

1、在 shell 启动文件（如 ~/.bashrc 或 ~/.zshrc）中设置示例变量：

export TF_WORKSPACE="staging"

2、在 starship.toml 中为 terraform 模块启用环境变量回退机制（需 Starship v1.18.0+）：

```toml

[terraform]

disabled = false

detect_env_vars = ["TF_WORKSPACE"]

format = 'via $symbol$workspace '

```

3、重新加载 shell 配置并验证 TF_WORKSPACE 是否被 Starship 读取。

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

对于复杂工作流（如多后端共存、动态 workspace 切换），Starship 支持通过 custom 模块调用外部命令获取动态值。该方法绕过内置检测逻辑，完全可控。

1、编写一个轻量脚本（如 ~/bin/terraform-workspace-name），内容如下：

```bash

#!/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"

```

2、赋予执行权限：chmod +x ~/bin/terraform-workspace-name。

3、在 starship.toml 中添加 custom 模块：

```toml

[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'

```

文中关于Starship的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Starship配置Terraform工作区显示方法》文章吧，也可关注golang学习网公众号了解相关技术文章。