Oh My Posh

https://ohmyposh.dev/docs
Admin
Oh My Posh is a highly customizable and fast prompt engine for any shell that displays Git status,...
Tokens:4,670
Snippets:94
Trust Score:9.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install and Start Website

Source: https://ohmyposh.dev/docs/contributing/started

Navigate to the `website` folder, install Node.js dependencies using npm, and start the local development server.

```bash
npm install  

npm start  
```

--------------------------------

### Install Dependencies with Winget

Source: https://ohmyposh.dev/docs/contributing/started

Use winget to install project dependencies by running the configuration file in the cloned repository.

```powershell
winget configure .config/configuration.winget
```

--------------------------------

### Install Oh My Posh with Homebrew

Source: https://ohmyposh.dev/docs/installation/macos

Use this command to install Oh My Posh via Homebrew. Ensure you have Homebrew installed.

```bash
brew install jandedobbeleer/oh-my-posh/oh-my-posh
```

--------------------------------

### Configure Upgrade Notice (JSON)

Source: https://ohmyposh.dev/docs/installation/upgrade

Enable displaying upgrade notices on shell start. Checks are performed based on the configured interval.

```json
{
  "upgrade": {
    "notice": true,
    "interval": "168h",
    "auto": false,
    "source": "cdn"
  }
}
```

--------------------------------

### Install Oh My Posh using winget

Source: https://ohmyposh.dev/docs/installation/windows

Use this command in PowerShell to install Oh My Posh via the winget package manager. Ensure winget is available on your system.

```powershell
winget install JanDeDobbeleer.OhMyPosh --source winget
```

--------------------------------

### Install Oh My Posh using PowerShell script

Source: https://ohmyposh.dev/docs/installation/windows

Execute this command in PowerShell to download and run the Oh My Posh installation script. This method bypasses execution policy for the current process.

```powershell
Set-ExecutionPolicy Bypass -Scope Process -Force; Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://ohmyposh.dev/install.ps1'))
```

--------------------------------

### Install APM and Shared Skills

Source: https://ohmyposh.dev/docs/contributing/started

Install the Agent Package Manager (APM) and then use it to install shared AI agent skills required for the project.

```bash
# Install APM  

pip install apm-cli  

# Install shared skills  

apm install  
```

--------------------------------

### Configure Upgrade Notice (TOML)

Source: https://ohmyposh.dev/docs/installation/upgrade

Enable displaying upgrade notices on shell start. Checks are performed based on the configured interval.

```toml
[upgrade]
notice = true
interval = "168h"
auto = false
source = "cdn"
```

--------------------------------

### Configure Upgrade Notice (YAML)

Source: https://ohmyposh.dev/docs/installation/upgrade

Enable displaying upgrade notices on shell start. Checks are performed based on the configured interval.

```yaml
upgrade:
  notice: true
  interval: 168h
  auto: false
  source: cdn
```

--------------------------------

### Install Oh My Posh with MacPorts

Source: https://ohmyposh.dev/docs/installation/macos

Install Oh My Posh using MacPorts. This command updates MacPorts and then installs the package.

```bash
sudo port selfupdate

sudo port install oh-my-posh
```

--------------------------------

### Install Oh My Posh using Chocolatey

Source: https://ohmyposh.dev/docs/installation/windows

Install Oh My Posh using the Chocolatey package manager. Note that the Chocolatey package is community-maintained and may not always be up-to-date.

```powershell
choco install oh-my-posh
```

--------------------------------

### Build Oh My Posh (Output Parameter)

Source: https://ohmyposh.dev/docs/contributing/started

Build the Oh My Posh application, specifying the output path to the source of the currently installed Oh My Posh executable. This is useful if Oh My Posh is already in your PATH.

```powershell
go build -o (Get-Command oh-my-posh.exe).Source  
```

--------------------------------

### Update Oh My Posh with MacPorts

Source: https://ohmyposh.dev/docs/installation/macos

Update Oh My Posh to the latest version if you installed it via MacPorts.

```bash
sudo port selfupdate

sudo port upgrade oh-my-posh
```

--------------------------------

### Uninstall PowerShell module

Source: https://ohmyposh.dev/docs/migrating

Removes all installed versions of the Oh My Posh PowerShell module.

```powershell
Uninstall-Module oh-my-posh -AllVersions
```

--------------------------------

### Reload Shell After Homebrew Upgrade

Source: https://ohmyposh.dev/docs/installation/macos

If you encounter issues after upgrading Oh My Posh with Homebrew, reload your shell using this command. This example is for zsh.

```bash
brew update && brew upgrade && exec zsh
```

--------------------------------

### Update Oh My Posh using Chocolatey

Source: https://ohmyposh.dev/docs/installation/windows

Upgrade Oh My Posh to the latest version using Chocolatey. As with installation, be aware that this package is community-maintained.

```powershell
choco upgrade oh-my-posh
```

--------------------------------

### Troubleshoot Bash Version Error

Source: https://ohmyposh.dev/docs/installation/macos

If you see a 'conditional binary operator expected' error, you may need to update your bash version. This command installs a newer bash via Homebrew and sets it as the default shell.

```bash
brew install bash

grep -qxF "$(brew --prefix)/bin/bash" /etc/shells || sudo bash -c 'echo "$(brew --prefix)/bin/bash" >> /etc/shells'

chsh -s "$(brew --prefix)/bin/bash" $USER
```

--------------------------------

### Initialize prompt with custom theme

Source: https://ohmyposh.dev/docs/migrating

Replaces the legacy Set-PoshPrompt command for users with a custom theme file.

```powershell
oh-my-posh init pwsh --config ~/.custom.omp.json | Invoke-Expression
```

--------------------------------

### Run Unit Tests

Source: https://ohmyposh.dev/docs/contributing/started

Navigate to the `src/` directory and run all unit tests using the `go test` command with the verbose flag.

```bash
go test -v ./...  
```

--------------------------------

### Build Oh My Posh (GOPATH)

Source: https://ohmyposh.dev/docs/contributing/started

Build the Oh My Posh application and place the executable in the `$GOPATH/bin/` directory. Ensure this directory is added to your PATH.

```powershell
$env:PATH = "$env:GOPATH\bin;$env:PATH"  
go build -o $GOPATH/bin/oh-my-posh  
```

--------------------------------

### Initialize prompt with built-in theme

Source: https://ohmyposh.dev/docs/migrating

Replaces the legacy Set-PoshPrompt command for users utilizing an out-of-the-box theme.

```powershell
oh-my-posh init pwsh --config "jandedobbeleer" | Invoke-Expression
```

--------------------------------

### Integrate with Windows CMD via Clink

Source: https://ohmyposh.dev/docs/installation/prompt

Configure Clink to load Oh My Posh and manage prompt settings.

```lua
load(io.popen('oh-my-posh init cmd'):read("*a"))()
```

```cmd
clink config prompt use oh-my-posh
```

```cmd
clink set ohmyposh.theme <path>
```

--------------------------------

### Initialize Zsh

Source: https://ohmyposh.dev/docs/installation/prompt

Add initialization to the Zsh configuration file. Includes an optional check to skip Apple Terminal.

```zsh
eval "$(oh-my-posh init zsh)"
```

```zsh
if [ "$TERM_PROGRAM" != "Apple_Terminal" ]; then
  eval "$(oh-my-posh init zsh)"
fi
```

```zsh
exec zsh
```

--------------------------------

### Initialize Xonsh

Source: https://ohmyposh.dev/docs/installation/prompt

Add initialization to the Xonsh configuration file and reload.

```xonsh
execx($(oh-my-posh init xonsh))
```

```xonsh
exec xonsh
```

--------------------------------

### Initialize PowerShell

Source: https://ohmyposh.dev/docs/installation/prompt

Configure the PowerShell profile. Use the --eval flag if execution policies prevent script execution.

```powershell
notepad $PROFILE
```

```powershell
New-Item -Path $PROFILE -Type File -Force
```

```powershell
oh-my-posh init pwsh | Invoke-Expression
```

```powershell
oh-my-posh init pwsh --eval | Invoke-Expression
```

```powershell
. $PROFILE
```

--------------------------------

### Initialize Elvish

Source: https://ohmyposh.dev/docs/installation/prompt

Add initialization to the Elvish configuration file and reload.

```elvish
eval (oh-my-posh init elvish)
```

```elvish
exec elvish
```

--------------------------------

### Enable Automated Upgrade (CLI)

Source: https://ohmyposh.dev/docs/installation/upgrade

Enable automated upgrade features via the command-line interface.

```bash
oh-my-posh enable upgrade
```

--------------------------------

### Initialize Fish

Source: https://ohmyposh.dev/docs/installation/prompt

Add initialization to the Fish config file. Requires Fish 4.1.0 or higher for full feature support.

```fish
oh-my-posh init fish | source
```

```fish
exec fish
```

--------------------------------

### Define an empty blocks configuration

Source: https://ohmyposh.dev/docs

Initial structure for a configuration file with no blocks defined.

```json
{
  "blocks": []
}
```

```yaml
blocks: []
```

```toml
blocks = []
```

--------------------------------

### Run golangci-lint

Source: https://ohmyposh.dev/docs/contributing/started

Execute the `golangci-lint run` command to validate code quality according to the project's linting rules.

```bash
golangci-lint run  
```

--------------------------------

### Initialize Nushell

Source: https://ohmyposh.dev/docs/installation/prompt

Add initialization to the Nushell config file. Requires Nushell v0.104.0 or higher.

```nu
oh-my-posh init nu
```

--------------------------------

### Initialize Bash

Source: https://ohmyposh.dev/docs/installation/prompt

Add the initialization command to your shell profile and reload the environment.

```bash
eval "$(oh-my-posh init bash)"
```

```bash
exec bash
```

```bash
. ~/.profile
```

--------------------------------

### Manual Upgrade Command

Source: https://ohmyposh.dev/docs/installation/upgrade

Use the 'upgrade' command to update Oh My Posh to the latest version manually.

```bash
oh-my-posh upgrade
```

--------------------------------

### Clone Oh My Posh Repository

Source: https://ohmyposh.dev/docs/contributing/started

Clone your fork of the Oh My Posh repository to your local machine. Replace `<user>` with your GitHub username.

```bash
git clone git@github.com:<user>/oh-my-posh.git
```

--------------------------------

### Configure Auto Upgrade (TOML)

Source: https://ohmyposh.dev/docs/installation/upgrade

Automatically update Oh My Posh when an update is found. Checks are performed based on the configured interval.

```toml
[upgrade]
interval = "168h"
auto = true
source = "cdn"
```

--------------------------------

### Configure Auto Upgrade (JSON)

Source: https://ohmyposh.dev/docs/installation/upgrade

Automatically update Oh My Posh when an update is found. Checks are performed based on the configured interval.

```json
{
  "upgrade": {
    "interval": "168h",
    "auto": true,
    "source": "cdn"
  }
}
```

--------------------------------

### Update Oh My Posh with Homebrew

Source: https://ohmyposh.dev/docs/installation/macos

Run this command to update Oh My Posh to the latest version using Homebrew.

```bash
brew update && brew upgrade oh-my-posh
```

--------------------------------

### Define blocks with segments

Source: https://ohmyposh.dev/docs

Structure for a configuration file containing blocks with nested segments.

```json
{
  "blocks": [
    {
      "segments": []
    }
  ]
}
```

```yaml
blocks:
  - segments: []
```

```toml
[[blocks]]
segments = []
```

--------------------------------

### Configure Auto Upgrade (YAML)

Source: https://ohmyposh.dev/docs/installation/upgrade

Automatically update Oh My Posh when an update is found. Checks are performed based on the configured interval.

```yaml
upgrade:
  interval: 168h
  auto: true
  source: cdn
```

--------------------------------

### Update Oh My Posh using winget

Source: https://ohmyposh.dev/docs/installation/windows

Use this command in PowerShell to upgrade Oh My Posh to the latest version via the winget package manager.

```powershell
winget upgrade JanDeDobbeleer.OhMyPosh --source winget
```

--------------------------------

### Configure Claude Code Integration

Source: https://ohmyposh.dev/docs/installation/prompt

Set Oh My Posh as the statusline command in Claude Code settings.

```json
{
  "statusLine": {
    "type": "command",
    "command": "oh-my-posh claude",
    "padding": 0
  }
}
```

--------------------------------

### Configure Delve Debugger in VS Code

Source: https://ohmyposh.dev/docs/contributing/started

Configure the Delve debugger settings in VS Code's `settings.json` or `launch.json` to expand limits for variable inspection, such as string length and array values.

```json
"go.delveConfig": {  

  "dlvLoadConfig": {  

    "followPointers": true,  

    "maxVariableRecurse": 3,  

    "maxStringLen": 400,  

    "maxArrayValues": 400,  

    "maxStructFields": -1  

  },  

  "apiVersion": 2,  

  "showGlobalVariables": false  

}  
```

--------------------------------

### Identify Current Shell

Source: https://ohmyposh.dev/docs/installation/prompt

Utility command to detect the shell currently in use.

```bash
oh-my-posh get shell
```

--------------------------------

### Remove module import

Source: https://ohmyposh.dev/docs/migrating

Locate and delete this line from your PowerShell profile to stop loading the legacy module.

```powershell
Import-Module oh-my-posh
```

--------------------------------

### Remove cached module files

Source: https://ohmyposh.dev/docs/migrating

Deletes the cached files associated with the legacy module. Ensure any custom elements in this directory are backed up first.

```powershell
Remove-Item $env:POSH_PATH -Force -Recurse
```
Tokens:
Raw