diff options
Diffstat (limited to 'docs/config/README.md')
| -rw-r--r-- | docs/config/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 3de40b5ee..8c0131fb0 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -100,6 +100,7 @@ prompt_order = [ "git_state", "git_status", "hg_branch", + "docker_context", "package", "dotnet", "elixir", @@ -405,6 +406,30 @@ a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/ truncation_length = 8 ``` +## Docker Context + +The `docker_context` module shows the currently active +[Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to +`default`. + +### Options + +| Variable | Default | Description | +| ----------------- | ------------- | ---------------------------------------------------------------------------- | +| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context . | +| `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `true` | Disables the `docker_context` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[docker_context] +symbol = "🐋 " +``` + ## Dotnet The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If |