From ddfcee38095ea117341cd4c6744d74511b33190a Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Wed, 15 Jan 2020 12:23:25 -0500 Subject: [PATCH] docs(i18n): Update translated docs (#792) --- docs/de-DE/config/README.md | 22 +- docs/de-DE/guide/README.md | 23 +- docs/es-ES/README.md | 114 +++ docs/es-ES/advanced-config/README.md | 84 +++ docs/es-ES/config/README.md | 1038 ++++++++++++++++++++++++++ docs/es-ES/faq/README.md | 45 ++ docs/es-ES/guide/README.md | 351 +++++++++ docs/es-ES/presets/README.md | 61 ++ docs/fr-FR/config/README.md | 8 +- docs/fr-FR/guide/README.md | 19 +- docs/ja-JP/README.md | 12 +- docs/ja-JP/config/README.md | 52 +- docs/ja-JP/guide/README.md | 77 +- docs/ja-JP/presets/README.md | 16 +- docs/ru-RU/config/README.md | 176 ++--- docs/ru-RU/guide/README.md | 25 +- docs/zh-CN/advanced-config/README.md | 4 +- docs/zh-CN/config/README.md | 6 + docs/zh-CN/guide/README.md | 23 +- docs/zh-TW/config/README.md | 6 + docs/zh-TW/guide/README.md | 23 +- 21 files changed, 2002 insertions(+), 183 deletions(-) create mode 100644 docs/es-ES/README.md create mode 100644 docs/es-ES/advanced-config/README.md create mode 100644 docs/es-ES/config/README.md create mode 100644 docs/es-ES/faq/README.md create mode 100644 docs/es-ES/guide/README.md create mode 100644 docs/es-ES/presets/README.md diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index b85f4d90..8b7b7eed 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -27,6 +27,11 @@ symbol = "➜" # Das "symbol" Feld wird "➜" gesetzt disabled = true ``` +You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: +```shell +export STARSHIP_CONFIG=~/.starship +``` + ### Terminologie **Module**: Eine Komponente in der Konsole, die auf kontextualisierte Informationen des OS basiert. Zum Beispiel zeigt das Modul "nodejs" die Version von NodeJS, die derzeit auf Ihrem Computer installiert ist, wenn Ihr aktuelles Verzeichnis ein NodeJS-Projekt ist. @@ -499,6 +504,7 @@ The `git_status` module shows symbols representing the state of the repo in your | `untracked` | `"?"` | There are untracked files in the working directory. | | `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. | | `stashed` | `"$"` | A stash exists for the local repository. | +| `stashed_count` | [link](#git-status-counts) | Show and style the number of stashes. | | `modified` | `"!"` | There are file modifications in the working directory. | | `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. | | `staged` | `"+"` | A new file has been added to the staging area. | @@ -783,7 +789,7 @@ style = "bold dimmed green" ## NodeJS -Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +Das `nodejs` Modul zeigt die derzeit installierte Version von NodeJS. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: - Das aktuelle Verzeichnis enthält eine `package.json`-Datei - Das aktuelle Verzeichnis enthält ein `node_modules`-Verzeichnis @@ -836,7 +842,7 @@ symbol = "🎁 " ## PHP -Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: - Das aktuelle Verzeichnis enthält eine `composer.json`-Datei - Das aktuelle Verzeichnis enthält eine `.php`-Datei @@ -866,7 +872,7 @@ Wenn `pyenv_version_name` auf `true` gesetzt ist, wird die version der pyenv ang Andernfalls wird die gleiche Versionsnummer angezeigt wie `python --version`, sowie der Name des aktuellen virtualenvs, wenn eines aktiv ist. -Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: - Das aktuelle Verzeichnis enthält eine `.python-version`-Datei - Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei @@ -923,7 +929,7 @@ symbol = "🔺 " ## Rust -Das `rust` Modul zeigt die derzeit installierte Version von Rust an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +Das `rust` Modul zeigt die derzeit installierte Version von Rust an. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: - Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei - Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung @@ -947,7 +953,7 @@ symbol = "⚙️ " ## Terraform -Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. Standardmäßig wird die Terraform-Version nicht angezeigt, da dies bei aktuellen Versionen von Terraform langsam ist, wenn viele Plugins verwendet werden. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. Standardmäßig wird die Terraform-Version nicht angezeigt, da dies bei aktuellen Versionen von Terraform langsam ist, wenn viele Plugins verwendet werden. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: - Das aktuelle Verzeichnis enthält eine `.terraform`-Datei - Das aktuelle Verzeichnis enthält eine Datei mit der `.tf`-Erweiterung @@ -974,7 +980,7 @@ symbol = "🏎💨 " Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen. -::: Tipp +::: tip Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. @@ -990,7 +996,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis | `utc_time_offset` | `lokal` | Legt das UTC-Offset fest, das verwendet werden soll. Reicht von -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | | `disabled` | `true` | Deaktiviert das `time`-Modul. | -Wird `use_12hr` auf `true` gestellt, nimmt `format` automatisch den Wert `"%r"` an. Andernfalls ist es standardmäßig `"%T"`. Wird hingegen `format` gesetzt, so überschreibt dies die Einstellung `use_12hr`. +Wird `use_12hr` auf `true` gestellt, so wird `format` automatisch auf `"%r"` gesetzt. Ansonsten ist der Standardwert hierfür `"%T"`. Wird hingegen `format` gesetzt, so überschreibt dies die Einstellung `use_12hr`. ### Beispiel @@ -1005,7 +1011,7 @@ utc_time_offset = -5 ## Username -Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +Das Modul `username` zeigt den Benutzernamen des aktiven Benutzers. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: - Der aktuelle Benutzer ist root - Der aktuelle Benutzer ist nicht der eingeloggte Benutzer diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index 9338133f..dbc4f6ee 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -21,7 +21,7 @@ src="https://img.shields.io/discord/567163873606500352?logo=discord" alt="Auf Discord chatten" /> -Alle Mitwirkenden +Alle Mitwirkenden

@@ -49,6 +49,9 @@ Deutsch   + Español +   Français   @@ -71,8 +74,8 @@ - Anzeigetext wird rot wenn der letzte Befehl mit einem Exit-code größer null terminiert - Derzeitige Go-Version (`🐹`) -- Derzeitige Java-Version (`☕`) -- Derzeitige Node.js-Version (`⬢`) +- Current Java version (`☕`) +- Current Node.js version (`⬢`) - Current PHP version (`🐘`) - Derzeitige Python-Version (`🐍`) - Derzeitige Ruby-Version (`💎`) @@ -122,13 +125,20 @@ #### Install Latest Version - ##### With Shell: + ##### From prebuilt binary, with Shell: ```sh curl -fsSL https://starship.rs/install.sh | bash ``` + ##### From source on [crates.io](https://crates.io/): + + ```sh + cargo install starship + ``` + + #### Install via Package Manager @@ -292,7 +302,7 @@ Danke an diese wunderbaren Leute ([emoji-Schlüssel](https://allcontributors.org
pinshan
🌍
Brian Low
💻 📖 ⚠️
Matias Kotlik
💻 -
marblenix
🚇 +
marblenix
🚇 💻 ⚠️
Raidou
💻 ⚠️ @@ -312,6 +322,9 @@ Danke an diese wunderbaren Leute ([emoji-Schlüssel](https://allcontributors.org
Mike Sampson
💻 📖 ⚠️
Dominik Braun
💻 + +
David Hewson
💻 + diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md new file mode 100644 index 00000000..7ddac16e --- /dev/null +++ b/docs/es-ES/README.md @@ -0,0 +1,114 @@ +--- +home: true +heroImage: /logo.svg +actionText: Empezar → +actionLink: /guide/ +footer: Bajo una licencia ISC | Derechos de autor © 2019-presente Colaboradores de Starship +--- + +
+
+

Compatibilidad primero

+

Funciona en las interfaces de líneas de comando (shells) más comunes en los sistemas operativos más comunes. ¡Úsalo donde sea!

+
+
+

Desarrollado en Rust

+

Obtén la mayor velocidad y seguridad de Rust, para hacer tu prompt lo más rápida y segura posible.

+
+
+

Personalizable

+

Puedes personalizar cada pequeño detalle a tu gusto, de manera que puedes tener una interfaz minimalista o rica en funcionalidades.

+
+
+ +
+ +
+ +### Instalación rápida + +1. Instalar el binario de **starship**: + + + #### Instalar la última versión + + Con la interfaz de línea de comandos: + + ```sh + curl -fsSL https://starship.rs/install.sh | bash + ``` + + + #### Instalar con un gestor de paquetes + + Con [Homebrew](https://brew.sh/): + + ```sh + brew install starship + ``` + + Con [Scoop](https://scoop.sh): + + ```powershell + scoop install starship + ``` + +1. Añade el script de inicio al archivo de configuración de tu interfaz de línea de comandos: + + + #### Bash + + Añade el siguiente código al final de `~/.bashrc`: + + ```sh + # ~/.bashrc + + eval "$(starship init bash)" + ``` + + + #### Fish + + Añade el siguiente código al final de `~/.config/fish/config.fish`: + + ```sh + # ~/.config/fish/config.fish + + starship init fish | source + ``` + + + #### Zsh + + Añade el siguiente código al final de `~/.zshrc`: + + ```sh + # ~/.zshrc + + eval "$(starship init zsh)" + ``` + + + #### Powershell + + Añade el siguiente código al final de `~\Documentos\PowerShell\Microsoft.PowerShell_profile.ps1` (o `~/.config/powershell/Microsoft.PowerShell_profile.ps1` en sistemas *nix): + + ```sh + # ~\Documentos\PowerShell\Profile.ps1 + + Invoke-Expression (&starship init powershell) + ``` + + + #### Ion + + Añade el siguiente código al final de `~/.config/ion/initrc`: + + ```sh + # ~/.config/ion/initrc + + eval $(starship init ion) + ``` diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md new file mode 100644 index 00000000..d5d27031 --- /dev/null +++ b/docs/es-ES/advanced-config/README.md @@ -0,0 +1,84 @@ +# Advanced Configuration + +While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship. + +::: warning + +The configurations in this section are subject to change in future releases of Starship. + +::: + +## Custom pre-prompt and pre-execution Commands in Bash + +Bash does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `bash`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure: + +- To run a custom function right before the prompt is drawn, define a new function and then assign its name to `starship_precmd_user_func`. For example, to draw a rocket before the prompt, you would do + +```bash +function blastoff(){ + echo "🚀" +} +starship_precmd_user_func="blastoff" +``` + +- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal *before* initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break. + +```bash +function blastoff(){ + echo "🚀" +} +trap blastoff DEBUG # Trap DEBUG *before* running starship +eval $(starship init bash) +``` + +## Change Window Title + +Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish even does it by default. Starship does not do this, but it's fairly straightforward to add this functionality to `bash` or `zsh`. + +First, define a window title change function (identical in bash and zsh): + +```bash +function set_win_title(){ + echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007" +} +``` + +You can use variables to customize this title (`$USER`, `$HOSTNAME`, and `$PWD` are popular choices). + +In `bash`, set this function to be the precmd starship function: + +```bash +starship_precmd_user_func="set_win_title" +``` + +In `zsh`, add this to the `precmd_functions` array: + +```bash +precmd_functions+=(set_win_title) +``` + +If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zsrhc`) to make it permanent. + +## Style Strings + +Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following: + + - `bold` + - `underline` + - `dimmed` + - `bg:` + - `fg:` + - `` + - `none` + +where `` is a color specifier (discussed below). `fg:` and `` currently do the same thing , though this may change in the future. The order of words in the string does not matter. + +The `none` token overrides all other tokens in a string, so that e.g. `fg:red none fg:blue` will still create a string with no styling. It may become an error to use `none` in conjunction with other tokens in the future. + +A color specifier can be one of the following: + + - One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`). + - A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp). + - A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png). + +If multiple colors are specified for foreground/background, the last one in the string will take priority. diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md new file mode 100644 index 00000000..2c225f0c --- /dev/null +++ b/docs/es-ES/config/README.md @@ -0,0 +1,1038 @@ +# Configuración + +::: tip + +🔥 Configuration is currently being worked on. Many new configuration options will be available in coming releases. + +::: + +To get started configuring starship, create the following file: `~/.config/starship.toml`. + +```shell +$ 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 + +# Replace the "❯" symbol in the prompt with "➜" +[character] # The name of the module we are configuring is "character" +symbol = "➜" # The "symbol" segment is being set to "➜" + +# Disable the package module, hiding it from the prompt completely +[package] +disabled = true +``` + +You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: +```shell +export STARSHIP_CONFIG=~/.starship +``` + +### Terminology + +**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. + +**Segment**: Smaller sub-components that compose a module. For example, the "symbol" segment in the "nodejs" module contains the character that is shown before the version number (⬢ by default). + +Here is the representation of the node module. In the following example, "symbol" and "version" are segments within it. Every module also has a prefix and suffix that are the default terminal color. + +``` +[prefix] [symbol] [version] [suffix] + "via " "⬢" "v10.4.1" "" +``` + +### Style Strings + +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/). + +- `"fg:green bg:blue"` sets green text on a blue background +- `"bg:blue fg:bright-green"` sets bright green text on a blue background +- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27 +- `"underline bg:#bf5700"` sets underlined text on a burnt orange background +- `"bold italic fg:purple"` sets bold italic purple text +- `""` explicitly disables all styling + +Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics. + +## Prompt + +This is the list of prompt-wide configuration options. + +### Options + +| Variable | Default | Description | +| -------------- | ----------------------------- | ------------------------------------------------------ | +| `add_newline` | `true` | Add a new line before the start of the prompt. | +| `prompt_order` | [link](#default-prompt-order) | Configure the order in which the prompt module occurs. | +| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). | + +### Example + +```toml +# ~/.config/starship.toml + +# Disable the newline at the start of the prompt +add_newline = false +# Overwrite a default_prompt_order and use custom prompt_order +prompt_order=["rust","line_break","package","line_break","character"] +# Wait 10 milliseconds for starship to check files under the current directory. +scan_timeout = 10 +``` + +### Default Prompt Order + +The default `prompt_order` is used to define the order in which modules are shown in the prompt, if empty or no `prompt_order` is provided. The default is as shown: + +```toml +prompt_order = [ + "username", + "hostname", + "kubernetes", + "directory", + "git_branch", + "git_commit", + "git_state", + "git_status", + "hg_branch", + "package", + "dotnet", + "golang", + "java", + "nodejs", + "php", + "python", + "ruby", + "rust", + "terraform", + "nix_shell", + "conda", + "memory_usage", + "aws", + "env_var", + "cmd_duration", + "line_break", + "jobs", + "battery", + "time", + "character", +] +``` + +## AWS + +The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. + +### Options + +| Variable | Default | Description | +| ----------------- | --------------- | --------------------------------------------------------------------------- | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `displayed_items` | `all` | Choose which item to display. Possible values: [`all`, `profile`, `region`] | +| `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. | + +### Example + +```toml +# ~/.config/starship.toml + +[aws] +style = "bold blue" +symbol = "🅰 " +displayed_items = "region" +[aws.region_aliases] +ap-southeast-2 = "au" +us-east-1 = "va" +``` + +## Battery + +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 + +| Variable | Default | Description | +| -------------------- | ------------------------ | ------------------------------------------------- | +| `full_symbol` | `"•"` | The symbol shown when the battery is full. | +| `charging_symbol` | `"⇡"` | The symbol shown when the battery is charging. | +| `discharging_symbol` | `"⇣"` | The symbol shown when the battery is discharging. | +| `display` | [link](#battery-display) | Display threshold and style for the module. | +| `disabled` | `false` | Disables the `battery` module. | + +
+There are also options for some uncommon battery states. + +| Variable | Description | +| ---------------- | --------------------------------------------------- | +| `unknown_symbol` | The symbol shown when the battery state is unknown. | +| `empty_symbol` | The symbol shown when the battery state is empty. | + +Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config. + +
+ +### Example + +```toml +# ~/.config/starship.toml + +[battery] +full_symbol = "🔋" +charging_symbol = "⚡️" +discharging_symbol = "💀" +``` + +### Battery 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. The default is as shown: + +```toml +[[battery.display]] +threshold = 10 +style = "bold red" +``` + +#### Options + +The `display` option is an array of the following table. + +| Variable | Description | +| ----------- | ----------------------------------------------- | +| `threshold` | The upper bound for the display option. | +| `style` | The style used if the display option is in use. | + +#### Example + +```toml +[[battery.display]] # "bold red" style when capacity is between 0% and 10% +threshold = 10 +style = "bold red" + +[[battery.display]] # "bold yellow" style when capacity is between 10% and 30% +threshold = 30 +style = "bold yellow" + +# when capacity is over 30%, the battery indicator will not be displayed + +``` + +## Character + +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. + +The character will tell you whether the last command was successful or not. It can do this in two ways: by changing color (red/green) or by changing its shape (❯/✖). The latter will only be done if `use_symbol_for_status` is set to `true`. + +### Options + +| Variable | Default | Description | +| ----------------------- | -------------- | ----------------------------------------------------------------------------------- | +| `symbol` | `"❯"` | The symbol used before the text input in the prompt. | +| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. | +| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. | +| `vicmd_symbol` | `"❮"` | The symbol used before the text input in the prompt if shell is in vim normal mode. | +| `style_success` | `"bold green"` | The style used if the last command was successful. | +| `style_failure` | `"bold red"` | The style used if the last command failed. | +| `disabled` | `false` | Disables the `character` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[character] +symbol = "➜" +error_symbol = "✗" +use_symbol_for_status = true +``` + +## Command Duration + +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 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. + +::: + +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 + +| Variable | Default | Description | +| ------------------- | --------------- | ---------------------------------------------------------- | +| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | +| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `prefix` | `took` | Prefix to display immediately before the command duration. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `cmd_duration` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[cmd_duration] +min_time = 500 +prefix = "underwent " +``` + +## Conda + +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. + +::: tip + +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. + +::: + +### Options + +| Variable | Default | Description | +| ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"C "` | The symbol used before the environment name. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `false` | Disables the `conda` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[conda] +style = "dimmed green" +``` + +## Directory + +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. + +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 + +| Variable | Default | Description | +| ------------------- | ------------- | -------------------------------------------------------------------------------- | +| `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. | +| `prefix` | `"in "` | Prefix to display immediately before the directory. | +| `style` | `"bold cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `directory` module. | + +
+This module has a few advanced configuration options that control how the directory is displayed. + +| Variable | Default | Description | +| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | +| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | + +
+ +### Example + +```toml +# ~/.config/starship.toml + +[directory] +truncation_length = 8 +``` + +## Dotnet + +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. + +This module will only be shown in your prompt when one of the following files are present in the current directory: `global.json`, `project.json`, `*.sln`, `*.csproj`, `*.fsproj`, `*.xproj`. You'll also need the .NET Core command-line tools installed in order to use it correctly. + +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. + +### Options + +| Variable | Default | Description | +| ----------- | ------------- | -------------------------------------------------------- | +| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. | +| `heuristic` | `true` | Use faster version detection to keep starship snappy. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dotnet` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[dotnet] +symbol = "🥅 " +style = "green" +heuristic = false +``` + +## Environment Variable + +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: + +- The `variable` configuration option matches an existing environment variable +- The `variable` configuration option is not defined, but the `default` configuration option is + +### Options + +| Variable | Default | Description | +| ---------- | ---------------- | ---------------------------------------------------------------------------- | +| `symbol` | | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `prefix` | `""` | Prefix to display immediately before the variable value. | +| `suffix` | `""` | Suffix to display immediately after the variable value. | +| `style` | `"dimmed black"` | The style for the module. | +| `disabled` | `false` | Disables the `env_var` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[env_var] +variable = "SHELL" +default = "unknown shell" +``` + +## Git Branch + +The `git_branch` module shows the active branch of the repo in your current directory. + +### Options + +| Variable | Default | Description | +| ------------------- | --------------- | ------------------------------------------------------------------------------------- | +| `symbol` | `" "` | The symbol used before the branch name of the repo in your current directory. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes | +| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use "" for no symbol | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `git_branch` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[git_branch] +symbol = "🌱 " +truncation_length = 4 +truncation_symbol = "" +``` + +## Git Commit + +The `git_commit` module shows the current commit hash of the repo in your current directory. + +::: tip + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +### Options + +| Variable | Default | Description | +| -------------------- | -------------- | ------------------------------------------------ | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `prefix` | `"("` | Prefix to display immediately before git commit. | +| `suffix` | `")"` | Suffix to display immediately after git commit. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `true` | Disables the `git_commit` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[git_commit] +disabled = false +commit_hash_length = 4 +``` + +## Git State + +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. + +### Options + +| Variable | Default | Description | +| ------------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------- | +| `rebase` | `"REBASING"` | The text displayed when a `rebase` is in progress. | +| `merge` | `"MERGING"` | The text displayed when a `merge` is in progress. | +| `revert` | `"REVERTING"` | The text displayed when a `revert` is in progress. | +| `cherry_pick` | `"CHERRY-PICKING"` | The text displayed when a `cherry-pick` is in progress. | +| `bisect` | `"BISECTING"` | The text displayed when a `bisect` is in progress. | +| `am` | `"AM"` | The text displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `"AM/REBASE"` | The text displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `progress_divider` | `"/"` | The symbol or text which will separate the current and total progress amounts. (e.g., `" of "`, for `"3 of 10"`) | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `git_state` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[git_state] +progress_divider = " of " +cherry_pick = "🍒 PICKING" +``` + +## Git Status + +The `git_status` module shows symbols representing the state of the repo in your current directory. + +### Options + +| Variable | Default | Description | +| ------------------ | -------------------------- | ------------------------------------------------------- | +| `conflicted` | `"="` | This branch has merge conflicts. | +| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. | +| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. | +| `behind` | `"⇣"` | This branch is behind of the branch being tracked. | +| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. | +| `untracked` | `"?"` | There are untracked files in the working directory. | +| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. | +| `stashed` | `"$"` | A stash exists for the local repository. | +| `stashed_count` | [link](#git-status-counts) | Show and style the number of stashes. | +| `modified` | `"!"` | There are file modifications in the working directory. | +| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. | +| `staged` | `"+"` | A new file has been added to the staging area. | +| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. | +| `renamed` | `"»"` | A renamed file has been added to the staging area. | +| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. | +| `deleted` | `"✘"` | A file's deletion has been added to the staging area. | +| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. | +| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. | +| `prefix` | `[` | Prefix to display immediately before git status. | +| `suffix` | `]` | Suffix to display immediately after git status. | +| `style` | `"bold red"` | The style for the module. | +| `disabled` | `false` | Disables the `git_status` module. | + +#### Git Status Counts + +| Variable | Default | Description | +| --------- | ------- | ------------------------------------------------------ | +| `enabled` | `false` | Show the number of files | +| `style` | | Optionally style the count differently than the module | + +### Example + +```toml +# ~/.config/starship.toml + +[git_status] +conflicted = "🏳" +ahead = "🏎💨" +behind = "😰" +diverged = "😵" +untracked = "🤷‍" +stashed = "📦" +modified = "📝" +staged.value = "++" +staged.style = "green" +staged_count.enabled = true +staged_count.style = "green" +renamed = "👅" +deleted = "🗑" +``` + +## Golang + +The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met: + +- The current directory contains a `go.mod` file +- The current directory contains a `go.sum` file +- The current directory contains a `glide.yaml` file +- The current directory contains a `Gopkg.yml` file +- The current directory contains a `Gopkg.lock` file +- The current directory contains a `Godeps` directory +- The current directory contains a file with the `.go` extension + +### Options + +| Variable | Default | Description | +| ---------- | ------------- | -------------------------------------------------------- | +| `symbol` | `"🐹 "` | The symbol used before displaying the version of Golang. | +| `style` | `"bold cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `golang` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[golang] +symbol = "🏎💨 " +``` + +## Mercurial Branch + +The `hg_branch` module shows the active branch of the repo in your current directory. + +### Options + +| Variable | Default | Description | +| ------------------- | --------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes | +| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `true` | Disables the `hg_branch` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[hg_branch] +symbol = "🌱 " +truncation_length = 4 +truncation_symbol = "" +``` + +## Hostname + +The `hostname` module shows the system hostname. + +### Options + +| Variable | Default | Description | +| ---------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `prefix` | `""` | Prefix to display immediately before the hostname. | +| `suffix` | `""` | Suffix to display immediately after the hostname. | +| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | +| `style` | `"bold dimmed green"` | The style for the module. | +| `disabled` | `false` | Disables the `hostname` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[hostname] +ssh_only = false +prefix = "⟪" +suffix = "⟫" +trim_at = ".companyname.com" +disabled = false +``` + +## Jobs + +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. + +### Options + +| Variable | Default | Description | +| ----------- | ------------- | ----------------------------------------------------- | +| `symbol` | `"✦"` | The symbol used before displaying the number of jobs. | +| `threshold` | `1` | Show number of jobs if exceeded. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `jobs` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[jobs] +symbol = "+ " +threshold = 4 +``` + +## Kubernetes + +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 + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +### Options + +| Variable | Default | Description | +| ---------- | ------------- | --------------------------------------------------- | +| `symbol` | `"☸ "` | The symbol used before displaying the Cluster info. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `true` | Disables the `kubernetes` module | + +### Example + +```toml +# ~/.config/starship.toml + +[kubernetes] +symbol = "⛵ " +style = "dim green" +disabled = false +``` + +## Line Break + +The `line_break` module separates the prompt into two lines. + +### Options + +| Variable | Default | Description | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | + +### Example + +```toml +# ~/.config/starship.toml + +[line_break] +disabled = true +``` + +## Nix-shell + +The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. + +### Options + +| Variable | Default | Description | +| ------------ | ------------ | ---------------------------------- | +| `use_name` | `false` | Display the name of the nix-shell. | +| `impure_msg` | `"impure"` | Customize the "impure" msg. | +| `pure_msg` | `"pure"` | Customize the "pure" msg. | +| `style` | `"bold red"` | The style for the module. | +| `disabled` | `false` | Disables the `nix_shell` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[nix_shell] +disabled = true +use_name = true +impure_msg = "impure shell" +pure_msg = "pure shell" +``` + +## Java + +The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met: + +- The current directory contains a `pom.xml`, `build.gradle`, `build.gradle.kts` or `build.sbt` file +- The current directory contains a file with the `.java`, `.class` or `.jar` extension + +### Options + +| Variable | Default | Description | +| ---------- | -------------- | ------------------------------------------------------ | +| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. | +| `style` | `"dimmed red"` | The style for the module. | +| `disabled` | `false` | Disables the `java` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[java] +symbol = "🌟 " +``` + +## Memory Usage + +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 + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +### Options + +| Variable | Default | Description | +| ----------------- | --------------------- | ------------------------------------------------------------- | +| `show_percentage` | `false` | Display memory usage as a percentage of the available memory. | +| `show_swap` | `true` | Display swap usage if total swap is non-zero. | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `symbol` | `"🐏 "` | The symbol used before displaying the memory usage. | +| `separator` | `" | "` | The symbol or text that will seperate the ram and swap usage. | +| `style` | `"bold dimmed white"` | The style for the module. | +| `disabled` | `true` | Disables the `memory_usage` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[memory_usage] +show_percentage = true +show_swap = true +threshold = -1 +symbol = " " +separator = "/" +style = "bold dimmed green" +``` + +## NodeJS + +The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met: + +- The current directory contains a `package.json` file +- The current directory contains a `node_modules` directory +- The current directory contains a file with the `.js` extension + +### Options + +| Variable | Default | Description | +| ---------- | -------------- | -------------------------------------------------------- | +| `symbol` | `"⬢ "` | The symbol used before displaying the version of NodeJS. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `false` | Disables the `nodejs` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[nodejs] +symbol = "🤖 " +``` + +## Package Version + +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`, and `poetry` packages. + +- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory +- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory +- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory +- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory + +> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. + +### Options + +| Variable | Default | Description | +| ---------- | ------------ | ---------------------------------------------------------- | +| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | +| `style` | `"bold red"` | The style for the module. | +| `disabled` | `false` | Disables the `package` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[package] +symbol = "🎁 " +``` + +## PHP + +The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met: + +- The current directory contains a `composer.json` file +- The current directory contains a `.php` file + +### Options + +| Variable | Default | Description | +| ---------- | ------------ | ----------------------------------------------------- | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `style` | `"bold red"` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[php] +symbol = "🔹 " +``` + +## Python + +The `python` module shows the currently installed version of Python. + +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` and show the current Python virtual environment if one is activated. + +The module will be shown if any of the following conditions are met: + +- The current directory contains a `.python-version` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `pyproject.toml` file +- The current directory contains a file with the `.py` extension +- The current directory contains a `Pipfile` file +- The current directory contains a `tox.ini` file +- A virtual environment is currently activated + +### Options + +| Variable | Default | Description | +| -------------------- | --------------- | --------------------------------------------------------------------------- | +| `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `python` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[python] +symbol = "👾 " +pyenv_version_name = true +pyenv_prefix = "foo " +``` + +## Ruby + +The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Gemfile` file +- The current directory contains a `.rb` file + +### Options + +| Variable | Default | Description | +| ---------- | ------------ | ------------------------------------------------------ | +| `symbol` | `"💎 "` | The symbol used before displaying the version of Ruby. | +| `style` | `"bold red"` | The style for the module. | +| `disabled` | `false` | Disables the `ruby` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[ruby] +symbol = "🔺 " +``` + +## Rust + +The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension + +### Options + +| Variable | Default | Description | +| ---------- | ------------ | ------------------------------------------------------ | +| `symbol` | `"🦀 "` | The symbol used before displaying the version of Rust. | +| `style` | `"bold red"` | The style for the module. | +| `disabled` | `false` | Disables the `rust` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[rust] +symbol = "⚙️ " +``` + +## Terraform + +The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. The module will be shown if any of the following conditions are met: + +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf` extension + +### Options + +| Variable | Default | Description | +| -------------- | ------------ | ----------------------------------------------------------- | +| `symbol` | `"💠 "` | The symbol used before displaying the terraform workspace. | +| `show_version` | `false` | Shows the terraform version. Very slow on large workspaces. | +| `style` | `"bold 105"` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[terraform] +symbol = "🏎💨 " +``` + +## Time + +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. + +::: tip + +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. + +::: + +### Options + +| Variable | Default | Description | +| ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------- | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `bold yellow` | The style for the module time | +| `utc_time_offset` | `local` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | + +If `use_12hr` is `true`, then `format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `format` will override the `use_12hr` setting. + +### Example + +```toml +# ~/.config/starship.toml + +[time] +disabled = false +format = "🕙[ %T ]" +utc_time_offset = -5 +``` + +## Username + +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: + +- 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 + +### Options + +| Variable | Default | Description | +| ------------- | --------------- | ------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root. | +| `style_user` | `"bold yellow"` | The style used for non-root users. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[username] +disabled = true +``` diff --git a/docs/es-ES/faq/README.md b/docs/es-ES/faq/README.md new file mode 100644 index 00000000..478f25c6 --- /dev/null +++ b/docs/es-ES/faq/README.md @@ -0,0 +1,45 @@ +# Preguntas frecuentes (FAQ) + +## ¿Cuál es la configuración usada en el GIF de demostración? + +- **Emulador de terminal**: [iTerm2](https://iterm2.com/) + - **Tema**: Mínimo + - **Esquema de color**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy) + - **Font**: [Fira Code](https://github.com/tonsky/FiraCode) +- **Interfaz de línea de comandos**: [Fish Shell](https://fishshell.com/) + - **Configuración**: [archivos de configuración de matchai](https://github.com/matchai/dotfiles/blob/master/.config/fish/config.fish) + - **Prompt**: [Starship](https://starship.rs/) + +## Do `prompt_order` and `.disabled` do the same thing? + +Yes, they can both be used to disable modules in the prompt. If all you plan to do is disable modules, `.disabled` is the preferred way to do so for these reasons: + +- Disabling modules is more explicit than omitting them from the prompt_order +- Newly created modules will be added to the prompt as Starship is updated + +## The docs say Starship is cross-shell, but it doesn't support X shell. Why? + +The way Starship is built, it should be possible to add support for virtually any shell. The starship binary is stateless and shell agnostic, so as long as your shell supports prompt customization and shell expansion, Starship can be used. + +Here's a small example getting Starship working with bash: + +```sh +# Get the status code from the last command executed +STATUS=$? + +# Get the number of jobs running. +NUM_JOBS=$(jobs -p | wc -l) + +# Set the prompt to the output of `starship prompt` +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. + +For a list of all flags accepted by `starship prompt`, use the following command: + +```sh +starship prompt --help +``` + +The prompt will use as much context as is provided, but no flags are "required". diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md new file mode 100644 index 00000000..f714730a --- /dev/null +++ b/docs/es-ES/guide/README.md @@ -0,0 +1,351 @@ +

+
Starship - Prompt multi interfaz de línea de comandos +

+

+ Estado del flujo de trabajo de GitHub Actions + Versión de Crates.io + Estado de empaquetado
+ Chat en Discord + +Todos los colaboradores + +

+ +

+
+ Sitio web + +Instalación + +Configuración +

+

+ English +   + 日本語 +   + 繁體中文 +   + 简体中文 +   + Deutsch +   + Español +   + Francés +   + Ruso +

+ +

+ +

¡Starship es la prompt minimalista, ultrarápida y altamente personalizable para cualquier interfaz de línea de comandos!
La prompt muestra información que necesitas mientras estás trabajando, mientras se mantiene elegante y fuera del camino.

+ +

+
+ Starship con iTerm 2 y el tema Snazzy +
+
+

+ +## 🍬 Características + +- Los caracteres de la prompt se colorean de rojo si el último comando termina con un código distinto a cero +- Versión actual de Go (`🐹`) +- Versión actual de Java (`☕`) +- Versión actual de Node.js (`⬢`) +- Versión actual de PHP (`🐘`) +- Versión actual de Python (`🐍`) +- Versión actual de Ruby (`💎`) +- Versión actual de Rust (`🦀`) +- Versión actual de .NET (`•NET`) +- Versión actual del paquete en el directorio actual (`📦`) + - npm (Node.js) + - cargo (Rust) + - poetry (Python) + - composer (PHP) +- Rama actual del repositorio git e información enriquecida de su estado: + - `=` — cambios conflictivos + - `⇡` — por delante de la rama remota + - `⇣` — por detrás de la rama remota + - `⇕` — cambios divergentes + - `?` — cambios sin rastrear + - `$` — cambios guardados + - `!` — archivos modificados + - `+` — archivos añadidos + - `»` — archivos renombrados + - `✘` — archivos eliminados +- Rama Mercurial actual +- Nivel y estado actual de la batería +- `⇡` – cargando +- `⇣` – descargándo +- `•` –completamente cargada +- Indicador para las tareas de fondo (`✦`) +- Cluster y espacio de nombres actual de Kubernetes (`☸`) +- Perfil actual de Amazon Web Services (AWS) (`☁️`) +- Tiempo de ejecución del último comando +- Valor de variable de entorno personalizado +- Detección del entorno de la interfaz de línea de comandos *nix +- Nombre de usuario actual si no es el mismo que el del usuario conectado +- Hora actual opcional en formato 12/24 hrs. + +## 🚀 Instalación + +### Prerequisitos + +- Una [fuente Powerline](https://github.com/powerline/fonts) instalado y activada en tu terminal (por ejemplo, prueba con [Fira Code](https://github.com/tonsky/FiraCode)). + +### Comenzando + +1. Instala el binario de **starship**: + + + #### Instalar la última versión + + + ##### From prebuilt binary, with Shell: + + ```sh + curl -fsSL https://starship.rs/install.sh | bash + ``` + + + ##### From source on [crates.io](https://crates.io/): + + ```sh + cargo install starship + ``` + + + #### Instalar con un gestor de paquetes + + + ##### Con [Homebew](https://brew.sh/): + + ```sh + brew install starship + ``` + + + ##### Con [Scoop](https://scoop.sh): + + ```powershell + scoop install starship + ``` + +1. Añade el script de inicio al archivo de configuración de tu interfaz de línea de comandos: + + + #### Bash + + Añade el siguiente código al final de `~/.bashrc`: + + ```sh + # ~/.bashrc + + eval "$(starship init bash)" + ``` + + + #### Fish + + Añade el siguiente código al final de `~/.config/fish/config.fish`: + + ```sh + # ~/.config/fish/config.fish + + starship init fish | source + ``` + + + #### Zsh + + Añade el siguiente código al final de `~/.zshrc`: + + ```sh + # ~/.zshrc + + eval "$(starship init zsh)" + ``` + + + #### PowerShell + + Añade el siguiente código al final de `~\Documentos\PowerShell\Microsoft.PowerShell_profile.ps1` (o `~/.config/powershell/Microsoft.PowerShell_profile.ps1` en *nix): + + ```sh + # ~\Documents\PowerShell\Profile.ps1 + + Invoke-Expression (&starship init powershell) + ``` + + + #### Ion + + Añade el siguiente código al final de `~/.config/ion/initrc`: + + ```sh + # ~/.config/ion/initrc + + eval $(starship init ion) + ``` + +## 🔧 Configuración + +Para más detalles sobre cómo configurar Starship, consulta nuestra [documentación](https://starship.rs/config/). + +## 🤝 Contribuir + +¡Siempre estamos buscando colaboradores de **todos los niveles y habilidades**! Si estás interesado en empezar en el proyecto con algo sencillo, prueba con un problema etiquetado como [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). + +### Necesidades de alta prioridad + +- 👩‍💼 **Gerente de producto** + - Tenemos un proyecto en GitHub y muchas características sin organizar ni priorizar, así como ideas que aún no han sido escritas en issues de GitHub. ¡Starship necesita alguien que gestione la dirección del producto! +- 👩‍🎨 **Diseñador/a** + - ¿Te gusta hacer sitios web llamativos? ¡Excelente! Estamos buscando crear una página principal que muestre Starship en toda su gloria. ¡Ayudar con el diseño de la marca de Starship es una gran oportunidad para probar nuevas ideas! +- 👩‍💻 **Programador de Rust** + - Hay _un montón_ de fruta madura cuando se trata de escribir Rust idiomático, diseñar una arquitectura Rust efectiva, optimizaciones de rendimiento, optimizaciones de compilación multiplataforma, ¡y mucho más! I ([@matchai](https://github.com/matchai)) soy un principiante con Rust. ¡Ven y llévanos por la dirección correcta! + +Si estás interesado en ayudar contribuyendo a starship, por favor échale un vistazo a [Guía de Colaboración](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). También siéntete libre de pasarte por nuestro [servidor de Discord](https://discord.gg/8Jzqu3T) y saludarnos. 👋 + +### Colaboradores + +Los agradecimientos van a estas maravillosas personas ([clave emoji](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Matan Kushner
💻 🎨 🤔 🚇 🚧 👀 ⚠️
John Letey
💻 🤔 👀 ⚠️
Tim Mulqueen
💻 🤔 👀 ⚠️
Tiffany Le-Nguyen
🤔 🚧 👀 📖
​Snuggle
🎨 🤔 🚧 👀
Ryan Leckey
👀
Youssef Habri
💻

Kevin Song
🐛 💻 📖 ⚠️
Andrew Dassonville
🐛 💻
MaT1g3R
💻 📖 ⚠️
André Zanellato
💻 📖 ⚠️
Saghm Rossi
💻 📖 ⚠️
Shu Kutsuzawa
💻 📖 ⚠️ 🌍
Saurav Sharma
💻 📖

Thomas O'Donnell
💻 ⚠️ 📖 👀
Bruno Bigras
💻 👀
Neil Kistner
💻 ⚠️ 👀
Quinn Strahl
💻 ⚠️
Titouan Vervack
💻 ⚠️
Francisco Lopes
💻
Andrew Houts
💻 📖 ⚠️

Nick Young
💻 📖 ⚠️ 👀
Gabriel de Perthuis
💻
Hofer-Julian
📖
Yuji Ueki
🖋 🌍
谢祯晖
💻 📖 🌍 👀
Kutsuzawa Ryo
👀 💻 ⚠️ 🌍
hdevalke
🤔

Kuba Clark
💻 📖 ⚠️
Gimbar
💻 ⚠️ 📖
Tom Hotston
💻 📖
Bijan Chokoufe Nejad
💻 ⚠️ 👀
yuri
💻 📖 ⚠️
TsubasaKawajiri
🌍
Ryo Yamashita
💻

Thomas Lee
💻
(´⌣`ʃƪ)
💻
Barnaby Keene
💻
Keith Wade
💻 ⚠️
LukeAI
📖
Zach Mertes
💻 📖 ⚠️
David Knaack
💻 📖 ⚠️

Carl Summers
📖
Yushan Lin
🌍
Weihang Lo
🌍
pinshan
🌍
Brian Low
💻 📖 ⚠️
Matias Kotlik
💻
marblenix
🚇 💻 ⚠️

Raidou
💻 ⚠️
Luca Greco
💻 📖 ⚠️
Luca Rinaldi
💻
Stephen Ball
💻 ⚠️ 📖
Qingping Hou
💻 📖 ⚠️
Dan Wendorf
💻 ⚠️
Alan Pope
🚇

BuggStream
💻 📖
Jon Grythe Stødle
💻 ⚠️
Jason Etcovitch
🐛
Etienne Mabille
💻
AppleTheGolden
💻 📖
Mike Sampson
💻 📖 ⚠️
Dominik Braun
💻

David Hewson
💻
+ + + + + +Este proyecto sigue la especificación [todos-los-colaboradores](https://github.com/all-contributors/all-contributors). ¡Son bienvenidas contribuciones de cualquier tipo! + +## 💭 Inspirado por + +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/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - robbyrussel, tema multi interfaz de línea de comandos escrito en JavaScript. + +- **[reujab/silver](https://github.com/reujab/silver)** - Una prompt con iconos, personalizable y multi interfaz de línea de comandos basada en PowerLine. + +

+
+ Icono de cohete de Starship +

+ +## 📝 Licencia + +Derechos de autor © 2019-presente, [Colaboradores de Starship](https://github.com/starship/starship/graphs/contributors).
Este proyecto está bajo una licencia [ISC](https://github.com/starship/starship/blob/master/LICENSE). diff --git a/docs/es-ES/presets/README.md b/docs/es-ES/presets/README.md new file mode 100644 index 00000000..71af0625 --- /dev/null +++ b/docs/es-ES/presets/README.md @@ -0,0 +1,61 @@ +# Presets + +Here is a collection of community-submitted configuration presets for Starship. If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊 + +## Nerd Font Symbols + +This preset doesn't change anything except for the symbols used for each module. If emojis aren't your thing, this might catch your eye! + +![Screenshot of Nerd Font Symbols preset](/presets/nerd-font-symbols.png) + +### Prerequisitos + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font) + +### Configuración + +```toml +[aws] +symbol = " " + +[battery] +full_symbol = "" +charging_symbol = "" +discharging_symbol = "" + +[conda] +symbol = " " + +[git_branch] +symbol = " " + +[golang] +symbol = " " + +[hg_branch] +symbol = " " + +[java] +symbol = " " + +[memory_usage] +symbol = " " + +[nodejs] +symbol = " " + +[package] +symbol = " " + +[php] +symbol = " " + +[python] +symbol = " " + +[ruby] +symbol = " " + +[rust] +symbol = " " +``` diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index f309621a..89173987 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -27,6 +27,11 @@ symbol = "➜" # Le segment "symbol" est mis comme "➜" disabled = true ``` +You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: +```shell +export STARSHIP_CONFIG=~/.starship +``` + ### Terminologie **Module**: Un composant dans l'invite donnant des informations basées sur des informations contextuelles à propos de votre Système d'Exploitation. Par exemple, le module "nodejs" montre la version de NodeJS qui est actuellement installée sur votre ordinateur, si votre répertoire actuel est un projet NodeJS. @@ -42,7 +47,7 @@ Voici la représentation du module node. Dans l'exemple suivant, "symbol" et "ve ### Chaînes de style -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/). +La plupart des modules de Starship vous permettent de configurer leurs styles d'affichage. 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/). - `"fg:green bg:blue"` sets green text on a blue background - `"bg:blue fg:bright-green"` sets bright green text on a blue background @@ -499,6 +504,7 @@ The `git_status` module shows symbols representing the state of the repo in your | `untracked` | `"?"` | There are untracked files in the working directory. | | `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. | | `stashed` | `"$"` | A stash exists for the local repository. | +| `stashed_count` | [link](#git-status-counts) | Show and style the number of stashes. | | `modified` | `"!"` | There are file modifications in the working directory. | | `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. | | `staged` | `"+"` | A new file has been added to the staging area. | diff --git a/docs/fr-FR/guide/README.md b/docs/fr-FR/guide/README.md index 3ab04db5..416313a0 100644 --- a/docs/fr-FR/guide/README.md +++ b/docs/fr-FR/guide/README.md @@ -21,7 +21,7 @@ src="https://img.shields.io/discord/567163873606500352?logo=discord" alt="Discuter sur Discord" /> -Tous les contributeurs +Tous les contributeurs

@@ -49,6 +49,9 @@ Deutsch   + Español +   Français   @@ -122,13 +125,20 @@ #### Installer la dernière version - ##### Avec Shell: + ##### From prebuilt binary, with Shell: ```sh curl -fsSL https://starship.rs/install.sh | bash ``` + ##### From source on [crates.io](https://crates.io/): + + ```sh + cargo install starship + ``` + + #### Installer via le gestionnaire de paquets @@ -290,7 +300,7 @@ Merci à ces personnes merveilleuses ([clé emojis](https://allcontributors.org/
pinshan
🌍
Brian Low
💻 📖 ⚠️
Matias Kotlik
💻 -
marblenix
🚇 +
marblenix
🚇 💻 ⚠️
Raidou
💻 ⚠️ @@ -310,6 +320,9 @@ Merci à ces personnes merveilleuses ([clé emojis](https://allcontributors.org/
Mike Sampson
💻 📖 ⚠️
Dominik Braun
💻 + +
David Hewson
💻 + diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md index d94ba653..6ae964ba 100644 --- a/docs/ja-JP/README.md +++ b/docs/ja-JP/README.md @@ -33,24 +33,24 @@ footer: ISC Licensed | Copyright © 2019-present Starship Contributors 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 @@ -105,7 +105,7 @@ footer: ISC Licensed | Copyright © 2019-present Starship Contributors #### Ion - Add the following to the end of `~/.config/ion/initrc`: + `~/.config/ion/initrc `の最後に次を追加してください ```sh # ~/.config/ion/initrc diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index a23a50c1..895b885e 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -27,6 +27,11 @@ symbol = "➜" # The "symbol" segment is being set to "➜" disabled = true ``` +You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: +```shell +export STARSHIP_CONFIG=~/.starship +``` + ### 用語 **モジュール**: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。 たとえば、現在のディレクトリがNodeJSプロジェクトである場合、「nodejs」モジュールは、現在コンピューターにインストールされているNodeJSのバージョンを表示します。 @@ -490,29 +495,30 @@ cherry_pick = "🍒 PICKING" ### オプション -| 変数 | デフォルト | 説明 | -| ------------------ | -------------------------- | ------------------------------- | -| `conflicted` | `"="` | このブランチにはマージの競合があります。 | -| `conflicted_count` | [link](#git-status-counts) | 競合の数の表示およびスタイル設定します。 | -| `ahead` | `"⇡"` | このブランチは、追跡されるブランチよりも先にあります。 | -| `behind` | `"⇣"` | このブランチは、追跡されているブランチの背後にあります。 | -| `diverged` | `"⇕"` | このブランチは、追跡されているブランチから分岐しています。 | -| `untracked` | `"?"` | 作業ディレクトリに追跡されていないファイルがあります。 | -| `untracked_count` | [link](#git-status-counts) | 追跡されていないファイルの数を表示およびスタイル設定します。 | -| `stashed` | `"$"` | ローカルリポジトリ用のスタッシュが存在します。 | -| `modified` | `"!"` | 作業ディレクトリにファイルの変更があります。 | -| `modified_count` | [link](#git-status-counts) | 変更されたファイルの数を表示およびスタイル設定します。 | -| `staged` | `"+"` | 新しいファイルがステージング領域に追加されました。 | -| `staged_count` | [link](#git-status-counts) | ステージングされたファイルの数を表示およびスタイル設定します。 | -| `renamed` | `"»"` | 名前が変更されたファイルがステージング領域に追加されました。 | -| `renamed_count` | [link](#git-status-counts) | 名前を変更したファイルの数を表示およびスタイル設定します。 | -| `deleted` | `"✘"` | ファイルの削除がステージング領域に追加されました。 | -| `deleted_count` | [link](#git-status-counts) | 削除されたファイルの数を表示およびスタイルします。 | -| `show_sync_count` | `false` | 追跡されているブランチの先行/後方カウントを表示します。 | -| `prefix` | `[` | このモジュールの先頭に表示される文字列です。 | -| `suffix` | `]` | このモジュールの末尾に表示される文字列です。 | -| `style` | `"bold red"` | モジュールのスタイルです。 | -| `disabled` | `false` | `git_status`モジュールを無効にします。 | +| 変数 | デフォルト | 説明 | +| ------------------ | -------------------------- | ------------------------------------- | +| `conflicted` | `"="` | このブランチにはマージの競合があります。 | +| `conflicted_count` | [link](#git-status-counts) | 競合の数の表示およびスタイル設定します。 | +| `ahead` | `"⇡"` | このブランチは、追跡されるブランチよりも先にあります。 | +| `behind` | `"⇣"` | このブランチは、追跡されているブランチの背後にあります。 | +| `diverged` | `"⇕"` | このブランチは、追跡されているブランチから分岐しています。 | +| `untracked` | `"?"` | 作業ディレクトリに追跡されていないファイルがあります。 | +| `untracked_count` | [link](#git-status-counts) | 追跡されていないファイルの数を表示およびスタイル設定します。 | +| `stashed` | `"$"` | ローカルリポジトリ用のスタッシュが存在します。 | +| `stashed_count` | [link](#git-status-counts) | Show and style the number of stashes. | +| `modified` | `"!"` | 作業ディレクトリにファイルの変更があります。 | +| `modified_count` | [link](#git-status-counts) | 変更されたファイルの数を表示およびスタイル設定します。 | +| `staged` | `"+"` | 新しいファイルがステージング領域に追加されました。 | +| `staged_count` | [link](#git-status-counts) | ステージングされたファイルの数を表示およびスタイル設定します。 | +| `renamed` | `"»"` | 名前が変更されたファイルがステージング領域に追加されました。 | +| `renamed_count` | [link](#git-status-counts) | 名前を変更したファイルの数を表示およびスタイル設定します。 | +| `deleted` | `"✘"` | ファイルの削除がステージング領域に追加されました。 | +| `deleted_count` | [link](#git-status-counts) | 削除されたファイルの数を表示およびスタイルします。 | +| `show_sync_count` | `false` | 追跡されているブランチの先行/後方カウントを表示します。 | +| `prefix` | `[` | このモジュールの先頭に表示される文字列です。 | +| `suffix` | `]` | このモジュールの末尾に表示される文字列です。 | +| `style` | `"bold red"` | モジュールのスタイルです。 | +| `disabled` | `false` | `git_status`モジュールを無効にします。 | #### Git Statusのカウント diff --git a/docs/ja-JP/guide/README.md b/docs/ja-JP/guide/README.md index 69c3213d..02523238 100644 --- a/docs/ja-JP/guide/README.md +++ b/docs/ja-JP/guide/README.md @@ -21,7 +21,7 @@ src="https://img.shields.io/discord/567163873606500352?logo=discord" alt="Chat on Discord" /> -All Contributors +All Contributors

@@ -49,6 +49,9 @@ Deutsch   + Español +   Français   @@ -70,14 +73,14 @@ ## 🍬 機能 - 最後のコマンドがゼロ以外のコードで終了すると、プロンプト文字が赤に変わります -- 現在の Go バージョン (`🐹`) +- 現在の Go のバージョン (`🐹`) - 現在の Java のバージョン (`☕`) - 現在の Node.js のバージョン (`⬢`) -- Current PHP version (`🐘`) +- 現在の PHP のバージョン (`🐘`) - 現在の Python のバージョン (`🐍`) - 現在の Ruby のバージョン (`💎`) - 現在の Rust のバージョン (`🦀`) -- Current .NET version (`•NET`) +- 現在の .NET のバージョン (`•NET`) - カレントディレクトリにある現在のパッケージバージョン(`📦`) - npm (Node.js) - cargo (Rust) @@ -94,58 +97,68 @@ - `+` — 追加されたファイル - `»` — 名前が変更されたファイル - `✘` — 削除されたファイル -- Current Mercurial branch +- 現在の Mercurial ブランチ - 現在のバッテリー残量と状態 -- `⇡` – charging -- `⇣` – discharging -- `•` – fully charged +- `⇡` – 充電中 +- `⇣` – 放電中 +- `•` – 満タン - バックグラウンドジョブのインジケーター (`✦`) - 現在のKubernetesクラスタとネームスペース (`☸`) -- Current Amazon Web Services (AWS) profile (`☁️`) -- Execution time of the last command -- Custom environment variable value -- Nix-shell の環境検出 -- ログインユーザーと異なる場合にユーザー名を表示する -- Optional current time in 12/24hr format +- 現在のAmazon Web Services (AWS) プロファイル(`☁️) +
  • 最後のコマンドの実行時間
    • +
  • カスタム環境変数の値
    • +
  • Nix-shell の環境検出
    • +
  • ログインユーザーと異なる場合にユーザー名を表示する
    • +
  • 12/24時間形式のオプションの現在時刻
    • + -## 🚀 インストール +

    🚀 インストール

    -### 必要なもの +

    必要なもの

    -- [Powerline フォント](https://github.com/powerline/fonts) がターミナルにインストールされて有効になっている必要があります（例えば [Fira Code](https://github.com/tonsky/FiraCode) を試してみてください）。 +
      +
    • Powerline フォント がターミナルにインストールされて有効になっている必要があります（例えば Fira Code を試してみてください）。
      • +
    -### 入門 +

    入門

    -1. **Starship** のバイナリをインストール +
      +

    1. Starship のバイナリをインストール

      + +

      最新版のインストール

      + +
      ビルド済みのバイナリをインストール
      + +
         curl -fsSL https://starship.rs/install.sh | bash
+`
      - #### Install Latest Version - - - ##### With Shell: + ##### [crates.io](https://crates.io/)からソースをインストール ```sh - curl -fsSL https://starship.rs/install.sh | bash + cargo install starship ``` - #### 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 ``` -1. 初期化のためのスクリプトをシェルの設定ファイルに追加 +1 + +初期化のためのスクリプトをシェルの設定ファイルに追加 #### Bash @@ -194,13 +207,14 @@ #### Ion - Add the following to the end of `~/.config/ion/initrc`: + `~/.config/ion/initrc `の最後に次を追加してください ```sh # ~/.config/ion/initrc eval $(starship init ion) ``` +
    ## 🔧 設定 @@ -290,7 +304,7 @@ Starship の設定方法の詳細に関しては、[ドキュメント](https://
    pinshan
    🌍
    Brian Low
    💻 📖 ⚠️
    Matias Kotlik
    💻 -
    marblenix
    🚇 +
    marblenix
    🚇 💻 ⚠️
    Raidou
    💻 ⚠️ @@ -310,6 +324,9 @@ Starship の設定方法の詳細に関しては、[ドキュメント](https://
    Mike Sampson
    💻 📖 ⚠️
    Dominik Braun
    💻 + +
    David Hewson
    💻 + diff --git a/docs/ja-JP/presets/README.md b/docs/ja-JP/presets/README.md index c19028d4..034a992d 100644 --- a/docs/ja-JP/presets/README.md +++ b/docs/ja-JP/presets/README.md @@ -1,19 +1,27 @@ -# Presets +# 準備するもの + +以下は、Starship用にコミュニティに提供された構成プリセットのコレクションです。 共有するプリセットがある場合は、このファイルを更新してPRを送信してください！ 😊

    + -Here is a collection of community-submitted configuration presets for Starship. If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊 ## Nerd Font Symbols -This preset doesn't change anything except for the symbols used for each module. If emojis aren't your thing, this might catch your eye! +このプリセットは、各モジュールに使用されるシンボル以外は何も変更しません。 絵文字が気に食わない場合、これはあなたの目を引くかもしれません！ ![Screenshot of Nerd Font Symbols preset](/presets/nerd-font-symbols.png) + + ### 必要なもの -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font) +- 端末にインストールされ、有効になっているNerd Font（例ではFira Code Nerd Fontを使用) + + ### 設定 + + ```toml [aws] symbol = " " diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index 9e499263..1726b110 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -27,6 +27,11 @@ symbol = "➜" # Сегменту "symbol" присваеваем знач disabled = true ``` +Вы можете изменить расположение файла `starship.toml` переменной окружения `STARSHIP_CONFIG`: +```shell +export STARSHIP_CONFIG=~/.starship +``` + ### Терминология **Модуль**: Компонент строки, дающий информацию на основе контекстной информации вашей ОС. Например, модуль "nodejs" показывает установленную версию NodeJS на вашем компьютере, если вы находитесь в директории проекта NodeJS. @@ -127,7 +132,7 @@ prompt_order = [ | ----------------- | --------------- | ---------------------------------------------------------------- | | `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. | | `displayed_items` | `all` | Выбор элементов. Возможные значения [`all`, `profile`, `region`] | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. | | `style` | `"bold yellow"` | Стиль модуля. | | `disabled` | `false` | Отключение модуля `AWS`. | @@ -259,13 +264,13 @@ use_symbol_for_status = true ### Опции -| Переменная | По умолчанию | Описание | -| ------------------- | --------------- | ---------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | -| `prefix` | `took` | Префикс, отображаемый перед продолжительностью команды. | -| `style` | `"bold yellow"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `cmd_duration`. | +| Переменная | По умолчанию | Описание | +| ------------------- | --------------- | -------------------------------------------------------------------- | +| `min_time` | `2_000` | Кратчайшая продолжительность для показа времени (в миллисекундах). | +| `show_milliseconds` | `false` | Показывать миллисекунды в дополнение к секундам в продолжительности. | +| `prefix` | `took` | Префикс, отображаемый перед продолжительностью команды. | +| `style` | `"bold yellow"` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `cmd_duration`. | ### Пример @@ -283,18 +288,18 @@ prefix = "underwent " ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить `conda config --set changeps1 False`. ::: ### Опции -| Переменная | По умолчанию | Описание | -| ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"C "` | Символ перед названием окружения. | -| `style` | `"bold green"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `conda`. | +| Переменная | По умолчанию | Описание | +| ------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `truncation_length` | `1` | Количество каталогов, в которых путь к окружению должен быть усечен, если окружение было создано через `conda create -p [path]`. `0` означает без усечения. Также смотрите модуль [`directory`](#directory). | +| `symbol` | `"C "` | Символ перед названием окружения. | +| `style` | `"bold green"` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `conda`. | ### Пример @@ -370,24 +375,24 @@ style = "green" heuristic = false ``` -## Environment Variable +## Переменная Окружения -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: +Модуль `env_var` отображает текущее значение выбранной переменной окружения. Модуль будет показан только в том случае, если любое из следующих условий соблюдено: -- The `variable` configuration option matches an existing environment variable -- The `variable` configuration option is not defined, but the `default` configuration option is +- Опция `variable` соответствует существующей переменной среды +- Опция `variable` не определена, но определена опция `default` ### Опции -| Переменная | По умолчанию | Описание | -| -------------- | ---------------- | ---------------------------------------------------------------------------- | -| `symbol` | | The symbol used before displaying the variable value. | -| `переменная` | | The environment variable to be displayed. | -| `по умолчанию` | | The default value to be displayed when the selected variable is not defined. | -| `prefix` | `""` | Prefix to display immediately before the variable value. | -| `suffix` | `""` | Suffix to display immediately after the variable value. | -| `style` | `"dimmed black"` | Стиль модуля. | -| `disabled` | `false` | Disables the `env_var` module. | +| Переменная | По умолчанию | Описание | +| ---------- | ---------------- | ------------------------------------------------------------------ | +| `symbol` | | Символ, используемый перед отображением значения переменной. | +| `variable` | | Отображаемая переменная окружения. | +| `default` | | Значение отображаемое, когда выбранная переменная не определена. | +| `prefix` | `""` | Префикс, отображаемый, непосредственно перед значением переменной. | +| `suffix` | `""` | Префикс, отображаемый, непосредственно после значением переменной. | +| `style` | `"dimmed black"` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `env_var`. | ### Пример @@ -399,19 +404,19 @@ variable = "SHELL" default = "unknown shell" ``` -## Git Branch +## Ветвь Git -The `git_branch` module shows the active branch of the repo in your current directory. +Модуль `git_branch` показывает активную ветку репозитория в вашем текущей директории. ### Опции -| Переменная | По умолчанию | Описание | -| ------------------- | --------------- | ------------------------------------------------------------------------------------- | -| `symbol` | `" "` | The symbol used before the branch name of the repo in your current directory. | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use "" for no symbol | -| `style` | `"bold purple"` | Стиль модуля. | -| `disabled` | `false` | Disables the `git_branch` module. | +| Переменная | По умолчанию | Описание | +| ------------------- | --------------- | --------------------------------------------------------------------------------------------------------------- | +| `symbol` | `" "` | Символ, используемый перед именем ветки репозитория в вашей текущей директории. | +| `truncation_length` | `2^63 - 1` | Отрезает ветку git до X графемов | +| `truncation_symbol` | `"…"` | Символ, используемый для обозначения усечения названия ветки. Вы можете использовать "", чтобы не видеть символ | +| `style` | `"bold purple"` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `git_branch`. | ### Пример @@ -424,7 +429,7 @@ truncation_length = 4 truncation_symbol = "" ``` -## Git Commit +## Коммит Git Модуль `git_commit` показывает хэш текущего коммита репозитория в вашем текущем каталоге. @@ -436,13 +441,13 @@ truncation_symbol = "" ### Опции -| Переменная | По умолчанию | Описание | -| -------------------- | -------------- | ------------------------------------------------ | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `prefix` | `"("` | Prefix to display immediately before git commit. | -| `suffix` | `")"` | Suffix to display immediately after git commit. | -| `style` | `"bold green"` | Стиль модуля. | -| `disabled` | `true` | Disables the `git_commit` module. | +| Переменная | По умолчанию | Описание | +| -------------------- | -------------- | ---------------------------------------------- | +| `commit_hash_length` | `7` | Длина отображаемого хэша коммита git. | +| `prefix` | `"("` | Префикс, отображаемый сразу после коммита. | +| `suffix` | `")"` | Суффикс, отображаемый сразу после коммита git. | +| `style` | `"bold green"` | Стиль модуля. | +| `disabled` | `true` | Отключает модуль `git_commit`. | ### Пример @@ -454,24 +459,24 @@ disabled = false commit_hash_length = 4 ``` -## Git State +## Состояние Git -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. +Модуль `git_state` будет отображаться в директориях, являющимися частью репозитория git, и там, где выполняется операция, такие как: _REBASING_, _BISECTING_, и т. д. Если есть информация о прогрессе (например, REBASING 3/10), эта информация также будет показана. ### Опции -| Переменная | По умолчанию | Описание | -| ------------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------- | -| `rebase` | `"REBASING"` | The text displayed when a `rebase` is in progress. | -| `merge` | `"MERGING"` | The text displayed when a `merge` is in progress. | -| `revert` | `"REVERTING"` | The text displayed when a `revert` is in progress. | -| `cherry_pick` | `"CHERRY-PICKING"` | The text displayed when a `cherry-pick` is in progress. | -| `bisect` | `"BISECTING"` | The text displayed when a `bisect` is in progress. | -| `am` | `"AM"` | The text displayed when an `apply-mailbox` (`git am`) is in progress. | -| `am_or_rebase` | `"AM/REBASE"` | The text displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | -| `progress_divider` | `"/"` | The symbol or text which will separate the current and total progress amounts. (e.g., `" of "`, for `"3 of 10"`) | -| `style` | `"bold yellow"` | Стиль модуля. | -| `disabled` | `false` | Disables the `git_state` module. | +| Переменная | По умолчанию | Описание | +| ------------------ | ------------------ | ------------------------------------------------------------------------------------------------------------- | +| `rebase` | `"REBASING"` | Текст, отображаемый в процессе операции `rebase`. | +| `merge` | `"MERGING"` | Текст, отображаемый в процессе операции `merge`. | +| `revert` | `"REVERTING"` | Текст, отображаемый в процессе операции `revert`. | +| `cherry_pick` | `"CHERRY-PICKING"` | Текст, отображаемый в процессе операции `cherry-pick`. | +| `bisect` | `"BISECTING"` | Текст, отображаемый в процессе операции `bisect`. | +| `am` | `"AM"` | Текст, отображаемый в процессе операции `apply-mailbox` (`git am`). | +| `am_or_rebase` | `"AM/REBASE"` | Текст, отображаемый, когда выполняется неоднозначный процесс `apply-mailbox` или `rebase`. | +| `progress_divider` | `"/"` | Символ или текст, который будет разделять текущую и общую сумму прогресса. (напр., `" из "`, для `"3 из 10"`) | +| `style` | `"bold yellow"` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `git_state`. | ### Пример @@ -483,35 +488,36 @@ progress_divider = " of " cherry_pick = "🍒 PICKING" ``` -## Git Status +## Статус Git -The `git_status` module shows symbols representing the state of the repo in your current directory. +Модуль `git_status` отображает символы, представляющие состояние репозитория в вашей текущей директории. ### Опции -| Переменная | По умолчанию | Описание | -| ------------------ | -------------------------- | ------------------------------------------------------- | -| `conflicted` | `"="` | This branch has merge conflicts. | -| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. | -| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. | -| `behind` | `"⇣"` | This branch is behind of the branch being tracked. | -| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. | -| `untracked` | `"?"` | There are untracked files in the working directory. | -| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. | -| `stashed` | `"$"` | A stash exists for the local repository. | -| `modified` | `"!"` | There are file modifications in the working directory. | -| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. | -| `staged` | `"+"` | A new file has been added to the staging area. | -| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. | -| `renamed` | `"»"` | A renamed file has been added to the staging area. | -| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. | -| `deleted` | `"✘"` | A file's deletion has been added to the staging area. | -| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. | -| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. | -| `prefix` | `[` | Prefix to display immediately before git status. | -| `suffix` | `]` | Suffix to display immediately after git status. | -| `style` | `"bold red"` | Стиль модуля. | -| `disabled` | `false` | Disables the `git_status` module. | +| Переменная | По умолчанию | Описание | +| ------------------ | ---------------------------- | ------------------------------------------------------ | +| `conflicted` | `"="` | Эта ветка имеет конфликты слияния. | +| `conflicted_count` | [ссылка](#git-status-counts) | Показывать в стиле количество конфликтов. | +| `ahead` | `"⇡"` | Эта ветка впереди отслеживаемой ветви. | +| `behind` | `"⇣"` | Эта ветка позади отслеживаемой ветви. | +| `diverged` | `"⇕"` | Эта ветка расходится от отслеживаемой ветки. | +| `untracked` | `"?"` | В рабочей директории есть неотслеженные файлы. | +| `untracked_count` | [ссылка](#git-status-counts) | Показывать в стиле количество неотслеженных файлов. | +| `stashed` | `"$"` | A stash exists for the local repository. | +| `stashed_count` | [ссылка](#git-status-counts) | Show and style the number of stashes. | +| `modified` | `"!"` | There are file modifications in the working directory. | +| `modified_count` | [ссылка](#git-status-counts) | Show and style the number of modified files. | +| `staged` | `"+"` | A new file has been added to the staging area. | +| `staged_count` | [ссылка](#git-status-counts) | Show and style the number of files staged files. | +| `renamed` | `"»"` | A renamed file has been added to the staging area. | +| `renamed_count` | [ссылка](#git-status-counts) | Show and style the number of renamed files. | +| `deleted` | `"✘"` | A file's deletion has been added to the staging area. | +| `deleted_count` | [ссылка](#git-status-counts) | Show and style the number of deleted files. | +| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. | +| `prefix` | `[` | Prefix to display immediately before git status. | +| `suffix` | `]` | Suffix to display immediately after git status. | +| `style` | `"bold red"` | Стиль модуля. | +| `disabled` | `false` | Disables the `git_status` module. | #### Git Status Counts @@ -580,7 +586,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | ------------------- | --------------- | -------------------------------------------------------------------------------------------- | | `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | +| `truncation_symbol` | `"…"` | Символ, используемый для обозначения усечения названия ветки. | | `style` | `"bold purple"` | Стиль модуля. | | `disabled` | `true` | Disables the `hg_branch` module. | diff --git a/docs/ru-RU/guide/README.md b/docs/ru-RU/guide/README.md index 84170a3d..70cc90c9 100644 --- a/docs/ru-RU/guide/README.md +++ b/docs/ru-RU/guide/README.md @@ -21,7 +21,7 @@ src="https://img.shields.io/discord/567163873606500352?logo=discord" alt="Chat on Discord" /> -All Contributors +All Contributors

    @@ -49,6 +49,9 @@ Deutsch   + Español +   Français   @@ -71,9 +74,9 @@ - Символ подсказки становится красным, если последняя команда завершается с ненулевым кодом - Текущая версия Go (`🐹< / 0>) -
  • Текущая версия Java(☕< / 0>)
    • -
  • Текущая версия Node.js (⬢< / 0>)
    • -
  • Текущая версия PHP (🐘< / 0>)
    • +
  • Текущая версия Java (☕`) +- Текущая версия Node.js (`⬢`) +- Текущая версия PHP (`🐘< / 0>)
  • Текущая версия Python (🐍< / 0>)
  • Текущая версия Ruby (💎< / 0>)
  • Текущая версия Rust (🦀< / 0>)
    • @@ -122,13 +125,20 @@ #### Установить последнюю версию - ##### Через Bash: + ##### From prebuilt binary, with Shell: ```sh curl -fsSL https://starship.rs/install.sh | bash ``` + ##### From source on [crates.io](https://crates.io/): + + ```sh + cargo install starship + ``` + + #### Установить через менеджер пакетов @@ -290,7 +300,7 @@
    pinshan
    🌍
    Brian Low
    💻 📖 ⚠️
    Matias Kotlik
    💻 -
    marblenix
    🚇 +
    marblenix
    🚇 💻 ⚠️
    Raidou
    💻 ⚠️ @@ -310,6 +320,9 @@
    Mike Sampson
    💻 📖 ⚠️
    Dominik Braun
    💻 + +
    David Hewson
    💻 + diff --git a/docs/zh-CN/advanced-config/README.md b/docs/zh-CN/advanced-config/README.md index efd22041..b1cd3527 100644 --- a/docs/zh-CN/advanced-config/README.md +++ b/docs/zh-CN/advanced-config/README.md @@ -61,7 +61,7 @@ If you like the result, add these lines to your shell configuration file (`~/.ba ## 样式设定 -Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following: +样式字符串是用空白分隔的单词列表。 The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following: - `bold` - `underline` @@ -75,7 +75,7 @@ where `` is a color specifier (discussed below). `fg:` and ` -所有贡献者 +所有贡献者

    @@ -49,6 +49,9 @@ Deutsch   + Español +   Français   @@ -71,8 +74,8 @@ - 当上一个命令以非 0 状态退出时，提示字符会变为红色 - 当前 Go 版本 (`🐹`) -- 当前 Java 版本(`☕`) -- 当前 Node.js 版本(`⬢`) +- Current Java version (`☕`) +- Current Node.js version (`⬢`) - Current PHP version (`🐘`) - 当前 Python 版本 (`🐍`) - 当前 Ruby 版本 (`💎`) @@ -122,13 +125,20 @@ #### Install Latest Version - ##### With Shell: + ##### From prebuilt binary, with Shell: ```sh curl -fsSL https://starship.rs/install.sh | bash ``` + ##### From source on [crates.io](https://crates.io/): + + ```sh + cargo install starship + ``` + + #### Install via Package Manager @@ -290,7 +300,7 @@
    pinshan
    🌍
    Brian Low
    💻 📖 ⚠️
    Matias Kotlik
    💻 -
    marblenix
    🚇 +
    marblenix
    🚇 💻 ⚠️
    Raidou
    💻 ⚠️ @@ -310,6 +320,9 @@
    Mike Sampson
    💻 📖 ⚠️
    Dominik Braun
    💻 + +
    David Hewson
    💻 + diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index c2e954fd..cbadf700 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -27,6 +27,11 @@ symbol = "➜" # 設定 "symbol" 區段為 "➜" disabled = true ``` +You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable: +```shell +export STARSHIP_CONFIG=~/.starship +``` + ### 術語 **模組 (Module)**： 提示字元中的一個元件，基於你的作業系統提供的背景資訊來提供訊息。 舉例來說，如果你現在的資料夾是一個 NodeJS 專案，"nodejs" 模組會顯示出現在安裝在你的電腦上的 NodeJS 版本。 @@ -499,6 +504,7 @@ cherry_pick = "🍒 PICKING" | `untracked` | `"?"` | 工作資料夾中有沒有追蹤的檔案。 | | `untracked_count` | [連結](#git-status-counts) | Show and style the number of untracked files. | | `stashed` | `"$"` | 本地儲存庫有 stash。 | +| `stashed_count` | [連結](#git-status-counts) | Show and style the number of stashes. | | `modified` | `"!"` | 工作資料夾中有修改過的檔案。 | | `modified_count` | [連結](#git-status-counts) | Show and style the number of modified files. | | `staged` | `"+"` | 一個新檔案被加入了暫存區 (staging area)。 | diff --git a/docs/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md index 3d9860e1..328b155c 100644 --- a/docs/zh-TW/guide/README.md +++ b/docs/zh-TW/guide/README.md @@ -21,7 +21,7 @@ src="https://img.shields.io/discord/567163873606500352?logo=discord" alt="在 Discord 上聊天" /> -All Contributors +All Contributors

    @@ -49,6 +49,9 @@ Deutsch   + Español +   Français   @@ -71,8 +74,8 @@ - 如果最近一個指令結束時回傳非零的代碼，提示字元將轉成紅色 - 現在的 Go 版本 (`🐹`) -- 現在的 Java 版本 (`☕`) -- 現在的 Node.js 版本 (`⬢`) +- Current Java version (`☕`) +- Current Node.js version (`⬢`) - Current PHP version (`🐘`) - 現在的 Python 版本 (`🐍`) - 現在的 Ruby 版本 (`💎`) @@ -122,13 +125,20 @@ #### Install Latest Version - ##### With Shell: + ##### From prebuilt binary, with Shell: ```sh curl -fsSL https://starship.rs/install.sh | bash ``` + ##### From source on [crates.io](https://crates.io/): + + ```sh + cargo install starship + ``` + + #### Install via Package Manager @@ -290,7 +300,7 @@
    pinshan
    🌍
    Brian Low
    💻 📖 ⚠️
    Matias Kotlik
    💻 -
    marblenix
    🚇 +
    marblenix
    🚇 💻 ⚠️
    Raidou
    💻 ⚠️ @@ -310,6 +320,9 @@
    Mike Sampson
    💻 📖 ⚠️
    Dominik Braun
    💻 + +
    David Hewson
    💻 +