diff --git a/docs/pl-PL/config/README.md b/docs/pl-PL/config/README.md index b85e0cc9..31bf72de 100644 --- a/docs/pl-PL/config/README.md +++ b/docs/pl-PL/config/README.md @@ -206,6 +206,13 @@ This is the list of prompt-wide configuration options. | `add_newline` | `true` | Inserts blank line between shell prompts. | | `palette` | `''` | Sets which color palette from `palettes` to use. | | `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | +| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | + +::: tip + +If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. + +::: ### Example @@ -836,7 +843,7 @@ format = 'underwent [$duration](bold yellow)' The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. -::: porada +::: tip This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. @@ -1319,13 +1326,13 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is -::: porada +::: tip The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. ::: -::: porada +::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. @@ -1759,7 +1766,7 @@ cherry_pick = '[🍒 PICKING](bold red)' The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: porada +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -1801,7 +1808,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: porada +::: tip The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. @@ -2375,7 +2382,7 @@ kotlin_binary = 'kotlinc' Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. -::: porada +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -2586,7 +2593,7 @@ 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. -::: porada +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -2959,7 +2966,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: -::: porada +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -3204,7 +3211,7 @@ The `pijul_channel` module shows the active channel of the repo in your current The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: porada +::: tip By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). @@ -3331,7 +3338,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | -::: porada +::: tip The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. @@ -3633,7 +3640,7 @@ symbol = '🌟 ' The `shell` module shows an indicator for currently used shell. -::: porada +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -3838,7 +3845,7 @@ format = '[$symbol$environment](dimmed blue) ' The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: porada +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -3899,7 +3906,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: porada +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -3987,7 +3994,7 @@ format = 'via [🏎 $version](red bold)' The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. -::: porada +::: tip By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). @@ -4046,7 +4053,7 @@ format = '[🏎💨 $workspace]($style) ' The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. -::: porada +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -4097,7 +4104,7 @@ The `username` module shows active user's username. The module will be shown if - The user is currently connected as an SSH session - The variable `show_always` is set to true -::: porada +::: tip SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. @@ -4289,19 +4296,19 @@ These modules will be shown if any of the following conditions are met: - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matches with `os` field if defined. -::: porada +::: tip Multiple custom modules can be defined by using a `.`. ::: -::: porada +::: tip The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. ::: -::: porada +::: tip [Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!