mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2025-02-02 05:41:10 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(git): add environment variable requirement

Browse source 
resolves #2355
This commit is contained in:
Jan De Dobbeleer 2022-05-31 17:27:41 +02:00 committed by Jan De Dobbeleer
parent 56987bf63a
commit f6703e9c2c
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
website/docs/segments/git.mdx
View file

@ -18,13 +18,14 @@ Local changes can also be displayed which uses the following syntax for both the
:::tip :::tip
PowerShell offers support for the `posh-git` module for autocompletion, but it is disabled by default. PowerShell offers support for the `posh-git` module for autocompletion, but it is disabled by default.
To enable this, set `$env:POSH_GIT_ENABLED = $true` in your `$PROFILE`. To enable this, set `$env:POSH_GIT_ENABLED = $true` in your `$PROFILE`. Be aware this calls `git status`
twice, so in case you're having a slow repository, it's better to migrate to the [Posh-Git segment][poshgit].
::: :::
:::warning :::warning
Starting from version 3.152.0, `display_status` is disabled by default. Starting from version 3.152.0, `display_status` is disabled by default.
It improves performance but reduces the quantity of information. Don't forget to enable it in your theme if needed. It improves performance but reduces the quantity of information. Don't forget to enable it in your theme if needed.
An alternative is to use the [Posh-Git segment][poshgit] An alternative is to use the [Posh-Git segment][poshgit].
::: :::
## Sample Configuration ## Sample Configuration

3
website/docs/segments/posh-git.mdx
View file

@ -9,7 +9,8 @@ sidebar_label: Git (posh-git)
Display the [posh-git][posh-git] prompt. Display the [posh-git][posh-git] prompt.
:::caution :::caution
This segment only works within Powershell and requires the posh-git module to be installed and imported. This segment only works within Powershell and requires the posh-git module to be installed and imported
as well as `$env:POSH_GIT_ENABLED = $true` added to your `$PROFILE`.
::: :::
## Sample Configuration ## Sample Configuration