andrei/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2026-06-22 02:02:12 +07:00
Code Issues Packages Projects Releases 10 Wiki Activity

docs(git_status): improve descriptions of options (#7277)

Browse Source 
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
joshmarkovic
2026-02-28 13:14:24 -05:00
committed by GitHub
parent 88d384f582
commit 0d71065a6e
1 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/config/README.md
+24 -24
View File
@@ -2070,28 +2070,28 @@ current directory.
| Option | Default | Description |
| ---------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
| `conflicted` | `'='` | This branch has merge conflicts. |
| `ahead` | `'⇡'` | The format of `ahead` |
| `behind` | `'⇣'` | The format of `behind` |
| `diverged` | `'⇕'` | The format of `diverged` |
| `up_to_date` | `''` | The format of `up_to_date` |
| `untracked` | `'?'` | The format of `untracked` |
| `stashed` | `'\$'` | The format of `stashed` |
| `modified` | `'!'` | The format of `modified` |
| `staged` | `'+'` | The format of `staged` |
| `renamed` | `'»'` | The format of `renamed` |
| `deleted` | `'✘'` | The format of `deleted` |
| `typechanged` | `""` | The format of `typechanged` |
| `conflicted` | `'='` | The format shown when this branch has merge conflicts. |
| `ahead` | `'⇡'` | The format shown when this branch is ahead of the branch being tracked. |
| `behind` | `'⇣'` | The format shown when this branch is behind the branch being tracked. |
| `diverged` | `'⇕'` | The format shown when this branch has diverged from the branch being tracked. |
| `up_to_date` | `''` | The format shown when this branch is up to date with the branch being tracked. |
| `untracked` | `'?'` | The format shown when there are untracked files in the working directory. |
| `stashed` | `'\$'` | The format shown when a stash exists for the local repository. |
| `modified` | `'!'` | The format shown when there are file modifications in the working directory. |
| `staged` | `'+'` | The format shown when a new file has been added to the staging area. |
| `renamed` | `'»'` | The format shown when a renamed file has been added to the staging area. |
| `deleted` | `'✘'` | The format shown when a file's deletion has been added to the staging area. |
| `typechanged` | `""` | The format shown when a file's type has been changed in the staging area. |
| `style` | `'bold red'` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. |
| `worktree_added` | `""` | The format of `worktree_added` |
| `worktree_deleted` | `""` | The format of `worktree_deleted` |
| `worktree_modified` | `""` | The format of `worktree_modified` |
| `worktree_typechanged` | `""` | The format of `worktree_typechanged` |
| `index_added` | `""` | The format of `index_added` |
| `index_deleted` | `""` | The format of `index_deleted` |
| `index_modified` | `""` | The format of `index_modified` |
| `index_typechanged` | `""` | The format of `index_typechanged` |
| `worktree_added` | `""` | The format shown when a new file has been added in the working directory. |
| `worktree_deleted` | `""` | The format shown when a file has been deleted in the working directory. |
| `worktree_modified` | `""` | The format shown when a file has been modified in the working directory. |
| `worktree_typechanged` | `""` | The format shown when a file's type has been changed in the working directory. |
| `index_added` | `""` | The format shown when a new file has been added to the staging area. |
| `index_deleted` | `""` | The format shown when a file has been deleted from the staging area. |
| `index_modified` | `""` | The format shown when a file has been modified in the staging area. |
| `index_typechanged` | `""` | The format shown when a file's type has been changed in the staging area. |
| `disabled` | `false` | Disables the `git_status` module. |
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. |
@@ -2102,7 +2102,7 @@ The following variables can be used in `format`:
| Variable | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------- |
| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked` |
| `all_status` | Shortcut for `$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked`. |
| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. |
| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |
| `untracked` | Displays `untracked` when there are untracked files in the working directory. |
@@ -2117,9 +2117,9 @@ The following variables can be used in `format`:
| `worktree_modified` | Displays `worktree_modified` when a file's been modified in the working directory. |
| `worktree_typechanged` | Displays `worktree_typechanged` when a file's type has been changed in the working directory. |
| `index_added` | Displays `index_added` when a new file has been added to the staging area. |
| `index_deleted` | Displays `index_deleted` when a file's been deleted to the staging area. |
| `index_modified` | Displays `index_modified` when a file's been modified to the staging area. |
| `index_typechanged` | Displays `index_typechanged` when a file's type has been changed to the staging area. |
| `index_deleted` | Displays `index_deleted` when a file has been deleted from the staging area. |
| `index_modified` | Displays `index_modified` when a file has been modified in the staging area. |
| `index_typechanged` | Displays `index_typechanged` when a file's type has been changed in the staging area. |
| style\* | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string