mirror of
https://github.com/starship/starship.git
synced 2026-06-23 02:05:51 +07:00
+11
-4
@@ -1,5 +1,12 @@
|
||||
# Configuration
|
||||
|
||||
::: 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`.
|
||||
|
||||
```sh
|
||||
@@ -7,9 +14,10 @@ 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
|
||||
format = "$all"
|
||||
|
||||
# Replace the "❯" symbol in the prompt with "➜"
|
||||
[character] # The name of the module we are configuring is "character"
|
||||
@@ -137,7 +145,6 @@ This is the list of prompt-wide configuration options.
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------- | ------------------------------ | ----------------------------------------------------- |
|
||||
| `add_newline` | `true` | Add a new line before the start of the prompt. |
|
||||
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
|
||||
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
|
||||
|
||||
@@ -147,7 +154,7 @@ This is the list of prompt-wide configuration options.
|
||||
# ~/.config/starship.toml
|
||||
|
||||
# Disable the newline at the start of the prompt
|
||||
add_newline = false
|
||||
format = "$all"
|
||||
|
||||
# Use custom format
|
||||
format = """
|
||||
@@ -164,7 +171,7 @@ scan_timeout = 10
|
||||
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
|
||||
|
||||
```toml
|
||||
format = "$all"
|
||||
format = "\n$all"
|
||||
|
||||
# Which is equivalent to
|
||||
format = """
|
||||
|
||||
Reference in New Issue
Block a user