2022-02-20 04:56:28 -08:00
---
2022-04-20 09:43:59 -07:00
id: secondary-prompt
2022-02-20 04:56:28 -08:00
title: Secondary prompt
sidebar_label: Secondary prompt
---
2024-11-02 13:46:16 -07:00
import Config from "@site/src/components/Config.js";
2022-02-20 04:56:28 -08:00
:::info
This feature only works in `powershell`, `zsh` and `bash` for the time being.
:::
The secondary prompt is displayed when a command text spans multiple lines. The default is `> `.
You can use go [text/template][go-text-template] templates extended with [sprig][sprig] to enrich the text.
Environment variables are available, just like the [`console_title_template`][console-title] functionality.
## Configuration
You need to extend or create a custom theme with your secondary prompt override. For example:
2024-11-02 13:46:16 -07:00
<Config
data={{
secondary_prompt: {
background: "transparent",
foreground: "#ffffff",
template: "-> ",
},
}}
/>
2022-02-20 04:56:28 -08:00
2022-09-16 07:32:48 -07:00
## Properties
2022-02-20 04:56:28 -08:00
2022-09-16 07:32:48 -07:00
| Name | Type | Description |
| ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `background` | `string` | [color][colors] |
| `foreground` | `string` | [color][colors] |
| `template` | `string` | a go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the properties below - defaults to `> ` |
2022-02-20 04:56:28 -08:00
## Template ([info][templates])
2022-09-16 07:32:48 -07:00
| Name | Type | Description |
| ----------- | --------- | ------------------------------------- |
| `.Root` | `boolean` | is the current user root/admin or not |
| `.Shell` | `string` | the current shell name |
| `.UserName` | `string` | the current user name |
| `.HostName` | `string` | the host name |
2022-02-20 04:56:28 -08:00
[go-text-template]: https://golang.org/pkg/text/template/
[sprig]: https://masterminds.github.io/sprig/
2022-04-20 09:43:59 -07:00
[console-title]: /docs/configuration/title#console-title-template
[templates]: /docs/configuration/templates
[colors]: /docs/configuration/colors