要在starship提示符中动态显示命令结果,需配置自定义模块:一、基础配置用[custom.name]定义;二、条件触发用when参数;三、复杂逻辑用shell数组与多命令组合;四、文件检测用detect_files等参数;五、通过调试日志、超时和错误处理确保稳定。

如果您希望在Starship提示符中动态显示任意命令的执行结果,例如系统负载、当前天气或自定义脚本输出,则需正确配置自定义命令模块。以下是实现此目标的具体操作步骤:
一、基础自定义模块配置
该方法通过[custom.module_name]定义最简可用模块,适用于单次命令、无条件触发的场景。其核心在于确保命令可执行、输出可捕获,并以格式字符串嵌入提示符。
1、打开或创建Starship配置文件:mkdir -p ~/.config && touch ~/.config/starship.toml
2、在配置文件中添加以下TOML结构:
3、将command字段替换为实际要执行的命令,例如获取当前用户名:command = "whoami"
4、设置format字段以控制显示样式,例如:format = "? $output "
5、必须显式启用模块:when = true
二、带条件触发的自定义模块
该方法通过when参数结合Shell表达式,实现仅在满足特定条件时才显示模块,避免无关信息干扰提示符,提升上下文相关性。
1、在配置中添加when字段,其值为一段返回0(真)或非0(假)的Shell命令,例如检测当前目录是否含README.md:when = 'test -f "README.md"'
2、确保shell参数指定执行环境,推荐显式声明:shell = ["bash", "-c"]
3、禁用stdin以防止阻塞:use_stdin = false
4、完整示例(仅在含package.json时显示Node版本):
[custom.node_version]
command = "node -v 2>/dev/null || echo 'N/A'"
format = "? Node $output "
when = 'test -f "package.json"'
shell = ["bash", "-c"]
一款AI工具,主要用于使用 Codex CLI 进行深度网络搜索,适用于需要多源综合分析的复杂查询。当 `web_search`(Brave)返回结果不足,或用户……时使用,适合需要提升相关任务效率的用户。
use_stdin = false
三、多命令组合与环境变量支持
该方法适用于需依赖环境变量、多步逻辑或跨Shell兼容的复杂命令,通过shell和command协同实现可靠执行,避免子shell变量丢失问题。
1、使用shell数组明确指定解释器及启动方式,例如调用bash并加载用户配置:shell = ["bash", "-i", "-c"]
2、在command中使用分号或&&连接多条指令,例如先切换目录再执行:command = "cd /tmp && date +%s"
3、若需引用当前Shell环境变量,可在command中直接使用,但须确保shell已正确初始化:command = "echo $HOME"
4、对可能失败的命令添加容错处理,例如重定向错误输出并提供默认值:command = "git rev-parse --short HEAD 2>/dev/null || echo 'detached'"
四、基于文件检测的自动激活模块
该方法利用Starship内置的文件检测机制,无需编写Shell条件表达式,由Starship运行时自动扫描指定文件或目录,降低配置复杂度并提升性能。
1、使用detect_files参数列出至少一个需存在的文件名,例如:detect_files = ["Cargo.toml"]
2、使用detect_folders参数匹配目录存在性,适用于项目根标识:detect_folders = [".git", "src"]
3、可同时启用detect_extensions识别特定后缀文件,例如检测Python项目:detect_extensions = ["py"]
4、当多个检测项共存时,满足任一即可激活模块;如需全部满足,应改用when配合Shell逻辑判断。
五、错误处理与调试配置
该方法用于定位自定义模块不显示的根本原因,通过日志、超时控制和显式错误反馈,快速验证命令执行路径是否通畅。
1、启用Starship调试日志,在终端运行:STARSHIP_LOG=debug starship prompt
2、为命令添加超时限制,防止挂起,例如限制执行时间不超过500毫秒:timeout = 500
3、在command中加入调试输出,例如记录执行时间戳:command = "echo \"[$(date +%H:%M:%S)] $(hostname)\""
4、若命令依赖外部工具(如curl),务必确认其已安装且在PATH中,可使用绝对路径增强健壮性:command = "/usr/bin/curl -s https://api.ipify.org"










