Transient Prompt Variables

[mateothegreat]

I can't figure out the source of truth for the variables exposed and how to access them for the transient_prompt.template value.

https://ohmyposh.dev/docs/configuration/transient#properties says:

a go text/template template extended with sprig utilizing the properties below - defaults to {{ .Shell }}

..but there is nothing indicating this.
 
So I dug for issues and discussions around this topic and came up empty handed. Then I did some trivial debugging and am left without a solution.

I can see that with {{ . }} it outputs gaggle of variables but I cannot use them (e.g. {{ .Time.CurrentDate }}).

Initial Test

transient_prompt:
  background: transparent
  foreground: "#6F0AFC"
  template: '{{ .Time.CurrentDate | date "15:04:05" }} {{ .PWD }} '

Dumping .

transient_prompt:
  background: transparent
  foreground: "#6F0AFC"
  template: "{{ . }}"

My Assumptions

Based on the {{ . }} dump I'm assuming the following to be true:

# Transient Prompt Variables Documentation
#
# The transient_prompt template has access to the following variables through {{ . }}:
#
# Core System Information:
# - .UserName: Current username (e.g., "matthew")
# - .HostName: System hostname (e.g., "hater")
# - .Shell: Shell name (e.g., "zsh")
# - .ShellVersion: Shell version (e.g., "5.9")
# - .OS: Operating system (e.g., "darwin")
# - .OSVersion: OS version (e.g., "26.20.1")
# - .Folder: Current folder name (e.g., ".zshrc.d")
# - .PWD: Current working directory path (e.g., "/Users/matthew/.zshrc.d")
#
# Path Information:
# - .Path.Location: Full path location
# - .Path.Path: Formatted path display
# - .Path.RootDir: Boolean indicating if in root directory
# - .Path.Writable: Boolean indicating if directory is writable
# - .Path.StackCount: Directory stack count
# - .Path.Folders: Array of folder objects with Name, Path, and Display properties
#
# Git Information (when in a git repository):
# - .Git.HEAD: Current branch name (e.g., "main")
# - .Git.Ref: Git reference
# - .Git.Hash: Full commit hash
# - .Git.ShortHash: Abbreviated commit hash
# - .Git.RepoName: Repository name
# - .Git.Ahead: Number of commits ahead of upstream
# - .Git.Behind: Number of commits behind upstream
# - .Git.BranchStatus: Branch status indicator (e.g., "≢")
# - .Git.Staging: Staging area status with Added, Modified, Deleted, etc.
# - .Git.Working: Working directory status with Added, Modified, Deleted, etc.
# - .Git.Upstream: Upstream branch name
# - .Git.UpstreamGone: Boolean indicating if upstream is gone
# - .Git.UpstreamIcon: Icon representing upstream status
# - .Git.Detached: Boolean indicating detached HEAD state
# - .Git.Merge: Boolean indicating merge in progress
# - .Git.Rebase: Rebase status
# - .Git.CherryPick: Boolean indicating cherry-pick in progress
# - .Git.Revert: Boolean indicating revert in progress
#
# Kubernetes Information (when kubectl context is available):
# - .Kubectl.Context: Current kubectl context
# - .Kubectl.Cluster: Current cluster name
# - .Kubectl.Namespace: Current namespace
# - .Kubectl.User: Current user
#
# System Information:
# - .Sysinfo.Load1: 1-minute load average
# - .Sysinfo.Load5: 5-minute load average
# - .Sysinfo.Load15: 15-minute load average
# - .Sysinfo.PhysicalTotalMemory: Total physical memory in bytes
# - .Sysinfo.PhysicalAvailableMemory: Available physical memory in bytes
# - .Sysinfo.PhysicalFreeMemory: Free physical memory in bytes
# - .Sysinfo.PhysicalPercentUsed: Percentage of physical memory used
# - .Sysinfo.SwapTotalMemory: Total swap memory in bytes
# - .Sysinfo.SwapFreeMemory: Free swap memory in bytes
# - .Sysinfo.SwapPercentUsed: Percentage of swap memory used
# - .Sysinfo.Disks: Map of disk information with read/write statistics
#
# Time Information:
# - .Time.CurrentDate: Current date and time
# - .Time.Format: Time format string
#
# Shell Information:
# - .Shell.Name: Shell name
# - .Shell.Version: Shell version
#
# Usage Examples:
# - Simple username: "{{ .UserName }} "
# - Path with git status: "{{ .Folder }}{{ if .Git.HEAD }} ({{ .Git.HEAD }}){{ end }} "
# - System load: "{{ .Folder }} [{{ .Sysinfo.Load1 }}] "

P.S.: My full config is here: https://gist.github.com/mateothegreat/93f6d7de397c53d5575abda3446b41f1

Thanks ya'll!
-Matthew

[JanDeDobbeleer]

@mateothegreat you're mixing multiple concepts here, so let me help you.

On the one hand, there are global properties you can use inside a template. These can be used as is using the . notation.

Secondly there are cross segment template properties. Every segment that is enabled is added to the list which you can access using .Segments.Segmentname.Property. This is what you've listed with .Time.CurrentDate, except you need to access it using .Segments.Time.CurrentDate provided that segment is part of your configuration and is enabled (will always be true in this case).

Thirdly there are custom and sprig functions you can use inside templates. In your use-case, you can also use {{ now | date "15:04:05" }} which doesn't require anything to be configured elsewhere. One caveat here is that this will be evaluated at the time of rendering the prompt, and .Segments.Time.CurrentDate is the cached timestamp when the primary prompt was rendered.