mirror of
https://github.com/starship/starship.git
synced 2026-06-22 02:02:12 +07:00
docs(i18n): new Crowdin updates (#6141)
* New translations gruvbox-rainbow.md (Dutch) * New translations jetpack.md (Dutch) * New translations readme.md (Norwegian) * New translations bracketed-segments.md (Norwegian) * New translations nerd-font.md (Norwegian) * New translations no-runtimes.md (Norwegian) * New translations plain-text.md (Norwegian) * New translations pure-preset.md (Norwegian) * New translations pastel-powerline.md (Norwegian) * New translations no-nerd-font.md (Norwegian) * New translations no-empty-icons.md (Norwegian) * New translations tokyo-night.md (Norwegian) * New translations gruvbox-rainbow.md (Norwegian) * New translations jetpack.md (Norwegian) * New translations readme.md (Polish) * New translations bracketed-segments.md (Polish) * New translations nerd-font.md (Polish) * New translations no-runtimes.md (Polish) * New translations plain-text.md (Polish) * New translations pure-preset.md (Polish) * New translations pastel-powerline.md (Polish) * New translations no-nerd-font.md (Polish) * New translations no-empty-icons.md (Polish) * New translations tokyo-night.md (Polish) * New translations gruvbox-rainbow.md (Polish) * New translations jetpack.md (Polish) * New translations readme.md (Portuguese) * New translations bracketed-segments.md (Portuguese) * New translations nerd-font.md (Portuguese) * New translations no-runtimes.md (Portuguese) * New translations plain-text.md (Portuguese) * New translations pure-preset.md (Portuguese) * New translations pastel-powerline.md (Portuguese) * New translations no-nerd-font.md (Portuguese) * New translations no-empty-icons.md (Portuguese) * New translations tokyo-night.md (Portuguese) * New translations gruvbox-rainbow.md (Portuguese) * New translations jetpack.md (Portuguese) * New translations readme.md (Russian) * New translations bracketed-segments.md (Russian) * New translations nerd-font.md (Russian) * New translations no-runtimes.md (Russian) * New translations plain-text.md (Russian) * New translations pure-preset.md (Russian) * New translations pastel-powerline.md (Russian) * New translations no-nerd-font.md (Russian) * New translations no-empty-icons.md (Russian) * New translations tokyo-night.md (Russian) * New translations gruvbox-rainbow.md (Russian) * New translations jetpack.md (Russian) * New translations readme.md (Turkish) * New translations bracketed-segments.md (Turkish) * New translations nerd-font.md (Turkish) * New translations no-runtimes.md (Turkish) * New translations plain-text.md (Turkish) * New translations pure-preset.md (Turkish) * New translations pastel-powerline.md (Turkish) * New translations no-nerd-font.md (Turkish) * New translations no-empty-icons.md (Turkish) * New translations tokyo-night.md (Turkish) * New translations gruvbox-rainbow.md (Turkish) * New translations jetpack.md (Turkish) * New translations readme.md (Ukrainian) * New translations bracketed-segments.md (Ukrainian) * New translations nerd-font.md (Ukrainian) * New translations no-runtimes.md (Ukrainian) * New translations plain-text.md (Ukrainian) * New translations pure-preset.md (Ukrainian) * New translations pastel-powerline.md (Ukrainian) * New translations no-nerd-font.md (Ukrainian) * New translations no-empty-icons.md (Ukrainian) * New translations tokyo-night.md (Ukrainian) * New translations gruvbox-rainbow.md (Ukrainian) * New translations jetpack.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations bracketed-segments.md (Chinese Simplified) * New translations nerd-font.md (Chinese Simplified) * New translations no-runtimes.md (Chinese Simplified) * New translations plain-text.md (Chinese Simplified) * New translations pure-preset.md (Chinese Simplified) * New translations pastel-powerline.md (Chinese Simplified) * New translations no-nerd-font.md (Chinese Simplified) * New translations no-empty-icons.md (Chinese Simplified) * New translations tokyo-night.md (Chinese Simplified) * New translations gruvbox-rainbow.md (Chinese Simplified) * New translations jetpack.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations bracketed-segments.md (Chinese Traditional) * New translations nerd-font.md (Chinese Traditional) * New translations no-runtimes.md (Chinese Traditional) * New translations plain-text.md (Chinese Traditional) * New translations pure-preset.md (Chinese Traditional) * New translations pastel-powerline.md (Chinese Traditional) * New translations no-nerd-font.md (Chinese Traditional) * New translations no-empty-icons.md (Chinese Traditional) * New translations tokyo-night.md (Chinese Traditional) * New translations gruvbox-rainbow.md (Chinese Traditional) * New translations jetpack.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations bracketed-segments.md (Vietnamese) * New translations nerd-font.md (Vietnamese) * New translations no-runtimes.md (Vietnamese) * New translations plain-text.md (Vietnamese) * New translations pure-preset.md (Vietnamese) * New translations pastel-powerline.md (Vietnamese) * New translations no-nerd-font.md (Vietnamese) * New translations no-empty-icons.md (Vietnamese) * New translations tokyo-night.md (Vietnamese) * New translations gruvbox-rainbow.md (Vietnamese) * New translations jetpack.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations bracketed-segments.md (Portuguese, Brazilian) * New translations nerd-font.md (Portuguese, Brazilian) * New translations no-runtimes.md (Portuguese, Brazilian) * New translations plain-text.md (Portuguese, Brazilian) * New translations pure-preset.md (Portuguese, Brazilian) * New translations pastel-powerline.md (Portuguese, Brazilian) * New translations no-nerd-font.md (Portuguese, Brazilian) * New translations no-empty-icons.md (Portuguese, Brazilian) * New translations tokyo-night.md (Portuguese, Brazilian) * New translations gruvbox-rainbow.md (Portuguese, Brazilian) * New translations jetpack.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations bracketed-segments.md (Indonesian) * New translations nerd-font.md (Indonesian) * New translations no-runtimes.md (Indonesian) * New translations plain-text.md (Indonesian) * New translations pure-preset.md (Indonesian) * New translations pastel-powerline.md (Indonesian) * New translations no-nerd-font.md (Indonesian) * New translations no-empty-icons.md (Indonesian) * New translations tokyo-night.md (Indonesian) * New translations gruvbox-rainbow.md (Indonesian) * New translations jetpack.md (Indonesian) * New translations readme.md (Bengali) * New translations bracketed-segments.md (Bengali) * New translations nerd-font.md (Bengali) * New translations no-runtimes.md (Bengali) * New translations plain-text.md (Bengali) * New translations pure-preset.md (Bengali) * New translations pastel-powerline.md (Bengali) * New translations no-nerd-font.md (Bengali) * New translations no-empty-icons.md (Bengali) * New translations tokyo-night.md (Bengali) * New translations gruvbox-rainbow.md (Bengali) * New translations jetpack.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations bracketed-segments.md (Sorani (Kurdish)) * New translations nerd-font.md (Sorani (Kurdish)) * New translations no-runtimes.md (Sorani (Kurdish)) * New translations plain-text.md (Sorani (Kurdish)) * New translations pure-preset.md (Sorani (Kurdish)) * New translations pastel-powerline.md (Sorani (Kurdish)) * New translations no-nerd-font.md (Sorani (Kurdish)) * New translations no-empty-icons.md (Sorani (Kurdish)) * New translations tokyo-night.md (Sorani (Kurdish)) * New translations gruvbox-rainbow.md (Sorani (Kurdish)) * New translations jetpack.md (Sorani (Kurdish)) * New translations bracketed-segments.md (Ukrainian) * New translations nerd-font.md (Ukrainian) * New translations no-runtimes.md (Ukrainian) * New translations plain-text.md (Ukrainian) * New translations pure-preset.md (Ukrainian) * New translations pastel-powerline.md (Ukrainian) * New translations no-nerd-font.md (Ukrainian) * New translations no-empty-icons.md (Ukrainian) * New translations tokyo-night.md (Ukrainian) * New translations gruvbox-rainbow.md (Ukrainian) * New translations jetpack.md (Ukrainian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (Ukrainian) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (German) * New translations readme.md (Japanese) * New translations readme.md (Russian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Japanese) * New translations readme.md (Japanese) * New translations readme.md (Japanese) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish)) * New translations readme.md (French) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (French) * New translations readme.md (Spanish) * New translations readme.md (Arabic) * New translations readme.md (German) * New translations readme.md (Italian) * New translations readme.md (Japanese) * New translations readme.md (Korean) * New translations readme.md (Dutch) * New translations readme.md (Norwegian) * New translations readme.md (Polish) * New translations readme.md (Portuguese) * New translations readme.md (Russian) * New translations readme.md (Turkish) * New translations readme.md (Ukrainian) * New translations readme.md (Chinese Simplified) * New translations readme.md (Chinese Traditional) * New translations readme.md (Vietnamese) * New translations readme.md (Portuguese, Brazilian) * New translations readme.md (Indonesian) * New translations readme.md (Bengali) * New translations readme.md (Sorani (Kurdish))
This commit is contained in:
Matan Kushner
+94
-62
@@ -553,10 +553,7 @@ discharging_symbol = '💦 '
|
||||
|
||||
## Buf
|
||||
|
||||
The `buf` module shows the currently installed version of [Buf](https://buf.build). By default, the module is shown if all of the following conditions are met:
|
||||
|
||||
- The [`buf`](https://github.com/bufbuild/buf) CLI is installed.
|
||||
- The current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file.
|
||||
The `buf` module shows the currently installed version of [Buf](https://buf.build). By default, the module is shown if the current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -635,7 +632,7 @@ format = 'via [🍔 $version](bold green) '
|
||||
|
||||
You can override the `detect_files` property of [the nodejs module](#nodejs) in your config so as to only show the bun runtime:
|
||||
|
||||
```
|
||||
```toml
|
||||
[nodejs]
|
||||
detect_files = ['package.json', '.node-version', '!bunfig.toml', '!bun.lockb']
|
||||
```
|
||||
@@ -863,7 +860,7 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
|
||||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
|
||||
@@ -1050,20 +1047,20 @@ format = 'via [🔰 $version](bold red) '
|
||||
|
||||
The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
|
||||
- The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `'green bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `deno` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `'green bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `deno` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1117,7 +1114,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
|
||||
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
|
||||
| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
|
||||
|
||||
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
|
||||
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD.
|
||||
|
||||
```toml
|
||||
[directory.substitutions]
|
||||
@@ -1207,7 +1204,7 @@ disabled = false
|
||||
|
||||
## Docker Context
|
||||
|
||||
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use).
|
||||
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or `desktop-linux`, or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1759,7 +1756,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||
| `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. |
|
||||
| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown |
|
||||
| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown |
|
||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1890,7 +1887,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
| `deleted` | `'✘'` | The format of `deleted` |
|
||||
| `typechanged` | `""` | The format of `typechange` |
|
||||
| `typechanged` | `""` | The format of `typechanged` |
|
||||
| `style` | `'bold red'` | The style for the module. |
|
||||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||||
| `disabled` | `false` | Disables the `git_status` module. |
|
||||
@@ -1911,7 +1908,7 @@ The following variables can be used in `format`:
|
||||
| `staged` | Displays `staged` when a new file has been added to the staging area. |
|
||||
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
|
||||
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
|
||||
| `typechanged` | Displays `typechange` when a file's type has been changed in the staging area. |
|
||||
| `typechanged` | Displays `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
|
||||
@@ -2257,6 +2254,7 @@ The `hostname` module shows the system hostname.
|
||||
| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
|
||||
| `style` | `'bold dimmed green'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `hostname` module. |
|
||||
| `aliases` | `{}` | Translate system hostnames to something else. If `trim_at` is specified, only the first part will be matched and replaced. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -2293,6 +2291,14 @@ detect_env_vars = ['!TMUX', 'SSH_CONNECTION']
|
||||
disabled = false
|
||||
```
|
||||
|
||||
#### Replace the hostname with a nickname
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
[hostname]
|
||||
aliases = { "Max's MacBook Pro" = "home" }
|
||||
```
|
||||
|
||||
## Java
|
||||
|
||||
The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2809,6 +2815,41 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mojo
|
||||
|
||||
The `mojo` module shows the current version of [Mojo programming language](https://www.modular.com/mojo) installed
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------- | ------------------------------------------------------ |
|
||||
| `format` | `'with [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `symbol` | `'🔥 '` | The symbol used before displaying the version of Mojo. |
|
||||
| `style` | `'bold 208'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `mojo` module. |
|
||||
| `detect_extensions` | `['mojo', '🔥']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| version | `24.4.0` | The version of `mojo` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[mojo]
|
||||
format = 'via [mojo ($version )($hash )]($style)'
|
||||
```
|
||||
|
||||
## NATS
|
||||
|
||||
The `nats` module shows the name of the current [NATS](https://nats.io) context.
|
||||
@@ -2934,17 +2975,17 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `' '` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `'bold red'` | The style for the module when an engines property in package.json does not match the Node.js version. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `' '` | A format string representing the symbol of Node.js. |
|
||||
| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['package.json', '.node-version', '.nvmrc']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||
| `not_capable_style` | `'bold red'` | The style for the module when an engines property in package.json does not match the Node.js version. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -3492,24 +3533,26 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a `requirements.txt` file
|
||||
- The current directory contains a `setup.py` file
|
||||
- The current directory contains a `tox.ini` file
|
||||
- The current directory contains a `pixi.toml` file
|
||||
- The current directory contains a file with the `.py` extension.
|
||||
- The current directory contains a file with the `.ipynb` extension.
|
||||
- A virtual environment is currently activated
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `['py']` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `detect_extensions` | `['py', 'ipynb']` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini', 'pixi.toml']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
|
||||
::: tip
|
||||
|
||||
@@ -4350,7 +4393,7 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
|
||||
| `format` | `'[$user]($style) in '` | The format for the module. |
|
||||
| `show_always` | `false` | Always shows the `username` module. |
|
||||
| `disabled` | `false` | Disables the `username` module. |
|
||||
| `aliases` | `{}` | Translate system usernames to something else |
|
||||
| `aliases` | `{}` | Translate system usernames to something else. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4361,7 +4404,7 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
|
||||
|
||||
### Example
|
||||
|
||||
#### Always show the hostname
|
||||
#### Always show the username
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@@ -4375,17 +4418,6 @@ show_always = true
|
||||
aliases = { "corpuser034g" = "matchai" }
|
||||
```
|
||||
|
||||
#### Hide the hostname in remote tmux sessions
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[hostname]
|
||||
ssh_only = false
|
||||
detect_env_vars = ['!TMUX', 'SSH_CONNECTION']
|
||||
disabled = false
|
||||
```
|
||||
|
||||
## Vagrant
|
||||
|
||||
The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -4573,7 +4605,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. |
|
||||
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
|
||||
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the `shell` returns a `0` status code from executing it. |
|
||||
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
|
||||
| `shell` | | [See below](#custom-command-shell) |
|
||||
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
|
||||
@@ -4593,7 +4625,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
|
||||
|
||||
| Variable | Description |
|
||||
| --------- | -------------------------------------- |
|
||||
| output | The output of shell command in `shell` |
|
||||
| output | The output of `command` run in `shell` |
|
||||
| symbol | Mirrors the value of option `symbol` |
|
||||
| style\* | Mirrors the value of option `style` |
|
||||
|
||||
@@ -4608,7 +4640,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
|
||||
|
||||
If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows.
|
||||
|
||||
The `command` will be passed in on stdin.
|
||||
The `command` (and `when`, if applicable) will be passed in on stdin.
|
||||
|
||||
If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user