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! -## [termux](https://termux.com) + +## [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! -## [termux](https://termux.com) + +## [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 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 | @@ -453,15 +456,15 @@ The `cmake` module shows the currently installed version of CMake. By default th ## Befehlsdauer -Das `cmd_duration` Modul zeigt an wie lange der letzte Befehl ausgeführt wurde. Das Modul wird nur angezeigt wenn der letzte Befehl länger als zwei Sekunden ausgeführt wurde. Mit der `min_time` Option kann die Zeit eingestellt werden ab der `cmd_duration` angezeigt wird. +The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Nicht die DEBUG-trap in der Bash hooken +::: warning Do not hook the DEBUG trap in Bash -Ist `bash` die Konsole der Wahl, dann nicht die `DEBUG`-trap nach der Ausführung von `eval $(starship init $0)` hooken, andernfalls **wird** dieses Modul unweigerlich untergehen. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -Bash Nutzer, die eine "preexec" ähnliche Funktion benötigen, können [rcaloras bash_preexec Framework](https://github.com/rcaloras/bash-preexec) verwenden. Definieren Sie einfach die Arrays `preexec_functions` und `precmd_functions` bevor sie `eval $(starship init $0)` ausführen, und fahren Sie dann wie gewohnt fort. +Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### Optionen @@ -475,7 +478,7 @@ Bash Nutzer, die eine "preexec" ähnliche Funktion benötigen, können [rcaloras | `show_notifications` | `false` | Show desktop notifications when command completes. | | `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | -::: Tipp +::: tip Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. @@ -502,11 +505,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -Das `conda`-Modul zeigt dessen aktuelle Umgebung an, sofern `$CONDA_DEFAULT_ENV` gesetzt ist. +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. -::: Tipp +::: tip -Hinweis: Dies unterdrückt nicht conda's eigenen Prompt-Modifikator, sie können jedoch conda mit `conda config --set changeps1 False` konfigurieren, um die Ausgabe von conda selbst auszuschalten. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -619,7 +622,7 @@ format = "via [🔰 $version](bold red) " ## Verzeichnis -Das `directory` -Modul zeigt den Pfad zu Ihrem aktuellen Verzeichnis an, abgeschnitten auf drei übergeordnete Ordner. Your directory will also be truncated to the root of the git repo that you're currently in. +The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. @@ -640,7 +643,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `home_symbol` | `"~"` | The symbol indicating home directory. |
-Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern. +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | Standardwert | Beschreibung | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -988,7 +991,7 @@ asia-northeast1 = "an1" ## Git-Branch -Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuellen Verzeichnis an. +The `git_branch` module shows the active branch of the repo in your current directory. ### Optionen @@ -1186,7 +1189,7 @@ behind = "⇣${count}" ## Golang -Das `golang`-Modul zeigt die aktuell installierte Version von Golang. By default the module will be shown if any of the following conditions are met: +The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met: - Das aktuelle Verzeichnis enthält eine `go.mod`-Datei - Das aktuelle Verzeichnis enthält eine `go.sum`-Datei @@ -1268,7 +1271,7 @@ format = "via [⎈ $version](bold white) " ## Hostname -Das `hostname`-Modul zeigt den Hostnamen des Systems an. +The `hostname` module shows the system hostname. ### Optionen @@ -1303,7 +1306,7 @@ disabled = false ## Java -Das `java` Modul zeigt die derzeit installierte Version von Java an. By default the module will be shown if any of the following conditions are met: +The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension @@ -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. +::: Warnung + +This module is not supported on tcsh. + +::: + ### Optionen | Option | Standardwert | Beschreibung | @@ -1462,9 +1471,9 @@ kotlin_binary = "kotlinc" Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. -::: Tipp +::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1503,7 +1512,7 @@ disabled = false ## Zeilenumbruch -Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen. +The `line_break` module separates the prompt into two lines. ### Optionen @@ -1562,13 +1571,13 @@ format = "via [🌕 $version](bold blue) " ## Speicherauslastung -Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung an. +The `memory_usage` module shows current system memory and swap usage. -Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist. +By default the swap usage is displayed if the total system swap is non-zero. -::: Tipp +::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1686,7 +1695,7 @@ symbol = "🎣 " ## Nix-Shell -Das `nix_shell`-Modul zeigt die nix-shell Umgebung an. Das Modul wird angezeigt, wenn es sich in einer nix-Shell-Umgebung befindet. +The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. ### Optionen @@ -1724,7 +1733,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## NodeJS -Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. By default the module will be shown if any of the following conditions are met: +The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met: - Das aktuelle Verzeichnis enthält eine `package.json`-Datei - The current directory contains a `.node-version` file @@ -1737,7 +1746,7 @@ Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. By default | Option | Standardwert | Beschreibung | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `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. | @@ -1843,7 +1852,7 @@ symbol = "☁️ " ## Paketversion -Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. - **npm** – Die `npm` Paketversion wird aus dem `package.json` gelesen, das sich im aktuellen Verzeichnis befindet - **Cargo** – Die `Cargo` Paketversion wird aus dem `Cargo.toml` gelesen, das sich im aktuellen Verzeichnis befindet @@ -1928,7 +1937,7 @@ format = "via [🦪 $version]($style) " ## PHP -Das `php`-Modul zeigt die aktuell installierte Version von PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: - Das aktuelle Verzeichnis enthält eine `composer.json`-Datei - The current directory contains a `.php-version` file @@ -2036,7 +2045,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | -::: Tipp +::: tip The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. @@ -2083,7 +2092,7 @@ detect_extensions = [] ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: - Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei - The current directory contains a `.ruby-version` file @@ -2122,7 +2131,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: - Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei - Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung @@ -2158,13 +2167,55 @@ By default the `rust` module shows the currently installed version of Rust. Das 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` + +### Optionen + + +| Option | Standardwert | Beschreibung | +| ------------------- | ---------------------------------------- | ------------------------------------------------- | +| `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"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `scala` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| --------- | -------- | ------------------------------------ | +| 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 + +### Beispiel + +```toml +# ~/.config/starship.toml + +[scala] +symbol = "🌟 " +``` + + ## Shell The `shell` module shows an indicator for currently used shell. -::: Tipp +::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2178,6 +2229,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis | `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. | @@ -2269,9 +2321,9 @@ format = '[📦 \[$env\]]($style) ' The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. -::: Tipp +::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2324,7 +2376,7 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension @@ -2364,7 +2416,7 @@ format = "via [🏎 $version](red bold)" The `terraform` module shows the currently selected terraform workspace and version. -::: Tipp +::: tip By default the terraform version is not shown, since this is slow for current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). @@ -2372,7 +2424,7 @@ By default the terraform version is not shown, since this is slow for current ve By default the module will be shown if any of the following conditions are met: -- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei +- The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf` or `.hcl` extensions ### Optionen @@ -2422,9 +2474,9 @@ format = "[🏎💨 $workspace]($style) " The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. -::: Tipp +::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2466,14 +2518,14 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- Der aktuelle Benutzer ist root -- Der aktuelle Benutzer ist nicht der eingeloggte Benutzer -- Der Benutzer ist aktuell via SSH verbunden -- Die Variable `show_always` ist auf true gesetzt +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true -::: Tipp +::: tip SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. @@ -2548,7 +2600,7 @@ format = "via [⍱ $version](bold white) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file @@ -2594,19 +2646,19 @@ These modules will be shown if any of the following conditions are met: - The current directory contains a file whose extension is in `extensions` - The `when` command returns 0 -::: Tipp +::: tip Multiple custom modules can be defined by using a `.`. ::: -::: Tipp +::: tip The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. ::: -::: Tipp +::: tip [Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! diff --git a/docs/de-DE/faq/README.md b/docs/de-DE/faq/README.md index b6f8654d2..29f613c36 100644 --- a/docs/de-DE/faq/README.md +++ b/docs/de-DE/faq/README.md @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -Die [Bash Implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) ist etwas komplexer, um erweiterte Funktionen wie das [Befehlsdauer-Modul](https://starship.rs/config/#Command-Duration) zu ermöglichen und um sicherzustellen, dass Starship mit vorinstallierten Bash Konfigurationen kompatibel ist. +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. Für eine Liste aller Flaggen, die von `Starship-Eingabeaufforderung` akzeptiert wird, verwenden Sie den folgenden Befehl: @@ -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/de-DE/guide/README.md b/docs/de-DE/guide/README.md index d87511b6d..a03230dc5 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -2,18 +2,21 @@ Starship – Cross-Shell Prompt + alt="Starship – Cross-Shell Prompt" + />

Workflow-Status der GitHub Actions + alt="Workflow-Status der GitHub Actions" + /> Crates.io-Version + alt="Crates.io-Version" + /> Chat auf Discord + alt="Chat auf Discord" + /> Folge @StarshipPrompt auf Twitter + alt="Folge @StarshipPrompt auf Twitter" + />

@@ -42,63 +47,72 @@ >Englisch + alt="Englisch" + />   日本語 + alt="日本語" + />   繁體中文 + alt="繁體中文" + />   Russisch + alt="Russisch" + />   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 mit iTem2 und dem Theme „Snazzy“" width="50%" - align="right" /> + align="right" + /> **Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!** @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 Mitwirken Wir laden Leute **aller Erfahrungsstufen** herzlich ein mitzumachen! Falls du dich mit dem Projekt vertaut machen willst, versuche ein [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/de-DE/installing/README.md b/docs/de-DE/installing/README.md index b98ddce39..aa64a272a 100644 --- a/docs/de-DE/installing/README.md +++ b/docs/de-DE/installing/README.md @@ -1,6 +1,6 @@ # 🚀 Advanced Installation -To install starship, you need to do two things: +Um starship zu installieren, musst du zwei Dinge tun: 1. Get the **starship** binary onto your computer 1. Tell your shell to use the starship binary as its prompt by modifying its init scripts @@ -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! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### Voraussetzungen + +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) + +### Voraussetzungen + ```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/de-DE/presets/README.md b/docs/de-DE/presets/README.md index 5fc218662..01e037d0e 100644 --- a/docs/de-DE/presets/README.md +++ b/docs/de-DE/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/es-ES/README.md b/docs/es-ES/README.md index 994c2ceca..8f0990d8f 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -8,17 +8,17 @@ actionLink: ./guide/ features: - title: Compatibilidad primero - details: Funciona en las shells más comunes en los sistemas operativos más comunes. ¡Úsalo en todas partes! + details: Funciona en los intérprete de comandos más comunes de los sistemas operativos más comunes. ¡Úsalo en todas partes! - title: Desarrollado en Rust details: Obtén la mayor velocidad y seguridad de Rust, para hacer tu prompt lo más rápida y segura posible. - title: Personalizable - details: Puedes personalizar cada pequeño detalle a tu gusto, de manera que puedes tener una interfaz minimalista o rica en funcionalidades. + details: Puedes personalizar cada pequeño detalle a tu gusto, de manera que puedes tener un prompt minimalista o rico en funcionalidades. footer: Bajo una licencia ISC | Derechos de autor © 2019-presente Colaboradores de Starship #Used for the description meta tag, for SEO -metaTitle: "Starship: el indicador de comando multi-intérprete" -description: Starship es el símbolo de sistema minimalista, ultrarápido e infinitamente customizable para cualquier intérprete de comandos. Muestra la información que necesitas, a la par que es elegante y minimalista. Instalación rápida disponible para Bash, Fish, ZSH, Ion y PowerShell. +metaTitle: "Starship: el prompt multi-intérprete" +description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos! Muestra la información que necesitas, a la par que es elegante y minimalista. Instalación rápida disponible para Bash, Fish, ZSH, Ion y PowerShell.' ---
@@ -35,7 +35,7 @@ description: Starship es el símbolo de sistema minimalista, ultrarápido e infi #### Instalar la última versión - Con la interfaz de línea de comandos: + Con el intérprete de comandos: ```sh curl -fsSL https://starship.rs/install.sh | bash @@ -56,7 +56,7 @@ description: Starship es el símbolo de sistema minimalista, ultrarápido e infi scoop install starship ``` -1. Añade el script de inicio al archivo de configuración de tu interfaz de línea de comandos: +1. Añade el guión de inicio al archivo de configuración de tu intérprete de comandos: #### Bash @@ -123,3 +123,14 @@ description: Starship es el símbolo de sistema minimalista, ultrarápido e infi eval (starship init elvish) ``` + + #### Tcsh + + Añade el siguiente código al final de `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md index bc0e41f72..3a84d2f5e 100644 --- a/docs/es-ES/advanced-config/README.md +++ b/docs/es-ES/advanced-config/README.md @@ -82,7 +82,7 @@ Las cadenas de estilo son una lista de palabras, separadas por espacios en blanc donde `` es un especificador de color (discutido a continuación). `fg:` y `` hacen actualmente lo mismo, aunque esto puede cambiar en el futuro. El orden de las palabras en la cadena no importa. -El token `none` anula todos los demás tokens en una cadena si no es parte de un especificador `bg:`, de modo que por ejemplo `fg:red none fg:blue` creará una cadena sin ningún estilo. `bg:none` establece el fondo al color predeterminado, así que `fg:red bg:none` es equivalente a `red` o `fg:red` y `bg:green fg:red bg:none` también es equivalente a `fg:red` o `red`. Puede convertirse en un error usar `none` junto con otros tokens en el futuro. +El token `none` anula todos los demás tokens en una cadena si no es parte de un especificador `bg:`, de modo que por ejemplo `fg:red none fg:blue` creará una cadena sin ningún estilo. `bg:none` establece el fondo al color por defecto, así que `fg:red bg:none` es equivalente a `red` o `fg:red` y `bg:green fg:red bg:none` también es equivalente a `fg:red` o `red`. Puede convertirse en un error usar `none` junto con otros tokens en el futuro. Un especificador de color puede ser uno de los siguientes: diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index 23e3a4ad4..7b0ae2f88 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -9,20 +9,19 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Toda la configuración de Starship se realiza en este archivo [TOML](https://github.com/toml-lang/toml): ```toml -# Evita imprimir una nueva línea al inicio del prompt -add_newline = false +# Inserta una línea en blanco al inicio del prompt +add_newline = true -# Reemplaza el símbolo "❯" por "➜" del prompt -[character] # El nombre del módulo que se está configurando es "character" -symbol = "➜" # El segmento "symbol" es reemplazado por "➜" -success_symbol = "[➜](bold green)" # El segmento "success_symbol" es reemplazado por "➜" con el color "bold green" +# Reemplaza el símbolo "❯" por "➜" en el prompt +[character] # El nombre del módulo que se está configurandoes "character" +success_symbol = "[➜](bold green)" # El segmento "success_symbol" es reemplzado por "➜" con el color "bold green" -# Desactiva el gestor de paquetes, ocultándolo por completo del prompt +# Deshabilita el módulo "package", ocultándolo por completo del prompt [package] disabled = true ``` -You can change default configuration file location with `STARSHIP_CONFIG` environment variable: +Puedes cambiar la ubicación por defecto del archivo de configuración con la variable de entorno `STARSHIP_CONFIG`: ```sh export STARSHIP_CONFIG=~/.starship/config.toml @@ -54,7 +53,7 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" **Variable**: subcomponentes más pequeños que contienen información proporcionada por el módulo. Por ejemplo, la variable "version" en el módulo "nodejs" contiene la versión actual de NodeJS. -Por convención, la mayoría de los módulos tienen un prefijo del color predeterminado de la terminal (por ejemplo, `vía` en "nodejs") y un espacio vacío como sufijo. +Por convención, la mayoría de los módulos tienen un prefijo del color por defecto de la terminal (por ejemplo, `vía` en "nodejs") y un espacio vacío como sufijo. ### Cadenas de Formato @@ -81,7 +80,7 @@ En la segunda parte, que está encerrada entre `()`, es una [cadena de estilo](# Por ejemplo: - `[en](bold red)` imprimirá una cadena `en` con texto en negrita color rojo. -- `[⬢ $version](bold green)` imprimirá un símbolo `⬢` seguido por el contenido de la variable `version`, con texto en negrita color verde. +- `[⌘ $version](bold green)` imprimirá un símbolo `⌘` seguido por el contenido de la variable `version`, con texto en negrita color verde. - `[a [b](red) c](green)` imprimirá `a b c` con `b` en rojo, `a` y `c` en verde. #### Cadenas de estilo @@ -139,15 +138,15 @@ format = ''' ## Prompt -Esta es la lista de opciones de configuración. +Esta es la lista de opciones de configuración del prompt. ### Opciones -| Opción | Por defecto | Descripción | -| -------------- | ---------------------------------- | ----------------------------------------------------------------------------- | -| `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. | -| `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea los archivos (en milisegundos). | -| `add_newline` | `true` | Añade una nueva línea antes del prompt. | +| Opción | Por defecto | Descripción | +| -------------- | ---------------------------------- | ------------------------------------------------------------------------------ | +| `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. | +| `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea los archivos (en milisegundos). | +| `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. | ### Ejemplo @@ -163,7 +162,7 @@ format = """ # Espera 10 milisegundos para que starship revise los archivos del directorio actual. scan_timeout = 10 -# Desactiva la nueva línea al inicio del prompt +# Deshabilita la línea en blanco al inicio del prompt add_newline = false ``` @@ -208,6 +207,7 @@ $purescript\ $python\ $ruby\ $rust\ +$scala\ $swift\ $terraform\ $vagrant\ @@ -238,15 +238,17 @@ El módulo `aws` muestra la región y el perfil actual de AWS. Éste se basa en Cuando uses [aws-vault](https://github.com/99designs/aws-vault) el perfil se obtiene de la variable de entorno `AWS_VAULT`. +When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. + ### Opciones -| Opción | Por defecto | Descripción | -| ---------------- | ------------------------------------------------ | ------------------------------------------------------------ | -| `format` | `'on [$symbol$profile(\($region\))]($style) '` | El formato del módulo. | -| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. | -| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo AWS. | +| Opción | Por defecto | Descripción | +| ---------------- | --------------------------------------------------- | ------------------------------------------------------------ | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | El formato del módulo. | +| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. | +| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo AWS. | ### Variables @@ -257,7 +259,7 @@ Cuando uses [aws-vault](https://github.com/99designs/aws-vault) el perfil se obt | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplos @@ -267,7 +269,7 @@ Cuando uses [aws-vault](https://github.com/99designs/aws-vault) el perfil se obt # ~/.config/starship.toml [aws] -format = 'en [$symbol$profile(\($region\))]($style) ' +format = 'on [$symbol($profile )(\($region\) )]($style)' style = "bold blue" symbol = "🅰 " [aws.region_aliases] @@ -302,7 +304,7 @@ symbol = "🅰 " ## Battery -El módulo `battery` muestra la cantidad de batería y si se está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%. +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%. ### Opciones @@ -331,7 +333,7 @@ discharging_symbol = "💀" ### Indicador de batería -La configuración de la opción `display` es usada para definir cuándo se debe mostrar el indicador de batería y cómo debe mostrarse. Si no se provee ningún valor para `display` El valor por defecto es el siguiente: +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. El valor por defecto es el siguiente: ```toml [[battery.display]] @@ -341,7 +343,7 @@ style = "bold red" #### Opciones -La opción `display` es un array de la siguiente tabla. +The `display` option is an array of the following table. | Opción | Descripción | | ----------- | --------------------------------------------------------------- | @@ -365,16 +367,16 @@ style = "bold yellow" ## Character -El módulo `character` muestra un carater (normalmente una flecha) tras el texto que introduces en el terminal. +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -El carácter te dirá si el último comando funcionó o no. Se puede hacer de dos maneras: +The character will tell you whether the last command was successful or not. It can do this in two ways: - Cambiando el color (`red`/`green`) - Cambiando la forma (`.`/`✖`) -Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape). +By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). -::: advertencia `error_symbol` no es compatible con el intérprete de comandos Elvish. ::: +::: warning `error_symbol` is not supported on elvish shell. ::: ### Opciones @@ -435,12 +437,12 @@ The `cmake` module shows the currently installed version of CMake. By default th | Opción | Por defecto | Descripción | | ------------------- | -------------------------------------- | ------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"喝 "` | El símbolo usado antes de la versión de cmake. | +| `symbol` | `"△ "` | El símbolo usado antes de la versión de cmake. | | `detect_extensions` | `[]` | Qué extensiones deben activar este módulo | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Qué nombres de archivo deben activar este módulo | | `detect_folders` | `[]` | Qué carpetas deben activar este módulo | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `cmake` module. | +| `disabled` | `false` | Deshabilita el módulo `cmake`. | ### Variables @@ -450,19 +452,19 @@ The `cmake` module shows the currently installed version of CMake. By default th | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ## Tiempo de Ejecución -El módulo `cmd_duration` muestra cuánto tiempo tomó ejecutarse el último comando. El módulo se mostrará solo si el comando tomó más de dos segundos, o si el valor de configuración de `min_time` existe. +The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: advertencia No utilizar la trampa DEBUG en Bash +::: warning Do not hook the DEBUG trap in Bash -Si se está usando Starship con `bash`, no usar `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -Los usuarios de bash que necesiten una funcionalidad como preexec pueden usar el [framework rcaloras's bash_preexec](https://github.com/rcaloras/bash-preexec). Simplemente definir los arreglos `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder de forma normal. +Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### Opciones @@ -478,7 +480,7 @@ Los usuarios de bash que necesiten una funcionalidad como preexec pueden usar el ::: tip -Mostrar notificaciones de escritorio requiere que se construya starship con soporte de `rust-notify`. Comprueba si tu Starship soporta notificaciones ejecutando `STARSHIP_LOG=debug starship module cmd_duration -d 60000` cuando `show_notifications` está establecido en `true`. +Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. ::: @@ -489,7 +491,7 @@ Mostrar notificaciones de escritorio requiere que se construya starship con sopo | duration | `16m40s` | El tiempo que tardó en ejecutar el comando | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -503,11 +505,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -El módulo `conda` muestra el actual entorno conda, si la variable `$CONDA_DEFAULT_ENV` existe. +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -Esto no modifica el propio prompt de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -530,7 +532,7 @@ Esto no modifica el propio prompt de conda. En caso de querer suprimirlo, ejecut | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -543,22 +545,22 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -El módulo `crystal` muestra la versión actual instalada de Crystal. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `crystal` module shows the currently installed version of Crystal. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un fichero `shard.yml` - El directorio actual contiene un fichero `.cr` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | --------------------------------------------- | -| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. | -| `style` | `"bold red"` | El estilo del módulo. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `disabled` | `false` | Disables the `crystal` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | ---------------------------------------------------- | +| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. | +| `style` | `"bold red"` | El estilo del módulo. | +| `detect_extensions` | `["cr"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["shard.yml"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `disabled` | `false` | Deshabilita el módulo `crystal`. | ### Variables @@ -568,7 +570,7 @@ El módulo `crystal` muestra la versión actual instalada de Crystal. Por defect | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -581,11 +583,11 @@ format = "via [✨ $version](bold blue) " ## Dart -El módulo `dart` muestra la versión actualmente instalada de Dart. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `dart` module shows the currently installed version of Dart. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo con la extensión `.dart` - El directorio actual contiene un directorio `.dart_tool` -- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file +- El directorio actual contiene un archivo `pubspec.yaml`, `pubspec.yml` o `pubspec.lock` ### Opciones @@ -593,11 +595,11 @@ El módulo `dart` muestra la versión actualmente instalada de Dart. Por defecto | ------------------- | ------------------------------------------------- | ------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this moudle. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `detect_extensions` | `['dart']` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[".dart_tool"]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `dart` module. | +| `disabled` | `false` | Deshabilita el módulo `dart`. | ### Variables @@ -607,7 +609,7 @@ El módulo `dart` muestra la versión actualmente instalada de Dart. Por defecto | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -620,11 +622,11 @@ format = "via [🔰 $version](bold red) " ## Directory -El módulo `directory` muestra la ruta hasta el directorio actual, mostrando tres directorios padre como máximo. Tu directorio se truncará a la raíz del repositorio git en el que estés. +The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. -Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activaste para la opción. +When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. -Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y la opción establecida a `1`. En ese caso, verás `~/D/N/nixpkgs/pkgs`, cuando antes hubiera sido `nixpkgs/pkgs`. +For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### Opciones @@ -641,15 +643,15 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos | `home_symbol` | `"~"` | El símbolo que indica el directorio personal. |
-Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio. +This module has a few advanced configuration options that control how the directory is displayed. -| Opciones avanzadas | Por defecto | Descripción | -| --------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `substitutions` | | Una tabla de sustituciones que se deben hacer a la ruta. | -| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd de la shell de fish. | -| `use_logical_path` | `true` | Si `true` renderiza la ruta lógica originada desde el shell a través de `PWD` o `--logical-path`. Si `false` en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos. | +| Opciones avanzadas | Por defecto | Descripción | +| --------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `substitutions` | | Una tabla de sustituciones que se deben hacer a la ruta. | +| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd del intérprete de comandos de Fish. | +| `use_logical_path` | `true` | Si `true` renderiza la ruta lógica originada desde el intérprete de comandos a través de `PWD` o `--logical-path`. Si `false` en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos. | -`substitutions` permite definir reemplazos arbitrarios para cadenas literales que ocurren en la ruta, por ejemplo prefijos largos de red o directorios de desarrollo (p. ej. Java). Ten en cuenta que esto desactivará el estilo PWD de fish. +`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. ```toml [directory.substitutions] @@ -657,7 +659,7 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` interactúa con las opciones de truncamiento estándar de una manera que puede sorprenderse primero: si no es cero, los componentes de la ruta que normalmente se truncarían se muestran con esa cantidad de caracteres. Por ejemplo, la ruta `/built/this/city/on/rock/and/roll`, que normalmente se mostraría como `rock/and/roll`, se mostraría como `/b/t/c/o/rock/and/roll` con `fish_style_pwd_dir_length = 1`--los componentes de ruta que normalmente se eliminarían se muestran con un solo carácter. Para `fish_style_pwd_dir_length = 2`, sería `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -668,7 +670,7 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos | path | `"D:/Projects"` | La ruta de directorio actual | | style\* | `"black bold dimmed"` | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -682,20 +684,20 @@ truncation_symbol = "…/" ## Docker Context -El módulo `docker_context` muestra el [contexto de Docker](https://docs.docker.com/engine/context/working-with-contexts/) actualmente activo si no está establecido en `default`. +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`. ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$context]($style) "` | El formato del módulo. | -| `symbol` | `"🐳 "` | El símbolo usado antes de mostrar el contexto de Docker. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `"blue bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$context]($style) "` | El formato del módulo. | +| `symbol` | `"🐳 "` | El símbolo usado antes de mostrar el contexto de Docker. | +| `only_with_files` | `true` | Mostrar solo cuando haya una coincidencia | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). | +| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Qué nombres de archivo deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). | +| `style` | `"blue bold"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `docker_context`. | ### Variables @@ -705,7 +707,7 @@ El módulo `docker_context` muestra el [contexto de Docker](https://docs.docker. | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -718,7 +720,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -El módulo `dotnet` muestra la versión usada de .NET Core SDK para el directorio actual. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. De lo contrario, el módulo muestra la última versión instalada del SDK. +The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -732,11 +734,11 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -También necesitarás tener instalado .NET Core SDK para poder usarlo correctamente. +You'll also need the .NET Core SDK installed in order to use it correctly. -Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar `dotnet --version`, pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo `heurístico = false` en las opciones del módulo. +Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -El módulo también mostrará el Target Framework Moniker ([https://docs.microsoft. om/es/dotnet/standard/frameworks#supported-target-framework-versions](https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions)) cuando exista un archivo csproj en el directorio actual. +The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### Opciones @@ -745,11 +747,11 @@ El módulo también mostrará el Target Framework Moniker ([https://docs.microso | `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | El formato del módulo. | | `symbol` | `"•NET "` | Símbolo usado antes de mostrar la versión de .NET | | `heuristic` | `true` | Usa una detección de versiones más rápida para mantener a starship veloz. | -| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | -| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `dotnet` module. | +| `disabled` | `false` | Deshabilita el módulo `dotnet`. | ### Variables @@ -760,7 +762,7 @@ El módulo también mostrará el Target Framework Moniker ([https://docs.microso | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -775,7 +777,7 @@ heuristic = false ## Elixir -El módulo `elixir` muestra la version instalada actualmente de Elixir y Erlang/OTP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `mix.exs`. @@ -784,12 +786,12 @@ El módulo `elixir` muestra la version instalada actualmente de Elixir y Erlang/ | Opción | Por defecto | Descripción | | ------------------- | ----------------------------------------------------------- | -------------------------------------------------------------- | | `symbol` | `"💧 "` | El símbolo usado antes de mostrar la version de Elixir/Erlang. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["mix.exs"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | | `style` | `"bold purple"` | El estilo del módulo. | -| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | -| `disabled` | `false` | Disables the `elixir` module. | +| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | El formato para el módulo de elixir. | +| `disabled` | `false` | Deshabilita el módulo `elixir`. | ### Variables @@ -800,7 +802,7 @@ El módulo `elixir` muestra la version instalada actualmente de Elixir y Erlang/ | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -813,7 +815,7 @@ symbol = "🔮 " ## Elm -El módulo `elm` muestra la versión actualmente instalada de Elm. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `elm` module shows the currently installed version of Elm. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un fichero `elm.json` - El directorio actual contiene un fichero `elm-package.json` @@ -827,11 +829,11 @@ El módulo `elm` muestra la versión actualmente instalada de Elm. Por defecto, | ------------------- | -------------------------------------------------- | ------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `symbol` | `"🌳 "` | Una cadena de formato que representa el símbolo de Elm. | -| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. | -| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. | +| `detect_extensions` | `["elm"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `["elm-stuff"]` | Qué carpetas deberían activar estos módulos. | | `style` | `"cyan bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `elm` module. | +| `disabled` | `false` | Deshabilita el módulo `elm`. | ### Variables @@ -841,7 +843,7 @@ El módulo `elm` muestra la versión actualmente instalada de Elm. Por defecto, | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -854,7 +856,7 @@ format = "via [ $version](cyan bold) " ## Variable de entorno -El módulo `env_var` muestra el valor actual de una variable de entorno seleccionada. El módulo se mostrará sólo si se cumplen cualquiera de las siguientes condiciones: +The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met: - La opción de configuración de `variable` coincide con una variable de entorno existente - La opción de configuración de `variable` no está definida, pero la opción de configuración `predeterminada` se encuentra @@ -877,7 +879,7 @@ El módulo `env_var` muestra el valor actual de una variable de entorno seleccio | symbol | | Refleja el valor de la opción `symbol` | | style\* | `black bold dimmed` | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -891,7 +893,7 @@ default = "unknown shell" ## Erlang -El módulo `erlang` muestra la versión instalada de Erlang/OTP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `erlang` module shows the currently installed version of Erlang/OTP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un fichero `rebar.config`. - El directorio actual contiene un fichero `erlang.mk`. @@ -902,11 +904,11 @@ El módulo `erlang` muestra la versión instalada de Erlang/OTP. Por defecto, el | ------------------- | ------------------------------------ | ------------------------------------------------------- | | `symbol` | `" "` | El símbolo usado antes de mostrar la versión de Erlang. | | `style` | `"bold red"` | El estilo del módulo. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["rebar.config", "elang.mk"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `disabled` | `false` | Disables the `erlang` module. | +| `disabled` | `false` | Deshabilita el módulo `erlang`. | ### Variables @@ -916,7 +918,7 @@ El módulo `erlang` muestra la versión instalada de Erlang/OTP. Por defecto, el | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -929,7 +931,7 @@ format = "via [e $version](bold red) " ## Gcloud -El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud`](https://cloud.google.com/sdk/gcloud). Esto se basa en el archivo `~/.config/gcloud/active_config`, el archivo `~/.config/gcloud/configurations/config_{CONFIG NAME}` y la varieble de entorno `CLOUDSDK_CONFIG`. +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. ### Opciones @@ -952,7 +954,7 @@ El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud`](h | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplos @@ -989,7 +991,7 @@ asia-northeast1 = "an1" ## Git Branch -El módulo `git_branch` muestra la rama activa del repositorio en su directorio actual. +The `git_branch` module shows the active branch of the repo in your current directory. ### Opciones @@ -1014,7 +1016,7 @@ El módulo `git_branch` muestra la rama activa del repositorio en su directorio | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1029,7 +1031,7 @@ truncation_symbol = "" ## Git commit -El módulo `git_commit` muestra el hash de commit actual y también la etiqueta (si existe) del repositorio en su directorio actual. +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### Opciones @@ -1050,7 +1052,7 @@ El módulo `git_commit` muestra el hash de commit actual y también la etiqueta | hash | `b703eb3` | El hash actual del commit de git | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1064,7 +1066,7 @@ tag_symbol = "🔖 " ## Git state -El módulo `git_state` se mostrará en directorios que son parte de un repositorio git, y donde hay una operación en curso, tales como: _REBASING_, _BISECTING_, etc. Si hay información de progreso (por ejemplo, REBASING 3/10), esa información será mostrada también. +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Opciones @@ -1090,7 +1092,7 @@ El módulo `git_state` se mostrará en directorios que son parte de un repositor | progress_total | `2` | El progreso total de la operación | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1104,7 +1106,7 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git status -El módulo `git_status` muestra símbolos que representan el estado del repositorio en su directorio actual. +The `git_status` module shows symbols representing the state of the repo in your current directory. ### Opciones @@ -1126,7 +1128,7 @@ El módulo `git_status` muestra símbolos que representan el estado del reposito ### Variables -Las siguientes variables se pueden utilizar en `format`: +The following variables can be used in `format`: | Variable | Descripción | | -------------- | -------------------------------------------------------------------------------------------------------- | @@ -1141,16 +1143,16 @@ Las siguientes variables se pueden utilizar en `format`: | `deleted` | Muestra `deleted` cuando un archivo ha sido añadido al área de "stash". | | style\* | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string -Las siguientes variables pueden ser usadas en `diverged`: +The following variables can be used in `diverged`: | Variable | Descripción | | -------------- | ------------------------------------------------------- | | `ahead_count` | Número de commits por delante de la rama de seguimiento | | `behind_count` | Número de commits detrás de la rama de seguimiento | -Las siguientes variales pueden ser usadas en `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: +The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: | Variable | Descripción | | -------- | ----------------------------- | @@ -1174,7 +1176,7 @@ renamed = "👅" deleted = "🗑" ``` -Mostrar el recuento delante/detrás de la rama que está siendo rastreada +Show ahead/behind count of the branch being tracked ```toml # ~/.config/starship.toml @@ -1187,7 +1189,7 @@ behind = "⇣${count}" ## Golang -El módulo `golang` muestra la versión actualmente instalada de Golang. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `golang` module shows the currently installed version of Golang. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un fichero `go.mod` - El directorio actual contiene un fichero `go.sum` @@ -1204,11 +1206,11 @@ El módulo `golang` muestra la versión actualmente instalada de Golang. Por def | ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `symbol` | `"🐹 "` | Una cadena de formato que representa el símbolo de Go. | -| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. | -| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | +| `detect_extensions` | `["go"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `["Godeps"]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold cyan"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `golang` module. | +| `disabled` | `false` | Deshabilita el módulo de `golang`. | ### Variables @@ -1218,7 +1220,7 @@ El módulo `golang` muestra la versión actualmente instalada de Golang. Por def | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1231,22 +1233,22 @@ format = "via [🏎💨 $version](bold cyan) " ## Helm -El módulo `helm` muestra la versión instalada de Helm. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `helm` module shows the currently installed version of Helm. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un fichero `helmfile.yaml` - El directorio actual contiene un archivo `Chart.yaml` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | -| `style` | `"bold white"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `helm` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | -------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | +| `symbol` | `"⎈ "` | Una cadena de formato que representa el símbolo de Helm. | +| `style` | `"bold white"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `helm`. | ### Variables @@ -1256,7 +1258,7 @@ El módulo `helm` muestra la versión instalada de Helm. Por defecto, el módulo | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1269,7 +1271,7 @@ format = "via [⎈ $version](bold white) " ## Hostname -El módulo `hostname` muestra el nombre de host del sistema. +The `hostname` module shows the system hostname. ### Opciones @@ -1288,7 +1290,7 @@ El módulo `hostname` muestra el nombre de host del sistema. | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1304,22 +1306,22 @@ disabled = false ## Java -El módulo `java` muestra la versión actualmente instalada de Java. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `java` module shows the currently installed version of Java. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, o `build.boot` - El directorio actual contiene un archivo con la extensión `.java`, `.class`, `.gradle` o `.jar`, `.clj` o `.cljc` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | El formato del módulo. | -| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Which extensions should trigger this module. | -| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `"☕ "` | A format string representing the symbol of Java | -| `style` | `"red dimmed"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `java` module. | +| Opción | Por defecto | Descripción | +| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | El formato del módulo. | +| `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | +| `symbol` | `"☕ "` | Una cadena de formato que representa el símbolo de Java | +| `style` | `"red dimmed"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `java`. | ### Variables @@ -1329,7 +1331,7 @@ El módulo `java` muestra la versión actualmente instalada de Java. Por defecto | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1342,7 +1344,13 @@ symbol = "🌟 " ## Jobs -El módulo `jobs` muestra el número actual de tareas en ejecución. El módulo se mostrará sólo si hay tareas en segundo plano ejecutándose. El módulo mostrará el número de tareas en ejecución si hay más de 1 tarea o más que el valor configurado de `threshold`, si existe. +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. + +::: aviso + +This module is not supported on tcsh. + +::: ### Opciones @@ -1362,7 +1370,7 @@ El módulo `jobs` muestra el número actual de tareas en ejecución. El módulo | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1376,7 +1384,7 @@ threshold = 4 ## Julia -El módulo `Julia` muestra la versión actualmente instalada de Julia. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `julia` module shows the currently installed version of Julia. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `Project.toml` - El directorio actual contiene un archivo `Manifest.toml` @@ -1384,15 +1392,15 @@ El módulo `Julia` muestra la versión actualmente instalada de Julia. Por defec ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. | -| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | -| `style` | `"bold purple"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `julia` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `detect_extensions` | `["jl"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["Project.toml", "Manifest.toml"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | +| `symbol` | `"ஃ "` | Una cadena de formato que representa el símbolo de Julia. | +| `style` | `"bold purple"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `julia`. | ### Variables @@ -1402,7 +1410,7 @@ El módulo `Julia` muestra la versión actualmente instalada de Julia. Por defec | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1415,22 +1423,22 @@ symbol = "∴ " ## Kotlin -El módulo `kotlin` muestra la versión instalada de Kotlin. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `kotlin` module shows the currently installed version of Kotlin. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `.kt` o `.kts` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `kotlin` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `detect_extensions` | `["kt", "kts"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | +| `symbol` | `"🅺 "` | Una cadena de formato que representa el símbolo de Kotlin. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `kotlin_binary` | `"kotlin"` | Configura el binario kotlin que Starship ejecuta al obtener la versión. | +| `disabled` | `false` | Deshabilita el módulo `kotlin`. | ### Variables @@ -1440,7 +1448,7 @@ El módulo `kotlin` muestra la versión instalada de Kotlin. Por defecto, el mó | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1461,11 +1469,11 @@ kotlin_binary = "kotlinc" ## Kubernetes -Muestra el nombre del contexto actual de Kubernetes y, si se establece, el espacio de nombres del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante `kubectl config set-context starship-cluster --namespace astronaut`. Si se establece la variable de entorno `$KUBECONFIG`, el módulo usará eso si no usará el `~/.kube/config`. +Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1488,7 +1496,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1504,13 +1512,13 @@ disabled = false ## Salto de línea -El módulo `line_break` separa el indicador en dos líneas. +The `line_break` module separates the prompt into two lines. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ----------- | ------------------------------------------------------------------------------- | -| `disabled` | `false` | Deshabilita el módulo `line_break`, haciendo que el mensaje sea una sola línea. | +| Opción | Por defecto | Descripción | +| ---------- | ----------- | ------------------------------------------------------------------------------ | +| `disabled` | `false` | Deshabilita el módulo `line_break`, haciendo que el prompt sea una sola línea. | ### Ejemplo @@ -1523,7 +1531,7 @@ disabled = true ## Lua -El módulo `lua` muestra la versión instalada de Lua. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `lua` module shows the currently installed version of Lua. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `.lua-version` - El directorio actual contiene un directorio `lua` @@ -1531,16 +1539,16 @@ El módulo `lua` muestra la versión instalada de Lua. Por defecto, el módulo s ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"🌙 "` | Una cadena de formato que representa el símbolo de Lua. | -| `detect_extensions` | `["lua"]` | Which extensions should trigger this moudle. | -| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["lua"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `lua` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | -------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `symbol` | `"🌙 "` | Una cadena de formato que representa el símbolo de Lua. | +| `detect_extensions` | `["lua"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[".lua-version"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `["lua"]` | Qué carpetas deberían activar este módulo. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `lua_binary` | `"lua"` | Configura el binario lua que Starship ejecuta al obtener la versión. | +| `disabled` | `false` | Deshabilita el módulo `lua`. | ### Variables @@ -1550,7 +1558,7 @@ El módulo `lua` muestra la versión instalada de Lua. Por defecto, el módulo s | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1563,13 +1571,13 @@ format = "via [🌕 $version](bold blue) " ## Memoria utilizada -El módulo `memory_usage` muestra la memoria del sistema actual y el uso de memoria de intercambio. +The `memory_usage` module shows current system memory and swap usage. -Por defecto, el uso de swap se muestra si el intercambio total del sistema no es cero. +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1594,7 +1602,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable | symbol | `🐏` | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede utilizarse como parte de una cadena de estilo \*\*: La información del archivo SWAP sólo se muestra si se detecta en el sistema actual +\*: This variable can only be used as a part of a style string \*\*: The SWAP file information is only displayed if detected on the current system ### Ejemplo @@ -1610,7 +1618,7 @@ style = "bold dimmed green" ## Mercurial Branch -El módulo `hg_branch` muestra la rama activa del repositorio en su directorio actual. +The `hg_branch` module shows the active branch of the repo in your current directory. ### Opciones @@ -1631,7 +1639,7 @@ El módulo `hg_branch` muestra la rama activa del repositorio en su directorio a | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1646,7 +1654,7 @@ truncation_symbol = "" ## Nim -El módulo `nim` muestra la versión instalada de Nim. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `nim` module shows the currently installed version of Nim. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `nim.cfg` - El directorio actual contiene un archivo con la extensión `.nim` @@ -1659,11 +1667,11 @@ El módulo `nim` muestra la versión instalada de Nim. Por defecto, el módulo s | ------------------- | ------------------------------------ | ---------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo | | `symbol` | `"👑 "` | El símbolo usado antes de mostrar la versión de Nim. | -| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this moudle. | -| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `["nim", "nims", "nimble"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["nim.cfg"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `nim` module. | +| `disabled` | `false` | Deshabilita el módulo `nim`. | ### Variables @@ -1673,7 +1681,7 @@ El módulo `nim` muestra la versión instalada de Nim. Por defecto, el módulo s | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1687,7 +1695,7 @@ symbol = "🎣 " ## Nix-shell -El módulo `nix_shell` muestra el entorno nix-shell. El módulo se mostrará dentro de un entorno nix-shell. +The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. ### Opciones @@ -1709,7 +1717,7 @@ El módulo `nix_shell` muestra el entorno nix-shell. El módulo se mostrará den | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1725,7 +1733,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## NodeJS -El módulo `nodejs` muestra la versión instalada de NodeJS. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `nodejs` module shows the currently installed version of NodeJS. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `package.json` - El directorio actual contiene un archivo `.node-version` @@ -1735,16 +1743,16 @@ El módulo `nodejs` muestra la versión instalada de NodeJS. Por defecto, el mó ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"⬢ "` | Una cadena de formato que representa el símbolo de 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. | -| `style` | `"bold green"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in Packages.json does not match the NodeJS version. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `symbol` | `" "` | Una cadena de formato que representa el símbolo de NodeJS. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["package.json", ".node-version"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `["node_modules"]` | Qué carpetas deberían activar este módulo. | +| `style` | `"bold green"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `nodejs`. | +| `not_capable_style` | `bold red` | El estilo para el módulo cuando una propiedad de motores en Packages.json no coincide con la versión de NodeJS. | ###  Variables @@ -1754,7 +1762,7 @@ El módulo `nodejs` muestra la versión instalada de NodeJS. Por defecto, el mó | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1767,7 +1775,7 @@ format = "via [🤖 $version](bold green) " ## OCaml -El módulo `ocaml` muestra la versión actualmente instalada de OCaml. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `ocaml` module shows the currently installed version of OCaml. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo con extensión `.opam` o directorio `_opam` - El directorio actual contiene un directorio `esy.lock` @@ -1782,11 +1790,11 @@ El módulo `ocaml` muestra la versión actualmente instalada de OCaml. Por defec | ------------------- | ---------------------------------------------------------------- | ------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | La cadena de formato para el módulo. | | `symbol` | `"🐫 "` | El símbolo usado antes de mostrar la versión de OCaml. | -| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this moudle. | -| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. | -| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. | +| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `["_opam", "esy.lock"]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `ocaml` module. | +| `disabled` | `false` | Deshabilita el módulo `ocaml`. | ### Variables @@ -1796,7 +1804,7 @@ El módulo `ocaml` muestra la versión actualmente instalada de OCaml. Por defec | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1809,7 +1817,7 @@ format = "via [🐪 $version]($style) " ## OpenStack -El módulo `openstack` muestra la nube OpenStack actual y el proyecto. El módulo solo está activo cuando la variable env `OS_CLOUD` está definida en cuyo caso leerá el archivo `nubes. aml` desde cualquiera de las [ubicaciones por defecto](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files) para obtener el proyecto actual en uso. +The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. ### Opciones @@ -1829,7 +1837,7 @@ El módulo `openstack` muestra la nube OpenStack actual y el proyecto. El módul | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1844,7 +1852,7 @@ symbol = "☁️ " ## Versión del paquete -El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. El módulo soporta actualmente los paquetes `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` y `helm`. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. - **npm** – La versión del paquete `npm` se extrae del `package.json` presente en el directorio actual - **cargo** – La versión del paquete `cargo` se extrae del `Cargo.toml` presente en el directorio actual @@ -1877,7 +1885,7 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1890,7 +1898,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -El módulo `perl` muestra la versión actualmente instalada de Perl. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `perl` module shows the currently installed version of Perl. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `Makefile.PL` o `Build.PL` - El directorio actual contiene un archivo `cpanfile` o `cpanfile.snapshot` @@ -1904,11 +1912,11 @@ El módulo `perl` muestra la versión actualmente instalada de Perl. Por defecto | ------------------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | La cadena de formato para el módulo. | | `symbol` | `"🐪 "` | El símbolo usado antes de mostrar la versión de Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this moudle. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `["pl", "pm", "pod"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold 149"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `perl` module. | +| `disabled` | `false` | Deshabilita el módulo `perl`. | ### Variables @@ -1929,11 +1937,11 @@ format = "via [🦪 $version]($style) " ## PHP -El módulo `php` muestra la versión instalada de PHP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `php` module shows the currently installed version of PHP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `composer.json` - El directorio actual contiene un archivo `.php-version` -- The current directory contains a `.php` extension +- El directorio actual contiene una extensión `.php` ### Opciones @@ -1941,11 +1949,11 @@ El módulo `php` muestra la versión instalada de PHP. Por defecto, el módulo s | ------------------- | ------------------------------------ | ---------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `symbol` | `"🐘 "` | El símbolo usado antes de mostrar la versión de PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this moudle. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `["php"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["composer.json", ".php-version"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"147 bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `php` module. | +| `disabled` | `false` | Deshabilita el módulo `php`. | ### Variables @@ -1955,7 +1963,7 @@ El módulo `php` muestra la versión instalada de PHP. Por defecto, el módulo s | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -1968,10 +1976,10 @@ format = "via [🔹 $version](147 bold) " ## PureScript -El módulo `purescript` muestra la versión actualmente instalada de PureScript. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `purescript` module shows the currently installed version of PureScript version. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `spago.dhall` -- The current directory contains a file with the `.purs` extension +- El directorio actual contiene un archivo con la extensión `.purs` ### Opciones @@ -1979,11 +1987,11 @@ El módulo `purescript` muestra la versión actualmente instalada de PureScript. | ------------------- | ------------------------------------ | ----------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `symbol` | `"<=> "` | El símbolo usado antes de mostrar la versión de PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this moudle. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `["purs"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["spago.dhall"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold white"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `purescript` module. | +| `disabled` | `false` | Deshabilita el módulo `purescript`. | ### Variables @@ -1993,7 +2001,7 @@ El módulo `purescript` muestra la versión actualmente instalada de PureScript. | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2006,9 +2014,9 @@ format = "via [$symbol$version](bold white)" ## Python -El módulo `python` muestra la versión actualmente instalada de Python y el actual entorno virtual de Python si uno está activado. +The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. -Si `pyenv_version_name` se establece en `true`, mostrará el nombre de la versión de pyenv. De lo contrario, se mostrará el número de versión de `python --version`. +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: @@ -2039,9 +2047,9 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes ::: tip -La variable `python_binary` acepta una cadena o una lista de cadenas. Starship intentará ejecutar cada binario hasta que obtenga un resultado. Ten en cuenta que sólo puedes cambiar el binario que Starship ejecuta para obtener la versión de Python no los argumentos que se utilizan. +The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. -Los valores por defecto y el orden para `python_binary` fue elegido para identificar primero la versión de Python en un entorno virtualenv/conda (que actualmente añade un `python`, no importa si apunta a `pithon3` o `pithon2`). Esto tiene el efecto secundario que si todavía tienes un sistema de Python 2 instalado, puede ser recogido antes de cualquier Python 3 (al menos en las Distros de Linux que siempre enlazan `/usr/bin/python` a Python 2). Si ya no trabajas con Python 2 pero no puedes removerlo del sistema, cambiando esto a `"python3"` ocultará cualquier versión de Python 2, ver ejemplo a continuación. +The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `"python3"` will hide any Python version 2, see example below. ::: @@ -2084,7 +2092,7 @@ detect_extensions = [] ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: - El directorio actual contiene un archivo `Gemfile` - El directorio actual contiene un archivo `.ruby-version` @@ -2096,11 +2104,11 @@ By default the `ruby` module shows the currently installed version of Ruby. El m | ------------------- | ------------------------------------ | -------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `symbol` | `"💎 "` | Una cadena de formato que representa el símbolo de Ruby. | -| `detect_extensions` | `["rb"]` | Which extensions should trigger this module. | -| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `["rb"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["Gemfile", ".ruby-version"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `ruby` module. | +| `disabled` | `false` | Deshabilita el módulo `ruby`. | ### Variables @@ -2110,7 +2118,7 @@ By default the `ruby` module shows the currently installed version of Ruby. El m | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2123,7 +2131,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: - El directorio actual contiene un archivo `Cargo.toml` - El directorio actual contiene un archivo con la extensión `.rs` @@ -2134,11 +2142,11 @@ By default the `rust` module shows the currently installed version of Rust. El m | ------------------- | ------------------------------------ | ------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `symbol` | `"🦀 "` | Una cadena de formato que representa el símbolo de Rust | -| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. | -| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `["rs"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["Cargo.toml"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `rust` module. | +| `disabled` | `false` | Deshabilita el módulo `rust`. | ### Variables @@ -2148,7 +2156,7 @@ By default the `rust` module shows the currently installed version of Rust. El m | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2159,13 +2167,55 @@ By default the `rust` module shows the currently installed version of Rust. El m format = "via [⚙️ $version](red bold)" ``` + +## Scala + +The `scala` module shows the currently installed version of Scala. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: + +- 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` + +### Opciones + + +| Opción | Por defecto | Descripción | +| ------------------- | ---------------------------------------- | ---------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | El formato del módulo. | +| `detect_extensions` | `["sbt", "scala"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[".metals"]` | Qué carpetas deberían activar estos módulos. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `scala` module. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | -------- | -------------------------------------- | +| version | `2.13.5` | The version of `scala` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: This variable can only be used as a part of a style string + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[scala] +symbol = "🌟 " +``` + + ## Shell The `shell` module shows an indicator for currently used shell. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2179,6 +2229,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable | `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` | El formato del módulo. | | `disabled` | `true` | Disables the `shell` module. | @@ -2221,7 +2272,7 @@ The `shlvl` module shows the current SHLVL ("shell level") environment variable, | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2255,7 +2306,7 @@ The `singularity` module shows the current singularity image, if inside a contai | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2272,7 +2323,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2306,7 +2357,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2325,22 +2376,22 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `Package.swift` -- El directorio actual contiene un archivo con la extensión `.swift` +- The current directory contains a `Package.swift` file +- The current directory contains a file with the `.swift` extension ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this moudle. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `swift` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | ---------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["Package.swift"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `style` | `"bold 202"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2350,7 +2401,7 @@ By default the `swift` module shows the currently installed version of Swift. El | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2373,8 +2424,8 @@ By default the terraform version is not shown, since this is slow for current ve Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene una carpeta `.terraform` -- El directorio actual contiene un archivo con las extensiones `.tf` o `.hcl` +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf` or `.hcl` extensions ### Opciones @@ -2382,9 +2433,9 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | ------------------- | ------------------------------------ | ----------------------------------------------------- | | `format` | `"via [$symbol$workspace]($style) "` | La cadena de formato para el módulo. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `detect_extensions` | `["tf", "hcl"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[".terraform"]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold 105"` | El estilo del módulo. | | `disabled` | `false` | Disables the `terraform` module. | @@ -2397,7 +2448,7 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2425,7 +2476,7 @@ The `time` module shows the current **local** time. The `format` configuration v ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2450,7 +2501,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de | time | `13:08:10` | The current time. | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2467,12 +2518,12 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- El usuario actual es root -- El usuario actual no es el mismo que el que está conectado -- El usuario está actualmente conectado como una sesión SSH -- La variable `show_always` se establece en true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: tip @@ -2514,19 +2565,19 @@ show_always = true The `vagrant` module shows the currently installed version of Vagrant. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- El directorio actual contiene un archivo `Vagrantfile` +- The current directory contains a `Vagrantfile` file ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | --------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `Vagrant` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | ---------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["Vagrantfile"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `style` | `"cyan bold"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `Vagrant` module. | ### Variables @@ -2536,7 +2587,7 @@ The `vagrant` module shows the currently installed version of Vagrant. Por defec | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2549,9 +2600,9 @@ format = "via [⍱ $version](bold white) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `.zig` +- The current directory contains a `.zig` file ### Opciones @@ -2561,9 +2612,9 @@ By default the the `zig` module shows the currently installed version of Zig. El | `style` | `"bold yellow"` | El estilo del módulo. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| `detect_extensions` | `["zig"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | ### Variables @@ -2573,7 +2624,7 @@ By default the the `zig` module shows the currently installed version of Zig. El | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string ### Ejemplo @@ -2590,10 +2641,10 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo cuyo nombre está en `files` -- El directorio actual contiene un directorio cuyo nombre está en `directories` -- El directorio actual contiene un archivo cuya extensión está en `extensions` -- El comando `when` devuelve 0 +- The current directory contains a file whose name is in `files` +- The current directory contains a directory whose name is in `directories` +- The current directory contains a file whose extension is in `extensions` +- The `when` command returns 0 ::: tip @@ -2637,14 +2688,14 @@ The order in which custom modules are shown can be individually set by including | symbol | Refleja el valor de la opción `symbol` | | style\* | Refleja el valor de la opción `style` | -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo +\*: This variable can only be used as a part of a style string -#### Comando personalizado de shell +#### Comando personalizado del intérprete de comandos `shell` accepts a non-empty list of strings, where: -- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. -- Otros argumentos siguientes son pasados al shell. +- The first string is the path to the shell to use to execute the command. +- Other following arguments are passed to the shell. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. diff --git a/docs/es-ES/faq/README.md b/docs/es-ES/faq/README.md index 3c8d079bc..265803741 100644 --- a/docs/es-ES/faq/README.md +++ b/docs/es-ES/faq/README.md @@ -6,24 +6,24 @@ - **Tema**: Mínimo - **Esquema de color**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy) - **Font**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) -- **Interfaz de línea de comandos**: [Fish Shell](https://fishshell.com/) +- **Intérprete de comandos**: [Fish Shell](https://fishshell.com/) - **Configuración**: [archivos de configuración de matchai](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **Prompt**: [Starship](https://starship.rs/) ## ¿Cómo obtengo el autocompletado del comando como se muestra en el GIF? -El soporte de terminación, o autocompletado, es proporcionado por su shell de elección. En el caso de la demo, la demo se realizó con [Fish Shell](https://fishshell.com/), que proporciona el completado por defecto. Si usas Z Shell (zsh), te sugeriría echar un vistazo a [zsh-autosuggeries,](https://github.com/zsh-users/zsh-autosuggestions). +El soporte de terminación, o autocompletado, es proporcionado por tu intérprete de comandos de elección. En el caso de la demo, la demo se realizó con [Fish Shell](https://fishshell.com/), que proporciona el completado por defecto. Si usas Z Shell (zsh), te sugerimos echar un vistazo a [zsh-autosuggeries,](https://github.com/zsh-users/zsh-autosuggestions). ## ¿`prompt_order` y `.disabled` hacen lo mismo? -Sí, se pueden usar ambos para desactivar los módulos en el símbolo del sistema. Si todo lo que planeas es desactivar módulos, `.disabled` es el método preferido por las siguientes razones: +Sí, se pueden usar ambos para desactivar los módulos en el prompt. Si todo lo que planeas es desactivar módulos, `.disabled` es el método preferido por las siguientes razones: - Deshabilitar módulos es más explícito que omitirlos del nivel superior `format` -- Los nuevos módulos se añadirán al símbolo del sistema en cuanto Starship se actualice +- Los nuevos módulos se añadirán al prompt en cuanto Starship se actualice -## La documentación dice que Starship es "cross-shell". ¿Por qué no es compatible mi shell preferido? +## La documentación dice que Starship es "cross-shell". ¿Por qué no es compatible mi intérprete de comandos preferido? -Por la forma en que Starshp está construído, debería ser posible añadir soporte para prácticamente cualquier intérprete de comandos. El binario de Starship es sin estado y agnóstico, por lo que mientras que tu intérprete de comandos se pueda ampliar y soporte la personalización del símbolo del sistema, puede utilizar Starship. +Por la forma en que Starship está construído, debería ser posible añadir soporte para prácticamente cualquier intérprete de comandos. El binario de Starship es sin estado y agnóstico, por lo que mientras que tu intérprete de comandos se pueda ampliar y soporte la personalización del prompt, puedes utilizar Starship. Aquí tienes un pequeño ejemplo haciendo que Starship funcione con bash: @@ -38,9 +38,9 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -La [implementación de Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) en Starship es sensíblemente is ligeramente más compleja para permitir características avanzadas como [el módulo de duración de comando](https://starship.rs/config/#Command-Duration) y para asegurar que Starship es compatible con las configuraciones preinstaladas de Bash. +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. -Para obtener una lista de todos los parámetros aceptados por `el símbolo del sistema starship`, usa el siguiente comando: +Para obtener una lista de todos los parámetros aceptados por `el prompt de Starship`, usa el siguiente comando: ```sh starship prompt --help @@ -56,33 +56,37 @@ Si obtienes un error como "_version 'GLIBC_2.18' not found (required by starship curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl ``` +## Veo símbolos que no entiendo ni espero, ¿qué significan? + +Si ves símbolos que no reconoces, puedes usar `starship explain` para explicar los módulos que se muestran actualmente. + ## ¿Por qué no veo un símbolo de glifo en mi prompt? -La causa más común de esto es la mala configuración del sistema. Algunas distribuciones de Linux en particular no vienen con soporte de fuentes "listo para usare". Tienes que asegurar que: +La causa más común de esto es la mala configuración del sistema. Algunas distribuciones de Linux en particular no vienen con soporte de fuentes listos para usarse. Tienes que garantizar que: - Tu configuración regional está establecida con un valor UTF-8, como `de_DE.UTF-8` o `ja_JP.UTF-8`. Si `LC_ALL` no es un valor UTF-8, [necesitarás cambiarlo](https://www.tecmint.com/set-system-locales-in-linux/). - Tienes una fuente emoji instalada. La mayoría de los sistemas vienen con una fuente emoji por defecto, pero algunos (notablemente Arch Linux) no. Generalmente puedes instalar uno a través del gestor de paquetes del sistema --[noto emoji](https://www.google.com/get/noto/help/emoji/) es una elección popular. - Estás usando un [Nerd Font](https://www.nerdfonts.com/). -Para probar tu sistema, ejecuta los siguientes comandos en un terminal: +Para probar tu sistema, ejecua los siguientes comandos en un terminal: ```sh echo -e "\xf0\x9f\x90\x8d" echo -e "\xee\x82\xa0" ``` -La primera línea debe producir un [emoji snake](https://emojipedia.org/snake/), mientras que la segunda debe producir un [símbolo de rama de powerline (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs). +La primera línea debe producir un [emoji snake](https://emojipedia.org/snake/), mientras que la segunda debe producir un [símbolo de rama de Powerline(e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs). -Si cualquiera de los dos símbolos no se puede mostrar correctamente, tu sistema todavía está mal configurado. Desafortunadamente, obtener la configuración correcta de las fuentes es a veces difícil. Los usuarios en el Discord te pueden ayudar. Si ambos símbolos se muestran correctamente, pero todavía no los ves en starship, [¡envía un informe de error!](https://github.com/starship/starship/issues/new/choose) +Si cualquiera de los dos símbolos no se puede mostrar correctamente, su sistema todavía está mal configurado. Desafortunadamente, obtener la configuración correcta de las fuentes es a veces difícil. Los usuarios en el Discord pueden ayudar. Si ambos símbolos se muestran correctamente, pero todavía no los ves en Starship, [¡envía un informe de error!](https://github.com/starship/starship/issues/new/choose) ## ¿Cómo puedo desinstalar Starship? Starship es tan fácil de desinstalar como de instalar en primer lugar. -1. Elimina cualquier línea de tu configuración de shell (por ejemplo, `~/.bashrc`) usada para inicializar Starship. +1. Elimina cualquier línea de tu configuración de intérprete de comandos (por ejemplo, `~/.bashrc`) usada para inicializar Starship. 1. Elimina el binario de Starship. -Si Starship fue instalado usando un gestor de paquetes, por favor refiérere a sus documentos para instrucciones de desinstalación. +Si Starship fue instalado usando un gestor de paquetes, por favor refiérete a sus documentos para instrucciones de desinstalación. Si Starship fue instalado usando el script `curl | bash`, el siguiente comando eliminará el binario: diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md index f8b340336..7b6a46e97 100644 --- a/docs/es-ES/guide/README.md +++ b/docs/es-ES/guide/README.md @@ -2,18 +2,21 @@ Starship - Prompt multi intérprete de comandos + alt="Starship - Prompt multi-intérprete de comandos" + />

Estado del flujo de trabajo de GitHub Actions + alt="Estado del flujo de trabajo de GitHub Actions" + /> Versión de Crates.io + alt="Versión de Crates.io" + /> Chat en Discord + alt="Chat en Discord" + /> Sigue a @StarshipPrompt en Twitter + alt="Sigue a @StarshipPrompt en Twitter" + />

@@ -42,63 +47,72 @@ >English + alt="English" + />   日本語 + alt="日本語" + />   繁體中文 + alt="繁體中文" + />   Русский + alt="Русский" + />   Deutsch + alt="Deutsch" + />   简体中文 + alt="简体中文" + />   Español + alt="Español" + />   Francés + alt="Francés" + />   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 con iTerm 2 y el tema Snazzy" width="50%" - align="right" /> + align="right" + /> **¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!** @@ -163,7 +178,7 @@ scoop install starship ``` -2. Añade el script de inicio al archivo de configuración de tu interfaz de línea de comandos: +2. Añade el guión de inicio al archivo de configuración de tu intérprete de comandos: #### Bash @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Añade el siguiente código al final de `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 Colaborando ¡Siempre estamos buscando colaboradores de **todos los niveles y habilidades**! Si estas buscando una manera fácil de ayudar este proyecto, puedes intentar resolver un problema con la etiqueta "[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)". @@ -269,11 +295,11 @@ Apoya este proyecto con tu organización. Su logo se mostrará aquí con un enla Por favor, revisa estos trabajos previos que ayudaron a inspirar la creación de starship. 🙏 -- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - Una prompt ZSH para astronautas. +- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - Un prompt ZSH para astronautas. -- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - robbyrussel, tema multi intérprete de comandos escrito en JavaScript. +- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - robbyrussel, tema multi-intérprete de comandos escrito en JavaScript. -- **[reujab/silver](https://github.com/reujab/silver)** - Una prompt multi intérprete de comandos personalizable, basada en Powerline con iconos. +- **[reujab/silver](https://github.com/reujab/silver)** - Un prompt multi-intérprete de comandos personalizable, basada en Powerline con iconos.


diff --git a/docs/es-ES/installing/README.md b/docs/es-ES/installing/README.md index 71226790b..0294b5820 100644 --- a/docs/es-ES/installing/README.md +++ b/docs/es-ES/installing/README.md @@ -3,25 +3,41 @@ Para instalar Starship, necesitas hacer dos cosas: 1. Consigue el binario de **Starship** en tu ordenador -1. Decirle a tu shell que use el binario de Starship como su prompt modificando sus guiones de inicio +1. Decirle a tu intérprete de comandos que use el binario de Starship como su prompt modificando sus guiones de inicio Para la mayoría de los usuarios, las instrucciones en [la página principal](/guide/#🚀-installation) funcionarán genial. Sin embargo, para algunas plataformas más especializadas, se necesitan diferentes instrucciones. Hay tantas plataformas ahí fuera que no cabían en el README.md principal, así que aquí están algunas instrucciones de instalación para otras plataformas de la comunidad. ¿No está usted aquí? ¡Por favor, añádelo aquí si lo encuentras! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### Prerequisitos + +Dirígete a la página de instalación de [Chocolatey](https://chocolatey.org/install) y sigue las instrucciones para instalar Chocolatey. + +### Instalación + +```powershell +choco install starship +``` + +## [termux](https://termux.com) + +### Prerequisitos + ```sh pkg install getconf ``` -### Installation +### Instalación + ```sh curl -fsSL https://starship.rs/install.sh | bash -s -- -b /data/data/com.termux/files/usr/bin ``` ## [Nix](https://nixos.wiki/wiki/Nix) -### Getting the Binary +### Obtener el binario #### Imperativamente @@ -31,26 +47,38 @@ nix-env -iA nixos.starship #### Declarativo, usuario único, a través de [home-manager](home-manager) -Añade `pkgs.starship` a tu `home.packages` en tu archivo `home.nix` y luego ejecuta +Activa el módulo `programs.starship` en tu archivo `home.nix` y añade tus ajustes + +```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; + }; + }; +} +``` + +luego ejecutar ```sh -interruptor home-manager +home-manager switch ``` #### Declarativo, en todo el sistema, con NixOS -Añade `pkgs.starship` a `environment.packages` en tu `configuration.nix`, luego ejecuta +Añade `pkgs.starship` a `environment.systemPackages` en tu `configuration.nix`, luego ejecuta ```sh sudo nixos-rebuild switch ``` - -### Modifying Init Scripts - -#### Con Nix y home-manager, usando zsh: - -Añade lo siguiente a `programs.zsh.initExtra` en tu archivo `home.nix` y luego ejecutar - -```sh -interruptor home-manager -``` diff --git a/docs/es-ES/migrating-to-0.45.0/README.md b/docs/es-ES/migrating-to-0.45.0/README.md index 23d1a4f13..3c1748f0a 100644 --- a/docs/es-ES/migrating-to-0.45.0/README.md +++ b/docs/es-ES/migrating-to-0.45.0/README.md @@ -6,7 +6,7 @@ Esta guía pretende guiarle a través de los cambios de ruptura. ## `prompt_order` ha sido reemplazado por un "nivel raíz" `format` -Anterioramente a v0.45.0, `prompt_order` aceptaría un array de nombres de módulos en el orden que deberían ser renderizados por Starship. +Anterioramente a v0.45.0, `prompt_order` aceptaría un arreglo de nombres de módulos en el orden que deberían ser renderizados por Starship. En su lugar, Starship v0.45.0 acepta un valor de `format`, permitiendo la personalización del indicador fuera de los propios módulos. @@ -70,7 +70,7 @@ prefix = "tomó " ```toml [cmd_duration] # $duration – La duración del comando (p. ej. "15s") -# $style – El estilo predeterminado del módulo (p. ej. "bold yellow") +# $style – El estilo por defecto del módulo (p. ej. "bold yellow") format = "tomó [$duration]($style) " ``` diff --git a/docs/es-ES/presets/README.md b/docs/es-ES/presets/README.md index b9042b4b4..6ee28ef23 100644 --- a/docs/es-ES/presets/README.md +++ b/docs/es-ES/presets/README.md @@ -1,12 +1,12 @@ -# Ajustes predeterminados +# Ajustes por defecto -Aqui hay una colección de ajustes predeterminados creados por la comunidad de Starship. ¡Si quieres compartir un ajuste predeterminado, por favor, [envía un PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) actualizando este archivo! 😊 +Aquí hay una colección de ajustes por defecto creados por la comunidad de Starship. ¡Si quieres compartir un ajuste por defecto, por favor, [envía un PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) actualizando este archivo! 😊 ## Símbolos de Nerd Font -Este ajuste predeterminado no modifica nada excepto los símbolos usados para cada módulo. Si los emojis no son lo tuyo, ¡esto podría llamar tu atención! +Este ajuste por defecto no modifica nada excepto los símbolos usados para cada módulo. Si los emojis no son lo tuyo, ¡esto podría llamar tu atención! -![Captura de pantalla de los ajustes predeterminados de los Símbolos de Nerd Font](/presets/nerd-font-symbols.png) +![Captura de pantalla de los ajustes por defecto de los Símbolos de Nerd Font](/presets/nerd-font-symbols.png) ### Prerequisitos @@ -16,7 +16,7 @@ Este ajuste predeterminado no modifica nada excepto los símbolos usados para ca ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/fr-FR/README.md b/docs/fr-FR/README.md index 88a1784bd..61a2512d9 100644 --- a/docs/fr-FR/README.md +++ b/docs/fr-FR/README.md @@ -123,3 +123,14 @@ description: Starship est un invite minimaliste, ultra-rapide et hautement perso eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index 4a8d18796..45a2c6231 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -9,14 +9,14 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Toute la configuration de starship est faite dans ce fichier [TOML](https://github.com/toml-lang/toml): ```toml -# N'écrivez pas une nouvelle ligne au début de la console -add_newline = false +# Inserts a blank line between shell prompts +add_newline = true -# Remplacez le symbole "❯" dans la console avec "➜" -[character] # Le nom du module que nous configurons est "character" -success_symbol = "[➜](bold green)" # Le segment "success_symbol" est mis comme "➜" avec la couleur "bold green" +# Replace the "❯" symbol in the prompt with "➜" +[character] # The name of the module we are configuring is "character" +success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" -# Désactivez le module package, le masquant complètement dans la console +# Disable the package module, hiding it from the prompt completely [package] disabled = true ``` @@ -80,7 +80,7 @@ La deuxième partie, qui est entourée par `()`, est une [chaîne de style](#sty Par exemple : - `[on](red bold)` affichera une chaîne de caractères `on` avec un texte gras de couleur rouge. -- `[⬢ $version](bold green)` affichera un symbole `⬢` suivi du contenu de la variable `version`, avec un texte en gras de couleur verte. +- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `[a [b](red) c](green)` affichera `a b c` avec `b` rouge, et `a` et `c` vert. #### Chaînes de style @@ -146,7 +146,7 @@ Voici la liste des options de configuration de l'invite en lui-même. | -------------- | ------------------------------ | -------------------------------------------------------------------------- | | `format` | [lien](#default-prompt-format) | Configure le format de l'invite. | | `scan_timeout` | `30` | Délai d'attente avant que starship scanne les fichiers (en millisecondes). | -| `add_newline` | `true` | Ajoute une nouvelle ligne a début de l'invite. | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### Exemple @@ -162,7 +162,7 @@ format = """ # Attendez 10 millisecondes pour que starship vérifie les fichiers dans le répertoire de travail. scan_timeout = 10 -# Désactive la nouvelle ligne au démarrage de l'invite +# 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 @@ Le module `aws` affiche la région et le profil AWS courant. Ces informations so Quand [aws-vault](https://github.com/99designs/aws-vault) est utilisé, la valeur du profil est lu dans la variable d'environnement: `AWS_VAULT`. +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) '` | Format du module. | -| `symbol` | `"☁️ "` | Le symbole affiché avant le profil AWS actuel. | -| `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. | -| `style` | `"bold yellow"` | Le style du module. | -| `disabled` | `false` | Désactive le module `AWS`. | +| Option | Default | Description | +| ---------------- | --------------------------------------------------- | -------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | Format du module. | +| `symbol` | `"☁️ "` | Le symbole affiché avant le profil AWS actuel. | +| `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. | +| `style` | `"bold yellow"` | Le style du module. | +| `disabled` | `false` | Désactive le module `AWS`. | ### Variables @@ -256,7 +259,7 @@ Quand [aws-vault](https://github.com/99designs/aws-vault) est utilisé, la valeu | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | -\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style +\*: This variable can only be used as a part of a style string ### Exemples @@ -266,7 +269,7 @@ Quand [aws-vault](https://github.com/99designs/aws-vault) est utilisé, la valeu # ~/.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 = "🅰 " ## Battery -Le module `battery` montre à quel point la batterie de l'appareil est chargée et son état de charge actuel. Ce module n'est visible que lorsque la batterie de l'appareil est inférieure à 10%. +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%. ### Options @@ -330,7 +333,7 @@ discharging_symbol = "💀" ### Indicateur de batterie -L'option de configuration `display` est utilisée pour définir quand l'indicateur de batterie doit être affiché (seuil) et à quoi il ressemble (style). Si aucun `display` n'est fourni. La valeur par défaut est la suivante : +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. La valeur par défaut est la suivante : ```toml [[battery.display]] @@ -340,7 +343,7 @@ style = "bold red" #### Options -L'option `display` est une array de la table suivante. +The `display` option is an array of the following table. | Option | Description | | ----------- | -------------------------------------------------- | @@ -364,14 +367,14 @@ style = "bold yellow" ## Caractères -Le module `character` affiche un caractère (habituellement une flèche) à côté de l'endroit où le texte est entré dans votre terminal. +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -Le caractère vous dira si la dernière commande a été réussie ou pas. Cela peut être fait de deux manières: +The character will tell you whether the last command was successful or not. It can do this in two ways: - changement de couleur (`red`/`green`) - changement de forme (`❯`/`✖`) -Par défaut, il ne change que la couleur. Si vous voulez également changer sa forme, jetez un œil à [cet exemple](#with-custom-error-shape). +By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -434,7 +437,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | Option | Défaut | Description | | ------------------- | -------------------------------------- | --------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `symbol` | `"喝 "` | Le symbole utilisé avant la version de cmake. | +| `symbol` | `"△ "` | Le symbole utilisé avant la version de 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 | @@ -449,19 +452,19 @@ The `cmake` module shows the currently installed version of CMake. By default th | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | -\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style +\*: This variable can only be used as a part of a style string ## Temps d'exécution -Le module `cmd_duration` montre le temps qu'a pris la dernière commande a pris pour s'exécuter. Le module ne sera affiché que si la commande a pris plus de deux secondes, ou si la valeur de configuration `min_time` existe. +The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: attention, n'accrochez pas la trappe DEBUG en Bash +::: warning Do not hook the DEBUG trap in Bash -Si vous utilisez starship en `bash`, n'accrochez pas `DEBUG` après avoir exécuté `eval $(starship init $0)`, ou ce module **cassera**. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Définissez simplement les array `preexec_functions` et `precmd_functions` avant d'éxécuter `eval $(starship init $0)`, puis procédez comme d'habitude. +Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### Options @@ -477,7 +480,7 @@ Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent uti ::: tip -L'affichage des notifications de bureau nécessite que starship soit compilé avec la prise en charge de `rust-notify`. Vérifiez si starship supporte les notifications en exécutant `STARSHIP_LOG=debug starship module cmd_duration -d 60000` lorsque `show_notifications` est défini à `true`. +Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. ::: @@ -488,7 +491,7 @@ L'affichage des notifications de bureau nécessite que starship soit compilé av | duration | `16m40s` | Le temps nécessaire pour exécuter la commande | | style\* | | Reflète la valeur de l'option `style` | -\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style +\*: This variable can only be used as a part of a style string ### Exemple @@ -502,11 +505,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -Le module `conda` affiche l'environnement conda actuel, si `$CONDA_DEFAULT_ENV` est défini. +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -Cela ne supprime pas le modificateur d'invite de conda, vous pouvez exécuter `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -529,7 +532,7 @@ Cela ne supprime pas le modificateur d'invite de conda, vous pouvez exécuter `c | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | -\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style +\*: This variable can only be used as a part of a style string ### Exemple @@ -542,7 +545,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -Le module `crystal` affiche la version actuellement installée de Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: - Le répertoire courant contient un fichier `shard.yml` - Le répertoire courant contient un fichier `.cr` @@ -567,7 +570,7 @@ Le module `crystal` affiche la version actuellement installée de Crystal. By de | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | -\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style +\*: This variable can only be used as a part of a style string ### Exemple @@ -580,7 +583,7 @@ format = "via [✨ $version](bold blue) " ## Dart -Le module `dart` affiche la version courante installée de Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: - Le répertoire courant contient un fichier `.dart` - Le répertoire courant contient un répertoire `.dart_tool` @@ -606,7 +609,7 @@ Le module `dart` affiche la version courante installée de Dart. By default the | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | -\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style +\*: This variable can only be used as a part of a style string ### Exemple @@ -619,11 +622,11 @@ format = "via [🔰 $version](bold red) " ## Dossier -Le mode `directory` montre le chemin de votre dossier actuel, tronqué aux 3 dossiers parents. Votre répertoire sera également tronqué à la racine du repo git dans lequel vous vous trouvez actuellement. +The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. -Quand vous utilisez le style pwd de fish, au lieu de cacher le chemin qui est tronqué, vous verrez un nom raccourci de chaque dossier basé sur le nombre établi pour l'option. +When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. -Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo, et l'option définie à `1`. Vous verrez maintenant `~/D/N/nixpkgs/pkgs`, alors que vous auriez vu `nixpkgs/pkgs` avant. +For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### Options @@ -640,7 +643,7 @@ Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo | `home_symbol` | `"~"` | The symbol indicating home directory. |

-Ce module possède quelques options de configuration avancées qui contrôlent l'affichage du répertoire. +This module has a few advanced configuration options that control how the directory is displayed. | Options avancées | Défaut | Description | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -667,7 +670,7 @@ Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo | path | `"D:/Projects"` | Le chemin du répertoire courant | | style\* | `"black bold dimmed"` | Reflète la valeur de l'option `style` | -\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style +\*: This variable can only be used as a part of a style string ### Exemple @@ -704,7 +707,7 @@ The `docker_context` module shows the currently active [Docker context](https:// | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | -\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style +\*: This variable can only be used as a part of a style string ### Exemple @@ -759,7 +762,7 @@ The module will also show the Target Framework Moniker ( + alt="Starship – Prompt Shell multi-platformes" + />

Statut du workflow actions GitHub + alt="Statut du workflow actions GitHub" + /> Version Crates.io + alt="Version Crates.io" + /> Discuter sur Discord + alt="Discuter sur Discord" + /> Suivez @StarshipPrompt sur Twitter + alt="Suivez @StarshipPrompt sur Twitter" + />

@@ -42,63 +47,72 @@ >English + alt="English" + />   日本語 + alt="日本語" + />   繁體中文 + alt="繁體中文" + />   Русский + alt="Русский" + />   Deutsch + alt="Deutsch" + />   简体中文 + alt="简体中文" + />   Espagnol + alt="Espagnol" + />   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 avec iTerm2 et le thème Snazzy" width="50%" - align="right" /> + align="right" + /> **L'invite minimaliste, ultra-rapide et personnalisable à l'infini pour n'importe quel shell !** @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝Contribution Nous sommes toujours à la recherche de contributeurs de **tous niveaux de compétence**! Si vous cherchez à faciliter votre entrée dans le projet, essayez un [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/fr-FR/installing/README.md b/docs/fr-FR/installing/README.md index f8c995322..0426c742d 100644 --- a/docs/fr-FR/installing/README.md +++ b/docs/fr-FR/installing/README.md @@ -8,13 +8,29 @@ Pour installer starship, vous devez faire deux choses: Pour la plupart des utilisateurs, les instructions sur [la page principale](/guide/#🚀-installation) fonctionneront bien. Cependant, pour certaines plateformes plus spécialisées, des instructions différentes sont nécessaires. Il y a tellement de plates-formes, qu'il aurait été déraisonnable de les faire apparaître dans le README principal, voici donc quelques instructions d'installation supplémentaires pour celles-ci, écrient par la commaunauté. La vôtre n'est-elle pas là ? S'il vous plaît, ajoutez-la ici pour les suivants ! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### Pré-requis + +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) + +### Pré-requis + ```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 #### Déclaration, utilisateur unique, via [home-manager](home-manager) -Ajoutez `pkgs.starship` à votre `home.packages` dans votre fichier `home.nix` puis exécutez +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 #### Déclaration, au niveau du système, avec NixOS -Ajoutez `pkgs.starship` à `environment.packages` dans votre `configuration.nix`, puis exécutez +Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run ```sh sudo nixos-rebuild switch ``` - -### Modifying Init Scripts - -#### Avec Nix et home manager, en utilisant zsh : - -Ajoutez les éléments suivants à `programs.zsh.initExtra` dans votre fichier `home.nix` puis exécuter - -```sh -home-manager switch -``` diff --git a/docs/fr-FR/presets/README.md b/docs/fr-FR/presets/README.md index c926b285f..8fd5fb836 100644 --- a/docs/fr-FR/presets/README.md +++ b/docs/fr-FR/presets/README.md @@ -16,7 +16,7 @@ Cette configuration ne modifie rien sauf les symboles utilisés pour chaque modu ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/it-IT/README.md b/docs/it-IT/README.md index 210fe85d5..131620da0 100644 --- a/docs/it-IT/README.md +++ b/docs/it-IT/README.md @@ -38,7 +38,7 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per Con Shell: ```sh - curl -fsSL https://starship.rs/install.sh | bash + curl -fsSL https://starship.rs/install.sh bash ``` @@ -123,3 +123,14 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per eval (starship init elvish) ``` + + #### Tcsh + + Aggiungi quanto segue alla fine di `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/it-IT/advanced-config/README.md b/docs/it-IT/advanced-config/README.md index 1c7da93b6..9e7cfae07 100644 --- a/docs/it-IT/advanced-config/README.md +++ b/docs/it-IT/advanced-config/README.md @@ -27,11 +27,11 @@ starship_precmd_user_func="blastoff" function blastoff(){ echo "🚀" } -trap blastoff DEBUG # Trap DEBUG *before* running starship -eval $(starship init bash) +trap blastoff DEBUG # Trap DEBUG *prima* di eseguire starship +eval $(starship bash) ``` -## Cambia il Titolo della Finestra +## Cambia il titolo della finestra Alcune shell prompt cambieranno automaticamente il titolo della finestra (ad esempio per riflettere la directory di lavoro). Fish lo fa per impostazione predefinita. Starship non lo fa, ma è abbastanza semplice aggiungere questa funzionalità a `bash` o `zsh`. @@ -39,7 +39,7 @@ Innanzitutto, bisogna definire una funzione per il cambio del titolo della fines ```bash function set_win_title(){ - echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007" + echo -ne "\033]0; IL_TUO_TITOLO_QUI \007" } ``` @@ -68,7 +68,7 @@ function set_win_title(){ starship_precmd_user_func="set_win_title" ``` -## Stile delle Stringhe +## Stringhe di stile Le stringhe di stile sono un elenco di parole, separate da spazi bianchi. Le parole non sono sensibili alle maiuscole (cioè `grassetto` e `BoLd` sono considerate la stessa stringa). Ogni parola può essere una delle seguenti: diff --git a/docs/it-IT/config/README.md b/docs/it-IT/config/README.md index f5638dc70..1465eed39 100644 --- a/docs/it-IT/config/README.md +++ b/docs/it-IT/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,10 +80,10 @@ 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. -#### Stile delle Stringhe +#### Stringhe di stile Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/). @@ -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. +::: Attenzione + +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/it-IT/faq/README.md b/docs/it-IT/faq/README.md index 56a50d46a..be42b27fb 100644 --- a/docs/it-IT/faq/README.md +++ b/docs/it-IT/faq/README.md @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -L'implementazione [Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) integrata in Starship è leggermente più complessa per consentire funzionalità avanzate come il [modulo di durata dei comandi](https://starship.rs/config/#Command-Duration) e per garantire che Starship sia compatibile con le configurazioni Bash preinstallate. +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. Per un elenco di tutti i flag accettati da `starship prompt`, utilizzare il seguente comando: @@ -56,33 +56,37 @@ Se si ottiene un errore come "_versione 'GLIBC_2. 8' non trovato (richiesta da S curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl ``` -## Perché non vedo un simbolo di glifo nel mio prompt? +## I see symbols I don't understand or expect, what do they mean? -La causa più comune è la configurazione errata del sistema. Alcune distribuzioni Linux in particolare non vengono fornite con il supporto dei font come impostazione predefinita. È necessario assicurarsi che: +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: - In locale sia impostato un valore UTF-8, come `de_DE.UTF-8` o `ja_JP.UTF-8`. Se `LC_ALL` non è un valore UTF-8, [dovrai cambiarlo](https://www.tecmint.com/set-system-locales-in-linux/). - Hai un font emoji installato. La maggior parte dei sistemi ha un font emoji per impostazione predefinita, ma alcuni (in particolare Arch Linux) non lo fanno. Di solito puoi installarne uno attraverso il gestore dei pacchetti del tuo sistema-[noto emoji](https://www.google.com/get/noto/help/emoji/) è uno dei popolari. - Stai usando un [font Nerd](https://www.nerdfonts.com/). -Per testare il sistema, eseguire i seguenti comandi in un terminale: +To test your system, run the following commands in a terminal: ```sh echo -e "\xf0\x9f\x90\x8d" echo -e "\xee\x82\xa0" ``` -La prima riga dovrebbe riprodurre una [emoji di un serpente](https://emojipedia.org/snake/), mentre la seconda dovrebbe riprodurre il [simbolo powerline di ramo (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs). +The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs). -Se uno dei due simboli non viene visualizzato correttamente, il sistema è ancora mal configurato. Sfortunatamente, ottenere la configurazione dei caratteri corretta a volte è difficile. Gli utenti su Discord potrebbero essere in grado di aiutarti. Se entrambi i simboli vengono visualizzati correttamente, ma non li vedi ancora in starship, [segnala un bug!](https://github.com/starship/starship/issues/new/choose) +If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose) -## Come posso disinstallare Starship? +## How do I uninstall Starship? -Starship è altrettanto facile da disinstallare come lo è da installare. +Starship is just as easy to uninstall as it is to install in the first place. 1. Rimuovi qualsiasi riga utilizzata per inizializzare Starship nella configurazione della tua shell (ad es. `~/.bashrc`). 1. Elimina il binario di Starship. -Se Starship è stato installato utilizzando un gestore di pacchetti, fai riferimento alla documentazione per le istruzioni di disinstallazione. +If Starship was installed using a package manager, please refer to their docs for uninstallation instructions. If Starship was installed using the `curl | bash` script, the following command will delete the binary: diff --git a/docs/it-IT/guide/README.md b/docs/it-IT/guide/README.md index 89a277e07..d193fb8ee 100644 --- a/docs/it-IT/guide/README.md +++ b/docs/it-IT/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" + /> Versione Crates.io + alt="Versione Crates.io" + /> Chat su Discord + alt="Chat su Discord" + /> Segui @StarshipPrompt su Twitter + alt="Segui @StarshipPrompt su Twitter" + />

@@ -42,63 +47,72 @@ >Inglese + alt="Inglese" + />   日本語 + alt="日本語" + />   繁體中文 + alt="繁體中文" + />   Russo + alt="Russo" + />   Tedesco + alt="Tedesco" + />   简体中文 + alt="简体中文" + />   Spagnolo + alt="Spagnolo" + />   Francese + alt="Francese" + />   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 con iTerm2 e il tema Snazzy" width="50%" - align="right" /> + align="right" + /> **Il prompt minimalista, super veloce e infinitamente personalizzabile per qualsiasi shell!** @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Aggiungi quanto segue alla fine di `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 Contribuire Siamo sempre alla ricerca di collaboratori di **tutti i livelli**! Se stai cercando di entrare facilmente nel progetto, prova un [buon primo problema](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/it-IT/installing/README.md b/docs/it-IT/installing/README.md index 07925d0fd..ebc3ef35e 100644 --- a/docs/it-IT/installing/README.md +++ b/docs/it-IT/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! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### Prerequisiti + +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) + +### Prerequisiti + ```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/it-IT/presets/README.md b/docs/it-IT/presets/README.md index 4b8ab1e7b..dd6bf2256 100644 --- a/docs/it-IT/presets/README.md +++ b/docs/it-IT/presets/README.md @@ -16,7 +16,7 @@ Questo preset non cambia nulla tranne i simboli utilizzati per ogni modulo. Se g ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md index b72c9a54b..652266bce 100644 --- a/docs/ja-JP/README.md +++ b/docs/ja-JP/README.md @@ -94,7 +94,7 @@ description: Starship はミニマルで、非常に高速で、カスタマイ #### Powershell - Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. + Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. 通常、パスは `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` または -Nix 上では `~/.config/powershell/Microsoft.PowerShell_profile.ps1` です。 ```sh Invoke-Expression (&starship init powershell) @@ -115,7 +115,7 @@ description: Starship はミニマルで、非常に高速で、カスタマイ ::: warning Only elvish v0.15 or higher is supported. ::: - Add the following to the end of `~/.elvish/rc.elv`: + `~/.elvish/rc.elv` の最後に以下を追記してください。 ```sh # ~/.elvish/rc.elv @@ -123,3 +123,14 @@ description: Starship はミニマルで、非常に高速で、カスタマイ eval (starship init elvish) ``` + + #### Tcsh + + `~/.tcshrc` の最後に以下を追加します: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/ja-JP/advanced-config/README.md b/docs/ja-JP/advanced-config/README.md index b2d47a9c4..267220a92 100644 --- a/docs/ja-JP/advanced-config/README.md +++ b/docs/ja-JP/advanced-config/README.md @@ -82,7 +82,7 @@ starship_precmd_user_func="set_win_title" ここで、 `` は色を指定します（以下で述べます）。 `fg:` と `` は現在同様の動作ですが、将来変更される可能性があります。 文字列中の単語の順序は関係ありません。 -The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. 将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。 +`none` トークンは、文字列中の`bg:` 指定子の一部でない場合、他のすべてのトークンをオーバーライドします。そのため、たとえば、`fg:red none fg:blue` と指定した場合、スタイルなしの文字列が作られます。 `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. 将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。 色は以下のいずれか1つを指定できます。 diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index 36136cd78..49a86127d 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -9,14 +9,14 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。 ```toml -# プロンプトの先頭に改行を表示しません -add_newline = false +# Inserts a blank line between shell prompts +add_newline = true -# プロンプトの「❯」記号を「➜」に置き換えます -[character] # 設定しているモジュールの名前は「character」です -success_symbol = "[➜](bold green)" # 「success_symbol」セグメントは「ボールドグリーン」の色で「➜」に設定されています +# Replace the "❯" symbol in the prompt with "➜" +[character] # The name of the module we are configuring is "character" +success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" -# package モジュールを無効にし、プロンプトから完全に隠します +# Disable the package module, hiding it from the prompt completely [package] disabled = true ``` @@ -80,7 +80,7 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" 例： - `[on](red bold)` は文字列 `on` に太字のテキストを赤色で表示します。 -- `[⬢ $version](bold 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)` は `a b c` を `b` だけ赤色に表示し、 `a` と `c` を緑色に表示します。 #### スタイルの設定 @@ -142,11 +142,11 @@ format = ''' ### オプション -| オプション | デフォルト | 説明 | -| -------------- | ------------------------------ | ---------------------------------------- | -| `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 | -| `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 | -| `add_newline` | `true` | プロンプトの開始前に新しい行を追加します。 | +| オプション | デフォルト | 説明 | +| -------------- | ------------------------------ | ----------------------------------------- | +| `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 | +| `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### 設定例 @@ -163,7 +163,7 @@ format = """ scan_timeout = 10 -# プロンプトの 先頭での改行を無効にする +# Disable the blank line at the start of the prompt add_newline = false ``` @@ -208,6 +208,7 @@ $purescript\ $python\ $ruby\ $rust\ +$scala\ $swift\ $terraform\ $vagrant\ @@ -238,15 +239,17 @@ $character""" [aws-vault](https://github.com/99designs/aws-vault)を使用する場合、プロファイル は`AWS_VAULT`env varから読み取られます。 +When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. + ### オプション -| オプション | デフォルト | 説明 | -| ---------------- | ------------------------------------------------ | ----------------------------- | -| `format` | `'on [$symbol$profile(\($region\))]($style) '` | moduleのフォーマットです。 | -| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | -| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `disabled` | `false` | `aws`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ---------------- | --------------------------------------------------- | ----------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | moduleのフォーマットです。 | +| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | +| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | `aws`モジュールを無効にします。 | ### 変数 @@ -257,7 +260,7 @@ $character""" | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -267,7 +270,7 @@ $character""" # ~/.config/starship.toml [aws] -format = 'on [$symbol$profile(\($region\))]($style) ' +format = 'on [$symbol($profile )(\($region\) )]($style)' style = "bold blue" symbol = "🅰 " [aws.region_aliases] @@ -302,7 +305,7 @@ symbol = "🅰 " ## バッテリー -`battery`モジュールは、デバイスのバッテリー残量と現在の充電状態を示します。 モジュールは、デバイスのバッテリー残量が10％未満の場合にのみ表示されます。 +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%. ### オプション @@ -331,7 +334,7 @@ discharging_symbol = "💀" ### バッテリーの表示 -`display` オプションを使用して、バッテリーインジケーターを表示するタイミング（閾値）と外観（スタイル）を定義します。 `display` が提供されない場合、 デフォルトは次のとおりです。 +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. デフォルトは次のとおりです。 ```toml [[battery.display]] @@ -341,7 +344,7 @@ style = "bold red" #### オプション -`display`オプションは、次の表の通りです。 +The `display` option is an array of the following table. | オプション | 説明 | | ----------- | ------------------------------ | @@ -365,14 +368,14 @@ style = "bold yellow" ## 文字 -`character`モジュールは、端末でテキストが入力される場所の横に文字（通常は矢印）を表示します。 +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -文字は、最後のコマンドが成功したかどうかを示します。 表し方は下記の2つです。 +The character will tell you whether the last command was successful or not. It can do this in two ways: - 色の変更 (`赤`/`緑`) - プロンプトの表示の変更 (`❯`/`✖`) -デフォルトでは、色だけが変更されます。 If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -435,7 +438,7 @@ The `cmake` module shows the currently installed version of CMake. By default th | オプション | デフォルト | 説明 | | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | 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 | @@ -450,19 +453,19 @@ The `cmake` module shows the currently installed version of CMake. By default th | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ## コマンド実行時間 -`cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。 モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。 +The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning BashでDEBUGトラップをhookしない +::: warning Do not hook the DEBUG trap in Bash -`bash`でStarshipを実行している場合、 `eval $(starship init $0)`実行した後に`DEBUG`トラップをフックしないでください。そうしないと、このモジュールが**おそらくですが**壊れます。 +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -preexecのような機能を必要とするBashユーザーは、 [rcalorasのbash_preexecフレームワーク](https://github.com/rcaloras/bash-preexec)を使用できます。 `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定義するだけで、通常どおり続行します。 +Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### オプション @@ -489,7 +492,7 @@ Showing desktop notifications requires starship to be built with `rust-notify` s | duration | `16m40s` | コマンドの実行時間 | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -503,11 +506,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -`$CONDA_DEFAULT_ENV`が設定されている場合、`conda`モジュールは現在のcondaの環境を表示します。 +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -Note: これはconda自身の プロンプト修飾子 を抑制しません。`conda config --set changeps1 False` で実行することができます。 +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -530,7 +533,7 @@ Note: これはconda自身の プロンプト修飾子 を抑制しません。` | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -543,7 +546,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -`crystal`モジュールには、現在インストールされているCrystalのバージョンが表示されます。 By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: - カレントディレクトリに`shard.yml`ファイルが含まれている - カレントディレクトリに`.cr`の拡張子のファイルが含まれている @@ -568,7 +571,7 @@ format = "[$symbol$environment](dimmed green) " | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -607,7 +610,7 @@ The `dart` module shows the currently installed version of Dart. By default the | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -620,11 +623,11 @@ format = "via [🔰 $version](bold red) " ## ディレクトリ -`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。 ディレクトリは、現在のgitリポジトリであるとルートとなります。 +The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. -fishスタイルのpwdオプションを使用すると、切り捨てられたパスを非表示にする代わりに、オプションで有効にした番号に基づいて各ディレクトリの短縮名が表示されます。 +When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. -例として、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合を挙げます。 以前は`nixpkgs/pkgs`でしたが、`~/D/N/nixpkgs/pkgs`が表示されます。 +For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### オプション @@ -641,7 +644,7 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた | `home_symbol` | `"~"` | The symbol indicating home directory. |
-このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。 +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | デフォルト | 説明 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -668,7 +671,7 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた | path | `"D:/Projects"` | The current directory path | | style\* | `"black bold dimmed"` | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -682,7 +685,7 @@ truncation_symbol = "…/" ## Docker Context -`docker_context`モジュールは、 [Dockerコンテキスト](https://docs.docker.com/engine/context/working-with-contexts/)が`デフォルト`に設定されていない場合、現在アクティブな <1>Dockerコンテキストを表示します。 +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`. ### オプション @@ -705,7 +708,7 @@ truncation_symbol = "…/" | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -718,7 +721,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -`dotnet` モジュールはカレントディレクトリに関係する.NET Core SDKのバージョンを表示します。 もし SDKは現在のディレクトリに固定されているのであれば、その固定されたバージョンが表示されます。 それ以外の場合、モジュール SDKの最新のインストールバージョンを示します。 +The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -734,7 +737,7 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 `dotnet --version` を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションで`heuristic = false `を設定します。 +Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. @@ -760,7 +763,7 @@ The module will also show the Target Framework Moniker (モジュールは、現在のシステムメモリとスワップ使用量を示します。

+The `memory_usage` module shows current system memory and swap usage. -

デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。

+By default the swap usage is displayed if the total system swap is non-zero. -

::: tip

+::: tip -

このモジュールはデフォルトで無効になっています。 -有効にするには、設定ファイルでdisabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1611,7 +1619,7 @@ style = "bold dimmed green" ## Mercurial ブランチ -` hg_branch `モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを示します。 +The `hg_branch` module shows the active branch of the repo in your current directory. ### オプション @@ -1632,7 +1640,7 @@ style = "bold dimmed green" | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -1674,7 +1682,7 @@ The `nim` module shows the currently installed version of Nim. By default the mo | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -1688,7 +1696,7 @@ symbol = "🎣 " ## Nix-shell -`nix_shell`モジュールは、nix-shell環境を示しています。 このモジュールは、nixシェル環境内にあるときに表示されます。 +The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. ### オプション @@ -1710,7 +1718,7 @@ symbol = "🎣 " | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -1726,7 +1734,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## NodeJS -`nodejs`モジュールは、現在インストールされているNodeJSのバージョンを示します。 By default the module will be shown if any of the following conditions are met: +The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met: - カレントディレクトリに`package.json`ファイルが含まれている - The current directory contains a `.node-version` file @@ -1739,7 +1747,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | 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. | @@ -1755,7 +1763,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -1797,7 +1805,7 @@ The `ocaml` module shows the currently installed version of OCaml. By default th | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -1830,7 +1838,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -1845,7 +1853,7 @@ symbol = "☁️ " ## パッケージのバージョン -`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. - **npm** – `npm`パッケージバージョンは、現在のディレクトリにある`package.json`から抽出されます - **cargo** – `cargo`パッケージバージョンは、現在のディレクトリにある`Cargo.toml`から抽出されます。 @@ -1878,7 +1886,7 @@ symbol = "☁️ " | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -1930,7 +1938,7 @@ format = "via [🦪 $version]($style) " ## PHP -`php`モジュールは、現在インストールされているPHPのバージョンを示します。 By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: - カレントディレクトリに`composer.json`ファイルが含まれている - The current directory contains a `.php-version` file @@ -1956,7 +1964,7 @@ format = "via [🦪 $version]($style) " | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -1994,7 +2002,7 @@ The `purescript` module shows the currently installed version of PureScript vers | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2007,7 +2015,7 @@ format = "via [$symbol$version](bold white)" ## Python -`python` モジュールは現在インストールされているPythonのバージョンと アクティブ化されている場合は現在のPython仮想環境を表示します。 +The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2085,7 +2093,7 @@ detect_extensions = [] ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. 次の条件のいずれかが満たされると、モジュールが表示されます。 +By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: - カレントディレクトリに`Gemfile`ファイルが含まれている - The current directory contains a `.ruby-version` file @@ -2111,7 +2119,7 @@ By default the `ruby` module shows the currently installed version of Ruby. 次 | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2124,7 +2132,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. 次の条件のいずれかが満たされると、モジュールが表示されます。 +By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: - カレントディレクトリに`Cargo.toml`ファイルが含まれている - カレントディレクトリに`.rs`の拡張子のファイルが含まれている @@ -2149,7 +2157,7 @@ By default the `rust` module shows the currently installed version of Rust. 次 | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2160,13 +2168,55 @@ By default the `rust` module shows the currently installed version of Rust. 次 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` + +### オプション + + +| オプション | デフォルト | 説明 | +| ------------------- | ---------------------------------------- | ------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | 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"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `scala` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | -------- | ---------------------- | +| version | `2.13.5` | The version of `scala` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +\*: This variable can only be used as a part of a style string + +### 設定例 + +```toml +# ~/.config/starship.toml + +[scala] +symbol = "🌟 " +``` + + ## Shell The `shell` module shows an indicator for currently used shell. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2180,6 +2230,7 @@ The `shell` module shows an indicator for currently used shell. | `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` | moduleのフォーマットです。 | | `disabled` | `true` | Disables the `shell` module. | @@ -2222,7 +2273,7 @@ The `shlvl` module shows the current SHLVL ("shell level") environment variable, | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2256,7 +2307,7 @@ The `singularity` module shows the current singularity image, if inside a contai | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2273,7 +2324,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2307,7 +2358,7 @@ The `status` module displays the exit code of the previous command. The module w | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2326,7 +2377,7 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. 次の条件のいずれかが満たされると、モジュールが表示されます。 +By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension @@ -2351,7 +2402,7 @@ By default the `swift` module shows the currently installed version of Swift. | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2374,7 +2425,7 @@ By default the terraform version is not shown, since this is slow for current ve By default the module will be shown if any of the following conditions are met: -- カレントディレクトリに`.terraform`フォルダが含まれている +- The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf` or `.hcl` extensions ### オプション @@ -2398,7 +2449,7 @@ By default the module will be shown if any of the following conditions are met: | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2426,7 +2477,7 @@ The `time` module shows the current **local** time. The `format` configuration v ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2451,7 +2502,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de | time | `13:08:10` | The current time. | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2468,12 +2519,12 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- カレントユーザーがroot -- カレントユーザーが、ログインしているユーザーとは異なる -- ユーザーがSSHセッションとして接続されている -- `show_always`変数がtrueに設定されている +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: tip @@ -2537,7 +2588,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2550,7 +2601,7 @@ format = "via [⍱ $version](bold white) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. 次の条件のいずれかが満たされると、モジュールが表示されます。 +By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file @@ -2574,7 +2625,7 @@ By default the the `zig` module shows the currently installed version of Zig. | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string ### 設定例 @@ -2638,7 +2689,7 @@ The order in which custom modules are shown can be individually set by including | symbol | オプション `記号` の値をミラーする | | style\* | オプション `style` の値をミラーする | -\*: この変数はスタイル文字列の一部としてのみ使用できます +\*: This variable can only be used as a part of a style string #### Custom command shell diff --git a/docs/ja-JP/faq/README.md b/docs/ja-JP/faq/README.md index 724033310..aafcc372d 100644 --- a/docs/ja-JP/faq/README.md +++ b/docs/ja-JP/faq/README.md @@ -10,22 +10,22 @@ - **設定**: [matchaiのDotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **プロンプト**: [Starship](https://starship.rs/) -## How do I get command completion as shown in the demo GIF? +## デモのGIFのようにコマンド補完はどうしたら使用できますか？ -Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions). +補完サポート、または自動補完は選択したシェルによって提供されます。 デモ中では、デフォルトの[Fish Shell](https://fishshell.com/)によって補完されています。 Z Shell (zsh) を利用しているのであれば、[zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)を照参してください。 -## Do top level `format` and `.disabled` do the same thing? +## トップレベルの`format`と`.disabled`は同じように動作しますか？ はい、両方ともプロンプトでモジュールを無効にするために使用できます。 モジュールを無効にするだけの場合は、これらの理由から` .disabled `を無効にする方法をお勧めします。 -- Disabling modules is more explicit than omitting them from the top level `format` +- モジュールを無効化することは、トップレベルの`format`を削除するよりも明示的です。 - Starshipが更新されると、新しく作成されたモジュールがプロンプトに追加されます -## The docs say Starship is cross-shell. Why isn't my preferred shell supported? +## Starshipはcross-shellとのことです。 私の好みのshellはサポートしていないようですが。 Starshipの構築方法は、事実上すべてのシェルのサポートを追加できるはずです。 Starshipのバイナリはステートレスであり、シェルに依存しないため、シェルがプロンプトのカスタマイズとシェルの拡張をサポートしている限り、Starshipを使用できます。 -Starshipをbashで動作させる小さな例を次に示します。 +Starshipをbashで動作させる例を次に示します。 ```sh # Get the status code from the last command executed @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -Starshipに組み込まれた[Bashの実装](https://github.com/starship/starship/blob/master/src/init/starship.bash)は、[ Command Durationモジュール](https://starship.rs/config/#Command-Duration)などの高度な機能を可能にし、Starshipが事前にインストールされたBash構成と互換性があるようにするため、少し複雑です。 +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. `Starshipのプロンプト`で受け入れられるすべてのフラグのリストは、次のコマンドを取得できます。 @@ -50,43 +50,47 @@ starship prompt --help ## 古いバージョンの glibc を使用する Linux ディストリビューションで Starship を実行するにはどうすればよいですか? -"_version 'GLIBC_2のようなエラーが表示された場合。 8' が見つかりません (starshipで要求されます)_" プリビルドバイナリを使用しています（例えば、 CentOS 6 または 7 では、`glibc`の代わりに`musl`でコンパイルされたバイナリを使用できます。 +CentOS6や7などで事前にビルドされたバイナリを使用していて、"_version 'GLIBC_2.18' not found (required by starship)_" のようなエラーが出た場合、`glibc`の替わりに `musl`でコンパイルされたバイナリを使用できます。 ```sh curl -fsSL https://starship.rs/install.sh | bash -s --- -platform unknown-linux-musl ``` -## プロンプトにグリフ記号が表示されないのはなぜですか? +## よくわからない記号を見つけました。これはどういった意味ですか？ -これの最も一般的な原因は、システムの設定ミスです。 いくつかのLinuxディストリビューション 特に、すぐに使用できるフォントサポートは付属していません。 次のことを確認する必要があります。 +不明な記号に遭遇した場合、`starship explain` を使用することで、現在表示しているモジュールの説明を見ることができます。 -- ロケールは、`de_DE.UTF-8`や` ja_JP.UTF-8などのUTF-8値に設定されています。 LC_ALL`がUTF-8値でない場合、[変更する必要があります](https://www.tecmint.com/set-system-locales-in-linux/)。 -- 絵文字フォントがインストールされています。 ほとんどのシステムにはデフォルトで絵文字フォントが付属していますが、 一部(特にArch Linux) はそうではありません。 通常、システムの パッケージマネージャーからインストールすることができます--[noto emoji](https://www.google.com/get/noto/help/emoji/)は人気な選択肢です。 -- [Nerd Font](https://www.nerdfonts.com/)を使用しています。 +## 私のプロンプトで記号のグリフがないのはなぜですか？ -システムをテストするには、ターミナルで次のコマンドを実行します。 +よくある原因はシステム上での設定ミスです。 いくつかのLinuxディストリビューションの初期設定にフォントサポートがありません。 次のことを確認してください。 + +- ロケールが、`de_DE.UTF-8`や` ja_JP.UTF-8`などのUTF-8に設定されている。 `LC_ALL`がUTF-8でない場合、[変更する必要があります](https://www.tecmint.com/set-system-locales-in-linux/)。 +- 絵文字フォントがインストールされている。 ほとんどのシステムにはデフォルトで絵文字フォントが付属していますが、 一部 (特にArch Linux) はそうではありません。 通常、システムの パッケージマネージャーからインストールすることができます。--[noto emoji](https://www.google.com/get/noto/help/emoji/)は一般的な選択肢です。 +- [Nerd Font](https://www.nerdfonts.com/)を使用している。 + +ターミナルで以下のコマンドを実行することでテストできます。 ```sh echo -e "\xf0\x9f\x90\x8d" echo -e "\xee\x82\xa0" ``` -1行目は[snake emoji](https://emojipedia.org/snake/)を生成し、2行目は[powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs)を生成するはずです。 +一行目は[蛇の絵文字](https://emojipedia.org/snake/)、二行目は[powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs)が表示されるはずです。 -いずれかのシンボルが正しく表示されない場合でも、システムの設定が間違っています。 残念ながら、フォント設定を正しくするのは難しい場合があります。 Discordのユーザーがお役に立てるかもしれません。 両方の記号が正しく表示されているにもかかわらず、まだStarshipに表示されていない場合は、[バグ報告をしてください!](https://github.com/starship/starship/issues/new/choose) +もし、どちらの記号とも正しく表示されない場合は、システムの設定が間違っています。 不幸にも、正しくフォントを設定するのは難しいものです。 Discordのユーザーが助けてくれるかもしれません！ もし記号が正しく表示されているのにもかかわらず、Starshipが正しく表示されていない場合は、[バグの報告](https://github.com/starship/starship/issues/new/choose)をお願いします。 -## Starshipをアンインストールするにはどうすればいいですか? +## Starshipをアンインストールしたい -Starshipは、最初の場所にインストールするのと同じくらい簡単にアンインストールできます。 +Starshipのアンインストールはインストールと同じぐらい簡単です。 -1. Starshipを初期化するために使用されるシェル設定の行を削除します(例:`~/.bashrc`)。 +1. Starshipを初期化するために使用した、シェルの設定行を削除します (例:`~/.bashrc`)。 1. Starshipのバイナリを削除します。 -Starship がパッケージマネージャを使用してインストールされている場合は、アンインストール手順については、そのドキュメントを参照してください。 +パッケージマネージャーを使用してStarshipをインストールした場合は、パッケージマネージャーのアンインストールガイドを参照してください。 -Starship が `curl | bash` スクリプトを使用してインストールされた場合、次のコマンドはバイナリを削除します: +`curl | bash` スクリプトを使用してStarshipをインストールした場合は、以下のコマンドでバイナリを削除してください。 ```sh -# starshipバイナリを見つけて削除します +# starshipバイナリを見つけて削除 rm "$(which starship)" ``` diff --git a/docs/ja-JP/guide/README.md b/docs/ja-JP/guide/README.md index 7643e0567..751c8f541 100644 --- a/docs/ja-JP/guide/README.md +++ b/docs/ja-JP/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" + /> **シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです！** @@ -132,7 +147,7 @@ ### 入門 -**Note**: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the [extra platform instructions](https://starship.rs/installing/). +**注意**: さまざまなプラットフォームが急増しているため、ここでは対応プラットフォームの一部だけを挙げています。 自分が使っているシェルがありませんか？ [extra platform instructions](https://starship.rs/installing/) を確認してください。 1. **Starship** のバイナリをインストール @@ -150,7 +165,7 @@ #### パッケージマネージャー経由でインストール - ##### Example: [Homebrew](https://brew.sh/): + ##### 例: [Homebrew の場合](https://brew.sh/): ```sh brew install starship @@ -201,7 +216,7 @@ #### PowerShell - Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. + `Microsoft.PowerShell_profile.ps1` の最後に以下を追記してください。 PowerShell 上で `$PROFILE` 変数を問い合わせると、ファイルの場所を確認できます。 通常、パスは `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` または -Nix 上では `~/.config/powershell/Microsoft.PowerShell_profile.ps1` です。 ```powershell Invoke-Expression (&starship init powershell) @@ -221,7 +236,7 @@ #### Elvish - **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + **警告** elvish v0.15 以上のみがサポートされています。 `~/.elvish/rc.elv` の最後に以下を追記してください。 ```sh # ~/.elvish/rc.elv @@ -229,11 +244,22 @@ eval (starship init elvish) ``` + + #### Tcsh + + `~/.tcshrc` の最後に以下を追加します: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 貢献 私たちは常に**すべてのスキルレベル**の貢献者を探しています！ もし簡単にプロジェクトへ参加する方法をお探しなら、 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) に取り組んでみてください。 -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +あなたが英語以外の言語に堪能な場合、ドキュメントの翻訳と更新に協力していただけると嬉しいです。 協力してくれる場合、翻訳は [Starship Crowdin](https://translate.starship.rs/) から貢献できます。 もしあなたが Starship への貢献に興味がある場合は、我々の[貢献ガイド](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)をご覧ください。 また、気軽に我々の[Discord サーバー](https://discord.gg/8Jzqu3T)へ顔を出してください。 👋 diff --git a/docs/ja-JP/installing/README.md b/docs/ja-JP/installing/README.md index c8487ef46..df63b3c93 100644 --- a/docs/ja-JP/installing/README.md +++ b/docs/ja-JP/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! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### 必要なもの + +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) + +### 必要なもの + ```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/ja-JP/presets/README.md b/docs/ja-JP/presets/README.md index 4861c7f9a..fe55b21cf 100644 --- a/docs/ja-JP/presets/README.md +++ b/docs/ja-JP/presets/README.md @@ -16,7 +16,7 @@ ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/ko-KR/README.md b/docs/ko-KR/README.md index ee4bc3eea..e7ba257f9 100644 --- a/docs/ko-KR/README.md +++ b/docs/ko-KR/README.md @@ -28,7 +28,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
-### Quick Install +### 빠른 설치 1. **starship** 바이러니 설치: @@ -42,9 +42,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ``` - #### Install via Package Manager + #### 패키지 매니저를 이용한 설치 - With [Homebrew](https://brew.sh/): + [Homebrew](https://brew.sh/)를 통한 설치: ```sh brew install starship @@ -56,12 +56,12 @@ description: Starship is the minimal, blazing fast, and extremely customizable p scoop install starship ``` -1. Add the init script to your shell's config file: +1. 쉘 설정에 시동 스크립트를 추가: #### Bash - Add the following to the end of `~/.bashrc`: + `~/.bashrc`에 아래 라인을 추가 ```sh # ~/.bashrc @@ -72,7 +72,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Fish - Add the following to the end of `~/.config/fish/config.fish`: + `~/.config/fish/config.fish`에 아래 라인을 추가 ```sh # ~/.config/fish/config.fish @@ -83,7 +83,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Zsh - Add the following to the end of `~/.zshrc`: + `~/.zshrc`에 아래 라인을 추가 ```sh # ~/.zshrc @@ -94,7 +94,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Powershell - Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. + `Microsoft.PowerShell_profile.ps1`의 끝부분에 아래 내용을 추가. 해당 설정파일은 파워쉘에서 `$PROFILE` 변수 확인을 통해 확인 가능. 일반적으로 해당 파일은 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 혹은 -Nix의 경우 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`에 위치. ```sh Invoke-Expression (&starship init powershell) @@ -103,7 +103,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Ion - Add the following to the end of `~/.config/ion/initrc`: + 아래의 라인을 `~/.config/ion/initrc` 마지막에 추가: ```sh # ~/.config/ion/initrc @@ -113,9 +113,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning Only elvish v0.15 or higher is supported. ::: + ::: 주의 elvish v0.15 이상만 지원. ::: - Add the following to the end of `~/.elvish/rc.elv`: + 아래의 라인을 `~/.elvish/rc.elv` 마지막에 추가: ```sh # ~/.elvish/rc.elv @@ -123,3 +123,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval (starship init elvish) ``` + + #### Tcsh + + 아래의 라인을 `~/.tcshrc` 마지막에 추가: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md index 6484c7d5b..3a9111cd6 100644 --- a/docs/ko-KR/config/README.md +++ b/docs/ko-KR/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/ko-KR/faq/README.md b/docs/ko-KR/faq/README.md index 9bb23bf93..d3c6d238c 100644 --- a/docs/ko-KR/faq/README.md +++ b/docs/ko-KR/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/ko-KR/guide/README.md b/docs/ko-KR/guide/README.md index 1bf1dfdd4..2e0f87469 100644 --- a/docs/ko-KR/guide/README.md +++ b/docs/ko-KR/guide/README.md @@ -2,18 +2,21 @@ Starship – Cross-shell prompt + alt="Starship – Cross-shell prompt" + />

깃헙 액션 워크풀로 상태 + alt="깃헙 액션 워크풀로 상태" + /> Crates.io 버전 + alt="Crates.io 버전" + /> 디스코드에 채팅을 하세요 + alt="디스코드에 채팅을 하세요" + /> 트위터에서 @StarshipPrompt를 팔로우 하세요 + alt="트위터에서 @StarshipPrompt를 팔로우 하세요" + />

@@ -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!** @@ -201,7 +216,7 @@ #### 파워셀 - Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. + `Microsoft.PowerShell_profile.ps1`의 끝부분에 아래 내용을 추가. 해당 설정파일은 파워쉘에서 `$PROFILE` 변수 확인을 통해 확인 가능. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. ```powershell Invoke-Expression (&starship init powershell) @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 기여 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/ko-KR/installing/README.md b/docs/ko-KR/installing/README.md index 52c0ac4c3..73b998f7c 100644 --- a/docs/ko-KR/installing/README.md +++ b/docs/ko-KR/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! -## [termux](https://termux.com) + +## [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/ko-KR/presets/README.md b/docs/ko-KR/presets/README.md index 746364fa2..c4b2f7ca8 100644 --- a/docs/ko-KR/presets/README.md +++ b/docs/ko-KR/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/nl-NL/README.md b/docs/nl-NL/README.md index 5887681e3..eb5b35ff2 100644 --- a/docs/nl-NL/README.md +++ b/docs/nl-NL/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/nl-NL/config/README.md b/docs/nl-NL/config/README.md index 6484c7d5b..3a9111cd6 100644 --- a/docs/nl-NL/config/README.md +++ b/docs/nl-NL/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/nl-NL/faq/README.md b/docs/nl-NL/faq/README.md index 9bb23bf93..d3c6d238c 100644 --- a/docs/nl-NL/faq/README.md +++ b/docs/nl-NL/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/nl-NL/guide/README.md b/docs/nl-NL/guide/README.md index 445e3027c..fd107ff3c 100644 --- a/docs/nl-NL/guide/README.md +++ b/docs/nl-NL/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/nl-NL/installing/README.md b/docs/nl-NL/installing/README.md index 52c0ac4c3..73b998f7c 100644 --- a/docs/nl-NL/installing/README.md +++ b/docs/nl-NL/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! -## [termux](https://termux.com) + +## [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/nl-NL/presets/README.md b/docs/nl-NL/presets/README.md index 746364fa2..c4b2f7ca8 100644 --- a/docs/nl-NL/presets/README.md +++ b/docs/nl-NL/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/pl-PL/README.md b/docs/pl-PL/README.md index 5887681e3..eb5b35ff2 100644 --- a/docs/pl-PL/README.md +++ b/docs/pl-PL/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/pl-PL/config/README.md b/docs/pl-PL/config/README.md index 6484c7d5b..3a9111cd6 100644 --- a/docs/pl-PL/config/README.md +++ b/docs/pl-PL/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/pl-PL/faq/README.md b/docs/pl-PL/faq/README.md index 9bb23bf93..d3c6d238c 100644 --- a/docs/pl-PL/faq/README.md +++ b/docs/pl-PL/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/pl-PL/guide/README.md b/docs/pl-PL/guide/README.md index 445e3027c..fd107ff3c 100644 --- a/docs/pl-PL/guide/README.md +++ b/docs/pl-PL/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/pl-PL/installing/README.md b/docs/pl-PL/installing/README.md index 52c0ac4c3..73b998f7c 100644 --- a/docs/pl-PL/installing/README.md +++ b/docs/pl-PL/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! -## [termux](https://termux.com) + +## [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/pl-PL/presets/README.md b/docs/pl-PL/presets/README.md index 746364fa2..c4b2f7ca8 100644 --- a/docs/pl-PL/presets/README.md +++ b/docs/pl-PL/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/pt-BR/README.md b/docs/pt-BR/README.md index 6714e8244..db241bf53 100644 --- a/docs/pt-BR/README.md +++ b/docs/pt-BR/README.md @@ -123,3 +123,14 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md index b3f3ae777..cec739eb2 100644 --- a/docs/pt-BR/config/README.md +++ b/docs/pt-BR/config/README.md @@ -9,8 +9,8 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml): ```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. #### Estilo dos textos @@ -142,11 +142,11 @@ This is the list of prompt-wide configuration options. ### Opções -| Option | Padrão | Descrição | -| -------------- | ------------------------------ | ------------------------------------------------------------- | -| `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` | Adiciona uma nova linha antes que o prompt de comando inicie. | +| Option | Padrão | Descrição | +| -------------- | ------------------------------ | ----------------------------------------------------- | +| `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` | Inserts blank line between shell prompts. | ### Exemplo @@ -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. + ### Opções -| Option | Padrão | Descrição | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `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"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Padrão | Descrição | +| ---------------- | --------------------------------------------------- | --------------------------------------------------------------- | +| `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"` | O estilo do módulo. | +| `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 | Padrão | Descrição | | ------------------- | -------------------------------------- | -------------------------------------------- | | `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 | @@ -455,7 +458,7 @@ The `cmake` module shows the currently installed version of CMake. By default th The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Não utilize o DEBUG-trap no Bash +::: warning Do not hook the DEBUG trap in Bash If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. @@ -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. + +::: + ### Opções | Option | Padrão | Descrição | @@ -1737,7 +1746,7 @@ The `nodejs` module shows the currently installed version of NodeJS. By default | Option | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `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` + +### Opções + + +| Option | Padrão | Descrição | +| ------------------- | ---------------------------------------- | ------------------------------------------------- | +| `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"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `scala` module. | + +### Variables + +| Variável | Exemplo | Descrição | +| --------- | -------- | ------------------------------------ | +| 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 + +### Exemplo + +```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/pt-BR/faq/README.md b/docs/pt-BR/faq/README.md index 9bb23bf93..d3c6d238c 100644 --- a/docs/pt-BR/faq/README.md +++ b/docs/pt-BR/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/pt-BR/guide/README.md b/docs/pt-BR/guide/README.md index 10b243e17..8f27af993 100644 --- a/docs/pt-BR/guide/README.md +++ b/docs/pt-BR/guide/README.md @@ -2,18 +2,21 @@ Starship – Cross-shell prompt + alt="Starship – Cross-shell prompt" + />

Status do workflow Actions do GitHub + alt="Status do workflow Actions do GitHub" + /> Versão no Crates.io + alt="Versão no Crates.io" + /> Chat no Discord + alt="Chat no Discord" + /> Siga o @StarshipPrompt no Twitter + alt="Siga o @StarshipPrompt no 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 com iTerm2 e o tema Snazzy" width="50%" - align="right" /> + align="right" + /> **O prompt minimalista, extremamente rápido e infinitamente personalizável para qualquer shell!** @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 Contribuindo Nós estamos sempre procurando contribuidores de **todos os níveis de conhecimento**! Se você está buscando um caminho mais fácil para começar no projeto, veja essas [boas issues para começar](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/pt-BR/installing/README.md b/docs/pt-BR/installing/README.md index 4eee793c4..46fe5891d 100644 --- a/docs/pt-BR/installing/README.md +++ b/docs/pt-BR/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! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### Pré-requisitos + +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) + +### Pré-requisitos + ```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/pt-BR/presets/README.md b/docs/pt-BR/presets/README.md index 80a18c3d8..2de5bb9b0 100644 --- a/docs/pt-BR/presets/README.md +++ b/docs/pt-BR/presets/README.md @@ -16,7 +16,7 @@ Essa predefinição não altera nada exceto os símbolos usados para cada módul ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/pt-PT/README.md b/docs/pt-PT/README.md index 5887681e3..eb5b35ff2 100644 --- a/docs/pt-PT/README.md +++ b/docs/pt-PT/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/pt-PT/config/README.md b/docs/pt-PT/config/README.md index 6484c7d5b..3a9111cd6 100644 --- a/docs/pt-PT/config/README.md +++ b/docs/pt-PT/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/pt-PT/faq/README.md b/docs/pt-PT/faq/README.md index 9bb23bf93..d3c6d238c 100644 --- a/docs/pt-PT/faq/README.md +++ b/docs/pt-PT/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/pt-PT/guide/README.md b/docs/pt-PT/guide/README.md index 445e3027c..fd107ff3c 100644 --- a/docs/pt-PT/guide/README.md +++ b/docs/pt-PT/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/pt-PT/installing/README.md b/docs/pt-PT/installing/README.md index 52c0ac4c3..73b998f7c 100644 --- a/docs/pt-PT/installing/README.md +++ b/docs/pt-PT/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! -## [termux](https://termux.com) + +## [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/pt-PT/presets/README.md b/docs/pt-PT/presets/README.md index 746364fa2..c4b2f7ca8 100644 --- a/docs/pt-PT/presets/README.md +++ b/docs/pt-PT/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/ru-RU/README.md b/docs/ru-RU/README.md index 9b008285d..f4c4b6f4d 100644 --- a/docs/ru-RU/README.md +++ b/docs/ru-RU/README.md @@ -123,3 +123,14 @@ description: Starship - минимальная, быстрая и бесконе eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index becf3a4ab..f5578a009 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -9,14 +9,14 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Вся конфигурация Starship выполняется в этом файле [TOML](https://github.com/toml-lang/toml): ```toml -# Не добавлять пустую строку в начале ввода -add_newline = false +# Inserts a blank line between shell prompts +add_newline = true -# Поменять символ "❯" на символ "➜" -[character] # Имя настраемого модуля - "character" -symbol = "➜" # Сегменту "symbol" присваеваем значение "➜" +# Replace the "❯" symbol in the prompt with "➜" +[character] # The name of the module we are configuring is "character" +success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" -# Отключить модуль пакетов, полностью скрывая его из терминала +# Disable the package module, hiding it from the prompt completely [package] disabled = true ``` @@ -80,7 +80,7 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" Например: - `[on](red bold)` будет печатать строку `on` жирным текстом красного цвета. -- `[⬢ $version](bold 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)` будет печатать `a b c` с `b` красного и `a` и `c` зеленого цвета соответсвенно. #### Строки стиля @@ -142,11 +142,11 @@ format = ''' ### Опции -| Параметр | По умолчанию | Описание | -| -------------- | -------------------------------- | -------------------------------------------------------- | -| `format` | [ссылка](#default-prompt-format) | Настройка форматирования оболочки. | -| `scan_timeout` | `30` | Тайм-аут запуска сканирования файлов (в миллисекундах). | -| `add_newline` | `true` | Добавление пустой строки перед началом командной строки. | +| Параметр | По умолчанию | Описание | +| -------------- | -------------------------------- | ------------------------------------------------------- | +| `format` | [ссылка](#default-prompt-format) | Настройка форматирования оболочки. | +| `scan_timeout` | `30` | Тайм-аут запуска сканирования файлов (в миллисекундах). | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### Пример @@ -162,7 +162,7 @@ format = """ # Подождите 10 милисекунд пока starship прочитает файлы в этой директории. scan_timeout = 10 -# Выключить новую строку в начале подсказки (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 @@ $character""" При использовании [aws-vault](https://github.com/99designs/aws-vault) профиль читается из переменной среды `AWS_VAULT`. +When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. + ### Опции -| Параметр | По умолчанию | Описание | -| ---------------- | ------------------------------------------------ | -------------------------------------------------------------- | -| `format` | `'on [$symbol$profile(\($region\))]($style) '` | Формат модуля. | -| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. | -| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. | -| `style` | `"bold yellow"` | Стиль модуля. | -| `disabled` | `false` | Отключение модуля `AWS`. | +| Параметр | По умолчанию | Описание | +| ---------------- | --------------------------------------------------- | -------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | Формат модуля. | +| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. | +| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. | +| `style` | `"bold yellow"` | Стиль модуля. | +| `disabled` | `false` | Отключение модуля `AWS`. | ### Переменные @@ -256,7 +259,7 @@ $character""" | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: Эта переменная может использоваться только в качестве части строки style +\*: This variable can only be used as a part of a style string ### Примеры @@ -266,7 +269,7 @@ $character""" # ~/.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 = "🅰 " ## Батарея -Модуль `battery` показывает насколько заряжена батарея девайса и статус зарядки на данный момент. Модуль виден только, если заряд батареи устройства меньше 10%. +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%. ### Опции @@ -330,7 +333,7 @@ discharging_symbol = "💀" ### Отображение батареи -Параметр `display` используется для определения того, когда индикатор батареи должен быть показан (threshhold) и как он выглядит (style). Если `display` не предоставлено. Значение по умолчанию: +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. Значение по умолчанию: ```toml [[battery.display]] @@ -340,7 +343,7 @@ style = "bold red" #### Опции -Опция `display` представляет собой массив следующей таблицы. +The `display` option is an array of the following table. | Параметр | Описание | | ----------- | -------------------------------------------------------- | @@ -364,9 +367,9 @@ style = "bold yellow" ## Символ -Модуль `character` показывает символ (обычно, стрелка) рядом с вводимым текстом в терминале. +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -Символ показывает, была ли последняя команда успешной или нет. 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 | Параметр | По умолчанию | Описание | | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `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 | @@ -449,19 +452,19 @@ The `cmake` module shows the currently installed version of CMake. By default th | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: Эта переменная может использоваться только в качестве части строки style +\*: This variable can only be used as a part of a style string ## Длительность команды -Модуль `cmd_duration` показывает время исполнения последней команды. Модуль будет показан только, если команда заняла более двух секунд, или если задан параметр `min_time`. +The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Не подключайте ловушку DEBUG к Bash +::: warning Do not hook the DEBUG trap in Bash -Если вы испоьзуете Starship в `bash`, не подключайте ловушку `DEBUG` после запуска `eval $(starship init $0)`, иначе этот модуль сломается. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -Пользователи Bash, которым нужна функциональность, подобная preexec, могут использовать [фреймворк bash_preexec от rcaloras](https://github.com/rcaloras/bash-preexec). Просто определите массивы `preexec_functions` и `precmd_functions` перед запуском `eval $(starship init $0)`, а затем продолжайте нормально. +Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### Опции @@ -488,7 +491,7 @@ Showing desktop notifications requires starship to be built with `rust-notify` s | duration | `16m40s` | The time it took to execute the command | | style\* | | Отражает значение параметра `style` | -\*: Эта переменная может использоваться только в качестве части строки style +\*: This variable can only be used as a part of a style string ### Пример @@ -502,11 +505,11 @@ format = "underwent [$duration](bold yellow)" ## Конда -Модуль `conda` показывает текущее окружение conda, если `$CONDA_DEFAULT_ENV` присвоено значение. +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -529,7 +532,7 @@ format = "underwent [$duration](bold yellow)" | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: Эта переменная может использоваться только в качестве части строки style +\*: This variable can only be used as a part of a style string ### Пример @@ -542,7 +545,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -Модуль `crystal` показывает установленную версию Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: - Текущий каталог содержит файл `shard.yml` - Текущий каталог содержит файл `.cr` @@ -567,7 +570,7 @@ format = "[$symbol$environment](dimmed green) " | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: Эта переменная может использоваться только в качестве части строки style +\*: This variable can only be used as a part of a style string ### Пример @@ -606,7 +609,7 @@ The `dart` module shows the currently installed version of Dart. By default the | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: Эта переменная может использоваться только в качестве части строки style +\*: This variable can only be used as a part of a style string ### Пример @@ -619,11 +622,11 @@ format = "via [🔰 $version](bold red) " ## Каталог -Модуль `directory` показывает путь к вашей текущей директории, усеченной до трех родительских папок. Ваш каталог также будет отсечен до корня git репозитория, в котором вы находитесь. +The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. -При использовании стиля оболочки fish, вместо скрытия усеченного каталога, вы увидите укороченное имя каталога, зависимое от числа символов вы установите для этой опции. +When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. -Например, возьмем `~/Dev/Nix/nixpkgs/pkgs` где `nixpkgs` является корневым репозиторием, и в опции установлено `1`. Вы увидите `~/D/N/nixpkgs/pkgs`, а до этого было бы `nixpkgs/pkgs`. +For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### Опции @@ -640,7 +643,7 @@ format = "via [🔰 $version](bold red) " | `home_symbol` | `"~"` | The symbol indicating home directory. |
-Этот модуль имеет несколько расширенных опций конфигурации, которые контролируют отображение каталога. +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | По умолчанию | Описание | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -656,7 +659,7 @@ format = "via [🔰 $version](bold red) " "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` взаимодействует со стандартными параметрами усечения, которые могут сначала показаться странными: если он не равен нулю, элементы пути, который обычно усекается, вместо этого отображаются с указанным количеством символов. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -667,7 +670,7 @@ format = "via [🔰 $version](bold red) " | path | `"D:/Projects"` | The current directory path | | style\* | `"black bold dimmed"` | Отражает значение параметра `style` | -\*: Эта переменная может использоваться только в качестве части строки style +\*: This variable can only be used as a part of a style string ### Пример @@ -681,7 +684,7 @@ truncation_symbol = "…/" ## Контекст Docker -Модуль `docker_context` показывает текущий активный [контекст Docker](https://docs.docker.com/engine/context/working-with-contexts/), если он не установлен как `default`. +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`. ### Опции @@ -704,7 +707,7 @@ truncation_symbol = "…/" | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: Эта переменная может использоваться только в качестве части строки style +\*: This variable can only be used as a part of a style string ### Пример @@ -717,7 +720,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -Модуль `dotnet` показывает соответствующую версию .NET Core SDK для текущего каталога. Если SDK был закреплен в текущей директории, будет показана закрепленная версия. В противном случае модуль отображает последнюю установленную версию SDK. +The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -733,7 +736,7 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -Внутренне этот модуль использует свой собственный механизм определения версий. Обычно он в два раза быстрее, чем `dotnet --version`, но он может показывать неправильную версию, если ваш .NET проект имеет необычный формат каталога. Если точность важнее, чем скорость, вы можете отключить механизм опцией `heuristic = false` в настройках модуля. +Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. @@ -759,7 +762,7 @@ The module will also show the Target Framework Moniker ( + alt="Starship - меж-оболочная командная строка" + />

Статус GitHub Actions + alt="Статус GitHub Actions" + /> Версия Crates.io + alt="Версия Crates.io" + /> Чат в Discord + alt="Чат в Discord" + /> Подпишитесь на @StarshipPrompt в Twitter + alt="Подпишитесь на @StarshipPrompt в 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 в iTerm2 с темой Snazzy" width="50%" - align="right" /> + align="right" + /> **Минималистичная, быстрая и бесконечно настраиваемая командная строка для любой оболочки!** @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 Помощь Мы всегда ищем помощь людей **всех уровней навыков**! Если вы хотите облегчить свой путь к проекту, посмотрите хорошие первые ошибки ([first good issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)). diff --git a/docs/ru-RU/installing/README.md b/docs/ru-RU/installing/README.md index d863a445e..b8bb38e34 100644 --- a/docs/ru-RU/installing/README.md +++ b/docs/ru-RU/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! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### Требования + +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) + +### Требования + ```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/ru-RU/presets/README.md b/docs/ru-RU/presets/README.md index 57d5334ed..0611601ef 100644 --- a/docs/ru-RU/presets/README.md +++ b/docs/ru-RU/presets/README.md @@ -16,7 +16,7 @@ ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/tr-TR/README.md b/docs/tr-TR/README.md index 5887681e3..eb5b35ff2 100644 --- a/docs/tr-TR/README.md +++ b/docs/tr-TR/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/tr-TR/config/README.md b/docs/tr-TR/config/README.md index 6484c7d5b..3a9111cd6 100644 --- a/docs/tr-TR/config/README.md +++ b/docs/tr-TR/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/tr-TR/faq/README.md b/docs/tr-TR/faq/README.md index 9bb23bf93..d3c6d238c 100644 --- a/docs/tr-TR/faq/README.md +++ b/docs/tr-TR/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/tr-TR/guide/README.md b/docs/tr-TR/guide/README.md index 445e3027c..fd107ff3c 100644 --- a/docs/tr-TR/guide/README.md +++ b/docs/tr-TR/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/tr-TR/installing/README.md b/docs/tr-TR/installing/README.md index 52c0ac4c3..73b998f7c 100644 --- a/docs/tr-TR/installing/README.md +++ b/docs/tr-TR/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! -## [termux](https://termux.com) + +## [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/tr-TR/presets/README.md b/docs/tr-TR/presets/README.md index 746364fa2..c4b2f7ca8 100644 --- a/docs/tr-TR/presets/README.md +++ b/docs/tr-TR/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/vi-VN/README.md b/docs/vi-VN/README.md index 707137576..01a3a21c1 100644 --- a/docs/vi-VN/README.md +++ b/docs/vi-VN/README.md @@ -123,3 +123,14 @@ eval $(starship init ion) eval (starship init elvish) ``` + + #### Tcsh + + Thêm đoạn dưới vào cuối file `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/vi-VN/config/README.md b/docs/vi-VN/config/README.md index 148ad30d9..909fe78da 100644 --- a/docs/vi-VN/config/README.md +++ b/docs/vi-VN/config/README.md @@ -9,14 +9,14 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Tất cả cấu hình của starship đã xong trong tập tin này: [TOML](https://github.com/toml-lang/toml): ```toml -# Không in dòng mới tại điểm bắt đầu của prompt -add_newline = false +# Chèn một dòng trắng vào giữa các dấu nhắc lệnh +add_newline = true -# Thay thế kí hiệu "❯" trong prompt với "➜" -[character] # Tên module chúng ta đang cấu hình là "character" -success_symbol = "[➜](bold green)" # "success_symbol" được thiết lập là "➜" với màu "bold green" +# Thay thế biểu tượng "❯" trong dấu nhắc lệnh bằng "➜" +[character] # Tên mô đun chúng ta đang cấu hình là "character" +success_symbol = "[➜](bold green)" # đoạn "success_symbol" đươc thiết lập thành "➜" với màu "bold green" -# Vô hiệu hoá module, ẩn nó từ prompt hoàn chỉnh +#Vô hiệu mô đun package, ẩn nó hoàn toàn trong dấu nhắc lệnh [package] disabled = true ``` @@ -80,7 +80,7 @@ Phần thứ hai, cái được bao bọc trong một `()`, là một [chuỗi k Ví dụ: - `[on](red bold)` sẽ in một chuỗi `on` với chữ đậm tô màu đỏ. -- `[⬢ $version](bold green)` sẽ in một kí hiệu `⬢` theo sao bởi nội dung của biến `version`, với chữ đậm tô màu xanh lá cây. +- `[⌘ $version](bold green)` sẽ in một biểu tượng `⌘` theo sau là nội dung của biến `version`, với chữ in đậm màu xanh lá cây. - `[a [b](red) c](green)` sẽ in `a b c` với `b` màu đỏ, `a` và `c` màu xanh lá cây. #### Các chuỗi kiểu @@ -146,7 +146,7 @@ Cái này là danh sách các tuỳ chọn cho cấu hình prompt-wide. | -------------- | ------------------------------ | ------------------------------------------------------------------------ | | `format` | [link](#default-prompt-format) | Cấu hình định dạng của prompt. | | `scan_timeout` | `30` | Timeout của starship cho việc quét các tập tin (tính theo milliseconds). | -| `add_newline` | `true` | Thêm một dòng mới trước khi bắt đầu một prompt. | +| `add_newline` | `true` | Chèn dòng trắng giữa các dấu nhắc lệnh. | ### Ví dụ @@ -162,7 +162,7 @@ format = """ # Chờ 10 milliseconds để starship kiểm tra các tập tin trong đường dẫn hiện tại. scan_timeout = 10 -# Vô hiệu hoá dòng mới tại điểm bắt đầu của prompt +# Vô hiệu hóa dòng trắng tại ví trị bắt đầu của dấu nhắc lệnh add_newline = false ``` @@ -173,7 +173,7 @@ Mặc định `format` được sử dụng để định nghĩa định dạng ```toml format = "$all" -# Nó tương đương với +# Which is equivalent to format = """ $username\ $hostname\ @@ -207,6 +207,7 @@ $purescript\ $python\ $ruby\ $rust\ +$scala\ $swift\ $terraform\ $vagrant\ @@ -237,15 +238,17 @@ $character""" Khi sử dụng [aws-vault](https://github.com/99designs/aws-vault) profile được đọc từ biến môt trường `AWS_VAULT`. +When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. + ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ---------------- | ------------------------------------------------ | ---------------------------------------------------- | -| `format` | `'on [$symbol$profile(\($region\))]($style) '` | Định dạng cho module. | -| `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. | -| `region_aliases` | | Bảng của các region alias để hiển thị ngoài tên AWS. | -| `style` | `"bold yellow"` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `AWS` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ---------------- | --------------------------------------------------- | ---------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | Định dạng cho module. | +| `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. | +| `region_aliases` | | Bảng của các region alias để hiển thị ngoài tên AWS. | +| `style` | `"bold yellow"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu `AWS` module. | ### Các biến @@ -256,7 +259,7 @@ Khi sử dụng [aws-vault](https://github.com/99designs/aws-vault) profile đư | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: Biến này có thể chỉ được sử dụng như một phần của style string +\*: This variable can only be used as a part of a style string ### Các vị dụ @@ -266,7 +269,7 @@ Khi sử dụng [aws-vault](https://github.com/99designs/aws-vault) profile đư # ~/.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 = "🅰 " ## Battery -`battery` module cho biết cách sạc pin của thiết bị là gì và tình trạng sạc hiện tại của nó. Module chỉ được nhìn thấy khi pin của thiết bị dưới 10%. +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%. ### Các tuỳ chọn @@ -330,7 +333,7 @@ discharging_symbol = "💀" ### Hiển thị pin -Tuỳ chọn cấu hình `display` được sử dụng để định nghĩa khi nào pin nên cho biết (threshold) và nó trông như thế nào (style). Nếu `display` không được cung cấp. Mặc định như sau: +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. Mặc định như sau: ```toml [[battery.display]] @@ -340,11 +343,11 @@ style = "bold red" #### Các tuỳ chọn -Tuỳ chọn `display` là một mảng của của bảng sau. +The `display` option is an array of the following table. | Tuỳ chọn | Mô tả | | ----------- | ---------------------------------------------------------- | -| `threshold` | Cận trên của tuỳ chọn hiển thị. | +| `threshold` | Cận trên cho tuỳ chọn hiển thị. | | `style` | Kiểu sử dụng nếu tuỳ chọn hiển thị được sử dụng bên trong. | #### Ví dụ @@ -364,16 +367,16 @@ style = "bold yellow" ## Character -Module `character` cho biết một kí tự (thường là một mũi tên) bên cạnh nơi văn bản được nhập trong terminal của bạn. +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -Kí tự sẽ nói cho bạn câu lệnh cuối liệu thành công hay thất bại. Nó có thể làm điều này bằng hai cách: +The character will tell you whether the last command was successful or not. It can do this in two ways: - thay đổi màu(`đỏ`/`xanh lá`) - thay đổi hình dạng (`❯`/`✖`) -Mặc định, nó chỉ thay đổi màu. Nếu bạn cũng muốn thay đổi hình dạng, tham khảo [ví dụ này](#with-custom-error-shape). +By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). -::: warning `error_symbol` không được hỗ trợ trên elvish shell. ::: +::: warning `error_symbol` is not supported on elvish shell. ::: ### Các tuỳ chọn @@ -387,9 +390,9 @@ Mặc định, nó chỉ thay đổi màu. Nếu bạn cũng muốn thay đổi ### Các biến -| Biến | Ví dụ | Mô tả | -| ------ | ----- | --------------------------------------------------------------------- | -| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | +| Biến | Ví dụ | Mô tả | +| ------ | ----- | ----------------------------------------------------------------------------- | +| symbol | | Một phản ánh của một trong `success_symbol`, `error_symbol` or `vicmd_symbol` | ### Các vị dụ @@ -424,7 +427,7 @@ vicmd_symbol = "[V](bold green) " ## CMake -`cmake` module cho biết phiên bản Cmake hiện tại đã được cài đặt. Mặc định module sẽ được kích hoạt nếu thoả mãn bất kì điều kiện nào dưới đây: +The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: - Đường dẫn hiện tại chứa một tập tin `CmakeLists.txt` - Đường dẫn hiện tại chứa một tập tin `CMakeCache.txt` @@ -434,7 +437,7 @@ vicmd_symbol = "[V](bold green) " | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | -------------------------------------- | -------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `symbol` | `"喝 "` | Kí hiệu sử dụng trước phiên bản của cmake. | +| `symbol` | `"△ "` | Kí hiệu sử dụng trước phiên bản của cmake. | | `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Tên tệp nào sẽ kích hoạt mô-đun này | | `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này | @@ -449,19 +452,19 @@ vicmd_symbol = "[V](bold green) " | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: Biến này có thể chỉ được sử dụng như một phần của style string +\*: This variable can only be used as a part of a style string ## Command Duration -Module `cmd_duration`. cho biết câu lệnh cuối cùng thực thi trong bao lâu. Module sẽ được hiện chỉ khi câu lệnh lấy nhiều hơn 2 giây, hoặc giá trị cấu hình `min_time`, nếu nó tồn tại. +The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: cảnh báo Không thể hook DEBUG trap trong Bash +::: warning Do not hook the DEBUG trap in Bash -Nếu bạn đang chạy Starship trong `bash`, không thể hook `DEBUG` trap sau khi chạy `eval $(starship init $0)`, hoặc module này **sẽ** ngắt. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -Người dùng Bash, những người cần chức năng giống preexec có thể sử dụng [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Đơn giản là định nghĩa các mảng `preexec_functions` và `precmd_functions` trước khi chạy `eval $(starship init $0)`, và sau đó thực thi như bình thường. +Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### Các tuỳ chọn @@ -475,9 +478,9 @@ Người dùng Bash, những người cần chức năng giống preexec có th | `show_notifications` | `false` | Hiện thông báo desktop khi câu lệnh hoàn thành. | | `min_time_to_notify` | `45_000` | Khoảng thời gian ngắn nhất để thông báo (tính bằng milliseconds). | -::: thử thuật +::: tip -Hiện thông báo desktop yêu cầu starship được built với sự hỗ trợ của `rust-notify`. Bạn kiểm tra nếu starship hỗ trợ các thông báo bằng cách chạy `STARSHIP_LOG=debug starship module cmd_duration -d 60000` khi `show_notifications` được thiết lập là `true`. +Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. ::: @@ -488,7 +491,7 @@ Hiện thông báo desktop yêu cầu starship được built với sự hỗ tr | duration | `16m40s` | Thời gian nó lấy để thực thi câu lệnh | | style\* | | Giá trị ghi đè của `style` | -\*: Biến này có thể chỉ được sử dụng như một phần của style string +\*: This variable can only be used as a part of a style string ### Ví dụ @@ -502,11 +505,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -Module `conda` cho biết môi trường conda hiện tại, nếu `$CONDA_DEFAULT_ENV` được thiết lập. +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. -::: thử thuật +::: tip -Cái này không loại bỏ conda's prompt mà nó sở hữu, bạn có thể muốn chạy `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -529,7 +532,7 @@ Cái này không loại bỏ conda's prompt mà nó sở hữu, bạn có thể | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: Biến này có thể chỉ được sử dụng như một phần của style string +\*: This variable can only be used as a part of a style string ### Ví dụ @@ -542,7 +545,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -Module `crystal` cho biết phiên bản hiện tại của Crystal được đã cài đặt. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `crystal` module shows the currently installed version of Crystal. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: - Đường dẫn hiện tại chứa một tập tin `shard.yml` - Đường dẫn hiện tại chứa một tập tin `.cr` @@ -567,7 +570,7 @@ Module `crystal` cho biết phiên bản hiện tại của Crystal được đ | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: Biến này có thể chỉ được sử dụng như một phần của style string +\*: This variable can only be used as a part of a style string ### Ví dụ @@ -580,7 +583,7 @@ format = "via [✨ $version](bold blue) " ## Dart -Module `dart` cho biết phiên bản của Dart đã cài đặt. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `dart` module shows the currently installed version of Dart. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: - Đường dẫn hiện tại chứa một tập tin với phần mở rộng `.dart` - Đường dẫn hiện tại chứa một đường dẫn `.dart_tool` @@ -606,7 +609,7 @@ Module `dart` cho biết phiên bản của Dart đã cài đặt. Mặc định | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: Biến này có thể chỉ được sử dụng như một phần của style string +\*: This variable can only be used as a part of a style string ### Ví dụ @@ -619,7 +622,7 @@ format = "via [🔰 $version](bold red) " ## Đường dẫn -`directory` module hiển thị đường dẫn thư mục hiện hành của bạn,, cắt ngắn ba thư mục cha. Đường dẫn của bạn cũng sẽ được cắt ngắn tới đường dẫn gốc của git repo hiện tại của bạn. +The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. @@ -627,22 +630,22 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Định dạng cho module. | -| `style` | `"bold cyan"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------ | +| `truncation_length` | `3` | Số lượng thư mục cha của thư mục hiện tại nên được rút gọn. | +| `truncate_to_repo` | `true` | Có hoặc không rút gọn đường dẫn gốc của git repo hiện tại của bạn. | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Định dạng cho module. | +| `style` | `"bold cyan"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `directory`. | +| `read_only` | `"🔒"` | Biểu tượng để nhận biết thư mục hiện tại là chỉ đọc. | +| `read_only_style` | `"red"` | Style cho biểu tượng chỉ đọc. | +| `truncation_symbol` | `""` | Biểu tượng tiền tố cho các đường dẫn rút gọn. ví dụ: "…/" | +| `home_symbol` | `"~"` | Biểu tượng nhận biết thư mục home. |
This module has a few advanced configuration options that control how the directory is displayed. -| Advanced Option | Mặc định | Mô tả | +| Tùy chọn nâng cao | Mặc định | Mô tả | | --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | @@ -664,10 +667,10 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Biến | Ví dụ | Mô tả | | --------- | --------------------- | -------------------------- | -| path | `"D:/Projects"` | The current directory path | +| path | `"D:/Projects"` | Đường dẫn thư mục hiện tại | | style\* | `"black bold dimmed"` | Giá trị ghi đè của `style` | -\*: Biến này có thể chỉ được sử dụng như một phần của style string +\*: This variable can only be used as a part of a style string ### Ví dụ @@ -685,26 +688,26 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$context]($style) "` | Định dạng cho module. | -| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `"blue bold"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$context]($style) "` | Định dạng cho module. | +| `symbol` | `"🐳 "` | Biểu tượng sử dụng để hiển thị trước Docker context. | +| `only_with_files` | `true` | Chỉ hiển thị khi có một tệp tin khớp | +| `detect_extensions` | `[]` | Các mở rộng nào nên kích hoạt mô đun này (cần `only_with_files` thiết lập là true). | +| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Tên tệp tin nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). | +| `detect_folders` | `[]` | Thư mục nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). | +| `style` | `"blue bold"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `docker_context`. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------------- | -------------------------------- | -| context | `test_context` | The current docker context | +| context | `test_context` | Docker context hiện tại | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: Biến này có thể chỉ được sử dụng như một phần của style string +\*: This variable can only be used as a part of a style string ### Ví dụ @@ -739,27 +742,27 @@ The module will also show the Target Framework Moniker ( + alt="Starship – Cross-shell prompt" + />

Trạng thái GitHub Actions workflow + alt="Trạng thái GitHub Actions workflow" + /> Phiên bản Crates.io + alt="Phiên bản Crates.io" + /> Trò chuyện trên Discord + alt="Trò chuyện trên Discord" + /> Theo dõi @StarshipPrompt trên Twitter + alt="Theo dõi @StarshipPrompt trên Twitter" + />

@@ -42,63 +47,72 @@ >Tiếng Anh + alt="Tiếng Anh" + />   Tiếng Nhật + alt="Tiếng Nhật" + />   Tiếng Trung hiện đại + alt="Tiếng Trung hiện đại" + />   Tiếng Nga + alt="Tiếng Nga" + />   Tiếng Đức + alt="Tiếng Đức" + />   Tiếng Trung giản thể + alt="Tiếng Trung giản thể" + />   Tiếng Tây Ban Nha + alt="Tiếng Tây Ban Nha" + />   Thiếng Pháp + alt="Thiếng Pháp" + />   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 với iTerm2 and chủ đề Snazzy" width="50%" - align="right" /> + align="right" + /> **Nhỏ gọn, cực nhanh, và khả năng tuỳ chỉnh vô hạn prompt cho bất kì shell nào!** @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Thêm đoạn sau vào cuối tệp tin `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 Đóng góp Chúng tôi luôn luôn tìm kiếm những cộng tác viên ở **tất cả các các mức độ về kĩ năng**! Nếu bạn đang tìm kiếm cách dễ dàng để tham gia vào dự án, thử một [good issue đầu tiên](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/vi-VN/installing/README.md b/docs/vi-VN/installing/README.md index 146934c8e..313644c24 100644 --- a/docs/vi-VN/installing/README.md +++ b/docs/vi-VN/installing/README.md @@ -8,13 +8,29 @@ Đối với đa số người dùng, các hướng dẫn trên [trang chính](/guide/#🚀-installation) sẽ làm việc tốt. Tuy nhiên, với một vài nền tảng đặc biệt hơn, các hướng dẫn khác nhau là cần thiết. Có rất nhiều nền tảng bên ngoài, rằng chúng đã không khớp như trong tệp tin README.md, do đó đây là vài hướng dẫn cài đặt cho những nền tảng khác đến từ cộng đồng. Của bạn không có ở đây? Xin hãy thêm nó vào đây nếu bạn tìm ra nó! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### Yêu cầu + +Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. + +### Cài đặt + +```powershell +choco install starship +``` + +## [termux](https://termux.com) + +### Yêu cầu + ```sh pkg install getconf ``` -### Installation +### Cài đặt + ```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 #### Khai báo, người dùng đơn, thông qua [home-manager](home-manager) -Thêm `pkgs.starship` vào `home.packages` trong tệp tin `home.nix` của bạn, sau đó chạy +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 #### Khai báo, system-wide, với NixOS -Thêm `pkgs.starship` vào `environment.packages` trong `configuration.nix` của bạn, sau đó chạy +Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run ```sh sudo nixos-rebuild switch ``` - -### Modifying Init Scripts - -#### Với Nix và home-manager, sử dụng zsh: - -Thêm phần sau vào `programs.zsh.initExtra` trong tệp tin `home.nix` của bạn, sau đó chạy - -```sh -home-manager switch -``` diff --git a/docs/vi-VN/migrating-to-0.45.0/README.md b/docs/vi-VN/migrating-to-0.45.0/README.md index ecbc0491e..aadc86858 100644 --- a/docs/vi-VN/migrating-to-0.45.0/README.md +++ b/docs/vi-VN/migrating-to-0.45.0/README.md @@ -1,16 +1,16 @@ -# Migrating to v0.45.0 +# Tích hợp sang v0.45.0 -Starship v0.45.0 is a release containing breaking changes, in preparation for the big v1.0.0. We have made some major changes around how configuration is done on the prompt, to allow for a greater degree of customization. +Starship v0.45.0 là một bản phát hành chứa nhiều thay đổi trong việc chuẩn bị cho bản thay đổi lớn v1.0.0. Chúng tôi tạo một vài thay đổi xung quanh cách cấu hình được thực hiện trên dáu nhắc lệnh, cho phép tùy biến theo góc độ tốt hơn. -This guide is intended to walk you through the breaking changes. +Hướng dẫn này nhằm hướng dẫn bạn vượt qua những sự thay đổi. -## `prompt_order` has been replaced by a root-level `format` +## `prompt_order` được thay thế boiwr một root-level `format` -Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship. +Từ trước đế v0.45.0, `prompt_order` sẽ chấp nhận một mảng các tên mô đun theo thứ tự mà chúng nên được render bởi Starship. -Starship v0.45.0 instead accepts a `format` value, allowing for customization of the prompt outside of the modules themselves. +Starship v0.45.0 thay vì chấp nhận một giá trị `format`, nó cho phép tùy biến dấu nhắc lệnh bên ngoài chính các mô đun đó. -**Example pre-v0.45.0 configuration** +**Ví dụcủa cấu hình pre-v0.45.0** ```toml prompt_order = [ @@ -31,7 +31,7 @@ prompt_order = [ ] ``` -**Example v0.45.0 configuration** +**Ví dụcủa cấu hình v0.45.0** ```toml format = """\ @@ -52,40 +52,40 @@ format = """\ """ ``` -## Module `prefix` and `suffix` have been replaced by `format` +## Mô đun `prefix` và`suffix` thay bằng `format` -Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered. +Từ trước tới v0.45.0, một vài mô đun sẽ chấp nhận `prefix` và/hoặc `suffix` theo thứ tự để stylize các mà các mô đun được render. -Starship v0.45.0 instead accepts a `format` value, allowing for further customization of how modules are rendered. Instead of defining a prefix and suffix for the context-based variables, the variables can now be substituted from within a format string, which represents the module's output. +Starship v0.45.0 thay vì chấp nhận một giá trị `format`, nó cho phép tùy biến dấu nhắc lệnh bên ngoài chính các mô đun đó. Thay vì định nghĩa một tiền tố và hậu tố cho các giá trị context-based, các giá trị bây giờ có thể được thay thế với một format string, cái đại diện cho đầu ra của module. -**Example pre-v0.45.0 configuration** +**Ví dụ của cấu hình pre-v0.45.0** ```toml [cmd_duration] prefix = "took " ``` -**Example v0.45.0 configuration** +**Ví dụ của cấu hình v0.45.0** ```toml [cmd_duration] -# $duration – The command duration (e.g. "15s") -# $style – The default style of the module (e.g. "bold yellow") +# $duration – Thời gian câu lệnh dùng để thực thi (e.g. "15s") +# $style – Style mặc định của mô đun (e.g. "bold yellow") format = "took [$duration]($style) " ``` -### Affected Modules +### Các mô đun ảnh hưởng #### Character -| Removed Property | Replacement | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | | ----------------------- | ---------------- | | `symbol` | `success_symbol` | | `use_symbol_for_status` | `error_symbol` | | `style_success` | `success_symbol` | | `style_failure` | `error_symbol` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [character] @@ -98,26 +98,26 @@ format = "took [$duration]($style) " ++ vicmd_symbol = "[❮](bold green)" ``` -Previously, the `use_symbol_for_status` property was used to configure the prompt to show the `error_symbol` when the last command resulted in a non-zero status code. +Trước đây, thuộc tính `use_symbol_for_status` được sử dụng để cấu hình dấu nhắc lệnh hiển thị `error_symbol` khi câu lệnh cuối cùng trả về kết quả có status code khác 0. -With the release of v0.45.0, we now always use `error_symbol` after non-zero status codes, unifying `use_symbol_for_status` and `error_symbol` properties. +Với bản hát hành v0.45.0, chúng ta bây giờ luôn sử dụng `error_symbol` sau các status khác 0, thống nhất các thuộc tính `use_symbol_for_status` và `error_symbol`. -To configure the prompt to use the older `use_symbol_for_status = true` configuration, add the following to your config file: +Cấu hình dâu nhắc lệnh để sử dụng cấu hình `use_symbol_for_status = true`, thêm đoạn dưới vào tệp cấu hình của bạn: ```toml [character] error_symbol = "[✖](bold red)" ``` -*Note:* The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples. +*Lưu ý:* Phần tử `character` tự động thêm vào một khoảng trắng phía sau, so unlike the other `format` strings, we specifically do not add one in the above examples. #### Command Duration -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | +| ------------------- | ------------- | +| `prefix` | `format` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [cmd_duration] @@ -127,11 +127,11 @@ error_symbol = "[✖](bold red)" #### Đường dẫn -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | +| ------------------- | ------------- | +| `prefix` | `format` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [directory] @@ -139,14 +139,14 @@ error_symbol = "[✖](bold red)" ++ format = "[$path]($style)[$read_only]($read_only_style) " ``` -#### Environment Variable +#### Biến môi trường -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | +| ------------------- | ------------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [env_var] @@ -157,12 +157,12 @@ error_symbol = "[✖](bold red)" #### Git Commit -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | +| ------------------- | ------------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [git_commit] @@ -173,13 +173,13 @@ error_symbol = "[✖](bold red)" #### Git Status -| Removed Property | Replacement | -| ----------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | -| `show_sync_count` | `format` | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | +| ------------------- | ------------- | +| `prefix` | `format` | +| `suffix` | `format` | +| `show_sync_count` | `format` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [git_status] @@ -189,11 +189,11 @@ error_symbol = "[✖](bold red)" ++ format = '([\[$all_status$ahead_behind\]]($style) )' ``` -Previously, the `show_sync_count` property was used to configure the prompt to show the number of commits the branch was ahead or behind the remote branch. +Trước đây, thuộc tính `show_sync_count` được sử dụng để cấu hình dấu nhắc lệnh hiển thị số commit của nhánh ahead hoặc số lượng behind của remote branch. -With the release of v0.45.0, this has been replaced with three separate properties, `ahead`, `behind`, and `diverged`. +Với bản phát hành v0.45.0, cái này được thay thế bằng ba thuộc tính rời `ahead`, `behind`, và `diverged`. -To configure the prompt to use the older `show_sync_count = true` configuration, set the following to your config file: +Cấu hình dấu nhắc lệnh sử dụng cấu hình `show_sync_count = true` cũ hơn, thiết lâp như dưới đây trong tệp cấu hình của bạn: ```toml [git_status] @@ -204,12 +204,12 @@ behind = "⇣${count}" #### Hostname -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | +| ------------------- | ------------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [hostname] @@ -220,13 +220,13 @@ behind = "⇣${count}" #### Singularity -| Removed Property | Replacement | -| ---------------- | ----------- | -| `label` | `format` | -| `prefix` | `format` | -| `suffix` | `format` | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | +| ------------------- | ------------- | +| `nhãn` | `format` | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [singularity] @@ -235,13 +235,13 @@ behind = "⇣${count}" ++ format = '[$symbol\[$env\]]($style) ' ``` -#### Time +#### Thời gian -| Removed Property | Replacement | -| ---------------- | ------------- | -| `format` | `time_format` | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | +| ------------------- | ------------- | +| `format` | `time_format` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [time] @@ -250,14 +250,14 @@ behind = "⇣${count}" ++ format = "at 🕙[$time]($style) " ``` -#### Custom Commands +#### Các câu lệnh tùy biến -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| Thuộc tính bị gỡ bỏ | Thay thế bằng | +| ------------------- | ------------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Các thay đổi về cấu hình mặc định** ```diff [custom.example] diff --git a/docs/vi-VN/presets/README.md b/docs/vi-VN/presets/README.md index 24aca7fba..f21620bac 100644 --- a/docs/vi-VN/presets/README.md +++ b/docs/vi-VN/presets/README.md @@ -16,7 +16,7 @@ Preset này không thay đổi bất kể thứ gì ngoại trừ các kí hiệ ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 336ceacbb..987aff893 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/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/zh-CN/advanced-config/README.md b/docs/zh-CN/advanced-config/README.md index 508b255da..e20552482 100644 --- a/docs/zh-CN/advanced-config/README.md +++ b/docs/zh-CN/advanced-config/README.md @@ -2,7 +2,7 @@ `Starship 功能繁多，有时您必须在编辑 starship.toml` 之外做更多工作才能实现某些效果。 此页面详细介绍了一些在 starship 中使用的高级配置技巧。 -::: 警告 +::: warning 本节所述的配置内容可能随 Starship 未来版本的更新而改变。 diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md index a66118ab0..abacfe431 100644 --- a/docs/zh-CN/config/README.md +++ b/docs/zh-CN/config/README.md @@ -9,8 +9,8 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Starship 的所有配置都在此 [TOML](https://github.com/toml-lang/toml) 配置文件中完成： ```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. #### 样式设定 @@ -142,11 +142,11 @@ format = ''' ### 配置项 -| Option | 默认值 | 描述 | -| -------------- | ----------------------------- | ----------------------------------- | -| `format` | [见下文](#default-prompt-format) | Configure the format of the prompt. | -| `scan_timeout` | `30` | Starship 扫描文件的超时时间（单位：毫秒）。 | -| `add_newline` | `true` | 在提示符与提示信息间换行。 | +| Option | 默认值 | 描述 | +| -------------- | ----------------------------- | ----------------------------------------- | +| `format` | [见下文](#default-prompt-format) | Configure the format of the prompt. | +| `scan_timeout` | `30` | Starship 扫描文件的超时时间（单位：毫秒）。 | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### 示例 @@ -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 @@ $character""" 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. + ### 配置项 -| Option | 默认值 | 描述 | -| ---------------- | ------------------------------------------------ | ------------------------- | -| `format` | `'on [$symbol$profile(\($region\))]($style) '` | 组件格式化模板。 | -| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 | -| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 | -| `style` | `"bold yellow"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `AWS` 组件。 | +| Option | 默认值 | 描述 | +| ---------------- | --------------------------------------------------- | ------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | 组件格式化模板。 | +| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 | +| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 | +| `style` | `"bold yellow"` | 此组件的样式。 | +| `disabled` | `false` | 禁用 `AWS` 组件。 | ### 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 = "🅰 " ## Battery -`battery` 组件显示电池充电情况和当前充电状态。 这个组件只会在当前电量低于 10% 时显示。 +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%. ### 配置项 @@ -330,7 +333,7 @@ discharging_symbol = "💀" ### Battery 组件的显示 -`display` 选项用于定义电池指示器的显示阈值（threshold）和显示效果（style）。 如果 `display` 没有设置， 默认设置如下： +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. 默认设置如下： ```toml [[battery.display]] @@ -340,7 +343,7 @@ style = "bold red" #### 配置项 -`display` 字段的子字段如下： +The `display` option is an array of the following table. | Option | 描述 | | ----------- | ---------------- | @@ -364,9 +367,9 @@ style = "bold yellow" ## Character -`character` 组件用于在您输入终端的文本旁显示一个字符（通常是一个箭头）。 +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -这个字符可以告诉您最后一个命令是否执行成功。 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 | 默认值 | 描述 | | ------------------- | -------------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `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 | @@ -453,15 +456,15 @@ The `cmake` module shows the currently installed version of CMake. By default th ## Command Duration -`cmd_duration` 组件显示上一个命令执行的时间。 此组件只在命令执行时间长于两秒时显示，或者当其 `min_time` 字段被设置时，按此值为执行时间的显示下限。 +The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning 不要在 Bash 里捕获 DEBUG 信号 +::: warning Do not hook the DEBUG trap in Bash -如果您正在 `bash` 上使用 Starship，在运行 `eval $(starship)` 后，不要捕获 `DEBUG` 信号，否则此组件**将会**坏掉。 +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -需要在自动每一条命令前执行某些操作的 Bash 用户可以使用 [rcaloras 的 bash_preexec 框架](https://github.com/rcaloras/bash-preexec)。 只需要在执行 `eval $(starship init $0)` 前简单地定义 `preexec_functions` 和 `precmd_functions` 两个列表，就可以照常运行了。 +Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### 配置项 @@ -502,11 +505,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -`conda` 组件在 `$CONDA_DEFAULT_ENV` 被设置时显示当前 conda 环境。 +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -此组件没有禁用 conda 自带的提示符修改，您可能需要执行 `conda config --set changeps1 False`。 +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -619,11 +622,11 @@ format = "via [🔰 $version](bold red) " ## Directory -`directory` 组件显示当前目录的路径，显示的路径会截断到三个父目录以内。 如果您处于一个 git 仓库中，显示的路径则最多会截断到该仓库的根目录。 +The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. -当使用 fish 风格的当前目录显示样式时，您会看到基于您的设置的每个上级目录的短名称，而不是隐藏被截断的上级目录。 +When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. -例如，对于 `~/Dev/Nix/nixpkgs/pkgs`，其中 `nixpkgs` 是 git 仓库根目录，fish 风格相关选项设置为 `1`。 您将会看到 `~/D/N/nixpkgs/pkgs`，而在设置 fish 风格之前，当前路径将显示成 `nixpkgs/pkgs`。 +For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### 配置项 @@ -640,7 +643,7 @@ format = "via [🔰 $version](bold red) " | `home_symbol` | `"~"` | The symbol indicating home directory. |
-此组件有几个高级配置选项来控制当前目录路径的显示方式。 +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | 默认值 | 描述 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -717,7 +720,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -`dotnet` 模块显示与当前目录下使用的 .NET Core SDK 相关联的版本。 如果当前目录已被绑定了一个版本的 SDK，则显示被帮定的版本。 否则此组件将显示最新安装的 SDK 版本。 +The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -733,7 +736,7 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -在内部，此组件使用自己的版本检测机制。 一般来说此组件是直接执行 `dotnet --version` 的两倍快，但当你的 .NET 项目使用了不常见的目录布局时此组件可能显示一个错误的版本。 如果相比于速度您更需要正确的版本号，您可以在组件设置中设置 `heuristic = false` 来禁用该机制。 +Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. @@ -853,7 +856,7 @@ format = "via [ $version](cyan bold) " ## Environment Variable -`env_var` 组件显示选定的环境变量的当前值。 此组件只有满足以下条件之一时才会被显示： +The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met: - 设置的 `variable` 是一个已存在的环境变量 - 未定义 `variable`，但定义了 `default` @@ -988,7 +991,7 @@ asia-northeast1 = "an1" ## Git Branch -`git_branch` 组件显示当前目录的 git 仓库的活动分支。 +The `git_branch` module shows the active branch of the repo in your current directory. ### 配置项 @@ -1063,7 +1066,7 @@ tag_symbol = "🔖 " ## Git State -`git_state` 组件会显示当前目录在哪个 git 仓库中，以及正在进行的操作，例如：_REBASING_，_BISECTING_ 等。 进度信息（例如 REBASING 3/10）如果存在则也会被显示。 +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### 配置项 @@ -1103,7 +1106,7 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git Status -`git_status`组件通过相应的符号显示您当前目录中 git 仓库的状态。 +The `git_status` module shows symbols representing the state of the repo in your current directory. ### 配置项 @@ -1186,7 +1189,7 @@ behind = "⇣${count}" ## Golang -`golang` 组件显示当前安装的 Golang 版本。 By default the module will be shown if any of the following conditions are met: +The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met: - 当前目录包含 `go.mod` 文件 - 当前目录包含 `go.sum` 文件 @@ -1268,7 +1271,7 @@ format = "via [⎈ $version](bold white) " ## Hostname -`hostname` 组件显示系统主机名。 +The `hostname` module shows the system hostname. ### 配置项 @@ -1303,7 +1306,7 @@ disabled = false ## Java -`java` 组件显示当前安装的 Java 版本。 By default the module will be shown if any of the following conditions are met: +The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension @@ -1341,7 +1344,13 @@ symbol = "🌟 " ## Jobs -`jobs` 组件显示当前正在运行的任务数量。 仅当有后台任务运行时，此组件才会显示。 如果有超过 1 个作业，模块将显示正在运行的作业数量，如果配置了 `threshold` 字段，则使用它作为显示作业数量的下限。 +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. + +::: ### 配置项 @@ -1464,7 +1473,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1503,7 +1512,7 @@ disabled = false ## Line Break -`line_break` 组件将提示分隔为两行。 +The `line_break` module separates the prompt into two lines. ### 配置项 @@ -1562,13 +1571,13 @@ format = "via [🌕 $version](bold blue) " ## Memory Usage -`memory_usage` 组件显示当前系统内存和交换区使用情况。 +The `memory_usage` module shows current system memory and swap usage. -默认情况下，如果系统交换区使用不为 0，则会显示交换区使用情况。 +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1609,7 +1618,7 @@ style = "bold dimmed green" ## Mercurial Branch -`hg_branch` 组件显示当前目录的 hg 仓库的活动分支。 +The `hg_branch` module shows the active branch of the repo in your current directory. ### 配置项 @@ -1686,7 +1695,7 @@ symbol = "🎣 " ## Nix-shell -`nix_shell` 组件显示 nix-shell 环境。 当处于一个 nix-shell 环境中时，此组件会被显示。 +The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. ### 配置项 @@ -1724,7 +1733,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## NodeJS -`nodejs` 组件显示当前安装的 NodeJS 版本。 By default the module will be shown if any of the following conditions are met: +The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met: - 当前目录包含 `package.json` 文件 - The current directory contains a `.node-version` file @@ -1737,7 +1746,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | Option | 默认值 | 描述 | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `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. | @@ -1843,7 +1852,7 @@ symbol = "☁️ " ## Package Version -当前目录是软件包的代码仓库时，将显示 `package` 组件，并显示软件包当前版本。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. - **npm** —— `npm` 软件包版本从当前目录下的 `package.json` 中得到 - **cargo** —— `cargo` 软件包的版本从当前目录下的 `Cargo.toml` 中得到 @@ -1928,7 +1937,7 @@ format = "via [🦪 $version]($style) " ## PHP -`php` 组件显示当前安装的 PHP 版本。 By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: - 当前目录包含一个 `composer.json` 文件 - The current directory contains a `.php-version` file @@ -2005,9 +2014,9 @@ format = "via [$symbol$version](bold white)" ## Python -`python` 组件组件展示已经安装了的Python版本以及如果虚拟环境被激活则会显示当前Python虚拟环境 +The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. -如果`pyenv_version_name`被设置为`true`, 本组件将会展示pyenv版本名。 否则则显示通过`python --version`获得的版本号 +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. By default the module will be shown if any of the following conditions are met: @@ -2083,7 +2092,7 @@ detect_extensions = [] ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. 此组件将在符合以下任意条件之一时显示： +By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: - 当前目录包含 `Gemfile` 文件 - The current directory contains a `.ruby-version` file @@ -2122,7 +2131,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. 此组件将在符合以下任意条件之一时显示： +By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: - 当前目录包含 `Cargo.toml` 文件 - 当前目录包含一个使用 `.rs` 扩展名的文件 @@ -2158,13 +2167,55 @@ By default the `rust` module shows the currently installed version of Rust. 此 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` + +### 配置项 + + +| Option | 默认值 | 描述 | +| ------------------- | ---------------------------------------- | ------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 | +| `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"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `scala` module. | + +### Variables + +| 字段 | 示例 | 描述 | +| --------- | -------- | ---------------------- | +| version | `2.13.5` | The version of `scala` | +| symbol | | `symbol`对应值 | +| style\* | | `style`对应值 | + +\*: This variable can only be used as a part of a style string + +### 示例 + +```toml +# ~/.config/starship.toml + +[scala] +symbol = "🌟 " +``` + + ## Shell The `shell` module shows an indicator for currently used shell. ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2178,6 +2229,7 @@ The `shell` module shows an indicator for currently used shell. | `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` | 组件格式化模板。 | | `disabled` | `true` | Disables the `shell` module. | @@ -2271,7 +2323,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2324,7 +2376,7 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. 此组件将在符合以下任意条件之一时显示： +By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension @@ -2372,7 +2424,7 @@ By default the terraform version is not shown, since this is slow for current ve By default the module will be shown if any of the following conditions are met: -- 当前目录包含 `.terraform` 目录 +- The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf` or `.hcl` extensions ### 配置项 @@ -2424,7 +2476,7 @@ The `time` module shows the current **local** time. The `format` configuration v ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2466,12 +2518,12 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. 此组件将在符合以下任意条件之一时显示： +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- 当前用户是 root -- 当前用户与登录用户不相同 -- 用户正通过 SSH 会话连接访问 -- 字段 `show_always` 被设置为 true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: tip @@ -2548,7 +2600,7 @@ format = "via [⍱ $version](bold white) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. 此组件将在符合以下任意条件之一时显示： +By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file diff --git a/docs/zh-CN/faq/README.md b/docs/zh-CN/faq/README.md index ec338c93d..ebb725144 100644 --- a/docs/zh-CN/faq/README.md +++ b/docs/zh-CN/faq/README.md @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -内置于 Starship 的 [Bash 适配](https://github.com/starship/starship/blob/master/src/init/starship.bash) 稍微复杂一些，实现了像 [命令用时统计组件](https://starship.rs/config/#Command-Duration) 这样的功能，还确保 Starship 能与之前设置的 Bash 配置相兼容。 +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. 使用以下命令了解 `starship prompt` 所能接受的所有参数： @@ -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/zh-CN/guide/README.md b/docs/zh-CN/guide/README.md index b169189e1..73e60e3a9 100644 --- a/docs/zh-CN/guide/README.md +++ b/docs/zh-CN/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" + /> 加入 Discord + alt="加入 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="使用 iTerm 和 Snazz 主题的 Starship" width="50%" - align="right" /> + align="right" + /> **轻量级、反应迅速，可定制的高颜值终端！** @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 贡献 我们一直在寻找贡献者！你都可以参与贡献 ** 不论你的技能如何 **。 如果您希望快速为项目作出贡献，请尝试解决 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)。 diff --git a/docs/zh-CN/installing/README.md b/docs/zh-CN/installing/README.md index 0426225b1..82e4b0c43 100644 --- a/docs/zh-CN/installing/README.md +++ b/docs/zh-CN/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! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### 前置要求 + +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) + +### 前置要求 + ```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/zh-CN/presets/README.md b/docs/zh-CN/presets/README.md index b97e3888a..0977466db 100644 --- a/docs/zh-CN/presets/README.md +++ b/docs/zh-CN/presets/README.md @@ -16,7 +16,7 @@ ```toml [aws] -symbol = " " +symbol = " " [conda] symbol = " " @@ -84,6 +84,9 @@ symbol = " " [rust] symbol = " " +[scala] +symbol = " " + [swift] symbol = "ﯣ " ``` diff --git a/docs/zh-TW/README.md b/docs/zh-TW/README.md index 10da9cda6..96ccbb568 100644 --- a/docs/zh-TW/README.md +++ b/docs/zh-TW/README.md @@ -2,8 +2,8 @@ home: true heroImage: /logo.svg heroText: -tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! -actionText: Get Started → +tagline: 適合任何 shell 的最小、極速、無限客製化的提示字元！ +actionText: 馬上開始 → actionLink: ./guide/ features: - @@ -17,8 +17,8 @@ features: details: 任何些微的細節都可以隨你喜愛地客製化，讓你的提示字元可以隨你所欲地最小化或是充滿各種特色。 footer: ISC Licensed | Copyright © 2019-present Starship Contributors #Used for the description meta tag, for SEO -metaTitle: "Starship: Cross-Shell Prompt" -description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, and PowerShell. +metaTitle: "Starship：跨 Shell 提示字元" +description: Starship 是適合任何 shell 的最小、極速、高度客製化的提示字元！ 顯示你需要的訊息，同時保持順暢與最小化。 有針對 Bash、Fish、ZSH、Ion 與 Powershell 的快速安裝指南。 ---
@@ -33,24 +33,24 @@ description: Starship is the minimal, blazing fast, and extremely customizable p 1. 安裝 **starship** 執行檔： - #### Install Latest Version + #### 安裝最新版本 - With Shell: + 使用 Shell 安裝： ```sh curl -fsSL https://starship.rs/install.sh | bash ``` - #### Install via Package Manager + #### 使用套件管理器安裝： - With [Homebrew](https://brew.sh/): + 使用 [Homebrew](https://brew.sh/)： ```sh brew install starship ``` - With [Scoop](https://scoop.sh): + 使用 [Scoop](https://scoop.sh)： ```powershell scoop install starship @@ -94,7 +94,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Powershell - Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. + 將以下內容放到 `Microsoft.PowerShell_profile.ps1` 的結尾。 你可以藉由在 PowerShell 查詢 `$PROFILE` 變數以取得這個檔案的位置。 一般來說檔案會出現在 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 或是在 -Nix 上的話會在 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`。 ```sh Invoke-Expression (&starship init powershell) @@ -103,7 +103,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Ion - Add the following to the end of `~/.config/ion/initrc`: + 將以下內容放到 `~/.config/ion/initrc` 的結尾： ```sh # ~/.config/ion/initrc @@ -113,9 +113,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning Only elvish v0.15 or higher is supported. ::: + ::: warning 只有 elvish v0.15 或以上版本才有支援 ::: - Add the following to the end of `~/.elvish/rc.elv`: + 將以下內容放到 `~/.elvish/rc.elv` 的結尾： ```sh # ~/.elvish/rc.elv @@ -123,3 +123,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval (starship init elvish) ``` + + #### Tcsh + + 將以下內容放到 `~/.tcshrc` 的結尾： + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index 36daff26e..487e27bfa 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -9,8 +9,8 @@ mkdir -p ~/.config && touch ~/.config/starship.toml 所有關於 Starship 的設定都在這個 [TOML](https://github.com/toml-lang/toml) 檔案內： ```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. #### 風格字串 @@ -146,7 +146,7 @@ format = ''' | -------------- | ---------------------------- | ----------------------------------------------------- | | `format` | [連結](#default-prompt-format) | Configure the format of the prompt. | | `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). | -| `add_newline` | `true` | 在提示字元前面加上換行字元。 | +| `add_newline` | `true` | Inserts blank line between shell prompts. | ### 範例 @@ -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 @@ $character""" 從 `AWS_VAULT`讀取而使用 [aws-vault](https://github.com/99designs/aws-vault) 這個設定檔 +When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. + ### 選項 -| Option | 預設 | 說明 | -| ---------------- | ------------------------------------------------ | -------------------------- | -| `format` | `'on [$symbol$profile(\($region\))]($style) '` | The format for the module. | -| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 | -| `region_aliases` | | 除了AWS名稱外，顯示區域別名表 | -| `style` | `"bold yellow"` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `AWS` 模組。 | +| Option | 預設 | 說明 | +| ---------------- | --------------------------------------------------- | -------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 | +| `region_aliases` | | 除了AWS名稱外，顯示區域別名表 | +| `style` | `"bold yellow"` | 這個模組的風格。 | +| `disabled` | `false` | 停用 `AWS` 模組。 | ### Variables @@ -266,7 +269,7 @@ $character""" # ~/.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 = "🅰 " ## 電池 -`battery` 模組顯示電池的電量以及現在的充電狀態。 這個模組只會在裝置的電量低於 10% 的時候看見。 +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%. ### 選項 @@ -330,7 +333,7 @@ discharging_symbol = "💀" ### 電池顯示 -`display` 設定是用來定義甚麼時候電池指示會顯示出來 (threshold)，以及它長甚麼樣子 (style)。 如果沒有提供 `display`。 預設如下： +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. 預設如下： ```toml [[battery.display]] @@ -340,7 +343,7 @@ style = "bold red" #### 選項 -`display` 選項是一個下列表格的陣列。 +The `display` option is an array of the following table. | Option | 說明 | | ----------- | ----------- | @@ -364,9 +367,9 @@ style = "bold yellow" ## 字元 -`character` 模組在你的文字輸入處旁顯示一個字元 (通常是箭頭)。 +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -這個字元會告訴你最後的指令是成功還是失敗。 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 | 預設 | 說明 | | ------------------- | -------------------------------------- | -------------------------------------------- | | `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 | @@ -453,15 +456,15 @@ The `cmake` module shows the currently installed version of CMake. By default th ## 指令持續時間 -`cmd_duration` 模組顯示最後一個指令執行所花費的時間。 這個模組只會在指令花費超過兩秒或是有設定 `min_time` 時，超過設定值時出現。 +The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning 不要在 Bash 中設置 DEBUG trap +::: warning Do not hook the DEBUG trap in Bash -如果你在 `bash` 中使用 Starship，不要在執行 `eval $(starship init $0)` 之後設置 `DEBUG` trap，不然這個模組**會**壞掉。 +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -想使用類似 preexec 功能的 Bash 使用者可以 [rcaloras 的 bash_preexec 框架](https://github.com/rcaloras/bash-preexec)。 只要在 `eval $(starship init $0)` 之前簡單地定義 `preexec_functions` 與 `precmd_functions` 兩個陣列，然後就可以照常進行。 +Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### 選項 @@ -502,7 +505,7 @@ format = "underwent [$duration](bold yellow)" ## Conda -如果有設定 `$CONDA_DEFAULT_ENV` 時，`conda` 模組顯示現在 conda 的環境。 +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip @@ -542,7 +545,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -`crystal` 模組顯示現在所安裝的Crystal版本 By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: - 現在資料夾中含有一個 `shard.yml` 檔案 - 現在資料夾中含有一個`.cr`檔案 @@ -619,11 +622,11 @@ format = "via [🔰 $version](bold red) " ## 資料夾 -`directory` 模組顯示到現在資料夾的路徑，並裁減到前三層資料夾。 你的資料夾也會被裁減到你所在的 git 儲存庫的根目錄。 +The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. -如果正在使用 fish 風格的 pwd 選項，將不會隱藏被裁減的資料夾，而是會根據你在選項中設定的數字看到每一層資料夾的縮寫。 +When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. -例如，給定一個右列的路徑 `~/Dev/Nix/nixpkgs/pkgs` 其中 `nixpkgs` 是儲存庫的根目錄，而且該選項被設定為 `1`。 你會看到 `~/D/N/nixpkgs/pkgs`，而在這個設定之前則是 `nixpkgs/pkgs`。 +For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### 選項 @@ -640,7 +643,7 @@ format = "via [🔰 $version](bold red) " | `home_symbol` | `"~"` | The symbol indicating home directory. |
-這個模組有些進階設定選項可以控制顯示資料夾。 +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | 預設 | 說明 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -717,7 +720,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -`dotnet` 模組顯示現在資料夾使用的 .NET Core SDK 的版本。 如果這個資料夾已經選定一個 SDK，則顯示這個 SDK 的版本。 如果沒有的話，則顯示最新安裝的 SDK 版本。 +The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -733,7 +736,7 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -這個模組內部是使用它自己的機制來偵測版本。 一般來說這個模組有 `dotnet --version` 的兩倍快，但是它可能會在你的 .NET 專案有不尋常的資料夾結構時顯示不正確的版本。 如果精確度比速度更重要的話，你可以藉由設定模組中的 `heuristic = false` 選項來停用這個功能。 +Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. @@ -853,7 +856,7 @@ format = "via [ $version](cyan bold) " ## 環境變數 -`env_var`模組顯示一個選擇的環境變數的現在數值。 這個模組只在下列條件其中之一達到時顯示： +The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met: - `variable` 設定選項符合一個存在的環境變數。 - 沒有設定 `variable` 選項，但是有設定 `default` 選項。 @@ -988,7 +991,7 @@ asia-northeast1 = "an1" ## Git 分支 -`git_branch` 模組顯示現在的資料夾中使用中的儲存庫的分支。 +The `git_branch` module shows the active branch of the repo in your current directory. ### 選項 @@ -1063,7 +1066,7 @@ tag_symbol = "🔖 " ## Git State -`git_state` 模組會顯示在 git 儲存庫中的資料夾內，以及會在有作業正在進行時顯示，像是：_REBASING_、_BISECTING_ 等等。 如果有進展的資訊 (像是 REBASING 3/10)，也會一併顯示出來。 +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### 選項 @@ -1103,7 +1106,7 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git Status -`git_status` 模組顯示用來表示現在資料夾之中儲存庫狀態的符號。 +The `git_status` module shows symbols representing the state of the repo in your current directory. ### 選項 @@ -1186,7 +1189,7 @@ behind = "⇣${count}" ## Golang -`golang` 模組顯示現在安裝的 Golang 版本。 By default the module will be shown if any of the following conditions are met: +The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met: - 現在資料夾中含有一個 `go.mod` 檔案 - 現在資料夾中含有一個 `go.sum` 檔案 @@ -1268,7 +1271,7 @@ format = "via [⎈ $version](bold white) " ## 主機名稱 -`hostname` 模組顯示系統的主機名稱。 +The `hostname` module shows the system hostname. ### 選項 @@ -1303,7 +1306,7 @@ disabled = false ## Java -`java` 模組顯示現在安裝的 Java 版本。 By default the module will be shown if any of the following conditions are met: +The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension @@ -1341,7 +1344,13 @@ symbol = "🌟 " ## 工作 -`jobs` 模組顯示現在正在執行中的工作。 這個模組只會在有背景工作正在執行時顯示。 這個模組會在工作數量超過一個，或者有設定 `threshold` 時且數量超過設定值時，顯示工作的數量。 +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. + +::: ### 選項 @@ -1464,7 +1473,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1503,7 +1512,7 @@ disabled = false ## 換行 -`line_break` 模組將提示字元分成兩行。 +The `line_break` module separates the prompt into two lines. ### 選項 @@ -1562,13 +1571,13 @@ format = "via [🌕 $version](bold blue) " ## 記憶體使用量 -`memory_usage` 模組顯示現在系統記憶體與 swap 的使用量。 +The `memory_usage` module shows current system memory and swap usage. -預設 swap 使用量會在系統總 swap 使用量不為 0 時顯示出來。 +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1686,7 +1695,7 @@ symbol = "🎣 " ## Nix-shell -`nix_shell` 模組顯示 nix-shell 環境。 這個模組會在 nix-shell 環境中顯示。 +The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. ### 選項 @@ -1724,7 +1733,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## NodeJS -`nodejs` 模組顯示現在安裝的 NodeJS 版本。 By default the module will be shown if any of the following conditions are met: +The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met: - 現在資料夾中包含一個 `package.json` 檔案 - The current directory contains a `.node-version` file @@ -1737,7 +1746,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | Option | 預設 | 說明 | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `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. | @@ -1843,7 +1852,7 @@ symbol = "☁️ " ## 套件版本 -The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 這個模組目前支援 `npm`、`cargo`、`poetry`、`composer`、`gradle`、`julia`、`mix`, 跟 `helm` 套件 +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. - **npm** – `npm` 套件的版本是從現在資料夾中的 `package.json` 之中擷取出來的 - **cargo** – `cargo` 套件的版本是從現在資料夾中的 `Cargo.toml` 之中擷取出來的 @@ -2083,7 +2092,7 @@ detect_extensions = [] ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. 這個模組在下列其中一個條件達成時顯示： +By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: - 目前資料夾中有一個 `Gemfile` 檔案 - The current directory contains a `.ruby-version` file @@ -2122,7 +2131,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. 這個模組在下列其中一個條件達成時顯示： +By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: - 目前資料夾中有一個 `Cargo.toml` 檔案 - 現在資料夾中包含一個檔案具有 `.rs` 副檔名 @@ -2158,13 +2167,55 @@ By default the `rust` module shows the currently installed version of Rust. 這 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` + +### 選項 + + +| Option | 預設 | 說明 | +| ------------------- | ---------------------------------------- | ------------------------------------------------- | +| `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"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `scala` module. | + +### Variables + +| 變數 | 範例 | 說明 | +| --------- | -------- | ------------------------------------ | +| 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 + +### 範例 + +```toml +# ~/.config/starship.toml + +[scala] +symbol = "🌟 " +``` + + ## Shell The `shell` module shows an indicator for currently used shell. ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2178,6 +2229,7 @@ The `shell` module shows an indicator for currently used shell. | `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. | @@ -2271,7 +2323,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2324,7 +2376,7 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. 這個模組在下列其中一個條件達成時顯示： +By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension @@ -2424,7 +2476,7 @@ The `time` module shows the current **local** time. The `format` configuration v ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2466,12 +2518,12 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. 這個模組在下列其中一個條件達成時顯示： +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: -- 目前使用者為 root -- 目前使用者並非登入時的使用者 -- 使用者透過 SSH session 進行連線 -- 變數 `show_always` 被設為 true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ::: tip @@ -2548,7 +2600,7 @@ format = "via [⍱ $version](bold white) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. 這個模組在下列其中一個條件達成時顯示： +By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file diff --git a/docs/zh-TW/faq/README.md b/docs/zh-TW/faq/README.md index 9bb23bf93..d3c6d238c 100644 --- a/docs/zh-TW/faq/README.md +++ b/docs/zh-TW/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/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md index 0f3c93caa..a5f629853 100644 --- a/docs/zh-TW/guide/README.md +++ b/docs/zh-TW/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" + /> 在 Discord 上聊天 + alt="在 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!** @@ -157,7 +172,7 @@ ``` - ##### With [Scoop](https://scoop.sh): + ##### 使用 [Scoop](https://scoop.sh)： ```powershell scoop install starship @@ -201,7 +216,7 @@ #### PowerShell - Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. + 將以下內容放到 `Microsoft.PowerShell_profile.ps1` 的結尾。 你可以藉由在 PowerShell 查詢 `$PROFILE` 變數以取得這個檔案的位置。 Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix. ```powershell Invoke-Expression (&starship init powershell) @@ -229,6 +244,17 @@ eval (starship init elvish) ``` + + #### Tcsh + + Add the following to the end of `~/.tcshrc`: + + ```sh + # ~/.tcshrc + + eval `starship init tcsh` + ``` + ## 🤝 貢獻 我們歡迎具有**各式各樣能力**的貢獻者！ 如果你正在尋找容易加入的方法，試試看標註為「[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)」的 issue。 diff --git a/docs/zh-TW/installing/README.md b/docs/zh-TW/installing/README.md index f815b9678..384120654 100644 --- a/docs/zh-TW/installing/README.md +++ b/docs/zh-TW/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! -## [termux](https://termux.com) + +## [Chocolatey](https://chocolatey.org) + ### 先決要求 + +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) + +### 先決要求 + ```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/zh-TW/presets/README.md b/docs/zh-TW/presets/README.md index a2808a2c9..6692fd169 100644 --- a/docs/zh-TW/presets/README.md +++ b/docs/zh-TW/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 = "ﯣ " ```