mirror of
https://github.com/starship/starship.git
synced 2026-06-21 02:02:14 +07:00
Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 github-actions[bot]
|
378f3e42be | ||
|
David Knaack
|
d6daf8a4e1 | ||
|
David Knaack
|
5736b481e2 | ||
|
David Knaack
|
7795bab3bd | ||
|
David Knaack
|
f143aed72a | ||
|
renovate[bot]
|
2f816f1e6e | ||
|
renovate[bot]
|
a71606d2bb | ||
|
renovate[bot]
|
47de63ed66 | ||
|
renovate[bot]
|
1ec0941bf0 | ||
|
renovate[bot]
|
3b78de84ae | ||
|
renovate[bot]
|
53f1ac9d92 | ||
|
renovate[bot]
|
c0206cd0f5 | ||
|
renovate[bot]
|
10b67d50dc | ||
|
Jaehyun Yeom
|
dbbc4ca293 | ||
|
renovate[bot]
|
5d48bbf11d | ||
|
renovate[bot]
|
a22fdfb7d4 | ||
|
renovate[bot]
|
6a42b09258 | ||
|
David Knaack
|
60b49f0dab | ||
|
renovate[bot]
|
408a7c05e1 | ||
|
renovate[bot]
|
6817c0f255 | ||
|
renovate[bot]
|
e6eef15a72 | ||
|
Segev Finer
|
1bf73f7baf | ||
|
Matan Kushner
|
3c366dc87a |
+3
-3
@@ -25,9 +25,9 @@
|
||||
"target/"
|
||||
],
|
||||
"plugins": [
|
||||
"https://github.com/dprint/dprint-plugin-typescript/releases/download/0.95.11/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-json/releases/download/0.20.0/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-markdown/releases/download/0.19.0/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-typescript/releases/download/0.95.12/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-json/releases/download/0.21.0/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-markdown/releases/download/0.20.0/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-toml/releases/download/0.7.0/plugin.wasm"
|
||||
]
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
"group:monorepos",
|
||||
"group:recommended",
|
||||
"workarounds:all",
|
||||
"replacements:all",
|
||||
// automerge minor updates
|
||||
":automergeMinor",
|
||||
":automergeBranch"
|
||||
|
||||
@@ -67,7 +67,7 @@ jobs:
|
||||
- name: Setup | Node
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 22.21.0
|
||||
node-version: 22.21.1
|
||||
cache: 'npm'
|
||||
cache-dependency-path: docs/package-lock.json
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ jobs:
|
||||
- name: Setup | Node
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 22.21.0
|
||||
node-version: 22.21.1
|
||||
cache: 'npm'
|
||||
cache-dependency-path: docs/package-lock.json
|
||||
|
||||
@@ -25,9 +25,7 @@ jobs:
|
||||
working-directory: docs
|
||||
|
||||
- name: Publish
|
||||
uses: netlify/actions/cli@master
|
||||
with:
|
||||
args: deploy --prod --dir=docs/.vitepress/dist
|
||||
run: npx netlify-cli deploy --no-build --prod --dir=docs/.vitepress/dist
|
||||
env:
|
||||
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
|
||||
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||
|
||||
@@ -20,7 +20,7 @@ jobs:
|
||||
release_created: ${{ steps.release.outputs.release_created }}
|
||||
tag_name: ${{ steps.release.outputs.tag_name }}
|
||||
steps:
|
||||
- uses: google-github-actions/release-please-action@v4
|
||||
- uses: googleapis/release-please-action@v4
|
||||
id: release
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -240,7 +240,7 @@ jobs:
|
||||
- name: Setup | Node
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 22.21.0
|
||||
node-version: 22.21.1
|
||||
|
||||
- name: Notarize | Build docs
|
||||
run: |
|
||||
|
||||
@@ -7,4 +7,4 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: crate-ci/typos@v1.38.1
|
||||
- uses: crate-ci/typos@v1.39.2
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
# Changelog
|
||||
|
||||
## [1.24.1](https://github.com/starship/starship/compare/v1.24.0...v1.24.1) (2025-11-16)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **fish:** fix job counting ([#7082](https://github.com/starship/starship/issues/7082)) ([7795bab](https://github.com/starship/starship/commit/7795bab3bd55c6515bce73e1e01c977203113ced))
|
||||
* improve timeout warning message in the directory scanner ([#7120](https://github.com/starship/starship/issues/7120)) ([d6daf8a](https://github.com/starship/starship/commit/d6daf8a4e1cdfbd361efe26ddefa0b60efaa5b1d))
|
||||
|
||||
## [1.24.0](https://github.com/starship/starship/compare/v1.23.0...v1.24.0) (2025-10-25)
|
||||
|
||||
|
||||
|
||||
Generated
+154
-39
@@ -379,9 +379,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "clap"
|
||||
version = "4.5.50"
|
||||
version = "4.5.51"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0c2cfd7bf8a6017ddaa4e32ffe7403d547790db06bd171c1c53926faab501623"
|
||||
checksum = "4c26d721170e0295f191a69bd9a1f93efcdb0aff38684b61ab5750468972e5f5"
|
||||
dependencies = [
|
||||
"clap_builder",
|
||||
"clap_derive",
|
||||
@@ -389,9 +389,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "clap_builder"
|
||||
version = "4.5.50"
|
||||
version = "4.5.51"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0a4c05b9e80c5ccd3a7ef080ad7b6ba7d6fc00a985b8b157197075677c82c7a0"
|
||||
checksum = "75835f0c7bf681bfd05abe44e965760fea999a5286c6eb2d59883634fd02011a"
|
||||
dependencies = [
|
||||
"anstream",
|
||||
"anstyle",
|
||||
@@ -403,18 +403,18 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "clap_complete"
|
||||
version = "4.5.59"
|
||||
version = "4.5.60"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2348487adcd4631696ced64ccdb40d38ac4d31cae7f2eec8817fcea1b9d1c43c"
|
||||
checksum = "8e602857739c5a4291dfa33b5a298aeac9006185229a700e5810a3ef7272d971"
|
||||
dependencies = [
|
||||
"clap",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "clap_complete_nushell"
|
||||
version = "4.5.9"
|
||||
version = "4.5.10"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "811159f339691baacdf7d534df2946b9d217014081099e23d31d887d99521e70"
|
||||
checksum = "685bc86fd34b7467e0532a4f8435ab107960d69a243785ef0275e571b35b641a"
|
||||
dependencies = [
|
||||
"clap",
|
||||
"clap_complete",
|
||||
@@ -2065,9 +2065,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "jsonc-parser"
|
||||
version = "0.27.0"
|
||||
version = "0.27.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7ec4ac49f13c7b00f435f8a5bb55d725705e2cf620df35a5859321595102eb7e"
|
||||
checksum = "01958dcb05b69d9612853b47df8f7881810e4f61b5cedd8894be04291f28ccb9"
|
||||
dependencies = [
|
||||
"serde_json",
|
||||
]
|
||||
@@ -2160,9 +2160,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "mach2"
|
||||
version = "0.4.3"
|
||||
version = "0.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d640282b302c0bb0a2a8e0233ead9035e3bed871f0b7e81fe4a1ec829765db44"
|
||||
checksum = "6a1b95cd5421ec55b445b5ae102f5ea0e768de1f82bd3001e11f426c269c3aea"
|
||||
dependencies = [
|
||||
"libc",
|
||||
]
|
||||
@@ -2349,6 +2349,27 @@ dependencies = [
|
||||
"objc2-encode",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-cloud-kit"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "73ad74d880bb43877038da939b7427bba67e9dd42004a18b809ba7d87cee241c"
|
||||
dependencies = [
|
||||
"bitflags 2.10.0",
|
||||
"objc2",
|
||||
"objc2-foundation",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-core-data"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0b402a653efbb5e82ce4df10683b6b28027616a2715e90009947d50b8dd298fa"
|
||||
dependencies = [
|
||||
"objc2",
|
||||
"objc2-foundation",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-core-foundation"
|
||||
version = "0.3.2"
|
||||
@@ -2360,6 +2381,51 @@ dependencies = [
|
||||
"objc2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-core-graphics"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e022c9d066895efa1345f8e33e584b9f958da2fd4cd116792e15e07e4720a807"
|
||||
dependencies = [
|
||||
"bitflags 2.10.0",
|
||||
"dispatch2",
|
||||
"objc2",
|
||||
"objc2-core-foundation",
|
||||
"objc2-io-surface",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-core-image"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e5d563b38d2b97209f8e861173de434bd0214cf020e3423a52624cd1d989f006"
|
||||
dependencies = [
|
||||
"objc2",
|
||||
"objc2-foundation",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-core-location"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "ca347214e24bc973fc025fd0d36ebb179ff30536ed1f80252706db19ee452009"
|
||||
dependencies = [
|
||||
"objc2",
|
||||
"objc2-foundation",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-core-text"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0cde0dfb48d25d2b4862161a4d5fcc0e3c24367869ad306b0c9ec0073bfed92d"
|
||||
dependencies = [
|
||||
"bitflags 2.10.0",
|
||||
"objc2",
|
||||
"objc2-core-foundation",
|
||||
"objc2-core-graphics",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-encode"
|
||||
version = "4.1.0"
|
||||
@@ -2379,6 +2445,60 @@ dependencies = [
|
||||
"objc2-core-foundation",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-io-surface"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "180788110936d59bab6bd83b6060ffdfffb3b922ba1396b312ae795e1de9d81d"
|
||||
dependencies = [
|
||||
"bitflags 2.10.0",
|
||||
"objc2",
|
||||
"objc2-core-foundation",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-quartz-core"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "96c1358452b371bf9f104e21ec536d37a650eb10f7ee379fff67d2e08d537f1f"
|
||||
dependencies = [
|
||||
"bitflags 2.10.0",
|
||||
"objc2",
|
||||
"objc2-core-foundation",
|
||||
"objc2-foundation",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-ui-kit"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d87d638e33c06f577498cbcc50491496a3ed4246998a7fbba7ccb98b1e7eab22"
|
||||
dependencies = [
|
||||
"bitflags 2.10.0",
|
||||
"block2",
|
||||
"objc2",
|
||||
"objc2-cloud-kit",
|
||||
"objc2-core-data",
|
||||
"objc2-core-foundation",
|
||||
"objc2-core-graphics",
|
||||
"objc2-core-image",
|
||||
"objc2-core-location",
|
||||
"objc2-core-text",
|
||||
"objc2-foundation",
|
||||
"objc2-quartz-core",
|
||||
"objc2-user-notifications",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "objc2-user-notifications"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9df9128cbbfef73cda168416ccf7f837b62737d748333bfe9ab71c245d76613e"
|
||||
dependencies = [
|
||||
"objc2",
|
||||
"objc2-foundation",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "once_cell"
|
||||
version = "1.21.3"
|
||||
@@ -2445,14 +2565,18 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "os_info"
|
||||
version = "3.12.0"
|
||||
version = "3.13.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d0e1ac5fde8d43c34139135df8ea9ee9465394b2d8d20f032d38998f64afffc3"
|
||||
checksum = "7c39b5918402d564846d5aba164c09a66cc88d232179dfd3e3c619a25a268392"
|
||||
dependencies = [
|
||||
"android_system_properties",
|
||||
"log",
|
||||
"plist",
|
||||
"nix",
|
||||
"objc2",
|
||||
"objc2-foundation",
|
||||
"objc2-ui-kit",
|
||||
"serde",
|
||||
"windows-sys 0.52.0",
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -2612,13 +2736,13 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "plist"
|
||||
version = "1.7.4"
|
||||
version = "1.8.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3af6b589e163c5a788fab00ce0c0366f6efbb9959c2f9874b224936af7fce7e1"
|
||||
checksum = "740ebea15c5d1428f910cd1a5f52cebf8d25006245ed8ade92702f4943d91e07"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"indexmap",
|
||||
"quick-xml 0.38.3",
|
||||
"quick-xml 0.38.4",
|
||||
"serde",
|
||||
"time",
|
||||
]
|
||||
@@ -2752,9 +2876,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "quick-xml"
|
||||
version = "0.38.3"
|
||||
version = "0.38.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "42a232e7487fc2ef313d96dde7948e7a3c05101870d8985e4fd8d26aedd27b89"
|
||||
checksum = "b66c2058c55a409d601666cffe35f04333cf1013010882cec174a7467cd4e21c"
|
||||
dependencies = [
|
||||
"memchr",
|
||||
]
|
||||
@@ -2979,9 +3103,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "schemars"
|
||||
version = "1.0.4"
|
||||
version = "1.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "82d20c4491bc164fa2f6c5d44565947a52ad80b9505d8e36f8d54c27c739fcd0"
|
||||
checksum = "9558e172d4e8533736ba97870c4b2cd63f84b382a3d6eb063da41b91cce17289"
|
||||
dependencies = [
|
||||
"dyn-clone",
|
||||
"indexmap",
|
||||
@@ -2993,9 +3117,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "schemars_derive"
|
||||
version = "1.0.4"
|
||||
version = "1.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "33d020396d1d138dc19f1165df7545479dcd58d93810dc5d646a16e55abefa80"
|
||||
checksum = "301858a4023d78debd2353c7426dc486001bddc91ae31a76fb1f55132f7e2633"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
@@ -3242,7 +3366,7 @@ checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596"
|
||||
|
||||
[[package]]
|
||||
name = "starship"
|
||||
version = "1.24.0"
|
||||
version = "1.24.1"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"clap",
|
||||
@@ -3268,7 +3392,7 @@ dependencies = [
|
||||
"pest",
|
||||
"pest_derive",
|
||||
"process_control",
|
||||
"quick-xml 0.38.3",
|
||||
"quick-xml 0.38.4",
|
||||
"rand 0.9.2",
|
||||
"rayon",
|
||||
"regex",
|
||||
@@ -3300,9 +3424,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "starship-battery"
|
||||
version = "0.10.2"
|
||||
version = "0.10.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5b781e3db6801873ce18c19041da668920c46223cdc7059ea20e2f8fe1ba85a2"
|
||||
checksum = "fd0efc2c44c92705be724265a0c758e3b7c120ea63817d2d684bab86fbeced9a"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"core-foundation",
|
||||
@@ -3313,7 +3437,7 @@ dependencies = [
|
||||
"num-traits",
|
||||
"plist",
|
||||
"uom",
|
||||
"windows-sys 0.60.2",
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -4171,15 +4295,6 @@ dependencies = [
|
||||
"windows-link 0.2.1",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-sys"
|
||||
version = "0.52.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d"
|
||||
dependencies = [
|
||||
"windows-targets 0.52.6",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-sys"
|
||||
version = "0.59.0"
|
||||
|
||||
+9
-9
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "starship"
|
||||
version = "1.24.0"
|
||||
version = "1.24.1"
|
||||
authors = ["Starship Contributors"]
|
||||
build = "build.rs"
|
||||
categories = ["command-line-utilities"]
|
||||
@@ -36,15 +36,15 @@ notify = ["notify-rust"]
|
||||
|
||||
[dependencies]
|
||||
chrono = { version = "0.4.42", default-features = false, features = ["clock", "std", "wasmbind"] }
|
||||
clap = { version = "4.5.50", features = ["derive", "cargo", "unicode"] }
|
||||
clap_complete = "4.5.59"
|
||||
clap_complete_nushell = "4.5.9"
|
||||
clap = { version = "4.5.51", features = ["derive", "cargo", "unicode"] }
|
||||
clap_complete = "4.5.60"
|
||||
clap_complete_nushell = "4.5.10"
|
||||
dirs = "6.0.0"
|
||||
dunce = "1.0.5"
|
||||
# default feature restriction addresses https://github.com/starship/starship/issues/4251
|
||||
gix = { version = "0.74.1", default-features = false, features = ["max-performance-safe", "revision", "zlib-rs", "status"] }
|
||||
indexmap = { version = "2.12.0", features = ["serde"] }
|
||||
jsonc-parser = { version = "0.27.0", features = ["serde"] }
|
||||
jsonc-parser = { version = "0.27.1", features = ["serde"] }
|
||||
log = { version = "0.4.28", features = ["std"] }
|
||||
# notify-rust is optional (on by default) because the crate doesn't currently build for darwin with nix
|
||||
# see: https://github.com/NixOS/nixpkgs/issues/160876
|
||||
@@ -52,14 +52,14 @@ notify-rust = { version = "4.11.7", optional = true }
|
||||
nu-ansi-term = "0.50.3"
|
||||
open = "5.3.2"
|
||||
# update os module config and tests when upgrading os_info
|
||||
os_info = "3.12.0"
|
||||
os_info = "3.13.0"
|
||||
# for efficient shared state between `git_status` and `git_metrics`, allowing parallel printing. This is for poison-free locks.
|
||||
parking_lot = "0.12.5"
|
||||
path-slash = "0.2.1"
|
||||
pest = "2.8.3"
|
||||
pest_derive = "2.8.3"
|
||||
process_control = "5.2.0"
|
||||
quick-xml = "0.38.3"
|
||||
quick-xml = "0.38.4"
|
||||
rand = "0.9.2"
|
||||
rayon = "1.11.0"
|
||||
regex = { version = "1.12.2", default-features = false, features = ["perf", "std", "unicode-perl"] }
|
||||
@@ -71,7 +71,7 @@ sha1 = "0.10.6"
|
||||
shadow-rs = { version = "1.4.0", default-features = false, features = ["build"] }
|
||||
# battery is optional (on by default) because the crate doesn't currently build for Termux
|
||||
# see: https://github.com/svartalf/rust-battery/issues/33
|
||||
starship-battery = { version = "0.10.2", optional = true }
|
||||
starship-battery = { version = "0.10.3", optional = true }
|
||||
strsim = "0.11.1"
|
||||
systemstat = "=0.2.5"
|
||||
terminal_size = "0.4.3"
|
||||
@@ -90,7 +90,7 @@ home = "0.5.12"
|
||||
shell-words = "1.1.0"
|
||||
|
||||
[dependencies.schemars]
|
||||
version = "1.0.4"
|
||||
version = "1.1.0"
|
||||
optional = true
|
||||
features = ["preserve_order", "indexmap2"]
|
||||
|
||||
|
||||
+4
-11
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
Only elvish v0.18 or higher is supported.
|
||||
|
||||
:::
|
||||
|
||||
أضف ما يلي إلى نهاية الملف `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,11 +161,7 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
:::
|
||||
> [!WARNING] This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
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.
|
||||
|
||||
::: تحذير
|
||||
|
||||
The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
|
||||
+229
-211
@@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options.
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### مثال
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Variable | الافتراضي | الوصف |
|
||||
@@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### مثال
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### مثال
|
||||
|
||||
@@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c
|
||||
|
||||
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
|
||||
|
||||
::: تحذير
|
||||
|
||||
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
@@ -899,11 +891,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1426,26 +1416,17 @@ 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
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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.
|
||||
|
||||
Example: following configuration will display value of USER environment variable
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Example: following configuration will display value of USER environment variable
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1596,10 +1577,49 @@ Produces a prompt that looks like:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before displaying the version of COBOL. |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| name | gfortran | The name of the compiler |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'$'` | The format of `stashed` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
@@ -2392,17 +2407,9 @@ The default functionality is:
|
||||
- 1 job -> `symbol` is shown.
|
||||
- 2 jobs or more -> `symbol` + `number` are shown.
|
||||
|
||||
::: تحذير
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
This module is not supported on tcsh and nu.
|
||||
|
||||
:::
|
||||
|
||||
::: تحذير
|
||||
|
||||
The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### مثال
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2530,21 +2545,13 @@ 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`.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Options
|
||||
|
||||
::: تحذير
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -2742,11 +2751,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic 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
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |
|
||||
| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | The style for the module. |
|
||||
| `format` | `'\([$state]($style)\) '` | The format for the module. |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| ---------------- | ---------- | ----------------------------------- |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | The current operation progress |
|
||||
| progress_total | `2` | The total operation progress |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: تحذير
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## 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`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel 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
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbol` | `'🧚 '` | The symbol used before the environment name. |
|
||||
| `style` | `'yellow bold' | The style for the module. |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.pixi']` | Which folders should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!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).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -3712,13 +3742,9 @@ 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. |
|
||||
|
||||
::: 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.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -4242,11 +4266,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Without Terraform version
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if
|
||||
- The variable `show_always` is set to true
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `xmake.lua` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'△ '` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
|
||||
@@ -4734,31 +4768,17 @@ 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.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Multiple custom modules can be defined by using a `.`.
|
||||
> [!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.
|
||||
|
||||
:::
|
||||
> [!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!
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### مثال
|
||||
|
||||
|
||||
@@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS +7 | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora +40 | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
أضف ما يلي إلى نهاية الملف `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
ملاحظة: فقط +Elvish v0.18 مدعوم
|
||||
ملاحظة: فقط +Elvish v0.18 مدعوم. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -407,7 +408,7 @@ If you're looking to further customize Starship:
|
||||
|
||||
## 🤝 المساهمة
|
||||
|
||||
نبحث دائماً عن مساهمين من **جميع المستويات**! إذا كنت تتطلع إلى تسهيل طريقك إلى المشروع، جرب [إنشاء اول مشكلة](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
|
||||
نبحث دائماً عن مساهمين من **جميع المستويات**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
إذا كنت تتحدث بطلاقة بلغة غير إنجليزية، فإننا نقدر أي مساعدة للحفاظ على ترجمة المستندات وتحديثها بلغات أخرى. إذا كنت ترغب في المساعدة، يمكن المساهمة بالترجمة على [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
|
||||
@@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pure)
|
||||
[Return to Presets](./#pure-prompt)
|
||||
|
||||
# Pure Preset
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pastel-powerline)
|
||||
[Return to Presets](./#tokyo-night)
|
||||
|
||||
# Tokyo Night Preset
|
||||
|
||||
|
||||
+4
-11
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
Only elvish v0.18 or higher is supported.
|
||||
|
||||
:::
|
||||
|
||||
`~/.elvish/rc.elv` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,11 +161,7 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
:::
|
||||
> [!WARNING] This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
|
||||
+229
-211
@@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options.
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### Example
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Variable | Default | Description |
|
||||
@@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Example
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Example
|
||||
|
||||
@@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c
|
||||
|
||||
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
|
||||
|
||||
::: warning
|
||||
|
||||
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
@@ -899,11 +891,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1426,26 +1416,17 @@ 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
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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.
|
||||
|
||||
Example: following configuration will display value of USER environment variable
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Example: following configuration will display value of USER environment variable
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1596,10 +1577,49 @@ Produces a prompt that looks like:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before displaying the version of COBOL. |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| name | gfortran | The name of the compiler |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'$'` | The format of `stashed` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
@@ -2392,17 +2407,9 @@ The default functionality is:
|
||||
- 1 job -> `symbol` is shown.
|
||||
- 2 jobs or more -> `symbol` + `number` are shown.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
This module is not supported on tcsh and nu.
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2530,21 +2545,13 @@ 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`.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Options
|
||||
|
||||
::: warning
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -2742,11 +2751,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic 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
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |
|
||||
| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | The style for the module. |
|
||||
| `format` | `'\([$state]($style)\) '` | The format for the module. |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ---------- | ----------------------------------- |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | The current operation progress |
|
||||
| progress_total | `2` | The total operation progress |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## 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`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel 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
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbol` | `'🧚 '` | The symbol used before the environment name. |
|
||||
| `style` | `'yellow bold' | The style for the module. |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.pixi']` | Which folders should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!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).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -3712,13 +3742,9 @@ 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. |
|
||||
|
||||
::: 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.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -4242,11 +4266,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Without Terraform version
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if
|
||||
- The variable `show_always` is set to true
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `xmake.lua` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'△ '` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
|
||||
@@ -4734,31 +4768,17 @@ 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.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Multiple custom modules can be defined by using a `.`.
|
||||
> [!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.
|
||||
|
||||
:::
|
||||
> [!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!
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
`~/.elvish/rc.elv` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
বিঃদ্রঃ শুধুমাত্র Elvish v0.18+ কাজ করবে ।
|
||||
Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -407,7 +408,7 @@ eval "$(starship init zsh)"
|
||||
|
||||
## 🤝 নিজে অবদান রাখুন
|
||||
|
||||
আমরা সবসময় **সকল দক্ষতা স্তরের** অবদানকারীদের খুঁজছি! আপনি যদি সহজ ভাবে এই প্রোজেক্টে অবদান রাখতে চান তাইলে ["good first issue"](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) গুলির সমাধান করার চেষ্টা করতে পারেন ।
|
||||
আমরা সবসময় **সকল দক্ষতা স্তরের** অবদানকারীদের খুঁজছি! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
আপনি যদি ইংরেজি ছাড়া অন্য কোন ভাষায় সাবলীল হন, তাহলে আপনি আমাদের ডকুমেন্টেশন অনুবাদে এবং আপ-টু-ডেট রাখতে সহায়তা করতে পারেন, আমরা খুবই কৃতজ্ঞ হব । যদি এক্ষেত্রে সাহায্য করতে চান, তাহলে [Starship Crowdin](https://translate.starship.rs/) পেইজ এ গিয়ে আপনার অনুবাদ গুলি যোগ করতে পারবেন ।
|
||||
|
||||
|
||||
@@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pure)
|
||||
[Return to Presets](./#pure-prompt)
|
||||
|
||||
# Pure Preset
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pastel-powerline)
|
||||
[Return to Presets](./#tokyo-night)
|
||||
|
||||
# Tokyo Night Preset
|
||||
|
||||
|
||||
+4
-11
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
Only elvish v0.18 or higher is supported.
|
||||
|
||||
:::
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,11 +161,7 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
:::
|
||||
> [!WARNING] This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
لەگەڵ ئەوەی Starship شێڵێکە بەکارهێنانی زۆرە، هەندێک جار دەسکاری کردنی `starship.toml` بەس نییە بۆ ئەوەی وای لێبکەی هەندێک شتی دیاریکراو ئەنجام بدات. ئەم پەڕەیە ووردەکاری زیاتر ئەدات لەسەر هەندێک لە شێوازە ڕێکخستنە پێشکەوتووترەکان کە لە Starshipـدا بەکارهاتووە.
|
||||
|
||||
::: ئاگادارکردنەوە
|
||||
|
||||
ڕێکخستنەکانی ئەم بەشە شایەنی گۆڕانن لە وەشانەکانی داهاتووی Starshipدا.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
|
||||
+229
-211
@@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options.
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### نموونە
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| گۆڕاو | Default | Description |
|
||||
@@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### نموونە
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### نموونە
|
||||
|
||||
@@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c
|
||||
|
||||
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
|
||||
|
||||
::: ئاگادارکردنەوە
|
||||
|
||||
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
@@ -899,11 +891,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1426,26 +1416,17 @@ 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
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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.
|
||||
|
||||
Example: following configuration will display value of USER environment variable
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Example: following configuration will display value of USER environment variable
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1596,10 +1577,49 @@ Produces a prompt that looks like:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before displaying the version of COBOL. |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| name | gfortran | The name of the compiler |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'$'` | The format of `stashed` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
@@ -2392,17 +2407,9 @@ The default functionality is:
|
||||
- 1 job -> `symbol` is shown.
|
||||
- 2 jobs or more -> `symbol` + `number` are shown.
|
||||
|
||||
::: ئاگادارکردنەوە
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
This module is not supported on tcsh and nu.
|
||||
|
||||
:::
|
||||
|
||||
::: ئاگادارکردنەوە
|
||||
|
||||
The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### نموونە
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2530,21 +2545,13 @@ 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`.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Options
|
||||
|
||||
::: ئاگادارکردنەوە
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -2742,11 +2751,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic 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
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |
|
||||
| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | The style for the module. |
|
||||
| `format` | `'\([$state]($style)\) '` | The format for the module. |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| ---------------- | ---------- | ----------------------------------- |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | The current operation progress |
|
||||
| progress_total | `2` | The total operation progress |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: ئاگادارکردنەوە
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## 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`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel 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
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbol` | `'🧚 '` | The symbol used before the environment name. |
|
||||
| `style` | `'yellow bold' | The style for the module. |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.pixi']` | Which folders should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!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).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -3712,13 +3742,9 @@ 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. |
|
||||
|
||||
::: 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.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -4242,11 +4266,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Without Terraform version
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if
|
||||
- The variable `show_always` is set to true
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `xmake.lua` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'△ '` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
|
||||
@@ -4734,31 +4768,17 @@ 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.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Multiple custom modules can be defined by using a `.`.
|
||||
> [!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.
|
||||
|
||||
:::
|
||||
> [!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!
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### نموونە
|
||||
|
||||
|
||||
@@ -226,9 +226,10 @@ Alternatively, install Starship using any of the following package managers:
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -301,13 +302,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
Note: Only Elvish v0.18+ is supported
|
||||
Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -403,7 +404,7 @@ If you're looking to further customize Starship:
|
||||
|
||||
## 🤝 بەژداریکردن
|
||||
|
||||
ئێمە هەموو کات ئەگەڕێین بۆ بەژداریکەرێک لە هەر **ئاست و توانایەکدا بێت**! ئەگەر بەدوای ئەوەوەی کە بێیتە ئەم پڕۆژەیەوە [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) تاقیبکەرەوە.
|
||||
ئێمە هەموو کات ئەگەڕێین بۆ بەژداریکەرێک لە هەر **ئاست و توانایەکدا بێت**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
ئەگەر پاراویت لە زمانێک جگە لە ئینگلیزی، ئێمە زۆر خۆشحاڵدەبین بە هەر یارمەتییەک کە بەڵگەنامەکانمان بە وەرگێڕدراوی بهێڵێتەوە و نوێکراوی بهێڵێتەوە بە زمانەکانی دیکە. ئەگەر نیازت هەیە یارمەتی بدەیت، ئەتوانی بەژداری لە وەرگێڕاندا بکەیت لەسەر [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
|
||||
@@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pure)
|
||||
[Return to Presets](./#pure-prompt)
|
||||
|
||||
# Pure Preset
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pastel-powerline)
|
||||
[Return to Presets](./#tokyo-night)
|
||||
|
||||
# Tokyo Night Preset
|
||||
|
||||
|
||||
+4
-11
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
Es wird nur elvish v0.18 oder höher unterstützt.
|
||||
|
||||
:::
|
||||
|
||||
Trage folgendes am Ende von `~/.config/fish/rc.elv` ein:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,11 +161,7 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
Das wird sich in Zukunft ändern. Nur Nushell v0.96+ wird unterstützt.
|
||||
|
||||
:::
|
||||
> [!WARNING] This will change in the future. Nur Nushell v0.96+ wird unterstützt.
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
Auch wenn Starship eine vielseitige Shell ist, reichen manche Konfigurationen in der `starship.toml` nicht aus, um manche Sachen zu erreichen. Diese Seite beschreibt einige fortgeschrittene Konfigurationen für Starship.
|
||||
|
||||
::: warning
|
||||
|
||||
Die hier beschriebenen Konfigurationen werden sich mit kommenden Updates von Starship verändern.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
|
||||
+230
-212
@@ -209,11 +209,7 @@ Dies ist eine Liste mit Prompt-weiten Konfigurationsoptionen.
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### Beispiel
|
||||
|
||||
@@ -268,6 +264,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -282,6 +279,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -443,6 +441,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Variable | Standartwert | Beschreibung |
|
||||
@@ -659,15 +659,13 @@ The `c` module shows some information about your C compiler. By default the modu
|
||||
| symbol | | Spiegelt den Wert der Option `symbol` |
|
||||
| style | | Spiegelt den Wert der Option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Beispiel
|
||||
|
||||
@@ -682,6 +680,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standardwert | Beschreibung |
|
||||
@@ -705,15 +705,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbol | | Spiegelt den Wert der Option `symbol` |
|
||||
| style | | Spiegelt den Wert der Option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Beispiel
|
||||
|
||||
@@ -736,11 +734,7 @@ Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erz
|
||||
|
||||
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
|
||||
|
||||
::: warning
|
||||
|
||||
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -856,13 +850,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
|
||||
|
||||
Das `cmd_duration` Modul zeigt an wie lange der letzte Befehl ausgeführt wurde. Das Modul wird nur angezeigt wenn der letzte Befehl länger als zwei Sekunden ausgeführt wurde. Mit der `min_time` Option kann die Zeit eingestellt werden ab der `cmd_duration` angezeigt wird.
|
||||
|
||||
::: warning Nicht die DEBUG-trap in der Bash hooken
|
||||
> [!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.
|
||||
|
||||
Ist `bash` die Konsole der Wahl, dann nicht die `DEBUG`-trap nach der Ausführung von `eval $(starship init $0)` hooken, andernfalls **wird** dieses Modul unweigerlich untergehen.
|
||||
|
||||
:::
|
||||
|
||||
Bash Nutzer, die eine "preexec" ähnliche Funktion benötigen, können [rcaloras bash_preexec Framework](https://github.com/rcaloras/bash-preexec) verwenden. Definieren Sie einfach die Arrays `preexec_functions` und `precmd_functions` bevor sie `eval $(starship init $0)` ausführen, und fahren Sie dann wie gewohnt fort.
|
||||
Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Definieren Sie einfach die Arrays `preexec_functions` und `precmd_functions` bevor sie `eval $(starship init $0)` ausführen, und fahren Sie dann wie gewohnt fort.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -900,11 +892,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.
|
||||
|
||||
::: tip
|
||||
|
||||
Hinweis: Dies unterdrückt nicht conda's eigenen Prompt-Modifikator, sie können jedoch conda mit `conda config --set changeps1 False` konfigurieren, um die Ausgabe von conda selbst auszuschalten. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -1207,6 +1195,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
@@ -1252,16 +1242,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | Das Format für das Modul. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | Das Format für das Modul. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1427,26 +1417,17 @@ 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
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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.
|
||||
|
||||
Example: following configuration will display value of USER environment variable
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Example: following configuration will display value of USER environment variable
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -1597,10 +1578,49 @@ Produces a prompt that looks like:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before displaying the version of COBOL. |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. |
|
||||
| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | Stil für dieses Modul. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| --------- | -------- | ------------------------------------- |
|
||||
| name | gfortran | The name of the compiler |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbol | | Spiegelt den Wert der Option `symbol` |
|
||||
| style\* | | Spiegelt den Wert der Option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
@@ -1637,6 +1657,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
@@ -1760,6 +1782,7 @@ Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuelle
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Deaktiviert das `git_branch`-Modul. |
|
||||
|
||||
### Variables
|
||||
@@ -1867,11 +1890,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
|
||||
|
||||
::: tip
|
||||
|
||||
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -1909,11 +1928,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -1926,7 +1941,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'$'` | The format of `stashed` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
@@ -2393,17 +2408,9 @@ The default functionality is:
|
||||
- 1 job -> `symbol` is shown.
|
||||
- 2 jobs or more -> `symbol` + `number` are shown.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
This module is not supported on tcsh and nu.
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -2429,7 +2436,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Beispiel
|
||||
### Beispiele
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@@ -2440,6 +2447,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2531,21 +2546,13 @@ 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`.
|
||||
|
||||
::: tip
|
||||
|
||||
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Optionen
|
||||
|
||||
::: warning
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2667,6 +2674,8 @@ disabled = true
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
@@ -2743,11 +2752,7 @@ Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung
|
||||
|
||||
Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist.
|
||||
|
||||
::: tip
|
||||
|
||||
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -2827,6 +2832,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic of the repo in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
@@ -2860,10 +2867,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |
|
||||
| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | Stil für dieses Modul. |
|
||||
| `format` | `'\([$state]($style)\) '` | Das Format für das Modul. |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| ---------------- | ---------- | ------------------------------------ |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | The current operation progress |
|
||||
| progress_total | `2` | The total operation progress |
|
||||
| style\* | | Spiegelt den Wert der Option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
@@ -3172,16 +3214,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `'bold bright-blue'` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -3278,17 +3320,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -3310,6 +3344,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3353,7 +3388,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3388,7 +3423,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## Paketversion
|
||||
|
||||
Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3404,6 +3439,7 @@ Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3525,6 +3561,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel of the repo in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
@@ -3540,11 +3578,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -3553,12 +3587,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | Das Format für das Modul. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbol` | `'🧚 '` | Symbol das vor dem Umgebungsnamen angezeigt wird. |
|
||||
| `style` | `'yellow bold' | Stil für dieses Modul. |
|
||||
| `style` | `'yellow bold'` | Stil für dieses Modul. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.pixi']` | Which folders should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
@@ -3583,11 +3617,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!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).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -3713,13 +3743,9 @@ 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` | Deaktiviert das `python`-Modul. |
|
||||
|
||||
::: 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.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4037,11 +4063,7 @@ symbol = '🌟 '
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
|
||||
::: tip
|
||||
|
||||
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -4089,6 +4111,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
@@ -4243,11 +4267,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.
|
||||
|
||||
::: tip
|
||||
|
||||
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -4306,11 +4326,7 @@ disabled = false
|
||||
|
||||
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
|
||||
|
||||
::: tip
|
||||
|
||||
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -4392,13 +4408,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -4407,16 +4419,17 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Deaktiviert das `terraform` Modul. |
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Deaktiviert das `terraform` Modul. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4437,7 +4450,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Without Terraform version
|
||||
@@ -4446,18 +4459,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## Uhrzeit
|
||||
|
||||
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.
|
||||
|
||||
::: tip
|
||||
|
||||
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -4538,11 +4547,7 @@ Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezei
|
||||
- Die Variable `show_always` ist auf true gesetzt
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -4685,6 +4690,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met:
|
||||
|
||||
- Das aktuelle Verzeichnis enthält eine `xmake.lua`-Datei
|
||||
|
||||
### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'△ '` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `style` | `'bold green'` | Stil für dieses Modul. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Beispiel | Beschreibung |
|
||||
| --------- | -------- | ------------------------------------- |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbol | | Spiegelt den Wert der Option `symbol` |
|
||||
| style\* | | Spiegelt den Wert der Option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
|
||||
@@ -4735,31 +4769,17 @@ 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.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Multiple custom modules can be defined by using a `.`.
|
||||
> [!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.
|
||||
|
||||
:::
|
||||
> [!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!
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Optionen
|
||||
|
||||
@@ -4809,17 +4829,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### Beispiel
|
||||
|
||||
|
||||
+10
-10
@@ -1,4 +1,4 @@
|
||||
# Frequently Asked Questions
|
||||
# Häufig gestellte Fragen
|
||||
|
||||
## Wie ist die Konfiguration im Demo GIF?
|
||||
|
||||
@@ -10,15 +10,15 @@
|
||||
- **Konfiguration**: [Matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish)
|
||||
- **Prompt**: [Starship](https://starship.rs/)
|
||||
|
||||
## How do I get command completion as shown in the demo GIF?
|
||||
## Wie bekomme ich die Autovervollständigung, wie sie im Demo-GIF gezeigt wird?
|
||||
|
||||
Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions).
|
||||
Autovervollständigung wird von der Shell deiner Wahl bereitgestellt. In der Demo wurde die [Fish Shell](https://fishshell.com/) benutzt, welche Standardmäßig eine Autovervollständigung beinhaltet. Wenn du die Z Shell (zsh) nutzt, empfehle ich dir, einen Blick auf [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) zu werfen.
|
||||
|
||||
## Do top level `format` and `<module>.disabled` do the same thing?
|
||||
## Bewirken Top Level `format` und `<module>.disabled` dasselbe?
|
||||
|
||||
Ja, beide können benutzt werden, um Module in der Prompt zu deaktivieren. Wenn nur Module deaktiviert werden wollen, sollte `<module>.disabled` benutzt werden, aus den folgenden Gründen:
|
||||
|
||||
- Disabling modules is more explicit than omitting them from the top level `format`
|
||||
- Die Deaktivierung von Modulen ist expliziter, als nur das Weglassen vom Top Level `format`
|
||||
- Mit der Aktualisierung von Starship werden neu erstellte Module an die Eingabezeile angefügt
|
||||
|
||||
## Die Dokumentation sagt, dass die Starship interkompatibel ist. Warum wird meine bevorzugte Shell nicht unterstützt?
|
||||
@@ -48,9 +48,9 @@ starship prompt --help
|
||||
|
||||
Die Eingabeaufforderung verwendet so viel Kontext wie möglich, aber keine Flagge ist "notwendig".
|
||||
|
||||
## How do I run Starship on Linux distributions with older versions of glibc?
|
||||
## Wie führe ich Starship auf Linux-Distributionen mit älteren Versionen von glibc aus?
|
||||
|
||||
If you get an error like "_version 'GLIBC_2.18' not found (required by starship)_" when using the prebuilt binary (for example, on CentOS 6 or 7), you can use a binary compiled with `musl` instead of `glibc`:
|
||||
Wenn Sie einen Fehler wie "_Version 'GLIBC_2 erhalten.' nicht gefunden (wird von starship benötigt)_" wenn das vorkompilierte Programm verwendet wird (zum Beispiel auf CentOS 6 oder 7), Sie können eine Binärdatei verwenden, die mit `musl` anstelle von `glibc` kompiliert wurde:
|
||||
|
||||
```sh
|
||||
curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
||||
@@ -60,13 +60,13 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
||||
|
||||
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](../config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
|
||||
|
||||
## I see symbols I don't understand or expect, what do they mean?
|
||||
## Ich sehe Symbole, die ich nicht verstehe oder erwarte, was bedeuten sie?
|
||||
|
||||
If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules.
|
||||
Wenn du Symbole siehst, die du nicht kennst, kannst du `starship explain` verwenden um die aktuell angezeigten Module erklären zu lassen.
|
||||
|
||||
## Starship is doing something unexpected, how can I debug it?
|
||||
|
||||
You can enable the debug logs by using the `STARSHIP_LOG` env var. These logs can be very verbose so it is often useful to use the `module` command if you are trying to debug a particular module, for example, if you are trying to debug the `rust` module you could run the following command to get the trace logs and output from the module.
|
||||
Sie können die Debug-Logs aktivieren, indem Sie die `STARSHIP_LOG` Umgebungsvariable verwenden. These logs can be very verbose so it is often useful to use the `module` command if you are trying to debug a particular module, for example, if you are trying to debug the `rust` module you could run the following command to get the trace logs and output from the module.
|
||||
|
||||
```sh
|
||||
env STARSHIP_LOG=trace starship module rust
|
||||
|
||||
@@ -230,9 +230,10 @@ Alternatively, install Starship using any of the following package managers:
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
Trage folgendes am Ende von `~/.config/fish/rc.elv` ein:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
Note: Only Elvish v0.18+ is supported
|
||||
Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -407,7 +408,7 @@ Falls du Starship weiter anpassen möchtest:
|
||||
|
||||
## 🤝 Mitwirken
|
||||
|
||||
Wir sind immer auf der Suche nach Helfern **jeder Erfahrungsstufe**! Probleme mit dem Label [„Good first issues“](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) sind der beste Weg, um dich mit dem Projekt vertraut zu machen.
|
||||
Wir sind immer auf der Suche nach Helfern **jeder Erfahrungsstufe**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
Wenn du eine andere Sprache flüssig sprichts, würden wir uns sehr freuen wenn du helfen würdest die Dokumentation in anderen Sprachen auf dem aktuellsten Stand zu halten. Hier kannst du bei der Übersetzung helfen [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
|
||||
@@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Zurück zu den Voreinstellungen](./#pure)
|
||||
[Zurück zu den Voreinstellungen](./#pure-prompt)
|
||||
|
||||
# Pure Voreinstellung
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Zurück zu den Voreinstellungen](./#pastel-powerline)
|
||||
[Zurück zu den Voreinstellungen](./#tokyo-night)
|
||||
|
||||
# Tokyo Night Preset
|
||||
|
||||
|
||||
+5
-12
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
Sólo se admite elvish v0.18 o superior.
|
||||
|
||||
:::
|
||||
|
||||
Añade el siguiente código al final de `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,13 +161,9 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This will change in the future. Sólo se admite Nushell v0.96+.
|
||||
|
||||
Esto cambiará en el futuro. Sólo se admite Nushell v0.96+.
|
||||
|
||||
:::
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
Agregue lo siguiente al final de su configuración de Nushell (encuéntrelo ejecutando `$nu.config-path` en Nushell):
|
||||
|
||||
```sh
|
||||
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
A pesar de que Starship es una prompt versátil, a veces necesitas hacer más que editar `starhip.toml` para que haga ciertas cosas. Esta página detalla algunas de las técnicas de configuración más avanzadas en Starship.
|
||||
|
||||
::: warning
|
||||
|
||||
Las configuraciones de esta sección están sujetos a cambios en futuras versiones de Starship.
|
||||
|
||||
:::
|
||||
> [!ADVERTENCIA] Las configuraciones de esta sección están sujetas a cambios en futuras versiones de Starship.
|
||||
|
||||
## Prompt Transitoria en PowerShell
|
||||
|
||||
@@ -80,21 +76,21 @@ starship init fish | source
|
||||
enable_transience
|
||||
```
|
||||
|
||||
## TransientPrompt and TransientRightPrompt in Bash
|
||||
## TransientPrompt y TransientRightPrompt en Bash
|
||||
|
||||
The [Ble.sh](https://github.com/akinomyoga/ble.sh) framework at v0.4 or higher allows you to replace the previous-printed prompt with custom strings. Esto es útil en los casos en que la información del prompt no es siempre necesaria. To enable this, put this in `~/.bashrc` `bleopt prompt_ps1_transient=<value>`:
|
||||
El marco estructura [Ble.sh](https://github.com/akinomyoga/ble.sh) en v0.4 o superior le permite reemplazar el mensaje impreso previamente con cadenas personalizadas. Esto es útil en los casos en que la información del prompt no es siempre necesaria. Para habilitar esto, coloque esto en `~/.bashrc` `bleopt prompt_ps1_transient=<value>`:
|
||||
|
||||
The \<value\> here is a colon-separated list of `always`, `same-dir` and `trim`. When `prompt_ps1_final` is empty and the option `prompt_ps1_transient` has a non-empty \<value\>, the prompt specified by `PS1` is erased on leaving the current command line. If \<value\> contains a field `trim`, only the last line of multiline `PS1` is preserved and the other lines are erased. Otherwise, the command line will be redrawn as if `PS1=` is specified. When a field `same-dir` is contained in \<value\> and the current working directory is different from the final directory of the previous command line, this option `prompt_ps1_transient` is ignored.
|
||||
El \<value\> aquí es una lista separada por dos puntos de `siempre`, `mismo-dir` y `recortar`. Cuando `prompt_ps1_final` está vacío y la opción `prompt_ps1_transient` tiene un \<value\> no vacío, el mensaje especificado por `PS1` se borra al salir de la línea de comando actual. Si \<value\> contiene un campo `trim`, solo se conserva la última línea de la multilínea `PS1` y las demás líneas se borran. De lo contrario, la línea de comando se volverá a dibujar como si se hubiera especificado `PS1=`. Cuando un campo `same-dir` está contenido en \<value\> y el directorio de trabajo actual es diferente del directorio final de la línea de comando anterior, esta opción `prompt_ps1_transient` se ignora.
|
||||
|
||||
Make the following changes to your `~/.blerc` (or in `~/.config/blesh/init.sh`) to customize what gets displayed on the left and on the right:
|
||||
Realice los siguientes cambios en su `~/.blerc` (o en `~/.config/blesh/init.sh`) para personalizar lo que se muestra a la izquierda y a la derecha:
|
||||
|
||||
- To customize what the left side of input gets replaced with, configure the `prompt_ps1_final` Ble.sh option. For example, to display Starship's `character` module here, you would do
|
||||
- Para personalizar con qué se reemplaza el lado izquierdo de la entrada, configure la opción `prompt_ps1_final` de Ble.sh. Por ejemplo, para mostrar el módulo de `personaje` de Starship aquí, harías
|
||||
|
||||
```bash
|
||||
bleopt prompt_ps1_final='$(starship module character)'
|
||||
```
|
||||
|
||||
- To customize what the right side of input gets replaced with, configure the `prompt_rps1_final` Ble.sh option. Por ejemplo, para mostrar la hora en la que se inició el último comando aquí, lo harías
|
||||
- Para personalizar con qué se reemplaza el lado derecho de la entrada, configure la opción `prompt_rps1_final` de Ble.sh. Por ejemplo, para mostrar la hora en la que se inició el último comando aquí, lo harías
|
||||
|
||||
```bash
|
||||
bleopt prompt_rps1_final='$(starship module time)'
|
||||
@@ -225,9 +221,9 @@ Algunos intérpretes de comandos soportan un prompt derecho que se renderiza en
|
||||
|
||||
Nota: El prompt derecho es una sola línea siguiendo la ubicación de entrada. Para alinear los módulos arriba de la línea de entrada en un prompt multi-línea, vea el [módulo de `relleno`](../config/#fill).
|
||||
|
||||
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.
|
||||
`right_format` actualmente es compatible con los siguientes shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.
|
||||
|
||||
Note: The [Ble.sh](https://github.com/akinomyoga/ble.sh) framework v0.4 or higher should be installed in order to use right prompt in bash.
|
||||
Nota: Se debe instalar el framework [Ble.sh](https://github.com/akinomyoga/ble.sh) v0.4 o superior para poder utilizar el indicador correcto en bash.
|
||||
|
||||
### Ejemplo
|
||||
|
||||
@@ -266,7 +262,7 @@ Nota: Los prompts de continuación solo están disponibles en los siguientes int
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
# A continuation prompt that displays two filled-in arrows
|
||||
# Un mensaje de continuación que muestra dos flechas rellenas
|
||||
continuation_prompt = '▶▶ '
|
||||
```
|
||||
|
||||
@@ -287,7 +283,7 @@ Las cadenas de estilo son una lista de palabras, separadas por espacios en blanc
|
||||
- `<color>`
|
||||
- `ninguno`
|
||||
|
||||
donde `<color>` es un especificador de color (discutido a continuación). `fg:<color>` y `<color>` hacen actualmente lo mismo, aunque esto puede cambiar en el futuro. `<color>` can also be set to `prev_fg` or `prev_bg` which evaluates to the previous item's foreground or background color respectively if available or `none` otherwise. `inverted` cambia el fondo y los colores de primer plano. El orden de las palabras en la cadena no importa.
|
||||
donde `<color>` es un especificador de color (discutido a continuación). `fg:<color>` y `<color>` hacen actualmente lo mismo, aunque esto puede cambiar en el futuro. `<color>` también se puede configurar como `prev_fg` o `prev_bg`, que evalúa el color de primer plano o de fondo del elemento anterior respectivamente si está disponible o `none` en caso contrario. `inverted` cambia el fondo y los colores de primer plano. El orden de las palabras en la cadena no importa.
|
||||
|
||||
El token `none` anula todos los demás tokens en una cadena si no es parte de un especificador `bg:`, de modo que por ejemplo `fg:red none fg:blue` creará una cadena sin ningún estilo. `bg:none` establece el fondo al color por defecto, así que `fg:red bg:none` es equivalente a `red` o `fg:red` y `bg:green fg:red bg:none` también es equivalente a `fg:red` o `red`. Puede convertirse en un error usar `none` junto con otros estilos en el futuro.
|
||||
|
||||
|
||||
+246
-228
@@ -74,16 +74,16 @@ Por convención, la mayoría de los módulos tienen un prefijo del color por def
|
||||
|
||||
### Cadenas de Texto
|
||||
|
||||
In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`.
|
||||
En la sintaxis TOML, los [valores de texto](https://toml.io/en/v1.0.0#string) se declaran con `'`, `"`, `'''` o `"""`.
|
||||
|
||||
The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.
|
||||
Los siguientes símbolos de sintaxis de Starship tienen un uso especial en una cadena de formato y deben escaparse para mostrarse como ese carácter: `$ [ ] ( )`.
|
||||
|
||||
| Simbol | Tipo | Notas |
|
||||
| ------ | ------------------------- | ------------------------------------------------------ |
|
||||
| `'` | literal string | less escaping |
|
||||
| `"` | string | more escaping |
|
||||
| `'''` | multi-line literal string | less escaping |
|
||||
| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
|
||||
| Simbol | Tipo | Notas |
|
||||
| ------ | -------------------------- | ------------------------------------------------------ |
|
||||
| `'` | cadena literal | menos escapes |
|
||||
| `"` | cadena | mas escapes |
|
||||
| `'''` | cadena literal multilineas | menos escapes |
|
||||
| `"""` | multi-line string | more escaping, newlines in declarations can be ignored |
|
||||
|
||||
Por ejemplo:
|
||||
|
||||
@@ -208,11 +208,7 @@ Esta es la lista de opciones de configuración del prompt.
|
||||
| `paletas` | `{}` | Colección de paletas de colores que asignan [colores](../advanced-config/#style-strings) a nombres definidos por el usuario. Tenga en cuenta que las paletas de colores no pueden hacer referencia a sus propias definiciones de color. |
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### Ejemplo
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
El módulo `azure` muestra la suscripción Azure actual. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Variable | Predeterminado | Descripción |
|
||||
@@ -496,10 +496,10 @@ El módulo `battery` muestra qué tan cargada está la batería del dispositivo
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| -------------------- | --------------------------------- | ------------------------------------------------------------------------ |
|
||||
| `full_symbol` | `' '` | Se muestra cuando la batería está cargada. |
|
||||
| `charging_symbol` | `' '` | Se muestra cuando la batería se está cargando. |
|
||||
| `discharging_symbol` | `' '` | Se muestra cuando la batería se está descargando. |
|
||||
| `unknown_symbol` | `' '` | El símbolo que se muestra cuando el estado de la batería es desconocido. |
|
||||
| `empty_symbol` | `' '` | El símbolo que se muestra cuando el estado de la batería está vacío. |
|
||||
| `charging_symbol` | `' '` | Se muestra cuando la batería se está cargando. |
|
||||
| `discharging_symbol` | `' '` | Se muestra cuando la batería se está descargando. |
|
||||
| `unknown_symbol` | `' '` | El símbolo que se muestra cuando el estado de la batería es desconocido. |
|
||||
| `empty_symbol` | `' '` | El símbolo que se muestra cuando el estado de la batería está vacío. |
|
||||
| `format` | `'[$symbol$percentage]($style) '` | El formato del módulo. |
|
||||
| `display` | [ver aquí](#battery-display) | Define cuándo mostrar el indicador y el estilo. |
|
||||
| `disabled` | `false` | Desactiva el módulo `battery`. |
|
||||
@@ -658,15 +658,13 @@ El módulo `c` muestra información sobre su compilador de C. Por defecto el mó
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style | | Refleja el valor de la opción `style` |
|
||||
|
||||
NB que `versión` no está en el formato por defecto.
|
||||
|
||||
### Commands
|
||||
|
||||
La opción de `commands` acepta una lista de comandos para determinar la versión y el nombre del compilador.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship intentará ejecutar cada comando hasta que obtenga un resultado en STDOUT.
|
||||
|
||||
Si un compilador C no es compatible con este módulo, puede solicitarlo [planteando un problema en GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Ejemplo
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style | | Refleja el valor de la opción `style` |
|
||||
|
||||
NB que `versión` no está en el formato por defecto.
|
||||
|
||||
### Commands
|
||||
|
||||
La opción de `commands` acepta una lista de comandos para determinar la versión y el nombre del compilador.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship intentará ejecutar cada comando hasta que obtenga un resultado en STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Ejemplo
|
||||
|
||||
@@ -735,11 +733,7 @@ El caracter te dirá si el último comando fue exitoso o no. Se puede hacer de d
|
||||
|
||||
Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape).
|
||||
|
||||
::: warning
|
||||
|
||||
`vicmd_symbol` solo es compatible con cmd, fish y zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -855,13 +849,11 @@ El módulo `cobol` muestra la versión instalada de COBOL. Por defecto, el módu
|
||||
|
||||
El módulo `cmd_duration` muestra cuánto tiempo tomó ejecutarse el último comando. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time` si existe.
|
||||
|
||||
::: warning No utilizar la trampa DEBUG en Bash
|
||||
> [!WARNING] Do not hook the DEBUG trap in Bash
|
||||
>
|
||||
> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
|
||||
|
||||
Si estás usando Starship con `Bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**.
|
||||
|
||||
:::
|
||||
|
||||
Los usuarios de Bash que necesiten la funcionalidad como preexec pueden usar el [framework bash_preexec de rcaloras](https://github.com/rcaloras/bash-preexec). Basta con definir los arreglos `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre.
|
||||
Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Basta con definir los arreglos `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -897,13 +889,9 @@ format = 'underwent [$duration](bold yellow)'
|
||||
|
||||
## Conda
|
||||
|
||||
El módulo `conda` muestra el entorno actual [Conda](https://docs.conda.io/en/latest/), si `$CONDA_DEFAULT_ENV` está configurado.
|
||||
The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
Esto no modifica el propio símbolo de sistema de Conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -970,7 +958,7 @@ format = '[$symbol \[$name\]]($style) '
|
||||
|
||||
## Crystal
|
||||
|
||||
El módulo `cristal` muestra la versión instalada de [Crystal](https://crystal-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||||
The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||||
|
||||
- El directorio actual contiene un fichero `shard.yml`
|
||||
- El directorio actual contiene un fichero `.cr`
|
||||
@@ -1047,7 +1035,7 @@ format = 'via [D $version](bold bright-green) '
|
||||
|
||||
## Dart
|
||||
|
||||
El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||||
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||||
|
||||
- El directorio actual contiene un archivo con la extensión `.dart`
|
||||
- El directorio actual contiene un directorio `.dart_tool`
|
||||
@@ -1087,7 +1075,7 @@ format = 'via [🔰 $version](bold red) '
|
||||
|
||||
## Deno
|
||||
|
||||
El módulo `deno` le muestra la versión instalada de [Deno](https://deno.land/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||||
The `deno` module shows you your currently installed version of [Deno](https://deno.land/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||||
|
||||
- The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol$context]($style) '` | El formato del módulo. |
|
||||
| `symbol` | `'🐳 '` | El símbolo usado antes de mostrar el contexto de Docker. |
|
||||
| `only_with_files` | `true` | Mostrar solo cuando haya una coincidencia |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo (necesita `solly_with_files` para ser verdadero). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Qué nombres de archivo deberían activar este módulo (necesita que `only_with_files` sea verdadero, con un valor "true"). |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo (necesita que `only_with_files` sea verdadero, con un valor "true"). |
|
||||
| `style` | `'blue bold'` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Deshabilita el módulo `docker_context`. |
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol$context]($style) '` | El formato del módulo. |
|
||||
| `symbol` | `'🐳 '` | El símbolo usado antes de mostrar el contexto de Docker. |
|
||||
| `only_with_files` | `true` | Mostrar solo cuando haya una coincidencia |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo (necesita `solly_with_files` para ser verdadero). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Qué nombres de archivo deberían activar este módulo (necesita que `only_with_files` sea verdadero, con un valor "true"). |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo (necesita que `only_with_files` sea verdadero, con un valor "true"). |
|
||||
| `style` | `'blue bold'` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Deshabilita el módulo `docker_context`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1426,26 +1416,17 @@ El módulo `env_var` muestra el valor actual de una variable de entorno seleccio
|
||||
- La opción de configuración de `variable` coincide con una variable de entorno existente
|
||||
- La opción de configuración de `variable` no está definida, pero la opción de configuración se encuentra `por defecto`
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
Múltiples variables de entorno pueden mostrarse usando una `.`. (ver ejemplo) Si la opción de configuración de la `variable` no está definida, el módulo mostrará el valor de la variable bajo el nombre del texto después del caracter `.`.
|
||||
|
||||
Ejemplo: la siguiente configuración mostrará el valor de la variable de entorno USER
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Ejemplo: la siguiente configuración mostrará el valor de la variable de entorno USER
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -1596,10 +1577,49 @@ Produce un prompt que se ve como:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | El símbolo usado antes de mostrar la versión de COBOL. |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
|
||||
| `version_format` | `'${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | El estilo del módulo. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `['fpm.toml']` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | Cómo detectar cuál compilador es |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Ejemplo | Descripción |
|
||||
| --------- | -------- | -------------------------------------- |
|
||||
| name | gfortran | El nombre del compilador |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | | Refleja el valor de la opción `style` |
|
||||
|
||||
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
|
||||
|
||||
### Commands
|
||||
|
||||
La opción de `commands` acepta una lista de comandos para determinar la versión y el nombre del compilador.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship intentará ejecutar cada comando hasta que obtenga un resultado en STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
@@ -1759,6 +1781,7 @@ El módulo `git_branch` muestra la rama activa del repositorio en tu directorio
|
||||
| `truncation_symbol` | `'…'` | El símbolo usado para indicar que un nombre de rama fue truncado. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Mostrar solo el hash de la confirmación de git cuando esté en estado "detached `HEAD`" |
|
||||
| `ignore_branches` | `[]` | Una lista de nombres a evitar ser visualizados. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Deshabilita el módulo `git_branch`. |
|
||||
|
||||
### Variables
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
El módulo `git_metrics` mostrará el número de líneas añadidas y eliminadas en el repositorio git actual.
|
||||
|
||||
::: tip
|
||||
|
||||
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
El módulo `git_status` muestra símbolos que representan el estado del repositorio en su directorio actual.
|
||||
|
||||
::: tip
|
||||
|
||||
El módulo Git Status es muy lento en los directorios de Windows (por ejemplo bajo `/mnt/c/`) en un entorno WSL. Puedes desactivar el módulo o utilizar la opción `windows_starship` para usar un ejecutable de la Starship nativa de Windows para calcular `git_status` para esas rutas.
|
||||
|
||||
:::
|
||||
> [!TIP] The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. Puedes desactivar el módulo o utilizar la opción `windows_starship` para usar un ejecutable de la Starship nativa de Windows para calcular `git_status` para esas rutas.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -1925,7 +1940,7 @@ El módulo Git Status es muy lento en los directorios de Windows (por ejemplo ba
|
||||
| `diverged` | `'⇕'` | El formato de `diverged` |
|
||||
| `up_to_date` | `''` | El formato de `up_to_date` |
|
||||
| `sin seguimiento` | `'?'` | El formato de `untracked` |
|
||||
| `stashed` | `'$'` | El formato de `stashed` |
|
||||
| `stashed` | `'\$'` | El formato de `stashed` |
|
||||
| `modificado` | `'!'` | El formato de `modified` |
|
||||
| `staged` | `'+'` | El formato de `staged` |
|
||||
| `renamed` | `'»'` | El formato de `renamed` |
|
||||
@@ -2392,17 +2407,9 @@ La funcionalidad por defecto es:
|
||||
- 1 tarea -> `symbol` se muestra.
|
||||
- 2 tareas o más -> `symbol` + `number` son mostrados.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
Este módulo no está soportado por tcsh y nu.
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
La opción `threshold` está obsoleta, pero si deseas usarla, el módulo mostrará el número de tareas en ejecución si hay más de 1 tarea, o más que el valor de configuración `threshold`, si existe. Si `threshold` se establece en 0, entonces el módulo también se mostrará cuando haya 0 tareas en ejecución.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -2428,7 +2435,7 @@ La opción `threshold` está obsoleta, pero si deseas usarla, el módulo mostrar
|
||||
|
||||
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
|
||||
|
||||
### Ejemplo
|
||||
### Ejemplos
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
El módulo `julia` muestra la versión instalada de [Julia](https://julialang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||||
@@ -2530,21 +2545,13 @@ kotlin_binary = 'kotlinc'
|
||||
|
||||
Muestra el nombre actual del [contexto de Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) y, si se establece, el espacio de nombres, el usuario y el clúster del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante `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`. Si se establece la variable de entorno `$KUBECONFIG`, el módulo usará eso si no usará el `~/.kube/config`.
|
||||
|
||||
::: tip
|
||||
|
||||
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Opciones
|
||||
|
||||
::: warning
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
El módulo `localip` muestra la dirección IPv4 de la interfaz de red principal.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
@@ -2742,11 +2751,7 @@ El módulo `memory_usage` muestra la memoria del sistema actual y el uso de la m
|
||||
|
||||
Por defecto, el uso de la memoria de intercambio se muestra si no es cero.
|
||||
|
||||
::: tip
|
||||
|
||||
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic of the repo in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Estado Mercurial
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------------------- |
|
||||
| `fusionar` | `'FUSIONANDO'` | Una cadena de formato que se muestra cuando un `merge` está en progreso. |
|
||||
| `rebase` | `'REBASING'` | Una cadena de formato que se muestra cuando un `rebase` está en progreso. |
|
||||
| `actualizar` | `'ACTUALIZANDO'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | Una cadena de formato que se muestra cuando un `bisect` está en progreso. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `trasplante` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | El estilo del módulo. |
|
||||
| `format` | `'\([$state]($style)\) '` | El formato del módulo. |
|
||||
| `disabled` | `true` | Desactiva el módulo `git_state`. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Ejemplo | Descripción |
|
||||
| ---------------- | ---------- | ------------------------------------- |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | El progreso de la operación actual |
|
||||
| progress_total | `2` | El progreso total de la operación |
|
||||
| style\* | | Refleja el valor de la opción `style` |
|
||||
|
||||
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
@@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------------- | ------------------------------------ | ---------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | El símbolo usado antes de mostrar la versión de Zig. |
|
||||
| `style` | `'bold bright-blue'` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch es lo mejor! "
|
||||
|
||||
## Package Version
|
||||
|
||||
El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – La versión del paquete `npm` se extrae del `package.json` presente en el directorio actual
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de
|
||||
- [**Maven**](https://maven.apache.org/) - La versión de paquete `maven` se extrae de `pom.xml` presente en el directorio actual
|
||||
- [**Meson**](https://mesonbuild.com/) - La versión del paquete `meson` se extrae de `meson.build` presente en el directorio actual
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - La versión del paquete `shards` se extrae de `shard.yml` presente en el directorio actual
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - La versión del paquete `vlang` se extrae de `v.mod` presente en el directorio actual
|
||||
- [**SBT**](https://scala-sbt.org) - La versión del paquete `sbt` se extrae del archivo `build.sbt` presente en el directorio actual
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel of the repo in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | El formato del módulo. |
|
||||
| `version_format` | `'v${raw}'` | El formato de versión. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbol` | `'🧚 '` | El símbolo usado antes del nombre del entorno. |
|
||||
| `style` | `'yellow bold' | El estilo del módulo. |
|
||||
| `style` | `'yellow bold'` | El estilo del módulo. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `['pixi.toml']` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `['.pixi']` | Qué carpetas deberían activar este módulo. |
|
||||
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
El módulo `pulumi` muestra el nombre de usuario actual, [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/)seleccionado y la versión.
|
||||
|
||||
::: tip
|
||||
|
||||
Por defecto la versión de Pulumi no se muestra, ya que toma un orden de magnitud más largo para cargar que la mayoría de los plugins (~70ms). Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-pulumi-version).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-pulumi-version).
|
||||
|
||||
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||||
|
||||
@@ -3712,13 +3742,9 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
|
||||
| `detect_folders` | `[]` | Qué carpetas deben activar este módulo |
|
||||
| `disabled` | `false` | Deshabilita el módulo `python`. |
|
||||
|
||||
::: tip
|
||||
|
||||
La variable `python_binary` acepta una cadena o una lista de cadenas. La Starship intentará ejecutar cada binario hasta que obtenga un resultado. Ten en cuenta que sólo puedes cambiar el binario que Starship ejecuta para obtener la versión de Python no los argumentos que se utilizan.
|
||||
|
||||
Los valores por defecto y el orden para `python_binary` fue elegido para identificar primero la versión de Python en un entorno virtualenv/conda (que actualmente añade un `python`, no importa si apunta a `python3` o `python2`). Esto tiene el efecto secundario que si todavía tienes un sistema de Python 2 instalado, puede ser recogido antes de cualquier Python 3 (al menos en las Distros de Linux que siempre enlazan `/usr/bin/python` a Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!TIP] The `python_binary` variable accepts either a string or a list of strings. La Starship intentará ejecutar cada binario hasta que obtenga un resultado. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
El módulo `shell` muestra un indicador para el intérprete de comandos actualmente utilizado.
|
||||
|
||||
::: tip
|
||||
|
||||
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
@@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) '
|
||||
|
||||
El módulo `status` muestra el código de salida del comando anterior. Si $success_symbol está vacío (por defecto), el módulo solo se mostrará si el código de salida no es `0`. El código de estado se convertirá a un entero con signo de 32 bits.
|
||||
|
||||
::: tip
|
||||
|
||||
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
El módulo `sudo` muestra si las credenciales de sudo están actualmente en caché. El módulo solo se mostrará si las credenciales están guardadas en caché.
|
||||
|
||||
::: tip
|
||||
|
||||
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'vía [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
El módulo `Terraform` muestra el [espacio de trabajo de Terraform](https://www.terraform.io/docs/language/state/workspaces.html) y la versión seleccionados actualmente.
|
||||
El módulo `Terraform` muestra el [espacio de trabajo de Terraform](https://www.terraform.io/docs/language/state/workspaces.html) y la versión seleccionados actualmente. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: tip
|
||||
|
||||
Por defecto no se muestra la versión de Terraform, ya que esto es lento para las versiones actuales de Terraform cuando hay muchos plugins en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version).
|
||||
|
||||
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
|
||||
|
||||
@@ -4406,16 +4418,17 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | La cadena de formato para el módulo. |
|
||||
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | Una cadena de formato que se muestra antes del espacio de trabajo terraform. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `['.terraform']` | Qué carpetas deberían activar este módulo. |
|
||||
| `style` | `'bold 105'` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Deshabilita el módulo `terraform`. |
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | La cadena de formato para el módulo. |
|
||||
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | Una cadena de formato que se muestra antes del espacio de trabajo terraform. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Qué extensiones deberían activar este módulo. |
|
||||
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
|
||||
| `detect_folders` | `['.terraform']` | Qué carpetas deberían activar este módulo. |
|
||||
| `style` | `'bold 105'` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Deshabilita el módulo `terraform`. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4436,7 +4449,7 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Sin Terraform Version
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## Time
|
||||
|
||||
El módulo `time` muestra la hora **local** actual. El valor de configuración de `format` es usado por el crate de [`chrono`](https://crates.io/crates/chrono) para controlar cómo se muestra la hora. Echa un vistazo a [los documentos de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver qué opciones están disponibles.
|
||||
|
||||
::: tip
|
||||
|
||||
Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Para activarlo, establece `disabled` como `false` en tu archivo de configuración.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -4537,11 +4546,7 @@ El módulo `username` muestra el nombre de usuario activo. El módulo se mostrar
|
||||
- La variable `show_always` se establece en true
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: tip
|
||||
|
||||
La conexión SSH se detecta comprobando las variables de entorno `SSH_CONNECTION`, `SSH_CLIENT`, y `SSH_TTY`. Si tu host SSH no configura estas variables, una solución es establecer una de ellas con un valor tonto.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -4684,6 +4689,35 @@ El módulo `vcsh` muestra el repositorio activo [VCSH](https://github.com/RichiH
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). Por defecto el módulo se activará si se cumplen cualquiera de las siguientes condiciones:
|
||||
|
||||
- El directorio actual contiene un archivo `xmake.lua`
|
||||
|
||||
### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. |
|
||||
| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'△ '` | El símbolo usado antes de la versión de cmake. |
|
||||
| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo |
|
||||
| `detect_files` | `['xmake.lua']` | Qué nombres de archivo deben activar este módulo |
|
||||
| `detect_folders` | `[]` | Qué carpetas deben activar este módulo |
|
||||
| `style` | `'bold green'` | El estilo del módulo. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Ejemplo | Descripción |
|
||||
| --------- | -------- | -------------------------------------- |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | | Refleja el valor de la opción `style` |
|
||||
|
||||
*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones:
|
||||
@@ -4734,31 +4768,17 @@ Estos módulos se mostrarán si se cumple alguna de las siguientes condiciones:
|
||||
- El comando `when` devuelve 0
|
||||
- El sistema operativo actual (std::env::consts::OS) coincide con el campo `os` si está definido.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Múltiples módulos personalizados pueden definirse usando un `.` (un punto).
|
||||
> [!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 `${...}`). Por defecto, el módulo `personalizado` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos.
|
||||
|
||||
:::
|
||||
> [!TIP] [Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. ¡Si tienes un ejemplo interesante no cubierto, siéntete libre de compartirlo ahí!
|
||||
|
||||
::: tip
|
||||
|
||||
El orden en el que se muestran los módulos personalizados se puede establecer individualmente incluyendo `${custom.foo}` en el `format` de nivel superior (ya que incluye un punto, necesita usar `${...}`). Por defecto, el módulo `personalizado` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
[El problema #1252](https://github.com/starship/starship/discussions/1252) contiene ejemplos de módulos personalizados. ¡Si tienes un ejemplo interesante no cubierto, siéntete libre de compartirlo ahí!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Cualquiera que sea la salida que genere el comando se imprime sin modificar en el prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Las cadenas de formato también pueden contener secuencias específicas del intérprete, por ejemplo, [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Cualquiera que sea la salida que genere el comando se imprime sin modificar en el prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Opciones
|
||||
|
||||
@@ -4808,17 +4828,15 @@ Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Asegúrate de que tu configuración personalizada del intérprete de comandos salga con éxito
|
||||
|
||||
Si estableces un comando personalizado, asegúrate de que el intérprete de comandos por defecto usado por Starship ejecutará correctamente el comando con una salida elegante (a través de la opción `shell`).
|
||||
|
||||
Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a Starship a un bucle recursivo donde el intérprete de comandos podría intentar cargar un entorno de perfil completo con Starship en sí misma y volver a ejecutar el comando personalizado, entrando en un bucle infinito.
|
||||
|
||||
Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros intérprete de comandos también para evitar tiempo extra de carga de un perfil personalizado en cada invocación de Starship.
|
||||
|
||||
La detección automática de intérpretes de comandos y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los intérpretes de comandos estén cubiertos. Por favor, [abre un problema](https://github.com/starship/starship/issues/new/choose) con los detalles del intérprete de comandos y la configuración de Starship si te encuentras en tal escenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### Ejemplo
|
||||
|
||||
|
||||
+29
-27
@@ -35,7 +35,7 @@
|
||||
<a href="https://stand-with-ukraine.pp.ua"
|
||||
><img
|
||||
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
|
||||
alt="Stand With Ukraine"
|
||||
alt="Quedarse con Ukraniano"
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
@@ -221,21 +221,22 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
Alternativamente, instale Starship usando cualquiera de los siguientes gestores de paquetes:
|
||||
|
||||
| Distribución | Repositorio | Instrucciones |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| **_Cualquiera_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| _Cualquiera_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| _Cualquiera_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Gentoo | [Paquetes Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
| Distribución | Repositorio | Instrucciones |
|
||||
| ------------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| **_Cualquiera_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| _Cualquiera_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| _Cualquiera_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||||
| Arch Linux | [Extra de Archi Linux](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Paquetes Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04 o más nuevo | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
|
||||
</details>
|
||||
|
||||
@@ -276,7 +277,7 @@ Instalar Starship usando cualquiera de los siguientes gestores de paquetes:
|
||||
|
||||
</details>
|
||||
|
||||
### Paso 2. Set up your shell to use Starship
|
||||
### Paso 2. Configure su consola para usar Starship
|
||||
|
||||
Configure su shell para inicializar starship. Selecciona el tuyo de la lista de abajo:
|
||||
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
Añade el siguiente código al final de `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
Nota: Sólo se admite Elvish v0.18+
|
||||
Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -340,11 +341,12 @@ eval $(starship init ion)
|
||||
<details>
|
||||
<summary>Nushell</summary>
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
Agregue lo siguiente al final de su configuración de Nushell (encuéntrelo ejecutando `$nu.config-path` en Nushell):
|
||||
|
||||
```sh
|
||||
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
|
||||
```
|
||||
|
||||
Nota: Sólo se admite Nushell v0.96+
|
||||
@@ -407,7 +409,7 @@ Si estás buscando personalizar Starship:
|
||||
|
||||
## 🤝 Contribuir
|
||||
|
||||
¡Siempre estamos buscando colaboradores de **todos los niveles y habilidades**! Si estas buscando una manera fácil de ayudar este proyecto, puedes intentar resolver un problema con la etiqueta "[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)".
|
||||
¡Siempre estamos buscando colaboradores de **todos los niveles y habilidades**! Si buscas avanzar gradualmente en el proyecto, prueba con un [buen primer número](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
Si habla con fluidez en un idioma que no es inglés, agradecemos mucho cualquier ayuda para mantener nuestros documentos traducidos y actualizados en otros idiomas. Si quieres ayudar, puedes contribuir con las traducciones en el [Crowdin de Starship](https://translate.starship.rs/).
|
||||
|
||||
@@ -427,16 +429,16 @@ Por favor, revisa estas obras anteriores que ayudaron a inspirar la creación de
|
||||
|
||||
Apoya este proyecto [convirtiéndote en patrocinador](https://github.com/sponsors/starship). Tu nombre o logo aparecerá aquí con un enlace a tu sitio web.
|
||||
|
||||
## 🔒 Code Signing Policy
|
||||
## Política de Firmado de Código
|
||||
|
||||
Free code signing provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org).
|
||||
Firma de código gratuita proporcionada por [SignPath.io](https://signpath.io), certificado por [SignPath Foundation](https://signpath.org).
|
||||
|
||||
Code Signing Roles:
|
||||
Roles de Firmado de Código:
|
||||
|
||||
- Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts)
|
||||
- Approvers and Authors: [Mission Control](https://github.com/orgs/starship/teams/mission-control)
|
||||
- Revisores: [Astronauts](https://github.com/orgs/starship/teams/astronauts)
|
||||
- Aprobadores y Autores: [Mission Control](https://github.com/orgs/starship/teams/mission-control)
|
||||
|
||||
This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.
|
||||
Este programa no transferirá ninguna información a otros sistemas en red a menos que lo solicite específicamente el usuario o la persona que lo instale u opere.
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
|
||||
@@ -14,11 +14,7 @@ Este preajuste cambia los símbolos de cada módulo para usar símbolos Nerd Fon
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Volver a Preajustes](./#pure)
|
||||
[Volver a Preajustes](./#pure-prompt)
|
||||
|
||||
# Preajuste Pure
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Volver a Preajustes](./#pastel-powerline)
|
||||
[Volver a Preajustes](./#tokyo-night)
|
||||
|
||||
# Tokyo Night Preset
|
||||
|
||||
|
||||
+8
-15
@@ -18,7 +18,7 @@ features:
|
||||
details: Profitez de toute la rapidité et la sécurité de Rust pour rendre votre invite de commandes la plus rapide et fiable possible.
|
||||
-
|
||||
title: Personnalisable
|
||||
details: Tous les petits détails sont personnalisable à votre goût, pour rendre votre invite de commandes aussi légère ou complète que le vous souhaitez.
|
||||
details: Tous les petits détails sont personnalisables à votre goût, pour rendre votre invite de commandes aussi légère ou complète que vous le souhaitez.
|
||||
footer: Licence ISC | Copyright © 2019-présent Contributeurs Starship
|
||||
#Used for the description meta tag, for SEO
|
||||
metaTitle: "Starship : Invite Multi-Shell"
|
||||
@@ -46,7 +46,7 @@ onMounted(() => {
|
||||
|
||||
### Pré-requis
|
||||
|
||||
- Une [Nerd Font](https://www.nerdfonts.com/) est installée et activée dans votre terminal.
|
||||
- Une police d'écriture [Nerd Font](https://www.nerdfonts.com/) est installée et activée dans votre terminal.
|
||||
|
||||
### Installation
|
||||
|
||||
@@ -72,7 +72,7 @@ onMounted(() => {
|
||||
brew install starship
|
||||
```
|
||||
|
||||
With [Winget](https://github.com/microsoft/winget-cli):
|
||||
Avec [Winget](https://github.com/microsoft/winget-cli):
|
||||
|
||||
```powershell
|
||||
winget install starship
|
||||
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
Seul elvish v0.18 ou supérieur est pris en charge.
|
||||
|
||||
:::
|
||||
|
||||
Ajoutez ce qui suit à la fin de `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,13 +161,9 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This will change in the future. Seul Nushell v0.96+ est supporté.
|
||||
|
||||
Ceci va changer dans le futur. Seul Nushell v0.96+ est supporté.
|
||||
|
||||
:::
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
Ajoutez la ligne suivante à la fin de votre configuration Nushell (trouvable en exécutant `$nu.config-path` dans Nushell) :
|
||||
|
||||
```sh
|
||||
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
Même si Starship est un shell polyvalent, éditer `starship.toml` ne suffit parfois pas pour faire certaines choses. Cette page détaille quelques techniques de configuration avancées utilisées dans starship.
|
||||
|
||||
::: warning
|
||||
|
||||
Les configurations dans cette section sont sujettes à modification dans les futures versions de Starship.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
|
||||
+225
-207
@@ -208,11 +208,7 @@ Voici la liste des options de configuration globales de l'invite de commandes.
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### Exemple
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
Le module `azure` affiche l'abonnement Azure actuel. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Variable | Défaut | Description |
|
||||
@@ -658,15 +658,13 @@ Le module `c` affiche des informations à propos de votre compilateur C. Par dé
|
||||
| symbole | | Reflète la valeur de l'option `symbol` |
|
||||
| style | | Reflète la valeur de l'option `style` |
|
||||
|
||||
Notez que `version` n’est pas dans le format par défaut.
|
||||
|
||||
### Commandes
|
||||
|
||||
L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT.
|
||||
|
||||
Si un compilateur C n’est pas supporté par ce module, vous pouvez demander son ajout en [créant un ticket sur GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Exemple
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbole | | Reflète la valeur de l'option `symbol` |
|
||||
| style | | Reflète la valeur de l'option `style` |
|
||||
|
||||
Notez que `version` n’est pas dans le format par défaut.
|
||||
|
||||
### Commandes
|
||||
|
||||
L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Exemple
|
||||
|
||||
@@ -735,11 +733,7 @@ Le caractère vous dira si la dernière commande a été réussie ou pas. Il peu
|
||||
|
||||
Par défaut, il ne change que de couleur. Si vous désirez également changer sa forme, jetez un à [cet exemple](#with-custom-error-shape).
|
||||
|
||||
::: warning
|
||||
|
||||
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -855,13 +849,11 @@ Le module `cobol` affiche la version de COBOL installée. Par défaut, le module
|
||||
|
||||
Le module `cmd_duration` montre le temps qu'a pris la dernière commande pour s'exécuter. Le module ne sera affiché que si la commande a pris plus de deux secondes, ou plus que la valeur `min_time`, si elle existe.
|
||||
|
||||
::: warning N'accrochez pas la trappe DEBUG en Bash
|
||||
> [!WARNING] Do not hook the DEBUG trap in Bash
|
||||
>
|
||||
> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
|
||||
|
||||
Si vous utilisez starship avec `bash`, n'interceptez pas `DEBUG` après avoir exécuté `eval $(starship init $0)`, ou ce module **ne fonctionnera pas**.
|
||||
|
||||
:::
|
||||
|
||||
Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Définissez simplement les tableaux `preexec_functions` et `precmd_functions` avant d'exécuter `eval $(starship init $0)`, puis procédez comme d'habitude.
|
||||
Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Définissez simplement les tableaux `preexec_functions` et `precmd_functions` avant d'exécuter `eval $(starship init $0)`, puis procédez comme d'habitude.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -897,13 +889,9 @@ format = 'underwent [$duration](bold yellow)'
|
||||
|
||||
## Conda
|
||||
|
||||
Le module `conda` affiche l’environnement [Conda](https://docs.conda.io/en/latest/) courant, si `$CONDA_DEFAULT_ENV` est définie.
|
||||
The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
Cela ne supprime pas le modificateur d'invite de conda, vous pourriez vouloir exécuter `conda config --set changeps1 False` pour le désactiver. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -970,7 +958,7 @@ format = '[$symbol \[$name\]]($style) '
|
||||
|
||||
## Crystal
|
||||
|
||||
Le module `crystal` affiche la version de [Crystal](https://crystal-lang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
|
||||
- Le dossier courant contient un fichier `shard.yml`
|
||||
- Le dossier courant contient un fichier `.cr`
|
||||
@@ -1047,7 +1035,7 @@ format = 'via [D $version](bold bright-green) '
|
||||
|
||||
## Dart
|
||||
|
||||
Le module `dart` affiche la version de [Dart](https://dart.dev/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
|
||||
- Le dossier courant contient un fichier avec l’extension `.dart`
|
||||
- Le dossier courant contient un fichier `.dart_tool`
|
||||
@@ -1087,7 +1075,7 @@ format = 'via [🔰 $version](bold red) '
|
||||
|
||||
## Deno
|
||||
|
||||
Le module `deno` affiche la version de [Deno](https://deno.land/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
The `deno` module shows you your currently installed version of [Deno](https://deno.land/). Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
|
||||
- The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol$context]($style) '` | Format du module. |
|
||||
| `symbole` | `'🐳 '` | Le symbole utilisé avant d'afficher le contexte Docker. |
|
||||
| `only_with_files` | `true` | Afficher uniquement quand il y a une correspondance |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module (il faut que `only_with_files` soit réglé sur true). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Quels noms de fichier devraient activer ce module (il faut que `only_with_files` soit réglé sur true). |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module (il faut que `only_with_files` soit réglé sur true). |
|
||||
| `style` | `'blue bold'` | Le style pour le module. |
|
||||
| `disabled` | `false` | Désactive le module `docker_context`. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol$context]($style) '` | Format du module. |
|
||||
| `symbole` | `'🐳 '` | Le symbole utilisé avant d'afficher le contexte Docker. |
|
||||
| `only_with_files` | `true` | Afficher uniquement quand il y a une correspondance |
|
||||
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module (il faut que `only_with_files` soit réglé sur true). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Quels noms de fichier devraient activer ce module (il faut que `only_with_files` soit réglé sur true). |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module (il faut que `only_with_files` soit réglé sur true). |
|
||||
| `style` | `'blue bold'` | Le style pour le module. |
|
||||
| `disabled` | `false` | Désactive le module `docker_context`. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1426,26 +1416,17 @@ Le module `env_var` affiche la valeur actuelle de la variable d’environnement
|
||||
- L'option `variable` correspond à une variable d'environnement existante
|
||||
- L'option `variable` n'est pas définie, mais l'option `default` l'est
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
Plusieurs variables d’environnement peuvent être affichées en utilisant un `.`. (voir exemple). Si l’option de configuration `variable` n’est pas définie, le module affichera la valeur de la variable dont le nom est le texte après le caractère `.`.
|
||||
|
||||
Exemple : la configuration suivante va afficher la valeur de la variable d’environnement UTILISATEUR
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Exemple : la configuration suivante va afficher la valeur de la variable d’environnement UTILISATEUR
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1596,10 +1577,49 @@ Produit une invite qui ressemble à :
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `symbole` | `' '` | Le symbole utilisé avant d’afficher la version de COBOL. |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
|
||||
| `version_format` | `'${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | Le style pour le module. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Les extensions qui déclenchent ce module. |
|
||||
| `detect_files` | `['fpm.toml']` | Les fichiers qui activent ce module. |
|
||||
| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | Comment détecter quel est le compilateur |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | -------- | -------------------------------------- |
|
||||
| name | gfortran | Le nom du compilateur |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbole | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
|
||||
*: Cette variable peut uniquement être utilisée dans une chaine de style
|
||||
|
||||
### Commandes
|
||||
|
||||
L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
@@ -1759,6 +1781,7 @@ Le module `git_branch` affiche la branche active du dépôt dans le dossier cour
|
||||
| `truncation_symbol` | `'…'` | Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Ne montrer le nom de la branche que si elle n'est pas dans un état `HEAD` détachée. |
|
||||
| `ignore_branches` | `[]` | Une liste de noms à ne pas afficher. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Désactive le module `git_branch`. |
|
||||
|
||||
### Variables
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
Le module `git_metrics` affiche le nombre de lignes ajoutées et supprimées dans le dépôt Git courant.
|
||||
|
||||
::: tip
|
||||
|
||||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
Le module `git_status` affiche des symboles représentant l’état du dépôt dans le dossier courant.
|
||||
|
||||
::: tip
|
||||
|
||||
Le module Statut Git est très lent dans les dossiers Windows (par exemple sous `/mnt/c/`) dans un environnement WSL. Vous pouvez désactiver le module ou utiliser l’option `windows_starship` pour utiliser un exécutable Starship natif pour calculer le `git_status` pour ces chemins.
|
||||
|
||||
:::
|
||||
> [!TIP] The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. Vous pouvez désactiver le module ou utiliser l’option `windows_starship` pour utiliser un exécutable Starship natif pour calculer le `git_status` pour ces chemins.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1925,7 +1940,7 @@ Le module Statut Git est très lent dans les dossiers Windows (par exemple sous
|
||||
| `diverged` | `'⇕'` | Le format de `diverged` |
|
||||
| `up_to_date` | `''` | The format de `up_to_date` |
|
||||
| `untracked` | `'?'` | Le format de `untracked` |
|
||||
| `stashed` | `'$'` | Le format de `stashed` |
|
||||
| `stashed` | `'\$'` | Le format de `stashed` |
|
||||
| `modified` | `'!'` | Le format de `modified` |
|
||||
| `staged` | `'+'` | Le format de `staged` |
|
||||
| `renamed` | `'»'` | Le format de `renamed` |
|
||||
@@ -2392,17 +2407,9 @@ Le fonctionnement par défaut est:
|
||||
- 1 tâche -> `symbol` est affiché.
|
||||
- 2 taĉhes ou plus -> `symbol` + `number` sont affichés.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
Ce module n'est pas pris en charge sur tcsh et nu.
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
L’option `threshold` est dépréciée, mais si vous voulez l’utiliser, le module affichera le nombre de tâches en cours s’il y a plus d'une tâche, ou plus que la valeur de `threshold`, si elle existe. Si `threshold` est définie à 0, alors le module s'affichera également lorsqu'il n'y a pas de tâches de fond en cours.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2428,7 +2435,7 @@ L’option `threshold` est dépréciée, mais si vous voulez l’utiliser, le mo
|
||||
|
||||
*: Cette variable peut uniquement être utilisée dans une chaine de style
|
||||
|
||||
### Exemple
|
||||
### Exemples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
Le module `julia` affiche la version de [Julia](https://julialang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
@@ -2530,21 +2545,13 @@ kotlin_binary = 'kotlinc'
|
||||
|
||||
Afficher le nom du [contexte Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) courant, et, si défini, l’espace de nom, l’utilisateur, et le cluster depuis le fichier kubeconfig. L'espace de noms doit être défini dans le fichier kubeconfig, ce qui peut être fait via `kubectl config set-context starship-cluster --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`. Si la variable d'environnement `$KUBECONFIG` est définie, le module l'utilisera, sinon il utilisera le fichier `~/.kube/config`.
|
||||
|
||||
::: tip
|
||||
|
||||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Options
|
||||
|
||||
::: warning
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
Le module `localip` affiche l’adresse IPv4 de l’interface réseau principale.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
@@ -2742,11 +2751,7 @@ Le module `memory_usage` affiche la mémoire système actuelle et l'utilisation
|
||||
|
||||
Par défaut, l'utilisation du swap est affichée si le swap total du système n'est pas nul.
|
||||
|
||||
::: tip
|
||||
|
||||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic of the repo in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------ | --------------------------- | -------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | Une chaîne de format affichée quand un `merge` est en cours. |
|
||||
| `rebase` | `'REBASING'` | Une chaîne de format affichée lorsqu'un `rebase` est en cours. |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | Une chaîne de format affichée quand un `bisect` est en cours. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | Le style pour le module. |
|
||||
| `format` | `'\([$state]($style)\) '` | Format du module. |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| ---------------- | ---------- | ------------------------------------- |
|
||||
| state | `REBASING` | L'état actuel du dépôt |
|
||||
| progress_current | `1` | Progression de l'opération en cours |
|
||||
| progress_total | `2` | Progression maximale de l'opération |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
|
||||
*: Cette variable peut uniquement être utilisée dans une chaine de style
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
@@ -3175,7 +3217,7 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbole` | `'Ø '` | Le symbole utilisé avant d'afficher la version de Zig. |
|
||||
| `symbole` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | Le style pour le module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Les extensions qui déclenchent ce module. |
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## Version du paquet
|
||||
|
||||
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`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – La version du paquet `npm` est extraite du `package.json` présent dans le répertoire courant
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - La version du paquet `sbt` est extraite du `build.sbt` présent dans le dossier courant
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel of the repo in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | Format du module. |
|
||||
| `version_format` | `'v${raw}'` | Le format de la version. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbole` | `'🧚 '` | Le symbole utilisé avant le nom d'environnement. |
|
||||
| `style` | `'yellow bold' | Le style pour le module. |
|
||||
| `style` | `'yellow bold'` | Le style pour le module. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Les extensions qui déclenchent ce module. |
|
||||
| `detect_files` | `['pixi.toml']` | Les fichiers qui activent ce module. |
|
||||
| `detect_folders` | `['.pixi']` | Les dossiers qui activent ce module. |
|
||||
| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: tip
|
||||
|
||||
Par défaut, la version de Pulumi n'est pas affichée, car cela prendre un ordre de magnitude plus de temps à charger que la plupart des plugins (~70ms). Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-pulumi-version).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-pulumi-version).
|
||||
|
||||
Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
|
||||
@@ -3712,13 +3742,9 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module |
|
||||
| `disabled` | `false` | Désactive le module `python`. |
|
||||
|
||||
::: tip
|
||||
|
||||
La variable `python_binary` accepte soit une chaine, soit une liste de chaines de caractères. Starship essayera d'exécuter chaque binaire jusqu'à obtenir un résultat. Notez que vous ne pouvez modifier que le binaire que Starship exécute pour obtenir la version de Python, mais pas les arguments utilisés.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!TIP] The `python_binary` variable accepts either a string or a list of strings. Starship essayera d'exécuter chaque binaire jusqu'à obtenir un résultat. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
Le module `shell` affiche un indicateur en fonction du shell actuellement utilisé.
|
||||
|
||||
::: tip
|
||||
|
||||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
@@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) '
|
||||
|
||||
Le module `status` affiche le code de sortie de la commande précédente. Si $success_symbol est vide (par défaut), ce module sera affiché uniquement quand le code de sortie n’est pas `0`. Le code de statut est converti en entier signé 32 bits.
|
||||
|
||||
::: tip
|
||||
|
||||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
Le moduel `sudo` affiche si les identifiants sudo sont actuellement en cache. Le module sera uniquement affiché si les identifiants sont en cache.
|
||||
|
||||
::: tip
|
||||
|
||||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
Le module `terraform` affiche [l’espace de travail Terraform](https://www.terraform.io/docs/language/state/workspaces.html) sélectionné et sa version.
|
||||
Le module `terraform` affiche [l’espace de travail Terraform](https://www.terraform.io/docs/language/state/workspaces.html) sélectionné et sa version. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: tip
|
||||
|
||||
Par défaut, la version de Terraform n’est pas affichée, car elle est lente pour les versions actuelles de Terraform quand beaucoup de plugins sont utilisés. Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-terraform-version).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-terraform-version).
|
||||
|
||||
Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
|
||||
@@ -4406,16 +4418,17 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | La chaîne de format pour le module. |
|
||||
| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbole` | `'💠'` | Une chaîne de format montrée avant l'espace de travail terraform. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Les extensions qui déclenchent ce module. |
|
||||
| `detect_files` | `[]` | Les fichiers qui activent ce module. |
|
||||
| `detect_folders` | `['.terraform']` | Les dossiers qui activent ce module. |
|
||||
| `style` | `'bold 105'` | Le style pour le module. |
|
||||
| `disabled` | `false` | Désactive le module `terraform`. |
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | La chaîne de format pour le module. |
|
||||
| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbole` | `'💠'` | Une chaîne de format montrée avant l'espace de travail terraform. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Les extensions qui déclenchent ce module. |
|
||||
| `detect_files` | `[]` | Les fichiers qui activent ce module. |
|
||||
| `detect_folders` | `['.terraform']` | Les dossiers qui activent ce module. |
|
||||
| `style` | `'bold 105'` | Le style pour le module. |
|
||||
| `disabled` | `false` | Désactive le module `terraform`. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4436,7 +4449,7 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Sans la version de Terraform
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## Date et Heure
|
||||
|
||||
Le module `time` affiche la date et heure **locale**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles.
|
||||
|
||||
::: tip
|
||||
|
||||
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4537,11 +4546,7 @@ Le module `username` affiche le nom de l’utilisateur actif. Le module sera aff
|
||||
- La variable `show_always` est définie à true
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). Par défaut, le module s’activera si l’une de ces conditions est remplie:
|
||||
|
||||
- Le dossier courant contient un fichier `xmake.lua`
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Défaut | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | Format du module. |
|
||||
| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbole` | `'△ '` | Le symbole utilisé avant la version de cmake. |
|
||||
| `detect_extensions` | `[]` | Les extensions qui déclenchent ce module |
|
||||
| `detect_files` | `['xmake.lua']` | Quels fichiers devraient activer ce module |
|
||||
| `detect_folders` | `[]` | Quels dossiers devraient activer ce module |
|
||||
| `style` | `'bold green'` | Le style pour le module. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Exemple | Description |
|
||||
| --------- | -------- | -------------------------------------- |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbole | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
|
||||
*: Cette variable peut uniquement être utilisée dans une chaine de style
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Le module sera affiché si l'une de ces conditions est remplie:
|
||||
@@ -4734,31 +4768,17 @@ Ces modules seront affichés si l'une de ces conditions est remplie:
|
||||
- La commande `when` retourne 0
|
||||
- The current Operating System (std::env::consts::OS) matches with `os` field if defined.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Plusieurs modules personnalisés peuvent être définis en utilisant un `.`.
|
||||
> [!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.
|
||||
|
||||
:::
|
||||
> [!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!
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### Exemple
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ L'aide à la complétion ou autocomplétion est fournie par le shell que vous av
|
||||
|
||||
## Est-ce que l'option globale `format` et `<module>.disabled` font la même chose ?
|
||||
|
||||
Oui, ils peuvent tous deux être utilisés pour désactiver les modules dans l'invite de commande. Si tout ce que vous prévoyez de faire est de désactiver les modules, `<module>.disabled` est le meilleur moyen de le faire pour ces raisons :
|
||||
Oui, elles peuvent toutes deux être utilisées pour désactiver les modules dans l'invite de commande. Si tout ce que vous prévoyez de faire est de désactiver les modules, `<module>.disabled` est le meilleur moyen de le faire pour ces raisons :
|
||||
|
||||
- Désactiver les modules est plus explicite que de les omettre du `format global`
|
||||
- Les modules nouvellement créés seront ajoutés à l'invite de commande au fur et à mesure que Starship sera mis à jour
|
||||
@@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l)
|
||||
PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
|
||||
```
|
||||
|
||||
L' [implémentation Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) intégrée à Starship est légèrement plus complexe pour permettre des fonctionnalités avancées comme le [module de durée de commande](https://starship.rs/config/#command-duration) et pour s'assurer que Starship est compatible avec les configurations Bash pré-installées.
|
||||
L'[implémentation Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) intégrée à Starship est légèrement plus complexe pour permettre des fonctionnalités avancées comme le [module de durée de commande](https://starship.rs/config/#command-duration) et pour s'assurer que Starship est compatible avec les configurations Bash pré-installées.
|
||||
|
||||
Pour une liste de tous les flags acceptés par `starship prompt`, utilisez la commande suivante :
|
||||
|
||||
@@ -72,7 +72,7 @@ Vous pouvez activer les journaux de débogage en utilisant la variable d’envir
|
||||
env STARSHIP_LOG=trace starship module rust
|
||||
```
|
||||
|
||||
If starship is being slow you can try using the `timings` command to see if there is a particular module or command that is to blame.
|
||||
Si Starship est lent, vous pouvez utiliser la commande `timings` pour vérifier si un module ou une commande en particulier est à l'origine du ralentissement.
|
||||
|
||||
```sh
|
||||
env STARSHIP_LOG=trace starship timings
|
||||
@@ -121,10 +121,10 @@ Si Starship a été installé en utilisant le script d'installation, la commande
|
||||
sh -c 'rm "$(command -v 'starship')"'
|
||||
```
|
||||
|
||||
## How do I install Starship without `sudo`?
|
||||
## Comment installer Starship sans `sudo` ?
|
||||
|
||||
The shell install script (`https://starship.rs/install.sh`) only attempts to use `sudo` if the target installation directory is not writable by the current user. The default installation directory is the value of the `$BIN_DIR` environment variable or `/usr/local/bin` if `$BIN_DIR` is not set. If you instead set the installation directory to one that is writable by your user, you should be able to install starship without `sudo`. For example, `curl -sS https://starship.rs/install.sh | sh -s -- -b ~/.local/bin` uses the `-b` command line option of the install script to set the installation directory to `~/.local/bin`.
|
||||
Le script d'installation (`https://starship.rs/install.sh`) essaye d'utiliser `sudo` seulement si le répertoire d'installation ciblé n'est pas disponible en écriture pour l'utilisateur actuel. Le répertoire d'installation par défaut correspond à la variable d'environnement `$BIN_DIR`, ou `/usr/local/bin` si `$BIN_DIR` n'est pas définie. Si vous avez défini à la place un répertoire d'installation accessible en écriture par votre utilisateur, vous devriez pouvoir installer Starship sans `sudo`. Par exemple, la commande `curl -sS https://starship.rs/install.sh | sh -s -- -b ~/.local/bin` utilise l'option `-b` du script d'installation pour définir le répertoire d'installation vers `~/.local/bin`.
|
||||
|
||||
For a non-interactive installation of Starship, don't forget to add the `-y` option to skip the confirmation. Check the source of the installation script for a list of all supported installation options.
|
||||
Pour une installation non interactive de Starship, n'oubliez pas d'ajouter l'option `-y` pour passer l'étape de confirmation. Vérifiez le code source du script d'installation pour obtenir une liste de toutes les options d'installation supportées.
|
||||
|
||||
When using a package manager, see the documentation for your package manager about installing with or without `sudo`.
|
||||
Lorsque vous utilisez un gestionnaire de paquet, référez-vous à la documentation dudit gestionnaire pour l'installation avec ou sans `sudo`.
|
||||
|
||||
@@ -180,7 +180,7 @@
|
||||
|
||||
### Pré-requis
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)).
|
||||
- Une police d'écriture [Nerd Font](https://www.nerdfonts.com/) est installée et activée sur votre terminal (par exemple, essayez [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)).
|
||||
|
||||
### Étape 1. Installer Starship
|
||||
|
||||
@@ -229,10 +229,11 @@ Vous pouvez aussi installer Starship en utilisant l’un de ces gestionnaires de
|
||||
| Alpine Linux 3.13+ | [Paquets Alpine Linux](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Debian 13+ | [Debian principal](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Paquets Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Paquets Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -262,7 +263,7 @@ Vous pouvez aussi installer Starship en utilisant l’un de ces gestionnaires de
|
||||
<details>
|
||||
<summary>Windows</summary>
|
||||
|
||||
Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest).
|
||||
Installez la dernière version pour votre système à partir de l'installeur MSI de la [section publication](https://github.com/starship/starship/releases/latest).
|
||||
|
||||
Installez Starship en utilisant l’un de ces gestionnaires de paquets:
|
||||
|
||||
@@ -276,7 +277,7 @@ Installez Starship en utilisant l’un de ces gestionnaires de paquets:
|
||||
|
||||
</details>
|
||||
|
||||
### Étape 2. Set up your shell to use Starship
|
||||
### Étape 2. Configurez votre Shell pour utiliser Starship
|
||||
|
||||
Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans la liste ci-dessous:
|
||||
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
Ajoutez ce qui suit à la fin de `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
Note: Seul Elvish v0.18+ est supporté
|
||||
Note: Seul Elvish v0.18+ est supporté. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -340,7 +341,7 @@ eval $(starship init ion)
|
||||
<details>
|
||||
<summary>Nushell</summary>
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
Ajoutez la ligne suivante à la fin de votre configuration Nushell (trouvable en exécutant `$nu.config-path` dans Nushell) :
|
||||
|
||||
```sh
|
||||
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
@@ -407,7 +408,7 @@ Si vous cherchez à personnaliser davantage Starship :
|
||||
|
||||
## 🤝 Contribuer
|
||||
|
||||
Nous sommes toujours à la recherche de contributeurs de **tous niveaux de compétence**! Si vous cherchez à faciliter votre entrée dans le projet, essayez un [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
|
||||
Nous sommes toujours à la recherche de contributeurs de **tous niveaux de compétence**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
Si vous parlez couramment une langue autre que l'anglais, nous apprécions grandement toute aide pour traduire et mettre à jour notre documentation dans d'autres langues. Si vous souhaitez nous aider, les traductions se font sur le [Crowdin Starship](https://translate.starship.rs/).
|
||||
|
||||
|
||||
@@ -14,11 +14,7 @@ Ce préréglage change les symboles de chaque module pour utiliser les symboles
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Retourner aux préréglages](./#pure)
|
||||
[Retourner aux préréglages](./#pure-prompt)
|
||||
|
||||
# Préréglage Pure
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Retourner aux préréglages](./#pastel-powerline)
|
||||
[Retourner aux préréglages](./#tokyo-night)
|
||||
|
||||
# Tokyo Night Preset
|
||||
|
||||
|
||||
+4
-11
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
Hanya elvish v0.18 atau versi yang lebih baru yang mendapat dukungan pengembangan.
|
||||
|
||||
:::
|
||||
|
||||
Tambahkan skrip berikut pada baris akhir `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,11 +161,7 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
Hal ini dapat berubah di kemudian hari. Hanya Nushell v0.96+ yang menerima dukungan.
|
||||
|
||||
:::
|
||||
> [!WARNING] This will change in the future. Hanya Nushell v0.96+ yang menerima dukungan.
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
Walaupun Starship adalah shell yang serbaguna, terkadang kita butuh upaya lebih dari sekadar mengedit `starship.toml` untuk membuatnya menjalankan beberapa hal tertentu. Halaman ini merincikan beberapa teknik konfigurasi lanjutan yang digunakan starship.
|
||||
|
||||
::: warning
|
||||
|
||||
Konfigurasi pada bagian ini dapat berubah saat Starship terbaru rilis di kemudian hari nanti.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
|
||||
+234
-216
@@ -208,11 +208,7 @@ Berikut adalah opsi konfigurasi dari list yang bersifat prompt-wide.
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### Contoh
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Variabel | Bawaan | Deskripsi |
|
||||
@@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu
|
||||
| symbol | | Menyalin nilai dari opsi `symbol` |
|
||||
| style | | Menyalin nilai dari opsi `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Contoh
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbol | | Menyalin nilai dari opsi `symbol` |
|
||||
| style | | Menyalin nilai dari opsi `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Contoh
|
||||
|
||||
@@ -735,11 +733,7 @@ Karakter dapat memberitahu kamu apakah perintah terakhir berhasil atau tidak. Ka
|
||||
|
||||
Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin mengganti bentuknya, perhatikan [contoh](#with-custom-error-shape) berikut.
|
||||
|
||||
::: warning
|
||||
|
||||
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -855,13 +849,11 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
|
||||
|
||||
Modul `cmd_duration` menampilkan seberapa lama perintah sebelumnya membutuhkan waktu untuk dilaksanakan. Modulnya hanya akan ditampilkan jika perintahnya membutuhkan waktu lebih dari dua detik, atau ada nilai dari konfigurasi `min_time`.
|
||||
|
||||
::: warning lakukan hook DEBUG trap dalam Bash
|
||||
> [!WARNING] Do not hook the DEBUG trap in Bash
|
||||
>
|
||||
> If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
|
||||
|
||||
Jia kamu menjalankan Starship di `bash`, jangan lakukan hook DEBUG trap setelah menjalankan `eval $(starship init $0)`, atau modulnya **akan** rusak.
|
||||
|
||||
:::
|
||||
|
||||
Pengguna Bash yang membutuhkan fungsi seperti preexec dapat menggunakan [kerangka kerja bash_preexec dari rcaloras](https://github.com/rcaloras/bash-preexec). Cukup dengan membuat array `preexec_functions` dan `precmd_functions` sebelum menjalankan `eval $(starship init $0)`, lalu lanjutkan seperti biasa.
|
||||
Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Cukup dengan membuat array `preexec_functions` dan `precmd_functions` sebelum menjalankan `eval $(starship init $0)`, lalu lanjutkan seperti biasa.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -899,11 +891,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.
|
||||
|
||||
::: tip
|
||||
|
||||
Hal ini tidak menahan pengubah (modifier) prompt dari conda sendiri, kamu mungkin bisa menjalankan `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -970,7 +958,7 @@ format = '[$symbol \[$name\]]($style) '
|
||||
|
||||
## Crystal
|
||||
|
||||
Modul `crystal` menampilkan versi terkini dari [Crystal](https://crystal-lang.org/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
|
||||
- Direktori terkini yang berisikan sebuah file `shard.yml`
|
||||
- Direktori terkini yang berisikan sebuah file `.cr`
|
||||
@@ -1047,7 +1035,7 @@ format = 'via [D $version](bold bright-green) '
|
||||
|
||||
## Dart
|
||||
|
||||
Modul `dart` menampilkan versi terkini dari [Dart](https://dart.dev/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
|
||||
- Direktori terkini yang berisikan sebuah file berekstensi `.dart`
|
||||
- Direktori terkini yang berisikan sebuah direktori `dart_tool`
|
||||
@@ -1087,7 +1075,7 @@ format = 'via [🔰 $version](bold red) '
|
||||
|
||||
## Deno
|
||||
|
||||
Modul `deno` menampilkan versi terkini dari [Deno](https://deno.land/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
The `deno` module shows you your currently installed version of [Deno](https://deno.land/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
|
||||
- The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | Format dari modul. |
|
||||
| `symbol` | `'🐳 '` | Simbol yang digunakan sebelum menampilkan Docker context. |
|
||||
| `only_with_files` | `true` | Hanya ditampilkan jika terdapat kecocokan |
|
||||
| `detect_extensions` | `[]` | Extensions mana yang harusnya memicu modul (butuh `only_with_files` untuk diset true). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | filenames mana yang harusnya memicu modul ini (butuh `only_with_files` untuk diset true). |
|
||||
| `detect_folders` | `[]` | Folder mana yang harusnya memicu modul (butuh `only_with_files` untuk diset true). |
|
||||
| `style` | `'blue bold'` | Gaya penataan untuk modul. |
|
||||
| `disabled` | `false` | Menonaktifkan module `docket_context`. |
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | Format dari modul. |
|
||||
| `symbol` | `'🐳 '` | Simbol yang digunakan sebelum menampilkan Docker context. |
|
||||
| `only_with_files` | `true` | Hanya ditampilkan jika terdapat kecocokan |
|
||||
| `detect_extensions` | `[]` | Extensions mana yang harusnya memicu modul (butuh `only_with_files` untuk diset true). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | filenames mana yang harusnya memicu modul ini (butuh `only_with_files` untuk diset true). |
|
||||
| `detect_folders` | `[]` | Folder mana yang harusnya memicu modul (butuh `only_with_files` untuk diset true). |
|
||||
| `style` | `'blue bold'` | Gaya penataan untuk modul. |
|
||||
| `disabled` | `false` | Menonaktifkan module `docket_context`. |
|
||||
|
||||
### Variabel
|
||||
|
||||
@@ -1426,26 +1416,17 @@ Modul `env_var` menampilkan nilai terkini dari variabel environment yang dipilih
|
||||
- Opsi konfigurasi `variable` cocok dengan variabel environment yang ada
|
||||
- Opsi konfigurasi `variable` tidak didefinisikan, tapi opsi konfigurasi `default` yang didefinisikan
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
Multiple environmental variables can be displayed by using a `.`. (lihat contoh) Jika opsi konfigurasi `variable` tidak diset, modul akan menampilkan nilai variabel di bawah teks nama setelah karakter `.`.
|
||||
|
||||
Contoh: konfigurasi berikut akan menampilkan nilai dari variabel USER environment
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Contoh: konfigurasi berikut akan menampilkan nilai dari variabel USER environment
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -1596,10 +1577,49 @@ Produces a prompt that looks like:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before displaying the version of COBOL. |
|
||||
| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
|
||||
| `version_format` | `'${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | Gaya penataan untuk modul. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Ekstensi mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_files` | `['fpm.toml']` | filenames mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variabel
|
||||
|
||||
| Variabel | Contoh | Deskripsi |
|
||||
| --------- | -------- | ----------------------------------- |
|
||||
| name | gfortran | The name of the compiler |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbol | | Menyalin nilai dari opsi `symbol` |
|
||||
| style\* | | Menyalin nilai dari opsi `style` |
|
||||
|
||||
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
@@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variabel
|
||||
@@ -1838,7 +1861,7 @@ The `git_state` module will show in directories which are part of a git reposito
|
||||
| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. |
|
||||
| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
|
||||
| `style` | `'bold yellow'` | Gaya penataan untuk modul. |
|
||||
| `fromat` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. |
|
||||
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. |
|
||||
| `disabled` | `false` | Disables the `git_state` module. |
|
||||
|
||||
### Variabel
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -1908,24 +1927,20 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| -------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
|
||||
| `fromat` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
|
||||
| `conflicted` | `'='` | This branch has merge conflicts. |
|
||||
| `ahead` | `'⇡'` | The format of `ahead` |
|
||||
| `behind` | `'⇣'` | The format of `behind` |
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'$'` | The format of `stashed` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
@@ -2392,17 +2407,9 @@ The default functionality is:
|
||||
- 1 job -> `symbol` is shown.
|
||||
- 2 jobs or more -> `symbol` + `number` are shown.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
This module is not supported on tcsh and nu.
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
@@ -2530,21 +2545,13 @@ 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`.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Opsi
|
||||
|
||||
::: warning
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
@@ -2742,11 +2751,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic 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.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |
|
||||
| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | Gaya penataan untuk modul. |
|
||||
| `fromat` | `'\([$state]($style)\) '` | Format dari modul. |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### Variabel
|
||||
|
||||
| Variabel | Contoh | Deskripsi |
|
||||
| ---------------- | ---------- | -------------------------------- |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | The current operation progress |
|
||||
| progress_total | `2` | The total operation progress |
|
||||
| style\* | | Menyalin nilai dari opsi `style` |
|
||||
|
||||
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
@@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `'bold bright-blue'` | Gaya penataan untuk modul. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Ekstensi mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | Gaya penataan untuk modul. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Ekstensi mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
|
||||
|
||||
### Variabel
|
||||
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## 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`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel 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.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `fromat` | `'via [$symbol($version )(\($environment\) )]($style)'` | Format dari modul. |
|
||||
| `version_format` | `'v${raw}'` | Format dari versi. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbol` | `'🧚 '` | Simbol yang digunakan sebelum nama environment. |
|
||||
| `style` | `'yellow bold' | Gaya penataan untuk modul. |
|
||||
| `style` | `'yellow bold'` | Gaya penataan untuk modul. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_files` | `['pixi.toml']` | filenames mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_folders` | `['.pixi']` | Folder mana yang sebaiknya memicul modul ini. |
|
||||
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variabel
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!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).
|
||||
|
||||
Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
|
||||
@@ -3712,13 +3742,9 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
|
||||
::: 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.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variabel
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
@@ -4242,11 +4266,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
|
||||
|
||||
Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
|
||||
@@ -4406,16 +4418,17 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
|
||||
| `fromat` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Ekstensi mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_folders` | `['.terraform']` | Folder mana yang sebaiknya memicul modul ini. |
|
||||
| `style` | `'bold 105'` | Gaya penataan untuk modul. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| `fromat` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Ekstensi mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. |
|
||||
| `detect_folders` | `['.terraform']` | Folder mana yang sebaiknya memicul modul ini. |
|
||||
| `style` | `'bold 105'` | Gaya penataan untuk modul. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variabel
|
||||
|
||||
@@ -4436,7 +4449,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Without Terraform version
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## Waktu
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if
|
||||
- The variable `show_always` is set to true
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
|
||||
|
||||
- Direktori ini memiliki berkas `xmake.lua`
|
||||
|
||||
### Opsi
|
||||
|
||||
| Opsi | Bawaan | Deskripsi |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- |
|
||||
| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. |
|
||||
| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'△ '` | Simbol yang digunakan sebelum versi cmake. |
|
||||
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini |
|
||||
| `detect_files` | `['xmake.lua']` | filenames mana yang sebaiknya memicu modul ini |
|
||||
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini |
|
||||
| `style` | `'bold green'` | Gaya penataan untuk modul. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variabel
|
||||
|
||||
| Variabel | Contoh | Deskripsi |
|
||||
| --------- | -------- | --------------------------------- |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbol | | Menyalin nilai dari opsi `symbol` |
|
||||
| style\* | | Menyalin nilai dari opsi `style` |
|
||||
|
||||
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
|
||||
@@ -4734,31 +4768,17 @@ 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.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Multiple custom modules can be defined by using a `.`.
|
||||
> [!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.
|
||||
|
||||
:::
|
||||
> [!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!
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Opsi
|
||||
|
||||
@@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### Contoh
|
||||
|
||||
|
||||
@@ -230,9 +230,10 @@ Alternatively, install Starship using any of the following package managers:
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
Tambahkan skrip berikut pada baris akhir `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
Note: Only Elvish v0.18+ is supported
|
||||
Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -407,7 +408,7 @@ Jika kamu ingin mengkustomisasi Starship lebih jauh:
|
||||
|
||||
## 🤝 Berkontribusi
|
||||
|
||||
We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
|
||||
We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
|
||||
@@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pure)
|
||||
[Return to Presets](./#pure-prompt)
|
||||
|
||||
# Pure Preset
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pastel-powerline)
|
||||
[Return to Presets](./#tokyo-night)
|
||||
|
||||
# Tokyo Night Preset
|
||||
|
||||
|
||||
@@ -27,16 +27,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
```sh
|
||||
pkg install getconf
|
||||
```
|
||||
|
||||
### Installation
|
||||
|
||||
```sh
|
||||
curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin
|
||||
pkg install starship
|
||||
```
|
||||
|
||||
## [Funtoo Linux](https://www.funtoo.org/Welcome)
|
||||
|
||||
+4
-11
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
Only elvish v0.18 or higher is supported.
|
||||
|
||||
:::
|
||||
|
||||
Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,11 +161,7 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
:::
|
||||
> [!WARNING] This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
Nonostante Starship sia una shell versatile, a volte devi fare qualche modifica in più in `starship.toml` per ottenere alcune cose. Questa pagina descrive alcune tecniche di configurazione avanzate utilizzate in Starship.
|
||||
|
||||
::: warning
|
||||
|
||||
Le configurazioni in questa sezione sono soggette a modifiche nelle future versioni di Starship.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt su PowerShell
|
||||
|
||||
|
||||
+229
-211
@@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options.
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### Esempio
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Variable | Default | Descrizione |
|
||||
@@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Esempio
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Esempio
|
||||
|
||||
@@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c
|
||||
|
||||
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
|
||||
|
||||
::: warning
|
||||
|
||||
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -855,11 +849,9 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
@@ -899,11 +891,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blu grassetto'` | Lo stile per il modulo. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blu grassetto'` | Lo stile per il modulo. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1426,26 +1416,17 @@ 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
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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.
|
||||
|
||||
Example: following configuration will display value of USER environment variable
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Example: following configuration will display value of USER environment variable
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -1596,10 +1577,49 @@ Produces a prompt that looks like:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before displaying the version of COBOL. |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | Lo stile per il modulo. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Quali estensioni dovrebbero attivare questo modulo. |
|
||||
| `detect_files` | `['fpm.toml']` | Quali nomi di file dovrebbero attivare questo modulo. |
|
||||
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Esempio | Descrizione |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| name | gfortran | The name of the compiler |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'$'` | The format of `stashed` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
@@ -2392,17 +2407,9 @@ The default functionality is:
|
||||
- 1 job -> `symbol` is shown.
|
||||
- 2 jobs or more -> `symbol` + `number` are shown.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
This module is not supported on tcsh and nu.
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Esempio
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2530,21 +2545,13 @@ 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`.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Opzioni
|
||||
|
||||
::: warning
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -2742,11 +2751,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic 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.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |
|
||||
| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | Lo stile per il modulo. |
|
||||
| `format` | `'\([$state]($style)\) '` | The format for the module. |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Esempio | Descrizione |
|
||||
| ---------------- | ---------- | ----------------------------------- |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | The current operation progress |
|
||||
| progress_total | `2` | The total operation progress |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `'bold bright-blue'` | Lo stile per il modulo. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Quali estensioni dovrebbero attivare questo modulo. |
|
||||
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
|
||||
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | Lo stile per il modulo. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Quali estensioni dovrebbero attivare questo modulo. |
|
||||
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
|
||||
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## 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`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel 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.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | Il formato della versione. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbol` | `'🧚 '` | The symbol used before the environment name. |
|
||||
| `style` | `'yellow bold' | Lo stile per il modulo. |
|
||||
| `style` | `'yellow bold'` | Lo stile per il modulo. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo. |
|
||||
| `detect_files` | `['pixi.toml']` | Quali nomi di file dovrebbero attivare questo modulo. |
|
||||
| `detect_folders` | `['.pixi']` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!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).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -3712,13 +3742,9 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo |
|
||||
| `disabled` | `false` | Disables the `python` module. |
|
||||
|
||||
::: 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.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -4242,11 +4266,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Quali estensioni dovrebbero attivare questo modulo. |
|
||||
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
|
||||
| `detect_folders` | `['.terraform']` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
| `style` | `'bold 105'` | Lo stile per il modulo. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Quali estensioni dovrebbero attivare questo modulo. |
|
||||
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
|
||||
| `detect_folders` | `['.terraform']` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
| `style` | `'bold 105'` | Lo stile per il modulo. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Without Terraform version
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## Ora
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if
|
||||
- The variable `show_always` is set to true
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `xmake.lua` file
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'△ '` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo |
|
||||
| `detect_files` | `['xmake.lua']` | Quali nomi di file dovrebbero attivare questo modulo |
|
||||
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo |
|
||||
| `style` | `'bold green'` | Lo stile per il modulo. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Esempio | Descrizione |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
|
||||
@@ -4734,31 +4768,17 @@ 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.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Multiple custom modules can be defined by using a `.`.
|
||||
> [!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.
|
||||
|
||||
:::
|
||||
> [!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!
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Opzioni
|
||||
|
||||
@@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### Esempio
|
||||
|
||||
|
||||
@@ -230,9 +230,10 @@ Alternatively, install Starship using any of the following package managers:
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
Note: Only Elvish v0.18+ is supported
|
||||
Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -407,7 +408,7 @@ Se stai cercando di personalizzare ulteriormente Starship:
|
||||
|
||||
## 🤝 Contribuire
|
||||
|
||||
Siamo sempre alla ricerca di collaboratori di **tutti i livelli**! Se stai cercando di entrare facilmente nel progetto, prova un [buon primo problema](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
|
||||
Siamo sempre alla ricerca di collaboratori di **tutti i livelli**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
Se parli correntemente una lingua diversa dall'inglese, apprezziamo molto qualsiasi aiuto per mantenere i nostri documenti tradotti e aggiornati in altre lingue. Se desideri collaborare, le traduzioni possono essere fornite su [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
|
||||
@@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pure)
|
||||
[Return to Presets](./#pure-prompt)
|
||||
|
||||
# Pure Preset
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./#pastel-powerline)
|
||||
[Return to Presets](./#tokyo-night)
|
||||
|
||||
# Tokyo Night Preset
|
||||
|
||||
|
||||
+4
-11
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
elvish v0.18 以降のみサポートされます。
|
||||
|
||||
:::
|
||||
|
||||
`~/.elvish/rc.elv` の最後に以下を追記してください。
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,11 +161,7 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
これは将来的に変更される可能性があります。 Nushell v0.96+ のみサポートされています。
|
||||
|
||||
:::
|
||||
> [!WARNING] This will change in the future. Nushell v0.96+ のみサポートされています。
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
Starship は汎用性の高いシェルですが、時には特定の処理を行うために `starship.toml` を編集する以上のことをする必要があります。 このページでは starship で使用される、より高度な設定の一部を詳しく説明していきます。
|
||||
|
||||
::: warning
|
||||
|
||||
ここに載せられた設定は、Starship の将来のリリースで変更される可能性があります。
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## PowerShell の TransientPrompt
|
||||
|
||||
@@ -251,7 +247,7 @@ right_format = """$all"""
|
||||
|
||||
一部のシェルは、通常のプロンプトの他に継続プロンプトをサポートしています。 このプロンプトは、ユーザーが不完全な文 (単一の左括弧や引用符など) を確定したときに通常のプロンプトの代わりに表示されます。
|
||||
|
||||
Starship では、 `contination_prompt` オプションを使用して継続プロンプトを設定できます。 既定の継続プロンプトは `'[・](bright-black) '` です。
|
||||
Starship では、 `contination_prompt` オプションを使用して継続プロンプトを設定できます。 既定の継続プロンプトは `'[∙](bright-black) '` です。
|
||||
|
||||
注意: `contination_prompt` には変数を含まないそのまま文字列を設定する必要があります。
|
||||
|
||||
|
||||
+259
-241
@@ -208,11 +208,7 @@ detect_extensions = ['ts', '!video.ts', '!audio.ts']
|
||||
| `palettes` | `{}` | [色](../advanced-config/#style-strings) をユーザー定義の色名に割り当てる配色のコレクション。 ※配色で自身の色定義を参照することはできません。 |
|
||||
| `follow_symlinks` | `true` | ディレクトリかどうかをチェックするためにシンボリックリンクをたどります。git などのモジュールで使われます。 |
|
||||
|
||||
::: tip
|
||||
|
||||
ネットワーク上のファイルシステムへのシンボリックリンクがある場合は、 `follow_symlinks` を `false` に設定することを検討してください。
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### 設定例
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
`azure` モジュールは、現在のAzureサブスクリプションを表示します。 これは、 `~/.azure/azureProfile.json` ファイルで定義されているデフォルトのサブスクリプション名またはユーザー名の表示に基づいています。
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| 変数 | デフォルト | 説明 |
|
||||
@@ -658,15 +658,13 @@ format = 'via [🍔 $version](bold green) '
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style | | オプション `style` の値をミラーする |
|
||||
|
||||
`version`はデフォルトのフォーマットではないことに注意してください。
|
||||
|
||||
### Commands
|
||||
|
||||
`commands`オプションは、コンパイラのバージョンと名前を判別するためのコマンドのリストを受け入れます。
|
||||
|
||||
各コマンドは、実行可能ファイル名 (とそれに続く引数) のリストで表現されます。通常は`['mycc', '--version']`のようになります。 StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。
|
||||
|
||||
もし、Cコンパイラがこのモジュールでサポートされていない場合は、[GitHubで問題を提起する](https://github.com/starship/starship/)ことでリクエストできます。
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### 設定例
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style | | オプション `style` の値をミラーする |
|
||||
|
||||
`version`はデフォルトのフォーマットではないことに注意してください。
|
||||
|
||||
### Commands
|
||||
|
||||
`commands`オプションは、コンパイラのバージョンと名前を判別するためのコマンドのリストを受け入れます。
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### 設定例
|
||||
|
||||
@@ -735,11 +733,7 @@ characterは、最後のコマンドが成功したかどうかを示します
|
||||
|
||||
デフォルトでは、色だけが変更されます。 形も変えてみたい場合は[このサンプル](#with-custom-error-shape)も参考にしてください。
|
||||
|
||||
::: warning
|
||||
|
||||
`vimcmd_symbol`はcmd, fish and zshでのみサポートされています。 `vimcmd_replace_one_symbol`、`vimcmd_replace_symbol`と`vimcmd_visual_symbol`は、[zshでのモード検出による問題](https://github.com/starship/starship/issues/625#issuecomment-732454148)のため、fishでのみサポートされています。
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -855,13 +849,11 @@ vimcmd_symbol = '[V](bold green) '
|
||||
|
||||
`cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。 モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。
|
||||
|
||||
::: warning BashでDEBUGトラップをhookしない
|
||||
> [!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`でStarshipを実行している場合、 `eval $(starship init $0)`実行した後に`DEBUG`トラップをフックしないでください。そうしないと、このモジュールが**おそらくですが**壊れます。
|
||||
|
||||
:::
|
||||
|
||||
preexecのような機能を必要とするBashユーザーは、 [rcalorasのbash_preexecフレームワーク](https://github.com/rcaloras/bash-preexec)を使用できます。 `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定義するだけで、通常どおり続行します。
|
||||
Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定義するだけで、通常どおり続行します。
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -897,13 +889,9 @@ format = 'underwent [$duration](bold yellow)'
|
||||
|
||||
## Conda
|
||||
|
||||
`conda` モジュールは、`$CONDA_DEFAULT_ENV` が設定されている場合、現在の[Conda](https://docs.conda.io/en/latest/) 環境を表示します。
|
||||
The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
Note: これはconda自身の プロンプト修飾子 を抑制しません。`conda config --set changeps1 False` で実行することができます。 If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -970,7 +958,7 @@ format = '[$symbol \[$name\]]($style) '
|
||||
|
||||
## Crystal
|
||||
|
||||
`crystal`モジュールは、現在インストールされている[Crystal](https://crystal-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
|
||||
- カレントディレクトリに`shard.yml`ファイルが含まれている
|
||||
- カレントディレクトリに`.cr`の拡張子のファイルが含まれている
|
||||
@@ -1009,7 +997,7 @@ format = 'via [✨ $version](bold blue) '
|
||||
|
||||
## Daml
|
||||
|
||||
`daml`モジュールは、Damlプロジェクトのルートディレクトリにいるときに、使用している[Daml](https://www.digitalasset.com/developers) SDKバージョンを表示します。 環境変数`DAML_SDK_VERSION`を上書きしない限り、`daml.yaml`ファイルの`sdk-version`が使用されます。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. 環境変数`DAML_SDK_VERSION`を上書きしない限り、`daml.yaml`ファイルの`sdk-version`が使用されます。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
|
||||
- カレントディレクトリに`daml.yaml`ファイルが含まれている
|
||||
|
||||
@@ -1047,7 +1035,7 @@ format = 'via [D $version](bold bright-green) '
|
||||
|
||||
## Dart
|
||||
|
||||
`dart`モジュールは、現在インストールされている[Dart](https://dart.dev/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
|
||||
- カレントディレクトリに`.dart`の拡張子のファイルが含まれている
|
||||
- カレントディレクトリに`.dart_tool`ディレクトリが含まれている
|
||||
@@ -1087,7 +1075,7 @@ format = 'via [🔰 $version](bold red) '
|
||||
|
||||
## Deno
|
||||
|
||||
`deno`モジュールは、現在インストールされている[Deno](https://deno.land/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
The `deno` module shows you your currently installed version of [Deno](https://deno.land/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
|
||||
- The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
`direnv` モジュールは、もし存在すれば、現在の rc ファイルの状態を示します。 状態として rc ファイルへのパス、ロードされているかどうか、および `direnv` によって許可されているかどうかを含みます。
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | module のフォーマットです。 |
|
||||
| `symbol` | `'🐳 '` | Dockerコンテキストを表示する前に使用される記号です。 |
|
||||
| `only_with_files` | `true` | ファイルに一致する場合にのみ表示 |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | どんなファイル名がこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 |
|
||||
| `detect_folders` | `[]` | どんなフォルダがこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 |
|
||||
| `style` | `'blue bold'` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | `docker_context`モジュールを無効にします。 |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | module のフォーマットです。 |
|
||||
| `symbol` | `'🐳 '` | Dockerコンテキストを表示する前に使用される記号です。 |
|
||||
| `only_with_files` | `true` | ファイルに一致する場合にのみ表示 |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | どんなファイル名がこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 |
|
||||
| `detect_folders` | `[]` | どんなフォルダがこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 |
|
||||
| `style` | `'blue bold'` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | `docker_context`モジュールを無効にします。 |
|
||||
|
||||
### 変数
|
||||
|
||||
@@ -1426,26 +1416,17 @@ format = 'via [ $version](cyan bold) '
|
||||
- `variable`オプションが、既存の環境変数と一致する
|
||||
- `variable`オプションが定義されておらず、`default`オプションが定義されている
|
||||
|
||||
::: tip
|
||||
> [!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 `${...}`). 既定では、 `env_var` モジュールは、単にすべての env_var モジュールを定義順で表示します。
|
||||
|
||||
env_var モジュールが表示される順序は、`${env_var.foo}` (ドットが含まれるので `${...}` を使う必要があります) をトップレベルの `format` に入れることで個別に設定できます。 既定では、 `env_var` モジュールは、単にすべての env_var モジュールを定義順で表示します。
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
`.`を使うことで複数の環境変数を表示することができます。 (例を確認してみてください) `variable`が設定されていない場合、このモジュールは`.`以降に書かれている環境変数の値を表示します。
|
||||
|
||||
例: 次の設定ではUSER環境変数を表示します。
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> 例: 次の設定ではUSER環境変数を表示します。
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -1596,10 +1577,49 @@ style = 'bold green'
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
|
||||
| `symbol` | `' '` | COBOLのバージョンを表示する前に使用される記号です。 |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
|
||||
| `version_format` | `'${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
|
||||
| `style` | `'bold purple'` | モジュールのスタイルです。 |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `['fpm.toml']` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | コンパイラを検出する方法 |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | -------- | ----------------------------------- |
|
||||
| name | gfortran | コンパイラ名 |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
|
||||
### Commands
|
||||
|
||||
`commands`オプションは、コンパイラのバージョンと名前を判別するためのコマンドのリストを受け入れます。
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
`fossil_branch`モジュールは、現在のディレクトリにあるチェックアウトのアクティブなブランチ名を表示します。
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
`fossil_branch` モジュールは、現在のディレクトリのチェックアウトにおける追加・削除された行数を表示します。 少なくとも Fossil バージョン 2.14 (2021-01-20) が必要です。
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
@@ -1759,6 +1781,7 @@ very-long-project-name = 'vlpn'
|
||||
| `truncation_symbol` | `'…'` | ブランチ名が切り捨てられていることを示すための記号です。 `''` で記号なしにできます。 |
|
||||
| `only_attached` | `false` | デタッチ `HEAD` 状態にない時はブランチ名のみ表示します。 |
|
||||
| `ignore_branches` | `[]` | 表示しない名前のリスト。 'master' や 'main' に対して有用です。 |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | `git_branch`モジュールを無効にします。 |
|
||||
|
||||
### 変数
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
`git_metrics` モジュールは、現在の git リポジトリにおける追加・削除された行数を表示します。
|
||||
|
||||
::: tip
|
||||
|
||||
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
`git_status` モジュールは、カレントディレクトリのリポジトリの状態を表すシンボルを表示します。
|
||||
|
||||
::: tip
|
||||
|
||||
WSL環境のWindowsディレクトリ(例: `/mnt/c/`以下) では、Git Statusモジュールは動作が非常に遅いです。 モジュールを無効にするか、`windows_starship`オプションを使用することで、WindowsネイティブのStarshipを使用し、対象の`git_status`を計算できます。
|
||||
|
||||
:::
|
||||
> [!TIP] The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. モジュールを無効にするか、`windows_starship`オプションを使用することで、WindowsネイティブのStarshipを使用し、対象の`git_status`を計算できます。
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -1925,7 +1940,7 @@ WSL環境のWindowsディレクトリ(例: `/mnt/c/`以下) では、Git Status
|
||||
| `diverged` | `'⇕'` | `diverged`のフォーマット |
|
||||
| `up_to_date` | `''` | `up_to_date`のフォーマット |
|
||||
| `untracked` | `'?'` | `untracked`のフォーマット |
|
||||
| `stashed` | `'$'` | `stashed`のフォーマット |
|
||||
| `stashed` | `'\$'` | `stashed`のフォーマット |
|
||||
| `modified` | `'!'` | `modified`のフォーマット |
|
||||
| `staged` | `'+'` | `staged`のフォーマット |
|
||||
| `renamed` | `'»'` | `renamed`のフォーマット |
|
||||
@@ -2119,10 +2134,10 @@ format = 'via [$symbol($version )($mod_version )]($style)'
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | --- | ----------------------- |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | --- | ------------------------- |
|
||||
| symbol | | オプション `symbol` の値をミラーします。 |
|
||||
| style\* | | オプション `style` の値をミラーします。 |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
|
||||
@@ -2163,11 +2178,11 @@ format = 'via [🐂](yellow bold) '
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| ------- | -------- | ------------------------- |
|
||||
| version | `v7.5.1` | `gradle`のバージョン |
|
||||
| symbol | | オプション `symbol` の値をミラーします。 |
|
||||
| style* | | オプション `style` の値をミラーします。 |
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| ------- | -------- | ----------------------- |
|
||||
| version | `v7.5.1` | `gradle`のバージョン |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style* | | オプション `style` の値をミラーする |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
|
||||
@@ -2227,11 +2242,11 @@ format = 'via [🐂](yellow bold) '
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | -------- | ----------------------- |
|
||||
| version | `v4.2.5` | `haxe` のバージョン |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | -------- | ------------------------ |
|
||||
| version | `v4.2.5` | `haxe` のバージョン |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーします。 |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
|
||||
@@ -2266,11 +2281,11 @@ format = "via [⌘ $version](bold fg:202) "
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | -------- | ------------------------ |
|
||||
| version | `v3.1.1` | `helm` のバージョン |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーします。 |
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | -------- | ----------------------- |
|
||||
| version | `v3.1.1` | `helm` のバージョン |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
|
||||
@@ -2392,17 +2407,9 @@ symbol = '🌟 '
|
||||
- 1個のジョブ -> `symbol` を表示します。
|
||||
- 2個以上のジョブ-> `symbol` + `number` を表示します。
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
このモジュールは tcsh と nu ではサポートされません。
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
オプション `threshold` は非推奨になりましたが、`threshold` が指定されている場合には、モジュールは走っているジョブの数を表示します。 `threshold` が 0 に設定されている場合は、ジョブが走っていない場合にもモジュールが表示されます。
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
`julia`モジュールは、現在インストールされている[Julia](https://julialang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
@@ -2489,7 +2504,7 @@ symbol = '∴ '
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | モジュールのフォーマットです。 |
|
||||
| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
|
||||
| `detect_extensions` | `['kt', 'kts']` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
@@ -2530,26 +2545,18 @@ kotlin_binary = 'kotlinc'
|
||||
|
||||
現在の[Kubernetes コンテキスト](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context)名を表示します。 kubeconfigファイルに設定されている場合は、名前空間、ユーザー、クラスターも表示します。 名前空間は kubeconfig ファイルの中で設定する必要があります。次のようにして行います: `kubectl config set-context starship-context --namespace astronaut`。 同様に、ユーザーとクラスターは `kubectl config set-context starship-context --user starship-user` と `kubectl config set-context starship-context ---cluster starship-cluster` で設定できます。 環境変数 `$KUBECONFIG` が設定されている場合、このモジュールはそれを利用し、 `~/.kube/config` を利用しません。
|
||||
|
||||
::: tip
|
||||
|
||||
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
モジュールが有効化されているとき、`detect_env_vars`, `detect_extensions`, `detect_files`, `detect_folders` の何れかのオプションが設定されていない限りモジュールは常に表示されます。これらのオプションが設定されている場合は、対応する条件が満たされるディレクトリ内にいるときまたは環境変数が存在するときに、モジュールが表示されます。
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### オプション
|
||||
|
||||
::: warning
|
||||
|
||||
`context_aliases` と `user_aliases` オプションは非推奨になりました。 代わりに `contexts` と対応するオプション `context_alias` と `user_alias` をお使いください。
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ---------------------------------------------------- | ------------------------------- |
|
||||
| `symbol` | `'☸ '` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 |
|
||||
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | モジュールのフォーマットです。 |
|
||||
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 |
|
||||
| `style` | `'cyan bold'` | モジュールのスタイルです。 |
|
||||
| `context_aliases`* | `{}` | 表示するコンテキストエイリアスを定義するテーブル。 |
|
||||
| `user_aliases`* | `{}` | 表示するユーザーエイリアスを定義するテーブル。 |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
`localip`モジュールは、プライマリネットワークインターフェイスのIPv4アドレスを表示します。
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
@@ -2742,11 +2751,7 @@ format = 'via [🌕 $version](bold blue) '
|
||||
|
||||
デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。
|
||||
|
||||
::: tip
|
||||
|
||||
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic of the repo in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | `merge`進行中に表示されるフォーマット文字列です。 |
|
||||
| `rebase` | `'REBASING'` | `rebase`進行中に表示されるフォーマット文字列です。 |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | `bisect`進行中に表示されるフォーマット文字列です。 |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | モジュールのスタイルです。 |
|
||||
| `format` | `'\([$state]($style)\) '` | module のフォーマットです。 |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| ---------------- | ---------- | ---------------------- |
|
||||
| state | `REBASING` | 現在のリポジトリの状態 |
|
||||
| progress_current | `1` | 現在の進行状態 |
|
||||
| progress_total | `2` | 全体の進行状態 |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
@@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ---------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | Zig のバージョンの前に表示されるシンボルです。 |
|
||||
| `style` | `'bold bright-blue'` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
|
||||
### 変数
|
||||
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## パッケージのバージョン
|
||||
|
||||
`package` モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
`package` モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ Arch = "Arch is the best! "
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel of the repo in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | module のフォーマットです。 |
|
||||
| `version_format` | `'v${raw}'` | バージョンのフォーマット。 Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbol` | `'🧚 '` | 環境名の直前に使用されるシンボルです。 |
|
||||
| `style` | `'yellow bold' | モジュールのスタイルです。 |
|
||||
| `style` | `'yellow bold'` | モジュールのスタイルです。 |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `['pixi.toml']` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `['.pixi']` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### 変数
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: tip
|
||||
|
||||
By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). それでも有効にしたい場合は、 [以下の例に従ってください](#with-pulumi-version).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). それでも有効にしたい場合は、 [以下の例に従ってください](#with-pulumi-version).
|
||||
|
||||
デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
|
||||
@@ -3712,13 +3742,9 @@ The `python` module shows the currently installed version of [Python](https://ww
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| `disabled` | `false` | `python`モジュールを無効にします。 |
|
||||
|
||||
::: 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.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### 変数
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
|
||||
::: tip
|
||||
|
||||
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
@@ -4153,8 +4177,8 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | ------------ | ----------------------------- |
|
||||
| env | `centos.img` | The current Singularity image |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
| symbol | | オプション `symbol` の値をミラーします |
|
||||
| style\* | | オプション `style` の値をミラーします |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
|
||||
@@ -4192,7 +4216,7 @@ The `solidity` module shows the currently installed version of [Solidity](https:
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | -------- | ------------------------- |
|
||||
| version | `v0.8.1` | The version of `solidity` |
|
||||
| symbol | | オプション `symbol` の値をミラーします |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
@@ -4225,7 +4249,7 @@ format = "via [S $version](blue bold)"
|
||||
| ----------- | ------------ | ----------------------- |
|
||||
| environment | `astronauts` | 現在の spack 環境 |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーします |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
|
||||
@@ -4242,11 +4266,7 @@ format = '[$symbol$environment](dimmed blue) '
|
||||
|
||||
`status` モジュールは、直前のコマンドの終了ステータスを表示します。 $success_symbol が空 (既定) の場合、モジュールは終了ステータスが `0` でない場合にのみ表示されます。 終了ステータスは符号付き32ビット整数にキャストされます。
|
||||
|
||||
::: tip
|
||||
|
||||
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
`sudo` モジュールは、sudo 資格情報が現在キャッシュされているかどうかを表示します。 モジュールは資格情報がキャッシュされている場合にのみ表示されます。
|
||||
|
||||
::: tip
|
||||
|
||||
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
`terraform` モジュールは、現在選択されている[Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) とバージョンを表示します。
|
||||
`terraform` モジュールは、現在選択されている[Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) とバージョンを表示します。 It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: tip
|
||||
|
||||
Terraformのバージョンはデフォルトでは表示されません。多くのプラグインが使用されている場合、現在のTerraformのバージョンでは遅くなるからです。 それでも有効にしたい場合は、 [以下の例に従ってください](#with-terraform-version).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. それでも有効にしたい場合は、 [以下の例に従ってください](#with-terraform-version).
|
||||
|
||||
デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
|
||||
|
||||
@@ -4406,16 +4418,17 @@ Terraformのバージョンはデフォルトでは表示されません。多
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | モジュールのフォーマット文字列。 |
|
||||
| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
|
||||
| `symbol` | `'💠'` | ワークスペースの前に表示されるフォーマット文字列。 |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `['.terraform']` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| `style` | `'bold 105'` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | `terraform` モジュールを無効にします。 |
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------------------------- | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | モジュールのフォーマット文字列。 |
|
||||
| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
|
||||
| `symbol` | `'💠'` | ワークスペースの前に表示されるフォーマット文字列。 |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `['.terraform']` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| `style` | `'bold 105'` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | `terraform` モジュールを無効にします。 |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### 変数
|
||||
|
||||
@@ -4436,7 +4449,7 @@ Terraformのバージョンはデフォルトでは表示されません。多
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Terraform バージョン表示なし
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## 時刻
|
||||
|
||||
`time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。
|
||||
|
||||
::: tip
|
||||
|
||||
このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. 有効にするには、設定ファイルで `disabled` を `false` に設定します。
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -4537,11 +4546,7 @@ time_range = '10:00:00-14:00:00'
|
||||
- `show_always`変数がtrueに設定されている
|
||||
- 配列 `detect_env_var` に、少なくとも1つの現在シェルで設定されている環境変数の名前が含まれている
|
||||
|
||||
::: tip
|
||||
|
||||
SSH接続は、環境変数 `SSH_CONNECTION`、 `SSH_CLIENT`、および `SSH_TTY` をチェックすることで検出されます。 お使いの SSH ホストがこれらの変数を設定しない場合、回避策として例えばこれらの変数にダミー値を設定してください。
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -4684,6 +4689,35 @@ format = 'via [V $version](blue bold) '
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). デフォルトでは次のいずれかの条件が満たされると、モジュールがアクティブになります。
|
||||
|
||||
- 現在のディレクトリに`xmake.lua`ファイルが含まれている
|
||||
|
||||
### オプション
|
||||
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 |
|
||||
| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
|
||||
| `symbol` | `'△ '` | cmakeのバージョンの前に使用される記号 |
|
||||
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
|
||||
| `detect_files` | `['xmake.lua']` | どのファイル名がこのモジュールをアクティブにするか |
|
||||
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
|
||||
| `style` | `'bold green'` | モジュールのスタイルです。 |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### 変数
|
||||
|
||||
| 変数 | 設定例 | 説明 |
|
||||
| --------- | -------- | ----------------------- |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbol | | オプション `symbol` の値をミラーする |
|
||||
| style\* | | オプション `style` の値をミラーする |
|
||||
|
||||
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
|
||||
|
||||
## Zig
|
||||
|
||||
既定で `zig`モジュールは、現在インストールされている[Zig](https://ziglang.org/)のバージョンを表示します。 このモジュールは次の条件のいずれかが満たされると表示されます:
|
||||
@@ -4734,31 +4768,17 @@ symbol = '⚡️ '
|
||||
- `when` コマンドが 0 を返す。
|
||||
- `os` フィールドが指定されている場合、現在のオペレーティング システム (std::env::consts::OS) がそれに一致する。
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
`.` を使用して複数のカスタムモジュールを定義できます。
|
||||
> [!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 `${...}`). 既定では、 `custom` モジュールは、単にすべての custom モジュールを定義順で表示します。
|
||||
|
||||
:::
|
||||
> [!TIP] [Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. 紹介されていない興味深い用例をお持ちでしたら、そちらで気軽に共有してください!
|
||||
|
||||
::: tip
|
||||
|
||||
カスタムモジュールが表示される順序は、`${custom.foo}` (ドットが含まれるので `${...}` を使う必要があります) をトップレベルの `format` に入れることで個別に設定できます。 既定では、 `custom` モジュールは、単にすべての custom モジュールを定義順で表示します。
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
[イシュー #1252](https://github.com/starship/starship/discussions/1252) にはカスタムモジュールの例が含まれています。 紹介されていない興味深い用例をお持ちでしたら、そちらで気軽に共有してください!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
コマンドが生成するいかなる出力もそのままプロンプト内に表示されます。 This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
フォーマット文字列には、シェル固有のプロンプトシーケンスを含めることもできます。例えば [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> コマンドが生成するいかなる出力もそのままプロンプト内に表示されます。 This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### オプション
|
||||
|
||||
@@ -4808,17 +4828,15 @@ The `command` (and `when`, if applicable) will be passed in on stdin.
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning 設定したカスタムシェルが正常終了することを再度ご確認ください
|
||||
|
||||
カスタムコマンドを設定するときは、(`shell` オプションを通して指定される) Starship が使用する既定のシェルがコマンドを正しく実行し正しく終了することを確認してください。
|
||||
|
||||
たとえば、PowerShell では一行コマンドを実行するために `-Command` パラメータを指定する必要があります。 このパラメータを省略すると、呼び出されたシェルが初期化のために再帰的に Starship を呼び出し、その Starship が再びカスタムコマンドを実行することによって、無限ループになる可能性があります。
|
||||
|
||||
PowerShell の `-NoProfile` に似たパラメータは、他のシェルでも推奨されます。これは、Starship の呼び出しごとにカスタムプロファイルの追加ロード時間が発生することを避けるためです。
|
||||
|
||||
現在、シェルと適切なパラメータの自動検出は実装されていますが、すべてのシェルがカバーされているとは限りません。 このような状況にお気づきの場合は、[イシューを開いて](https://github.com/starship/starship/issues/new/choose)シェルの詳細と Starship の設定をご報告ください。
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### 設定例
|
||||
|
||||
|
||||
@@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
`~/.elvish/rc.elv` の最後に以下を追記してください。
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
注意: Elvish v0.18以降でサポートされています
|
||||
注意: Elvish v0.18以降でサポートされています. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -407,7 +408,7 @@ Starshipのさらなるカスタマイズを目指すなら以下を参考にし
|
||||
|
||||
## 🤝 貢献
|
||||
|
||||
私たちは常に**すべてのスキルレベル**の貢献者を探しています！ もし簡単にプロジェクトへ参加する方法をお探しなら、 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) に取り組んでみてください。
|
||||
私たちは常に**すべてのスキルレベル**の貢献者を探しています！ If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
あなたが英語以外の言語に堪能な場合、ドキュメントの翻訳と更新に協力していただけると嬉しいです。 協力してくれる場合、翻訳は [Starship Crowdin](https://translate.starship.rs/) から貢献できます。
|
||||
|
||||
|
||||
@@ -14,11 +14,7 @@
|
||||
|
||||
このプリセットは一部のモジュールで使われるシンボルを変更して、Nerd Font シンボルをどこにも使わないようにします。
|
||||
|
||||
::: tip
|
||||
|
||||
このプリセットは [Starship の将来のリリース](https://github.com/starship/starship/pull/3544) でデフォルトのプリセットになります。
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[No Nerd Font プリセットを表示するにはクリックしてください。](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#catppuccin-powerline)
|
||||
[プリセット一覧に戻る](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline プリセット
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./#pure)
|
||||
[プリセット一覧に戻る](./#pure-prompt)
|
||||
|
||||
# Pureプリセット
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./#pastel-powerline)
|
||||
[プリセット一覧に戻る](./#tokyo-night)
|
||||
|
||||
# Tokyo Night プリセット
|
||||
|
||||
|
||||
+4
-11
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
elvish 버전 v0.18 이상에서만 지원됩니다.
|
||||
|
||||
:::
|
||||
|
||||
`~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,11 +161,7 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
추후에 변경될 예정입니다. Nushell v0.96 버전 이상에서만 지원됩니다.
|
||||
|
||||
:::
|
||||
> [!WARNING] This will change in the future. Nushell v0.96 버전 이상에서만 지원됩니다.
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
|
||||
+236
-218
@@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options.
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### 예시
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Variable | Default | Description |
|
||||
@@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu
|
||||
| 기호 | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### 예시
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| 기호 | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### 예시
|
||||
|
||||
@@ -724,7 +722,7 @@ disabled = false
|
||||
format = 'via [$name $version]($style)'
|
||||
```
|
||||
|
||||
## Character
|
||||
## 문자
|
||||
|
||||
The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
|
||||
|
||||
@@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c
|
||||
|
||||
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
|
||||
|
||||
::: warning
|
||||
|
||||
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -851,15 +845,13 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
@@ -899,11 +891,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1121,7 +1109,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
|
||||
format = 'via [🦕 $version](green bold) '
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `기호` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `기호` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1419,33 +1409,24 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
|
||||
format = 'via [ $version](cyan bold) '
|
||||
```
|
||||
|
||||
## Environment Variable
|
||||
## 환경 변수
|
||||
|
||||
The `env_var` module displays the current value of a selected environment variables. 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
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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.
|
||||
|
||||
Example: following configuration will display value of USER environment variable
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Example: following configuration will display value of USER environment variable
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1596,10 +1577,49 @@ Produces a prompt that looks like:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `기호` | `' '` | The symbol used before displaying the version of COBOL. |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | 예시 | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| name | gfortran | The name of the compiler |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| 기호 | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1785,7 +1808,7 @@ truncation_symbol = ''
|
||||
ignore_branches = ['master', 'main']
|
||||
```
|
||||
|
||||
## Git Commit
|
||||
## Git 커밋
|
||||
|
||||
The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
|
||||
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1904,15 +1923,11 @@ added_style = 'bold blue'
|
||||
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
```
|
||||
|
||||
## Git Status
|
||||
## Git 상태
|
||||
|
||||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'$'` | The format of `stashed` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
@@ -2283,7 +2298,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
|
||||
format = 'via [⎈ $version](bold white) '
|
||||
```
|
||||
|
||||
## Hostname
|
||||
## 호스트 이름
|
||||
|
||||
The `hostname` module shows the system hostname.
|
||||
|
||||
@@ -2392,17 +2407,9 @@ The default functionality is:
|
||||
- 1 job -> `symbol` is shown.
|
||||
- 2 jobs or more -> `symbol` + `number` are shown.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
This module is not supported on tcsh and nu.
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2530,21 +2545,13 @@ 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`.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Options
|
||||
|
||||
::: warning
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -2742,11 +2751,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic 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
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |
|
||||
| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | The style for the module. |
|
||||
| `format` | `'\([$state]($style)\) '` | The format for the module. |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | 예시 | Description |
|
||||
| ---------------- | ---------- | ----------------------------------- |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | The current operation progress |
|
||||
| progress_total | `2` | The total operation progress |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `기호` | `'Ø '` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `기호` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## 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`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel 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
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `기호` | `'🧚 '` | The symbol used before the environment name. |
|
||||
| `style` | `'yellow bold' | The style for the module. |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.pixi']` | Which folders should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: tip
|
||||
|
||||
By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). 그래도 활성화하려면, [아래에 있는 예시를 따라 하세요](#with-pulumi-version).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). 그래도 활성화하려면, [아래에 있는 예시를 따라 하세요](#with-pulumi-version).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -3712,13 +3742,9 @@ 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. |
|
||||
|
||||
::: 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.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -4242,11 +4266,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: 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. 그래도 활성화하려면, [아래에 있는 예시를 따라 하세요](#with-terraform-version).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. 그래도 활성화하려면, [아래에 있는 예시를 따라 하세요](#with-terraform-version).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `기호` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `기호` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Without Terraform version
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if
|
||||
- The variable `show_always` is set to true
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `xmake.lua` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `기호` | `'△ '` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | 예시 | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| 기호 | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
|
||||
@@ -4734,31 +4768,17 @@ 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.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Multiple custom modules can be defined by using a `.`.
|
||||
> [!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.
|
||||
|
||||
:::
|
||||
> [!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!
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### 예시
|
||||
|
||||
|
||||
+30
-31
@@ -10,22 +10,22 @@
|
||||
- **구성**: [matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish)
|
||||
- **프롬프트**: [Starship](https://starship.rs/)
|
||||
|
||||
## How do I get command completion as shown in the demo GIF?
|
||||
## 데모 GIF에 표시된 명령 완성 기능을 어떻게 얻을 수 있나요?
|
||||
|
||||
Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions).
|
||||
완성 지원 또는 자동 완성은 선택한 셸에서 제공합니다. 데모의 경우 [Fish Shell](https://fishshell.com/)로 데모를 진행했으며, Fish Shell은 기본적으로 완성을 제공합니다. Z Shell(zsh)을 사용하는 경우 [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)를 살펴보는 것이 좋습니다.
|
||||
|
||||
## Do top level `format` and `<module>.disabled` do the same thing?
|
||||
## 최상위 `format`과 `<module>.disabled`는 동일한 기능을 하나요?
|
||||
|
||||
Yes, they can both be used to disable modules in the prompt. If all you plan to do is disable modules, `<module>.disabled` is the preferred way to do so for these reasons:
|
||||
예, 둘 다 프롬프트에서 모듈을 비활성화하는 데 사용할 수 있습니다. 모듈을 비활성화하는 것이 유일한 계획이라면 다음과 같은 이유로 `<module>.disabled`가 선호되는 방법입니다.
|
||||
|
||||
- Disabling modules is more explicit than omitting them from the top level `format`
|
||||
- Newly created modules will be added to the prompt as Starship is updated
|
||||
- 모듈 비활성화는 최상위 `format`에서 생략하는 것보다 더 명시적입니다.
|
||||
- 새로 생성된 모듈은 Starship이 업데이트됨에 따라 프롬프트에 추가됩니다.
|
||||
|
||||
## The docs say Starship is cross-shell. Why isn't my preferred shell supported?
|
||||
|
||||
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.
|
||||
Starship이 구축된 방식으로는 사실상 모든 셸에 대한 지원을 추가할 수 있어야 합니다. starship 바이너리는 상태 비저장이며 셸에 구애받지 않으므로, 셸이 프롬프트 사용자 지정을 지원하고 셸 확장을 지원하는 한 Starship을 사용할 수 있습니다.
|
||||
|
||||
Here's a small example getting Starship working with bash:
|
||||
다음은 Starship이 bash에서 작동하는 작은 예시입니다.
|
||||
|
||||
```sh
|
||||
# Get the status code from the last command executed
|
||||
@@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l)
|
||||
PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
|
||||
```
|
||||
|
||||
The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations.
|
||||
Starship에 내장된 [Bash 구현](https://github.com/starship/starship/blob/master/src/init/starship.bash)은 [명령 지속 시간 모듈](https://starship.rs/config/#command-duration)과 같은 고급 기능을 허용하고 Starship이 사전 설치된 Bash 구성과 호환되도록 하기 위해 약간 더 복잡합니다.
|
||||
|
||||
`starship 프롬프트`에서 지원하는 모든 플래그 값을 보려면 아래 명령어를 사용하세요:
|
||||
|
||||
@@ -46,7 +46,7 @@ The [Bash implementation](https://github.com/starship/starship/blob/master/src/i
|
||||
starship prompt --help
|
||||
```
|
||||
|
||||
The prompt will use as much context as is provided, but no flags are "required".
|
||||
프롬프트는 제공된 만큼의 컨텍스트를 사용하지만, "필수" 플래그는 없습니다.
|
||||
|
||||
## 오래된 버전의 glibc가 있는 Linux 배포판에서 Starship을 어떻게 실행하나요?
|
||||
|
||||
@@ -58,52 +58,52 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
||||
|
||||
## 왜 `Executing command "..." timed out.` 경고가 뜨나요?
|
||||
|
||||
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](../config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
|
||||
Starship은 프롬프트에 표시할 정보를 얻기 위해 다양한 명령을 실행합니다. 예를 들어 프로그램 버전이나 현재 git 상태를 가져옵니다. starship이 이러한 명령을 실행하는 동안 멈추지 않도록 시간 제한을 설정합니다. 명령이 이 제한보다 오래 걸리면 starship은 명령 실행을 중지하고 위 경고를 출력합니다. 이는 예상된 동작입니다. 이 시간 제한은 [`command_timeout` 키](../config/#prompt)를 사용하여 구성할 수 있으므로 원하는 경우 시간 제한을 늘릴 수 있습니다. 또한 아래 디버깅 단계를 따라 어떤 명령이 느린지 확인하고 최적화할 수 있는지 확인할 수 있습니다. 마지막으로 이러한 경고를 숨기려면 `STARSHIP_LOG` 환경 변수를 `error`로 설정할 수 있습니다.
|
||||
|
||||
## 이해할 수 없거나 예상치 못한 기호가 보이는데 무슨 뜻인가요?
|
||||
|
||||
If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules.
|
||||
인식할 수 없는 기호가 보이면 `starship explain`을 사용하여 현재 표시되는 모듈을 설명할 수 있습니다.
|
||||
|
||||
## Starship is doing something unexpected, how can I debug it?
|
||||
## Starship이 예상치 못한 동작을 하는데, 어떻게 디버깅할 수 있나요?
|
||||
|
||||
You can enable the debug logs by using the `STARSHIP_LOG` env var. These logs can be very verbose so it is often useful to use the `module` command if you are trying to debug a particular module, for example, if you are trying to debug the `rust` module you could run the following command to get the trace logs and output from the module.
|
||||
`STARSHIP_LOG` 환경 변수를 사용하여 디버그 로그를 활성화할 수 있습니다. 이 로그는 매우 자세할 수 있으므로 특정 모듈을 디버깅하려는 경우 `module` 명령을 사용하는 것이 유용합니다. 예를 들어 `rust` 모듈을 디버깅하려는 경우 다음 명령을 실행하여 모듈의 추적 로그 및 출력을 얻을 수 있습니다.
|
||||
|
||||
```sh
|
||||
env STARSHIP_LOG=trace starship module rust
|
||||
```
|
||||
|
||||
If starship is being slow you can try using the `timings` command to see if there is a particular module or command that is to blame.
|
||||
starship이 느리다면 `timings` 명령을 사용하여 특정 모듈이나 명령이 원인인지 확인할 수 있습니다.
|
||||
|
||||
```sh
|
||||
env STARSHIP_LOG=trace starship timings
|
||||
```
|
||||
|
||||
This will output the trace log and a breakdown of all modules that either took more than 1ms to execute or produced some output.
|
||||
이것은 추적 로그와 실행하는 데 1ms 이상 걸렸거나 일부 출력을 생성한 모든 모듈의 분석을 출력합니다.
|
||||
|
||||
Finally if you find a bug you can use the `bug-report` command to create a GitHub issue.
|
||||
마지막으로 버그를 발견하면 `bug-report` 명령을 사용하여 GitHub 이슈를 생성할 수 있습니다.
|
||||
|
||||
```sh
|
||||
starship bug-report
|
||||
```
|
||||
|
||||
## Why don't I see a glyph symbol in my prompt?
|
||||
## 프롬프트에 글리프 기호가 보이지 않는 이유는 무엇인가요?
|
||||
|
||||
The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that:
|
||||
가장 흔한 원인은 시스템 설정 오류입니다. 특히 일부 Linux 배포판은 기본적으로 글꼴 지원이 제공되지 않습니다. 다음 사항을 확인해야 합니다.
|
||||
|
||||
- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value, [you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/).
|
||||
- You have an emoji font installed. Most systems come with an emoji font by default, but some (notably Arch Linux) do not. You can usually install one through your system's package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice.
|
||||
- You are using a [Nerd Font](https://www.nerdfonts.com/).
|
||||
- 로케일이 `de_DE.UTF-8` 또는 `ja_JP.UTF-8`과 같은 UTF-8 값으로 설정되어 있는지 확인하세요. `LC_ALL`이 UTF-8 값이 아닌 경우 [변경해야 합니다](https://www.tecmint.com/set-system-locales-in-linux/).
|
||||
- You have an emoji font installed. 대부분의 시스템에는 기본적으로 이모지 글꼴이 제공되지만, 일부(특히 Arch Linux)는 그렇지 않습니다. 일반적으로 시스템의 패키지 관리자를 통해 설치할 수 있습니다. [noto emoji](https://www.google.com/get/noto/help/emoji/)는 인기 있는 선택입니다.
|
||||
- [Nerd Font](https://www.nerdfonts.com/)를 사용하고 있는지 확인하세요.
|
||||
|
||||
To test your system, run the following commands in a terminal:
|
||||
시스템을 테스트하려면 터미널에서 다음 명령을 실행하세요.
|
||||
|
||||
```sh
|
||||
echo -e "\xf0\x9f\x90\x8d"
|
||||
echo -e "\xee\x82\xa0"
|
||||
```
|
||||
|
||||
The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
|
||||
첫 번째 줄은 [뱀 이모지](https://emojipedia.org/snake/)를 생성해야 하고, 두 번째 줄은 [파워라인 브랜치 기호(e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs)를 생성해야 합니다.
|
||||
|
||||
If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
|
||||
두 기호 중 하나라도 올바르게 표시되지 않으면 시스템이 여전히 잘못 구성된 것입니다. 안타깝게도 글꼴 구성을 올바르게 설정하는 것은 때때로 어렵습니다. Discord의 사용자들이 도움을 줄 수 있습니다. 두 기호 모두 올바르게 표시되지만 starship에서 여전히 보이지 않는다면 [버그 보고서를 제출하세요!](https://github.com/starship/starship/issues/new/choose)
|
||||
|
||||
## Starship을 어떻게 삭제하나요?
|
||||
|
||||
@@ -117,14 +117,13 @@ Starship을 패키지 매니저로 설치하였다면 해당 패키지 매니저
|
||||
Starship을 설치 스크립트로 설치하였다면 바이너리 파일 제거를 위해 아래 명령어를 실행하세요:
|
||||
|
||||
```sh
|
||||
# starship 바이너리 파일을 찾고 제거합니다.
|
||||
sh -c 'rm "$(command -v 'starship')"'
|
||||
# starship 바이너리 파일을 찾고 제거합니다. sh -c 'rm "$(command -v 'starship')"'
|
||||
```
|
||||
|
||||
## How do I install Starship without `sudo`?
|
||||
## `sudo` 없이 Starship을 어떻게 설치하나요?
|
||||
|
||||
The shell install script (`https://starship.rs/install.sh`) only attempts to use `sudo` if the target installation directory is not writable by the current user. The default installation directory is the value of the `$BIN_DIR` environment variable or `/usr/local/bin` if `$BIN_DIR` is not set. If you instead set the installation directory to one that is writable by your user, you should be able to install starship without `sudo`. For example, `curl -sS https://starship.rs/install.sh | sh -s -- -b ~/.local/bin` uses the `-b` command line option of the install script to set the installation directory to `~/.local/bin`.
|
||||
셸 설치 스크립트(`https://starship.rs/install.sh`)는 대상 설치 디렉토리가 현재 사용자가 쓸 수 없는 경우에만 `sudo`를 사용하려고 시도합니다. 예를 들어, `curl -sS https://starship.rs/install.sh | sh -s -- -b ~/.local/bin`은 설치 스크립트의 `-b` 명령줄 옵션을 사용하여 설치 디렉토리를 `~/.local/bin`으로 설정합니다. 기본 설치 디렉토리는 `$BIN_DIR` 환경 변수의 값 또는 `$BIN_DIR`이 설정되지 않은 경우 `/usr/local/bin`입니다. 대신 설치 디렉토리를 사용자가 쓸 수 있는 디렉토리로 설정하면 `sudo` 없이 starship을 설치할 수 있습니다.
|
||||
|
||||
For a non-interactive installation of Starship, don't forget to add the `-y` option to skip the confirmation. Check the source of the installation script for a list of all supported installation options.
|
||||
Starship의 비대화형 설치의 경우 확인을 건너뛰려면 `-y` 옵션을 추가하는 것을 잊지 마세요. 지원되는 모든 설치 옵션 목록은 설치 스크립트의 소스를 확인하세요.
|
||||
|
||||
When using a package manager, see the documentation for your package manager about installing with or without `sudo`.
|
||||
패키지 관리자를 사용하는 경우 `sudo`를 사용하거나 사용하지 않고 설치하는 방법에 대한 패키지 관리자 문서를 참조하세요.
|
||||
|
||||
@@ -230,9 +230,10 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo 패키지](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux 패키지](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
`~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
알림: Elvish v0.18 버전 이상에서만 지원됩니다.
|
||||
Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -407,7 +408,7 @@ Starship을 추가로 커스터마이징 하고싶다면:
|
||||
|
||||
## 🤝 기여하기
|
||||
|
||||
우리는 언제나 **기술 수준에 관계없이** 기여자를 찾고 있습니다! 프로젝트에 참여하고자 한다면, [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) 를 보내보세요.
|
||||
우리는 언제나 **기술 수준에 관계없이** 기여자를 찾고 있습니다! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
영어 이외의 언어에 유창하시다면, 저희 문서를 다른 언어로 최신화하는 데 도움을 주시면 대단히 감사하겠습니다. 번역에 도움을 주고자 한다면, [Starship Crowdin](https://translate.starship.rs/) 에서 기여할 수 있습니다.
|
||||
|
||||
|
||||
@@ -3,17 +3,17 @@
|
||||
Starship을 설치하려면 다음 두 가지를 수행해주세요
|
||||
|
||||
1. **Starship** 바이너리를 당신의 컴퓨터에 받으세요
|
||||
1. Tell your shell to use the starship binary as its prompt by modifying its init scripts
|
||||
1. 셸의 초기화 스크립트를 수정하여 starship 바이너리를 프롬프트로 사용하도록 셸에 지시하세요.
|
||||
|
||||
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
|
||||
대부분의 사용자에게는 [메인 페이지](../guide/#🚀-installation)의 지침이 잘 작동할 것입니다. 그러나 일부 더 전문화된 플랫폼의 경우 다른 지침이 필요합니다.
|
||||
|
||||
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
|
||||
너무 많은 플랫폼이 있어서 메인 README.md 파일에 모두 포함할 수 없었으므로, 다음은 커뮤니티에서 제공하는 다른 플랫폼에 대한 설치 지침입니다. Is yours not here? Please do add it here if you figure it out!
|
||||
|
||||
## [Chocolatey](https://chocolatey.org)
|
||||
|
||||
### 준비 사항
|
||||
|
||||
Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
|
||||
[Chocolatey 설치 페이지](https://chocolatey.org/install)로 이동하여 Chocolatey 설치 지침을 따르세요.
|
||||
|
||||
### 설치
|
||||
|
||||
@@ -39,7 +39,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term
|
||||
|
||||
### 설치
|
||||
|
||||
On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage:
|
||||
Funtoo Linux에서는 Portage를 통해 [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship)에서 starship을 설치할 수 있습니다.
|
||||
|
||||
```sh
|
||||
emerge app-shells/starship
|
||||
@@ -55,9 +55,9 @@ emerge app-shells/starship
|
||||
nix-env -iA nixos.starship
|
||||
```
|
||||
|
||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||
#### 선언형, 단일 사용자, [home-manager](https://github.com/nix-community/home-manager)를 통해
|
||||
|
||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||
`home.nix` 파일에서 `programs.starship` 모듈을 활성화하고 설정을 추가하세요.
|
||||
|
||||
```nix
|
||||
{
|
||||
@@ -78,15 +78,15 @@ Enable the `programs.starship` module in your `home.nix` file, and add your sett
|
||||
}
|
||||
```
|
||||
|
||||
then run
|
||||
그런 다음 실행하세요.
|
||||
|
||||
```sh
|
||||
home-manager switch
|
||||
```
|
||||
|
||||
#### Declarative, system-wide, with NixOS
|
||||
#### 선언형, 시스템 전체, NixOS 사용
|
||||
|
||||
Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run
|
||||
`configuration.nix` 파일의 `environment.systemPackages`에 `pkgs.starship`을 추가한 다음 실행하세요.
|
||||
|
||||
```sh
|
||||
sudo nixos-rebuild switch
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
# Migrating to v0.45.0
|
||||
# v0.45.0으로 마이그레이션
|
||||
|
||||
Starship v0.45.0 is a release containing breaking changes, in preparation for the big v1.0.0. We have made some major changes around how configuration is done on the prompt, to allow for a greater degree of customization.
|
||||
Starship v0.45.0은 대규모 v1.0.0을 준비하기 위한 주요 변경 사항이 포함된 릴리스입니다. 더 높은 수준의 사용자 정의를 허용하기 위해 프롬프트에서 구성이 수행되는 방식에 대한 몇 가지 주요 변경 사항을 적용했습니다.
|
||||
|
||||
This guide is intended to walk you through the breaking changes.
|
||||
이 가이드는 주요 변경 사항을 안내하기 위한 것입니다.
|
||||
|
||||
## `prompt_order` has been replaced by a root-level `format`
|
||||
## `prompt_order`가 최상위 `format`으로 대체되었습니다.
|
||||
|
||||
Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship.
|
||||
v0.45.0 이전에는 `prompt_order`가 Starship에서 렌더링되어야 하는 순서대로 모듈 이름 배열을 허용했습니다.
|
||||
|
||||
Starship v0.45.0 instead accepts a `format` value, allowing for customization of the prompt outside of the modules themselves.
|
||||
Starship v0.45.0은 대신 `format` 값을 허용하여 모듈 자체 외부에서 프롬프트를 사용자 정의할 수 있습니다.
|
||||
|
||||
**Example pre-v0.45.0 configuration**
|
||||
**v0.45.0 이전 구성 예시**
|
||||
|
||||
```toml
|
||||
prompt_order = [
|
||||
@@ -31,10 +31,10 @@ prompt_order = [
|
||||
]
|
||||
```
|
||||
|
||||
**Example v0.45.0 configuration**
|
||||
**v0.45.0 구성 예시**
|
||||
|
||||
```toml
|
||||
format = """\
|
||||
format = """
|
||||
$username\
|
||||
$hostname\
|
||||
$directory\
|
||||
@@ -52,40 +52,40 @@ format = """\
|
||||
"""
|
||||
```
|
||||
|
||||
## Module `prefix` and `suffix` have been replaced by `format`
|
||||
## 모듈 `prefix` 및 `suffix`가 `format`으로 대체되었습니다.
|
||||
|
||||
Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered.
|
||||
v0.45.0 이전에는 일부 모듈이 모듈이 렌더링되는 방식을 스타일링하기 위해 `prefix` 및/또는 `suffix`를 허용했습니다.
|
||||
|
||||
Starship v0.45.0 instead accepts a `format` value, allowing for further customization of how modules are rendered. Instead of defining a prefix and suffix for the context-based variables, the variables can now be substituted from within a format string, which represents the module's output.
|
||||
Starship v0.45.0은 대신 `format` 값을 허용하여 모듈이 렌더링되는 방식을 더욱 사용자 정의할 수 있습니다. 컨텍스트 기반 변수에 대한 접두사 및 접미사를 정의하는 대신, 이제 변수를 모듈의 출력을 나타내는 형식 문자열 내에서 대체할 수 있습니다.
|
||||
|
||||
**Example pre-v0.45.0 configuration**
|
||||
**v0.45.0 이전 구성 예시**
|
||||
|
||||
```toml
|
||||
[cmd_duration]
|
||||
prefix = "took "
|
||||
```
|
||||
|
||||
**Example v0.45.0 configuration**
|
||||
**v0.45.0 구성 예시**
|
||||
|
||||
```toml
|
||||
[cmd_duration]
|
||||
# $duration – The command duration (e.g. "15s")
|
||||
# $style – The default style of the module (e.g. "bold yellow")
|
||||
# $duration – 명령 지속 시간 (예: "15s")
|
||||
# $style – 모듈의 기본 스타일 (예: "bold yellow")
|
||||
format = "took [$duration]($style) "
|
||||
```
|
||||
|
||||
### Affected Modules
|
||||
### 영향을 받는 모듈
|
||||
|
||||
#### Character
|
||||
#### 문자
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| 제거된 속성 | 대체 |
|
||||
| ----------------------- | ---------------- |
|
||||
| `기호` | `success_symbol` |
|
||||
| `use_symbol_for_status` | `error_symbol` |
|
||||
| `style_success` | `success_symbol` |
|
||||
| `style_failure` | `error_symbol` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[character]
|
||||
@@ -98,26 +98,26 @@ format = "took [$duration]($style) "
|
||||
++ vicmd_symbol = "[❮](bold green)"
|
||||
```
|
||||
|
||||
Previously, the `use_symbol_for_status` property was used to configure the prompt to show the `error_symbol` when the last command resulted in a non-zero status code.
|
||||
이전에는 `use_symbol_for_status` 속성이 마지막 명령이 0이 아닌 상태 코드를 반환했을 때 `error_symbol`을 표시하도록 프롬프트를 구성하는 데 사용되었습니다.
|
||||
|
||||
With the release of v0.45.0, we now always use `error_symbol` after non-zero status codes, unifying `use_symbol_for_status` and `error_symbol` properties.
|
||||
v0.45.0 릴리스에서는 이제 0이 아닌 상태 코드 후에 항상 `error_symbol`을 사용하여 `use_symbol_for_status` 및 `error_symbol` 속성을 통합합니다.
|
||||
|
||||
To configure the prompt to use the older `use_symbol_for_status = true` configuration, add the following to your config file:
|
||||
이전 `use_symbol_for_status = true` 구성을 사용하도록 프롬프트를 구성하려면 구성 파일에 다음을 추가하세요.
|
||||
|
||||
```toml
|
||||
[character]
|
||||
error_symbol = "[✖](bold red)"
|
||||
```
|
||||
|
||||
_Note:_ The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples.
|
||||
_참고:_ `character` 요소는 자동으로 뒤에 공백을 추가하므로 다른 `format` 문자열과 달리 위 예시에서는 특별히 추가하지 않습니다.
|
||||
|
||||
#### Command Duration
|
||||
#### 명령 지속 시간
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| 제거된 속성 | 대체 |
|
||||
| -------- | -------- |
|
||||
| `prefix` | `format` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[cmd_duration]
|
||||
@@ -125,13 +125,13 @@ _Note:_ The `character` element automatically adds a space after, so unlike the
|
||||
++ format = "took [$duration]($style) "
|
||||
```
|
||||
|
||||
#### Directory
|
||||
#### 디렉토리
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| 제거된 속성 | 대체 |
|
||||
| -------- | -------- |
|
||||
| `prefix` | `format` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[directory]
|
||||
@@ -139,14 +139,14 @@ _Note:_ The `character` element automatically adds a space after, so unlike the
|
||||
++ format = "[$path]($style)[$read_only]($read_only_style) "
|
||||
```
|
||||
|
||||
#### Environment Variable
|
||||
#### 환경 변수
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| 제거된 속성 | 대체 |
|
||||
| -------- | -------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[env_var]
|
||||
@@ -155,45 +155,45 @@ _Note:_ The `character` element automatically adds a space after, so unlike the
|
||||
++ format = "with [$env_value]($style) "
|
||||
```
|
||||
|
||||
#### Git Commit
|
||||
#### Git 커밋
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| 제거된 속성 | 대체 |
|
||||
| -------- | -------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[git_commit]
|
||||
-- prefix = "("
|
||||
-- suffix = ")"
|
||||
++ format = '[\($hash\)]($style) '
|
||||
++ format = '[\]($hash\)]($style) '
|
||||
```
|
||||
|
||||
#### Git Status
|
||||
#### Git 상태
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ----------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| `show_sync_count` | `format` |
|
||||
| 제거된 속성 | 대체 |
|
||||
| ----------------- | -------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| `show_sync_count` | `format` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[git_status]
|
||||
-- prefix = "["
|
||||
-- suffix = "]"
|
||||
-- show_sync_count = false
|
||||
++ format = '([\[$all_status$ahead_behind\]]($style) )'
|
||||
++ format = '([\\\[$all_status$ahead_behind\\\]]($style) )'
|
||||
```
|
||||
|
||||
Previously, the `show_sync_count` property was used to configure the prompt to show the number of commits the branch was ahead or behind the remote branch.
|
||||
이전에는 `show_sync_count` 속성이 브랜치가 원격 브랜치보다 앞서거나 뒤처진 커밋 수를 표시하도록 프롬프트를 구성하는 데 사용되었습니다.
|
||||
|
||||
With the release of v0.45.0, this has been replaced with three separate properties, `ahead`, `behind`, and `diverged`.
|
||||
v0.45.0 릴리스에서는 이를 `ahead`, `behind`, `diverged`의 세 가지 개별 속성으로 대체했습니다.
|
||||
|
||||
To configure the prompt to use the older `show_sync_count = true` configuration, set the following to your config file:
|
||||
이전 `show_sync_count = true` 구성을 사용하도록 프롬프트를 구성하려면 구성 파일에 다음을 설정하세요.
|
||||
|
||||
```toml
|
||||
[git_status]
|
||||
@@ -202,14 +202,14 @@ diverged = "⇕⇡${ahead_count}⇣${behind_count}"
|
||||
behind = "⇣${count}"
|
||||
```
|
||||
|
||||
#### Hostname
|
||||
#### 호스트 이름
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| 제거된 속성 | 대체 |
|
||||
| -------- | -------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[hostname]
|
||||
@@ -220,28 +220,28 @@ behind = "⇣${count}"
|
||||
|
||||
#### Singularity
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `label` | `format` |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| 제거된 속성 | 대체 |
|
||||
| -------- | -------- |
|
||||
| `label` | `format` |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[singularity]
|
||||
-- prefix = ""
|
||||
-- suffix = ""
|
||||
++ format = '[$symbol\[$env\]]($style) '
|
||||
++ format = '[$symbol\\\[$env\\\]]($style) '
|
||||
```
|
||||
|
||||
#### Time
|
||||
#### 시간
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ------------- |
|
||||
| `format` | `time_format` |
|
||||
| 제거된 속성 | 대체 |
|
||||
| -------- | ------------- |
|
||||
| `format` | `time_format` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[time]
|
||||
@@ -250,14 +250,14 @@ behind = "⇣${count}"
|
||||
++ format = "at 🕙[$time]($style) "
|
||||
```
|
||||
|
||||
#### Custom Commands
|
||||
#### 사용자 지정 명령
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| 제거된 속성 | 대체 |
|
||||
| -------- | -------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Changes to the Default Configuration**
|
||||
**기본 구성 변경 사항**
|
||||
|
||||
```diff
|
||||
[custom.example]
|
||||
|
||||
@@ -14,11 +14,7 @@
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
이 프리셋은 [starship의 추후 배포](https://github.com/starship/starship/pull/3544)에서 기본 프리셋이 될 예정입니다.
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[클릭하여 No Nerd Font 프리셋 보기](./no-nerd-font)
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[프리셋으로 돌아가기](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
# Catppuccin Powerline 프리셋
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
이 프리셋은 [Catppuccin](https://github.com/catppuccin/catppuccin) 테마 팔레트를 사용하여 [Gruvbox Rainbow](./gruvbox-rainbow.md)를 최소한으로 수정한 버전입니다.
|
||||
|
||||
|
||||
|
||||
|
||||
### 준비 사항
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
- 터미널에 [Nerd Font](https://www.nerdfonts.com/) 설치 및 활성화
|
||||
|
||||
### 설정
|
||||
|
||||
@@ -16,13 +16,13 @@ This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainb
|
||||
starship preset catppuccin-powerline -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
By default this preset uses the Mocha flavour of Catppucin, but you can specify any of the flavours by modifying the value of `palette`:
|
||||
기본적으로 이 프리셋은 Catppuccin의 Mocha 플레이버를 사용하지만, `palette` 값을 수정하여 다음 플레이버 중 하나를 지정할 수 있습니다.
|
||||
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
[클릭하여 TOML 다운로드](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/presets/toml/catppuccin-powerline.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[프리셋으로 돌아가기](./#pure)
|
||||
[프리셋으로 돌아가기](./#pure-prompt)
|
||||
|
||||
# Pure 프리셋
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[프리셋으로 돌아가기](./#pastel-powerline)
|
||||
[프리셋으로 돌아가기](./#tokyo-night)
|
||||
|
||||
# Tokyo Night 프리셋
|
||||
|
||||
|
||||
+4
-11
@@ -136,19 +136,16 @@ onMounted(() => {
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNING] Only elvish v0.18 or higher is supported.
|
||||
|
||||
Only elvish v0.18 or higher is supported.
|
||||
|
||||
:::
|
||||
|
||||
Add the following to the end of `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
# ~/.elvish/rc.elv
|
||||
|
||||
eval (starship init elvish)
|
||||
```
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
|
||||
#### Tcsh
|
||||
@@ -164,11 +161,7 @@ onMounted(() => {
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
:::
|
||||
> [!WARNING] This will change in the future. Only Nushell v0.96+ is supported.
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
|
||||
@@ -2,11 +2,7 @@
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
|
||||
+235
-217
@@ -9,17 +9,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
|
||||
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
|
||||
|
||||
```toml
|
||||
# Get editor completions based on the config schema
|
||||
# Krijg editoraanvullingen gebaseerd op het configuratieschema
|
||||
"$schema" = 'https://starship.rs/config-schema.json'
|
||||
|
||||
# Inserts a blank line between shell prompts
|
||||
# Voegt een witregel toe tussen shell commando's
|
||||
add_newline = true
|
||||
|
||||
# Replace the '❯' symbol in the prompt with '➜'
|
||||
[character] # The name of the module we are configuring is 'character'
|
||||
success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
|
||||
# Vervang het '❯' symbool in de prompt met '➜'
|
||||
[character] # De naam van de module die we aan het configureren zijn is 'character'
|
||||
success_symbol = '[➜](bold green)' # Het 'success_symbol' segment wordt gezet naar '➜' met de kleur 'bold green'
|
||||
|
||||
# Disable the package module, hiding it from the prompt completely
|
||||
# Zet de 'package' module uit. Dit verbergt het volledig van de prompt
|
||||
[package]
|
||||
disabled = true
|
||||
```
|
||||
@@ -208,11 +208,7 @@ This is the list of prompt-wide configuration options.
|
||||
| `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`.
|
||||
|
||||
:::
|
||||
> [!TIP] If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.
|
||||
|
||||
### Example
|
||||
|
||||
@@ -267,6 +263,7 @@ $git_state\
|
||||
$git_metrics\
|
||||
$git_status\
|
||||
$hg_branch\
|
||||
$hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
@@ -281,6 +278,7 @@ $elixir\
|
||||
$elm\
|
||||
$erlang\
|
||||
$fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
@@ -442,6 +440,8 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
|
||||
|
||||
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Variable | Default | Description |
|
||||
@@ -658,15 +658,13 @@ The `c` module shows some information about your C compiler. By default the modu
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Example
|
||||
|
||||
@@ -681,6 +679,8 @@ format = 'via [$name $version]($style)'
|
||||
|
||||
The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`-related files.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -704,15 +704,13 @@ The `cpp` module shows some information about your `C++` compiler. By default, t
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
NB that `version` is not in the default format.
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose).
|
||||
|
||||
### Example
|
||||
|
||||
@@ -735,11 +733,7 @@ The character will tell you whether the last command was successful or not. It c
|
||||
|
||||
By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
|
||||
|
||||
::: warning
|
||||
|
||||
`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
:::
|
||||
> [!WARNING] `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -855,11 +849,9 @@ De `cobol` module laat de huidige geïnstalleerde versie van COBOL zien. By defa
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
@@ -899,11 +891,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1206,6 +1194,8 @@ truncation_symbol = '…/'
|
||||
|
||||
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1251,16 +1241,16 @@ The `docker_context` module shows the currently active [Docker context](https://
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$context]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |
|
||||
| `only_with_files` | `true` | Only show when there's a match |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
|
||||
| `style` | `'blue bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `docker_context` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1426,26 +1416,17 @@ 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
|
||||
|
||||
::: tip
|
||||
> [!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.
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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.
|
||||
|
||||
Example: following configuration will display value of USER environment variable
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[env_var.USER]
|
||||
default = 'unknown user'
|
||||
```
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> Example: following configuration will display value of USER environment variable
|
||||
>
|
||||
> ```toml
|
||||
>
|
||||
> # ~/.config/starship.toml
|
||||
>
|
||||
> [env_var.USER] default = 'unknown user' ```
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1596,10 +1577,49 @@ Produces a prompt that looks like:
|
||||
AA -------------------------------------------- BB -------------------------------------------- CC
|
||||
```
|
||||
|
||||
## Fortran
|
||||
|
||||
The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before displaying the version of COBOL. |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `disabled` | `false` | Disables the `fortran` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| name | gfortran | The name of the compiler |
|
||||
| version | `14.2.0` | The version of the Fortran compiler |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Commands
|
||||
|
||||
The `commands` option accepts a list of commands to determine the compiler version and name.
|
||||
|
||||
Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.
|
||||
|
||||
If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/).
|
||||
|
||||
## Fossil Branch
|
||||
|
||||
The `fossil_branch` module shows the name of the active branch of the check-out in your current directory.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1636,6 +1656,8 @@ truncation_symbol = ''
|
||||
|
||||
The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -1759,6 +1781,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |
|
||||
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
|
||||
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |
|
||||
| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |
|
||||
| `disabled` | `false` | Disables the `git_branch` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1866,11 +1889,7 @@ cherry_pick = '[🍒 PICKING](bold red)'
|
||||
|
||||
The `git_metrics` module will show the number of added and deleted lines in the current git repository.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1908,11 +1927,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
The `git_status` module shows symbols representing the state of the repo in your current directory.
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -1925,7 +1940,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'$'` | The format of `stashed` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
@@ -2392,17 +2407,9 @@ The default functionality is:
|
||||
- 1 job -> `symbol` is shown.
|
||||
- 2 jobs or more -> `symbol` + `number` are shown.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This module is not supported on tcsh.
|
||||
|
||||
This module is not supported on tcsh and nu.
|
||||
|
||||
:::
|
||||
|
||||
::: warning
|
||||
|
||||
The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2428,7 +2435,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
@@ -2439,6 +2446,14 @@ number_threshold = 4
|
||||
symbol_threshold = 0
|
||||
```
|
||||
|
||||
#### Changing process grouping behavior in fish
|
||||
|
||||
When using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:
|
||||
|
||||
```fish
|
||||
set -g __starship_fish_use_job_groups "false"
|
||||
```
|
||||
|
||||
## Julia
|
||||
|
||||
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2530,21 +2545,13 @@ 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`.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmatal variable has been set.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
>
|
||||
> When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.
|
||||
|
||||
### Options
|
||||
|
||||
::: warning
|
||||
|
||||
The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
:::
|
||||
> [!WARNING] The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2666,6 +2673,8 @@ disabled = true
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -2742,11 +2751,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -2826,6 +2831,8 @@ style = 'bold dimmed green'
|
||||
|
||||
The `hg_branch` module shows the active branch and topic 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
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -2859,10 +2866,45 @@ truncation_length = 4
|
||||
truncation_symbol = ''
|
||||
```
|
||||
|
||||
## Mercurial State
|
||||
|
||||
The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------ | --------------------------- | ------------------------------------------------------------- |
|
||||
| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |
|
||||
| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |
|
||||
| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |
|
||||
| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |
|
||||
| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |
|
||||
| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |
|
||||
| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |
|
||||
| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |
|
||||
| `style` | `'bold yellow'` | The style for the module. |
|
||||
| `format` | `'\([$state]($style)\) '` | The format for the module. |
|
||||
| `disabled` | `true` | Disables the `hg_state` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ---------------- | ---------- | ----------------------------------- |
|
||||
| state | `REBASING` | The current state of the repo |
|
||||
| progress_current | `1` | The current operation progress |
|
||||
| progress_total | `2` | The total operation progress |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Mise
|
||||
|
||||
The `mise` module shows the current mise health as reported by running `mise doctor`.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3171,16 +3213,16 @@ The `odin` module shows the currently installed version of [Odin](https://odin-l
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||
| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |
|
||||
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `odin` module. |
|
||||
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -3277,17 +3319,9 @@ symbol = '☁️ '
|
||||
|
||||
The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate.
|
||||
|
||||
::: warning
|
||||
> [!WARNING] The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3309,6 +3343,7 @@ AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
@@ -3352,7 +3387,7 @@ Ubuntu = "🎯 "
|
||||
Ultramarine = "🔷 "
|
||||
Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
```
|
||||
|
||||
@@ -3387,7 +3422,7 @@ Arch = "Arch is the best! "
|
||||
|
||||
## 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`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
|
||||
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.
|
||||
|
||||
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
|
||||
- [**JSR**](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory
|
||||
@@ -3403,6 +3438,7 @@ The `package` module is shown when the current directory is the repository for a
|
||||
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
|
||||
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
|
||||
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
|
||||
- [**Galaxy**](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory
|
||||
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
|
||||
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
|
||||
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
|
||||
@@ -3524,6 +3560,8 @@ format = 'via [🔹 $version](147 bold) '
|
||||
|
||||
The `pijul_channel` module shows the active channel 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
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3539,11 +3577,7 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
|
||||
::: tip
|
||||
|
||||
This does not suppress pixi's own prompt modifier, you may want to run `pixi config set change-ps1 false`.
|
||||
|
||||
:::
|
||||
> [!TIP] This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3552,12 +3586,12 @@ This does not suppress pixi's own prompt modifier, you may want to run `pixi con
|
||||
| `format` | `'via [$symbol($version )(\($environment\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. |
|
||||
| `symbol` | `'🧚 '` | The symbol used before the environment name. |
|
||||
| `style` | `'yellow bold' | The style for the module. |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |
|
||||
| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.pixi']` | Which folders should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
@@ -3582,11 +3616,7 @@ format = '[$symbol$environment](yellow) '
|
||||
|
||||
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!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).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -3712,13 +3742,9 @@ 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. |
|
||||
|
||||
::: 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.
|
||||
|
||||
The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
>
|
||||
> The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4036,11 +4062,7 @@ symbol = '🌟 '
|
||||
|
||||
The `shell` module shows an indicator for currently used shell.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4088,6 +4110,8 @@ disabled = false
|
||||
|
||||
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.
|
||||
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -4242,11 +4266,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.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4305,11 +4325,7 @@ disabled = false
|
||||
|
||||
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
|
||||
|
||||
::: tip
|
||||
|
||||
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4391,13 +4407,9 @@ format = 'via [🏎 $version](red bold)'
|
||||
|
||||
## Terraform
|
||||
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
|
||||
The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.
|
||||
|
||||
::: 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).
|
||||
|
||||
:::
|
||||
> [!TIP] By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version).
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
@@ -4406,16 +4418,17 @@ By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'💠'` | A format string shown before the terraform workspace. |
|
||||
| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold 105'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `terraform` module. |
|
||||
| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -4436,7 +4449,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $version$workspace]($style) '
|
||||
format = 'via [$symbol$version $workspace]($style) '
|
||||
```
|
||||
|
||||
#### Without Terraform version
|
||||
@@ -4445,18 +4458,14 @@ format = '[🏎💨 $version$workspace]($style) '
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[terraform]
|
||||
format = '[🏎💨 $workspace]($style) '
|
||||
format = 'via [$symbol$workspace]($style) '
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
:::
|
||||
> [!TIP] This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4537,11 +4546,7 @@ The `username` module shows active user's username. The module will be shown if
|
||||
- The variable `show_always` is set to true
|
||||
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
> [!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.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4684,6 +4689,35 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
|
||||
format = '[🆅 $repo](bold blue) '
|
||||
```
|
||||
|
||||
## XMake
|
||||
|
||||
The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `xmake.lua` file
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'△ '` | The symbol used before the version of cmake. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `xmake` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | -------- | ------------------------------------ |
|
||||
| version | `v2.9.5` | The version of xmake |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
## Zig
|
||||
|
||||
By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
|
||||
@@ -4734,31 +4768,17 @@ 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.
|
||||
|
||||
::: tip
|
||||
> [!TIP] Multiple custom modules can be defined by using a `.`.
|
||||
|
||||
Multiple custom modules can be defined by using a `.`.
|
||||
> [!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.
|
||||
|
||||
:::
|
||||
> [!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!
|
||||
|
||||
::: 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.
|
||||
|
||||
:::
|
||||
|
||||
::: 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!
|
||||
|
||||
:::
|
||||
|
||||
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
|
||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
|
||||
Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
:::
|
||||
> [!WARNING] If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||
>
|
||||
> Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||
>
|
||||
> Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
|
||||
|
||||
### Options
|
||||
|
||||
@@ -4808,17 +4828,15 @@ If `shell` is not given or only contains one element and Starship detects PowerS
|
||||
shell = ['pwsh', '-Command', '-']
|
||||
```
|
||||
|
||||
::: warning Make sure your custom shell configuration exits gracefully
|
||||
|
||||
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
|
||||
For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
|
||||
Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
|
||||
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
:::
|
||||
> [!WARNING] Make sure your custom shell configuration exits gracefully
|
||||
>
|
||||
> If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).
|
||||
>
|
||||
> For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
|
||||
>
|
||||
> Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
|
||||
>
|
||||
> Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -230,9 +230,10 @@ Als alternatief kan je Starship installeren met een van de volgende pakketbeheer
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Fedora 40+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
@@ -305,13 +306,13 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
|
||||
Add the following to the end of `~/.elvish/rc.elv`:
|
||||
Add the following to the end of `~/.config/elvish/rc.elv` (`%AppData%\elvish\rc.elv` on Windows):
|
||||
|
||||
```sh
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
Note: Only Elvish v0.18+ is supported
|
||||
Note: Only Elvish v0.18+ is supported. For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
@@ -407,7 +408,7 @@ If you're looking to further customize Starship:
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
|
||||
We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/"🌱%20good%20first%20issue").
|
||||
|
||||
If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
|
||||
@@ -14,11 +14,7 @@ This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
|
||||
::: tip
|
||||
|
||||
This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
:::
|
||||
> [!TIP] This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
[Click to view No Nerd Font preset](./no-nerd-font)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user