From 3a4c9063e90e8671fb99c977f7079d980933ae07 Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Mon, 15 Mar 2021 13:18:42 -0400 Subject: docs(i18n): New Crowdin updates (#2362) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Traditional) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Portuguese) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Russian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Traditional) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Spanish) * New translations README.md (Japanese) * New translations README.md (Korean) * New translations README.md (Chinese Simplified) * New translations README.md (Dutch) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Russian) * New translations README.md (Turkish) * New translations README.md (Chinese Traditional) * New translations README.md (Vietnamese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Korean) * New translations README.md (Korean) * New translations README.md (Korean) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (French) * New translations README.md (Portuguese) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Polish) * New translations README.md (Spanish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Sorani (Kurdish)) * New translations README.md (French) * New translations README.md (Arabic) * New translations README.md (French) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (Spanish) * New translations README.md (Polish) * New translations README.md (Portuguese) * New translations README.md (Chinese Traditional) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Portuguese) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Russian) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (German) * New translations README.md (Turkish) * New translations README.md (Russian) * New translations README.md (Portuguese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Chinese Simplified) * New translations README.md (Chinese Traditional) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Korean) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Portuguese) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Russian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Polish) * New translations README.md (Dutch) * New translations README.md (Japanese) * New translations README.md (Italian) * New translations README.md (German) * New translations README.md (Portuguese) * New translations README.md (Sorani (Kurdish)) * New translations README.md (Portuguese, Brazilian) * New translations README.md (Vietnamese) * New translations README.md (Chinese Traditional) * New translations README.md (Russian) * New translations README.md (Chinese Simplified) * New translations README.md (Turkish) * New translations README.md (Arabic) * New translations README.md (Spanish) * New translations README.md (French) * New translations README.md (Korean) * New translations README.md (Italian) * New translations README.md (Italian) --- docs/ar-SA/README.md | 11 + docs/ar-SA/config/README.md | 82 +++- docs/ar-SA/faq/README.md | 6 +- docs/ar-SA/guide/README.md | 56 ++- docs/ar-SA/installing/README.md | 52 +- docs/ar-SA/presets/README.md | 5 +- docs/ckb-IR/README.md | 11 + docs/ckb-IR/config/README.md | 82 +++- docs/ckb-IR/faq/README.md | 6 +- docs/ckb-IR/guide/README.md | 56 ++- docs/ckb-IR/installing/README.md | 52 +- docs/ckb-IR/presets/README.md | 5 +- docs/de-DE/README.md | 11 + docs/de-DE/config/README.md | 186 +++++--- docs/de-DE/faq/README.md | 6 +- docs/de-DE/guide/README.md | 56 ++- docs/de-DE/installing/README.md | 54 ++- docs/de-DE/presets/README.md | 5 +- docs/es-ES/README.md | 23 +- docs/es-ES/advanced-config/README.md | 2 +- docs/es-ES/config/README.md | 715 +++++++++++++++------------- docs/es-ES/faq/README.md | 32 +- docs/es-ES/guide/README.md | 64 ++- docs/es-ES/installing/README.md | 60 ++- docs/es-ES/migrating-to-0.45.0/README.md | 4 +- docs/es-ES/presets/README.md | 13 +- docs/fr-FR/README.md | 11 + docs/fr-FR/config/README.md | 256 ++++++---- docs/fr-FR/faq/README.md | 24 +- docs/fr-FR/guide/README.md | 56 ++- docs/fr-FR/installing/README.md | 52 +- docs/fr-FR/presets/README.md | 5 +- docs/it-IT/README.md | 13 +- docs/it-IT/advanced-config/README.md | 10 +- docs/it-IT/config/README.md | 84 +++- docs/it-IT/faq/README.md | 22 +- docs/it-IT/guide/README.md | 56 ++- docs/it-IT/installing/README.md | 52 +- docs/it-IT/presets/README.md | 5 +- docs/ja-JP/README.md | 15 +- docs/ja-JP/advanced-config/README.md | 2 +- docs/ja-JP/config/README.md | 303 +++++++----- docs/ja-JP/faq/README.md | 48 +- docs/ja-JP/guide/README.md | 66 ++- docs/ja-JP/installing/README.md | 52 +- docs/ja-JP/presets/README.md | 5 +- docs/ko-KR/README.md | 33 +- docs/ko-KR/config/README.md | 82 +++- docs/ko-KR/faq/README.md | 6 +- docs/ko-KR/guide/README.md | 58 ++- docs/ko-KR/installing/README.md | 52 +- docs/ko-KR/presets/README.md | 5 +- docs/nl-NL/README.md | 11 + docs/nl-NL/config/README.md | 82 +++- docs/nl-NL/faq/README.md | 6 +- docs/nl-NL/guide/README.md | 56 ++- docs/nl-NL/installing/README.md | 52 +- docs/nl-NL/presets/README.md | 5 +- docs/pl-PL/README.md | 11 + docs/pl-PL/config/README.md | 82 +++- docs/pl-PL/faq/README.md | 6 +- docs/pl-PL/guide/README.md | 56 ++- docs/pl-PL/installing/README.md | 52 +- docs/pl-PL/presets/README.md | 5 +- docs/pt-BR/README.md | 11 + docs/pt-BR/config/README.md | 92 +++- docs/pt-BR/faq/README.md | 6 +- docs/pt-BR/guide/README.md | 56 ++- docs/pt-BR/installing/README.md | 52 +- docs/pt-BR/presets/README.md | 5 +- docs/pt-PT/README.md | 11 + docs/pt-PT/config/README.md | 82 +++- docs/pt-PT/faq/README.md | 6 +- docs/pt-PT/guide/README.md | 56 ++- docs/pt-PT/installing/README.md | 52 +- docs/pt-PT/presets/README.md | 5 +- docs/ru-RU/README.md | 11 + docs/ru-RU/config/README.md | 300 +++++++----- docs/ru-RU/faq/README.md | 6 +- docs/ru-RU/guide/README.md | 56 ++- docs/ru-RU/installing/README.md | 52 +- docs/ru-RU/presets/README.md | 5 +- docs/tr-TR/README.md | 11 + docs/tr-TR/config/README.md | 82 +++- docs/tr-TR/faq/README.md | 6 +- docs/tr-TR/guide/README.md | 56 ++- docs/tr-TR/installing/README.md | 52 +- docs/tr-TR/presets/README.md | 5 +- docs/vi-VN/README.md | 11 + docs/vi-VN/config/README.md | 792 ++++++++++++++++--------------- docs/vi-VN/faq/README.md | 18 +- docs/vi-VN/guide/README.md | 56 ++- docs/vi-VN/installing/README.md | 54 ++- docs/vi-VN/migrating-to-0.45.0/README.md | 144 +++--- docs/vi-VN/presets/README.md | 5 +- docs/zh-CN/README.md | 11 + docs/zh-CN/advanced-config/README.md | 2 +- docs/zh-CN/config/README.md | 190 +++++--- docs/zh-CN/faq/README.md | 6 +- docs/zh-CN/guide/README.md | 56 ++- docs/zh-CN/installing/README.md | 52 +- docs/zh-CN/presets/README.md | 5 +- docs/zh-TW/README.md | 37 +- docs/zh-TW/config/README.md | 172 ++++--- docs/zh-TW/faq/README.md | 6 +- docs/zh-TW/guide/README.md | 60 ++- docs/zh-TW/installing/README.md | 52 +- docs/zh-TW/presets/README.md | 5 +- 108 files changed, 4184 insertions(+), 2078 deletions(-) diff --git a/docs/ar-SA/README.md b/docs/ar-SA/README.md index 5887681e3..eb5b35ff2 100644 --- a/docs/ar-SA/README.md +++ b/docs/ar-SA/README.md @@ -123,3 +123,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index 6484c7d5b..3a9111cd6 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -9,8 +9,8 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml -# Don't print a new line at the start of the prompt -add_newline = false +# Inserts a blank line between shell prompts +add_newline = true # Replace the "❯" symbol in the prompt with "➜" [character] # The name of the module we are configuring is "character" @@ -80,7 +80,7 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri For example: - `[on](red bold)` will print a string `on` with bold text colored red. -- `[⬢ $version](bold green)` will print a symbol `⬢` followed by the content of variable `version`, with bold text colored green. +- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green. #### Style Strings @@ -146,7 +146,7 @@ This is the list of prompt-wide configuration options. | -------------- | ------------------------------ | ----------------------------------------------------- | | `format` | [link](#default-prompt-format) | Configure the format of the prompt. | | `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). | -| `add_newline` | `true` | Add a new line before the start of the prompt. | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### Example @@ -162,7 +162,7 @@ format = """ # Wait 10 milliseconds for starship to check files under the current directory. scan_timeout = 10 -# Disable the newline at the start of the prompt +# Disable the blank line at the start of the prompt add_newline = false ``` @@ -207,6 +207,7 @@ $purescript\ $python\ $ruby\ $rust\ +$scala\ $swift\ $terraform\ $vagrant\ @@ -237,15 +238,17 @@ The `aws` module shows the current AWS region and profile. This is based on `AWS When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var. +When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. + ### Options -| Option | Default | Description | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `format` | `'on [$symbol$profile(\($region\))]($style) '` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Default | Description | +| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `AWS` module. | ### Variables @@ -266,7 +269,7 @@ When using [aws-vault](https://github.com/99designs/aws-vault) the profile is re # ~/.config/starship.toml [aws] -format = 'on [$symbol$profile(\($region\))]($style) ' +format = 'on [$symbol($profile )(\($region\) )]($style)' style = "bold blue" symbol = "🅰 " [aws.region_aliases] @@ -434,7 +437,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | Option | Default | Description | | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"喝 "` | The symbol used before the version of cmake. | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | @@ -1343,6 +1346,12 @@ symbol = "🌟 " The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. +::: warning + +This module is not supported on tcsh. + +::: + ### Options | Option | Default | Description | @@ -1737,7 +1746,7 @@ The `nodejs` module shows the currently installed version of NodeJS. By default | Option | Default | Description | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | +| `symbol` | `" "` | A format string representing the symbol of NodeJS. | | `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. | | `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | | `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | @@ -2158,6 +2167,48 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` + +## Scala + +The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file +- The current directory contains a file with the `.scala` or `.sbt` extension +- The current directory contains a directory named `.metals` + +### Options + + +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `2.13.5` | The version of `scala` | +| 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 + +[scala] +symbol = "🌟 " +``` + + ## Shell The `shell` module shows an indicator for currently used shell. @@ -2178,6 +2229,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | `powershell_indicator` | `psh` | A format string used to represent powershell. | | `ion_indicator` | `ion` | A format string used to represent ion. | | `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | | `format` | `$indicator` | The format for the module. | | `disabled` | `true` | Disables the `shell` module. | diff --git a/docs/ar-SA/faq/README.md b/docs/ar-SA/faq/README.md index 9bb23bf93..d3c6d238c 100644 --- a/docs/ar-SA/faq/README.md +++ b/docs/ar-SA/faq/README.md @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#Command-Duration) and to ensure that Starship is compatible with pre-installed Bash configurations. +The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations. For a list of all flags accepted by `starship prompt`, use the following command: @@ -56,6 +56,10 @@ If you get an error like "_version 'GLIBC_2.18' not found (required by starship) curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl ``` +## I see symbols I don't understand or expect, what do they mean? + +If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules. + ## Why don't I see a glyph symbol in my prompt? The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that: diff --git a/docs/ar-SA/guide/README.md b/docs/ar-SA/guide/README.md index 445e3027c..fd107ff3c 100644 --- a/docs/ar-SA/guide/README.md +++ b/docs/ar-SA/guide/README.md @@ -2,18 +2,21 @@ Starship – Cross-shell prompt + alt="Starship – Cross-shell prompt" + />

GitHub Actions workflow status + alt="GitHub Actions workflow status" + /> Crates.io version + alt="Crates.io version" + /> Chat on Discord + alt="Chat on Discord" + /> Follow @StarshipPrompt on Twitter + alt="Follow @StarshipPrompt on Twitter" + />

@@ -42,63 +47,72 @@ >English + alt="English" + />   日本語 + alt="日本語" + />   繁體中文 + alt="繁體中文" + />   Русский + alt="Русский" + />   Deutsch + alt="Deutsch" + />   简体中文 + alt="简体中文" + />   Español + alt="Español" + />   Français + alt="Français" + />   Tiếng Việt + alt="Tiếng Việt" + />

@@ -107,7 +121,8 @@ src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif" alt="Starship with iTerm2 and the Snazzy theme" width="50%" - align="right" /> + align="right" + /> **The minimal, blazing-fast, and infinitely customizable prompt for any shell!** @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/ar-SA/installing/README.md b/docs/ar-SA/installing/README.md index 52c0ac4c3..73b998f7c 100644 --- a/docs/ar-SA/installing/README.md +++ b/docs/ar-SA/installing/README.md @@ -8,13 +8,29 @@ To install starship, you need to do two things: For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! + +## [Chocolatey](https://chocolatey.org) + +### Prerequisites + +Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. + +### Installation + +```powershell +choco install starship +``` + ## [termux](https://termux.com) + ### Prerequisites + ```sh pkg install getconf ``` ### Installation + ```sh curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin ``` @@ -31,7 +47,29 @@ nix-env -iA nixos.starship #### Declarative, single user, via [home-manager](home-manager) -Add `pkgs.starship` to your `home.packages` in your `home.nix` file, then run +Enable the `programs.starship` module in your `home.nix` file, and add your settings + +```nix +{ + programs.starship = { + enable = true; + enableZshIntegration = true; + # Configuration written to ~/.config/starship.toml + settings = { + # add_newline = false; + + # character = { + # success_symbol = "[➜](bold green)"; + # error_symbol = "[➜](bold red)"; + # }; + + # package.disabled = true; + }; + }; +} +``` + +then run ```sh home-manager switch @@ -39,18 +77,8 @@ home-manager switch #### Declarative, system-wide, with NixOS -Add `pkgs.starship` to `environment.packages` in your `configuration.nix`, then run +Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run ```sh sudo nixos-rebuild switch ``` - -### Modifying Init Scripts - -#### With Nix and home-manager, using zsh: - -Add the following to `programs.zsh.initExtra` in your `home.nix` file, then run - -```sh -home-manager switch -``` diff --git a/docs/ar-SA/presets/README.md b/docs/ar-SA/presets/README.md index 746364fa2..c4b2f7ca8 100644 --- a/docs/ar-SA/presets/README.md +++ b/docs/ar-SA/presets/README.md @@ -16,7 +16,7 @@ This preset doesn't change anything except for the symbols used for each module. ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/ckb-IR/README.md b/docs/ckb-IR/README.md index 5887681e3..eb5b35ff2 100644 --- a/docs/ckb-IR/README.md +++ b/docs/ckb-IR/README.md @@ -123,3 +123,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md index 6484c7d5b..3a9111cd6 100644 --- a/docs/ckb-IR/config/README.md +++ b/docs/ckb-IR/config/README.md @@ -9,8 +9,8 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml -# Don't print a new line at the start of the prompt -add_newline = false +# Inserts a blank line between shell prompts +add_newline = true # Replace the "❯" symbol in the prompt with "➜" [character] # The name of the module we are configuring is "character" @@ -80,7 +80,7 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri For example: - `[on](red bold)` will print a string `on` with bold text colored red. -- `[⬢ $version](bold green)` will print a symbol `⬢` followed by the content of variable `version`, with bold text colored green. +- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green. #### Style Strings @@ -146,7 +146,7 @@ This is the list of prompt-wide configuration options. | -------------- | ------------------------------ | ----------------------------------------------------- | | `format` | [link](#default-prompt-format) | Configure the format of the prompt. | | `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). | -| `add_newline` | `true` | Add a new line before the start of the prompt. | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### Example @@ -162,7 +162,7 @@ format = """ # Wait 10 milliseconds for starship to check files under the current directory. scan_timeout = 10 -# Disable the newline at the start of the prompt +# Disable the blank line at the start of the prompt add_newline = false ``` @@ -207,6 +207,7 @@ $purescript\ $python\ $ruby\ $rust\ +$scala\ $swift\ $terraform\ $vagrant\ @@ -237,15 +238,17 @@ The `aws` module shows the current AWS region and profile. This is based on `AWS When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var. +When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. + ### Options -| Option | Default | Description | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `format` | `'on [$symbol$profile(\($region\))]($style) '` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Default | Description | +| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `AWS` module. | ### Variables @@ -266,7 +269,7 @@ When using [aws-vault](https://github.com/99designs/aws-vault) the profile is re # ~/.config/starship.toml [aws] -format = 'on [$symbol$profile(\($region\))]($style) ' +format = 'on [$symbol($profile )(\($region\) )]($style)' style = "bold blue" symbol = "🅰 " [aws.region_aliases] @@ -434,7 +437,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | Option | Default | Description | | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"喝 "` | The symbol used before the version of cmake. | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | | `detect_extensions` | `[]` | Which extensions should trigger this moudle | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | @@ -1343,6 +1346,12 @@ symbol = "🌟 " The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. +::: warning + +This module is not supported on tcsh. + +::: + ### Options | Option | Default | Description | @@ -1737,7 +1746,7 @@ The `nodejs` module shows the currently installed version of NodeJS. By default | Option | Default | Description | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | +| `symbol` | `" "` | A format string representing the symbol of NodeJS. | | `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. | | `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | | `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | @@ -2158,6 +2167,48 @@ By default the `rust` module shows the currently installed version of Rust. The format = "via [⚙️ $version](red bold)" ``` + +## Scala + +The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file +- The current directory contains a file with the `.scala` or `.sbt` extension +- The current directory contains a directory named `.metals` + +### Options + + +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `2.13.5` | The version of `scala` | +| 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 + +[scala] +symbol = "🌟 " +``` + + ## Shell The `shell` module shows an indicator for currently used shell. @@ -2178,6 +2229,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | `powershell_indicator` | `psh` | A format string used to represent powershell. | | `ion_indicator` | `ion` | A format string used to represent ion. | | `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | | `format` | `$indicator` | The format for the module. | | `disabled` | `true` | Disables the `shell` module. | diff --git a/docs/ckb-IR/faq/README.md b/docs/ckb-IR/faq/README.md index 9bb23bf93..d3c6d238c 100644 --- a/docs/ckb-IR/faq/README.md +++ b/docs/ckb-IR/faq/README.md @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#Command-Duration) and to ensure that Starship is compatible with pre-installed Bash configurations. +The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations. For a list of all flags accepted by `starship prompt`, use the following command: @@ -56,6 +56,10 @@ If you get an error like "_version 'GLIBC_2.18' not found (required by starship) curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl ``` +## I see symbols I don't understand or expect, what do they mean? + +If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules. + ## Why don't I see a glyph symbol in my prompt? The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that: diff --git a/docs/ckb-IR/guide/README.md b/docs/ckb-IR/guide/README.md index 445e3027c..fd107ff3c 100644 --- a/docs/ckb-IR/guide/README.md +++ b/docs/ckb-IR/guide/README.md @@ -2,18 +2,21 @@ Starship – Cross-shell prompt + alt="Starship – Cross-shell prompt" + />

GitHub Actions workflow status + alt="GitHub Actions workflow status" + /> Crates.io version + alt="Crates.io version" + /> Chat on Discord + alt="Chat on Discord" + /> Follow @StarshipPrompt on Twitter + alt="Follow @StarshipPrompt on Twitter" + />

@@ -42,63 +47,72 @@ >English + alt="English" + />   日本語 + alt="日本語" + />   繁體中文 + alt="繁體中文" + />   Русский + alt="Русский" + />   Deutsch + alt="Deutsch" + />   简体中文 + alt="简体中文" + />   Español + alt="Español" + />   Français + alt="Français" + />   Tiếng Việt + alt="Tiếng Việt" + />

@@ -107,7 +121,8 @@ src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif" alt="Starship with iTerm2 and the Snazzy theme" width="50%" - align="right" /> + align="right" + /> **The minimal, blazing-fast, and infinitely customizable prompt for any shell!** @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/ckb-IR/installing/README.md b/docs/ckb-IR/installing/README.md index 52c0ac4c3..73b998f7c 100644 --- a/docs/ckb-IR/installing/README.md +++ b/docs/ckb-IR/installing/README.md @@ -8,13 +8,29 @@ To install starship, you need to do two things: For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! + +## [Chocolatey](https://chocolatey.org) + +### Prerequisites + +Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. + +### Installation + +```powershell +choco install starship +``` + ## [termux](https://termux.com) + ### Prerequisites + ```sh pkg install getconf ``` ### Installation + ```sh curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin ``` @@ -31,7 +47,29 @@ nix-env -iA nixos.starship #### Declarative, single user, via [home-manager](home-manager) -Add `pkgs.starship` to your `home.packages` in your `home.nix` file, then run +Enable the `programs.starship` module in your `home.nix` file, and add your settings + +```nix +{ + programs.starship = { + enable = true; + enableZshIntegration = true; + # Configuration written to ~/.config/starship.toml + settings = { + # add_newline = false; + + # character = { + # success_symbol = "[➜](bold green)"; + # error_symbol = "[➜](bold red)"; + # }; + + # package.disabled = true; + }; + }; +} +``` + +then run ```sh home-manager switch @@ -39,18 +77,8 @@ home-manager switch #### Declarative, system-wide, with NixOS -Add `pkgs.starship` to `environment.packages` in your `configuration.nix`, then run +Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run ```sh sudo nixos-rebuild switch ``` - -### Modifying Init Scripts - -#### With Nix and home-manager, using zsh: - -Add the following to `programs.zsh.initExtra` in your `home.nix` file, then run - -```sh -home-manager switch -``` diff --git a/docs/ckb-IR/presets/README.md b/docs/ckb-IR/presets/README.md index 746364fa2..c4b2f7ca8 100644 --- a/docs/ckb-IR/presets/README.md +++ b/docs/ckb-IR/presets/README.md @@ -16,7 +16,7 @@ This preset doesn't change anything except for the symbols used for each module. ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md index 88bd159c6..0ea6a097d 100644 --- a/docs/de-DE/README.md +++ b/docs/de-DE/README.md @@ -123,3 +123,14 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index f00396f7c..54a94bbc5 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -9,8 +9,8 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Die gesamte Konfiguration von Starship wird über diese [TOML](https://github.com/toml-lang/toml)-Datei durchgeführt: ```toml -# Don't print a new line at the start of the prompt -add_newline = false +# Inserts a blank line between shell prompts +add_newline = true # Replace the "❯" symbol in the prompt with "➜" [character] # The name of the module we are configuring is "character" @@ -80,7 +80,7 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri For example: - `[on](red bold)` will print a string `on` with bold text colored red. -- `[⬢ $version](bold green)` will print a symbol `⬢` followed by the content of variable `version`, with bold text colored green. +- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green. #### Style-Strings @@ -146,7 +146,7 @@ Dies ist eine Liste mit Prompt-weiten Konfigurationsoptionen. | -------------- | ------------------------------ | ------------------------------------------------------- | | `format` | [link](#default-prompt-format) | Configure the format of the prompt. | | `scan_timeout` | `30` | Timeout für das Scannen von Dateien (in Millisekunden). | -| `add_newline` | `true` | Neuer Zeilenumbruch bei Start des Prompts. | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### Beispiel @@ -162,7 +162,7 @@ format = """ # Wait 10 milliseconds for starship to check files under the current directory. scan_timeout = 10 -# Disable the newline at the start of the prompt +# Disable the blank line at the start of the prompt add_newline = false ``` @@ -207,6 +207,7 @@ $purescript\ $python\ $ruby\ $rust\ +$scala\ $swift\ $terraform\ $vagrant\ @@ -237,15 +238,17 @@ Das `aws`-Modul zeigt das aktuelle AWS-Profil an. Dies basiert auf den Umgebungs When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var. +When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. + ### Optionen -| Option | Standardwert | Beschreibung | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `format` | `'on [$symbol$profile(\($region\))]($style) '` | The format for the module. | -| `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `aws`-Modul. | +| Option | Standardwert | Beschreibung | +| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | Stil für dieses Modul. | +| `disabled` | `false` | Deaktiviert das `aws`-Modul. | ### Variables @@ -266,7 +269,7 @@ When using [aws-vault](https://github.com/99designs/aws-vault) the profile is re # ~/.config/starship.toml [aws] -format = 'on [$symbol$profile(\($region\))]($style) ' +format = 'on [$symbol($profile )(\($region\) )]($style)' style = "bold blue" symbol = "🅰 " [aws.region_aliases] @@ -301,7 +304,7 @@ symbol = "🅰 " ## Akkustand -Das `battery` Modul zeigt, wie hoch der Akku des Geräts geladen ist und den aktuellen Ladestatus. Das Modul ist nur sichtbar, wenn der Akku des Geräts unter 10% geladen ist. +The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. ### Optionen @@ -330,7 +333,7 @@ discharging_symbol = "💀" ### Anzeige des Akkustandes -Die `display` Konfiguration "threshold" stellt ein ab wann die Akkuanzeige eingeblendet wird. Mit "style" wird das Erscheinungsbild festgelegt. Wenn `display` nicht angegeben ist. Die Standardwerte sind folgende: +The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. Die Standardwerte sind folgende: ```toml [[battery.display]] @@ -340,7 +343,7 @@ style = "bold red" #### Optionen -Die `display`-Option beinhaltet ein Array mit den folgenden Werten. +The `display` option is an array of the following table. | Option | Beschreibung | | ----------- | ------------------------------------------------------- | @@ -364,9 +367,9 @@ style = "bold yellow" ## Zeichen -Das `character` Modul zeigt ein Zeichen ( meistens einen Pfeil "❯") vor der Texteingabe an. +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erzeugt hat. It can do this in two ways: +The character will tell you whether the last command was successful or not. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) @@ -434,7 +437,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | Option | Standardwert | Beschreibung | | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"喝 "` | The symbol used bef