mirror of
https://github.com/starship/starship.git
synced 2026-06-24 02:01:36 +07:00
Compare commits
454 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 457f16069b | |||
| ba990c1111 | |||
| c8391a93e9 | |||
| ff0104afbc | |||
| d96e49c24f | |||
| ba5fecb625 | |||
| 18cc9f3ef9 | |||
| f2bd7f28b3 | |||
| 0450b84237 | |||
| 59cc115f75 | |||
| 0b6b417534 | |||
| aa645db610 | |||
| b26545e6ab | |||
| 727fbe1914 | |||
| 58b45cc927 | |||
| 4ea3c5d03e | |||
| 3c4a4868ae | |||
| 0e825d4f1d | |||
| 01e5ebe57c | |||
| 05b8f2e002 | |||
| 6b6bbd7673 | |||
| cab65a4696 | |||
| b84ffd6dfb | |||
| 85f664b4b6 | |||
| f19d847cec | |||
| 9345072a38 | |||
| 52d4a1494d | |||
| 3df5dd254e | |||
| 7104d79920 | |||
| 402e9cac57 | |||
| 8f9012b277 | |||
| 533479e99a | |||
| 56b8901f6f | |||
| 7a274752d0 | |||
| 9c0416a3a7 | |||
| b8ee82167c | |||
| 9a48087137 | |||
| 12d85c1c1d | |||
| 13103ec520 | |||
| a1fe09e956 | |||
| a071a73cd8 | |||
| 09b9d1f91e | |||
| 355f09e623 | |||
| 32e3105e5d | |||
| e5c1c7c4a9 | |||
| fce0ed741b | |||
| 70bee78942 | |||
| 9062d3f237 | |||
| c00fa5dfd1 | |||
| ed3cc53993 | |||
| 6d0a1263fc | |||
| a675122f28 | |||
| ebba0035a2 | |||
| aa9af212ed | |||
| f0c75042d3 | |||
| 0b1c74c823 | |||
| b9694629a3 | |||
| e1d55436a2 | |||
| 8b34bf94ad | |||
| 8994e3b6f7 | |||
| e0175ae5eb | |||
| 8952f47d90 | |||
| c372aca880 | |||
| e2277e5958 | |||
| 99fe1bc372 | |||
| a981bea094 | |||
| 724493e792 | |||
| 0d71065a6e | |||
| 88d384f582 | |||
| 3885e81357 | |||
| 4ede45c4fa | |||
| e7c75950c8 | |||
| bd461fe8a0 | |||
| 622ea6068a | |||
| fe5932f4c5 | |||
| e48dd8e372 | |||
| d49d431146 | |||
| be23facbee | |||
| d79fe5cca6 | |||
| d8713c48ee | |||
| 1b0797bb6d | |||
| 56ee01046c | |||
| 4b35a0e7ef | |||
| 7639b526be | |||
| 4473dbb937 | |||
| 98029fd7b1 | |||
| ee0ed24771 | |||
| d67f127743 | |||
| 3c139aa060 | |||
| 267de27d6f | |||
| dc185ecb3a | |||
| 55ac362a8f | |||
| 6d2df426d1 | |||
| aba0a12b61 | |||
| b712168d10 | |||
| f2b14d485b | |||
| 0d9f4953fc | |||
| f72a79dc21 | |||
| 4f879b5aa4 | |||
| 37fdd1d2ca | |||
| c8b3e6e1ad | |||
| b5cffce04c | |||
| 058c73d189 | |||
| 3db1bcb69c | |||
| b96c0e8bc3 | |||
| 4a4c4ceb72 | |||
| be27a48783 | |||
| c9becf311a | |||
| cf795a5b3d | |||
| 674b916c45 | |||
| 6e8e3f15f4 | |||
| 81352a9647 | |||
| d3d2445dda | |||
| 0301f9b0e0 | |||
| 083ab008fc | |||
| 2e8f26e448 | |||
| 70b0f73554 | |||
| 6109716afe | |||
| 61eee25ad5 | |||
| ef64ec87e7 | |||
| 478ae1a827 | |||
| 8108cc95cf | |||
| 304ad27555 | |||
| edd070de2d | |||
| cc493347dc | |||
| 17a7547ca3 | |||
| f5d555ac83 | |||
| 4f9cd04ae0 | |||
| 8803ef44c9 | |||
| 9cc93709a9 | |||
| 00f3c3cf1a | |||
| 74e080453f | |||
| 50a31e5d5a | |||
| 9931ab25b2 | |||
| be8e07e79e | |||
| 65966048cb | |||
| 0110bf59c8 | |||
| 7c824e41ec | |||
| 91861886a7 | |||
| 0dd5a4f402 | |||
| 8a69666084 | |||
| e910f47597 | |||
| 3ac96dfffc | |||
| 4c5176c5de | |||
| 815ddb2245 | |||
| c576625343 | |||
| 93169d31ca | |||
| d7ecd6156c | |||
| 9f53ac0cf5 | |||
| 5de07128ab | |||
| 33f7077fbe | |||
| 0daa8d3f92 | |||
| cd64933333 | |||
| d29471418f | |||
| 6d9c8ea8a9 | |||
| 88a3d37e64 | |||
| cc65e0c742 | |||
| 08824d7c6e | |||
| 6e6664dea6 | |||
| 74e13d1e59 | |||
| 0af0814b19 | |||
| a261b48caa | |||
| 6e72335c0e | |||
| 048acd1aa7 | |||
| 37b6225a12 | |||
| c5d65a38f7 | |||
| 4c9bd6de98 | |||
| a564fd8e98 | |||
| 94c6d6e012 | |||
| b0fd21f8b9 | |||
| 89d1ef0395 | |||
| bca890aa04 | |||
| d11bc8d586 | |||
| 056ab55dbb | |||
| 6d7ab0503e | |||
| 3b0aef3dc2 | |||
| e4d218f047 | |||
| 405ec43306 | |||
| 66d2c0e0a6 | |||
| e536a8ec1c | |||
| 550538c10b | |||
| bb4ae4e18c | |||
| 3943fc4c6e | |||
| 61a76a2665 | |||
| 909ff7a99a | |||
| f8be6ef568 | |||
| 46ab8621a7 | |||
| 93d62dc2fe | |||
| 0206c0b843 | |||
| 69ddff3e1b | |||
| e447cfae4e | |||
| ad9f55d709 | |||
| 62c51a8e69 | |||
| 6fb6b6cabc | |||
| 4b7d9d41e7 | |||
| 52ab91039c | |||
| b4d401c304 | |||
| 3ff1ec0e63 | |||
| fd637a41bb | |||
| bfd7adea7c | |||
| 378f3e42be | |||
| d6daf8a4e1 | |||
| 5736b481e2 | |||
| 7795bab3bd | |||
| f143aed72a | |||
| 2f816f1e6e | |||
| a71606d2bb | |||
| 47de63ed66 | |||
| 1ec0941bf0 | |||
| 3b78de84ae | |||
| 53f1ac9d92 | |||
| c0206cd0f5 | |||
| 10b67d50dc | |||
| dbbc4ca293 | |||
| 5d48bbf11d | |||
| a22fdfb7d4 | |||
| 6a42b09258 | |||
| 60b49f0dab | |||
| 408a7c05e1 | |||
| 6817c0f255 | |||
| e6eef15a72 | |||
| 1bf73f7baf | |||
| 3c366dc87a | |||
| 083870239e | |||
| 8f263209c3 | |||
| 3e58ce8ee5 | |||
| c8dcc8ffb1 | |||
| 56c8d063e2 | |||
| 699a005c0d | |||
| b7dea479eb | |||
| 6a604b4671 | |||
| 8258063791 | |||
| fe4abb605f | |||
| 3749d67025 | |||
| ef5227eeaf | |||
| 90d8c4a256 | |||
| 3b5bbe3566 | |||
| 583031e597 | |||
| 49eb281441 | |||
| e5933327d7 | |||
| 87b7ac342f | |||
| 5db4ea7878 | |||
| 4caee4a7ca | |||
| 31d890cb7c | |||
| b9c68930a5 | |||
| a64823d45e | |||
| 06fa704aed | |||
| 2cc2b49bfc | |||
| bd7948f3e1 | |||
| 0b525753ce | |||
| 7b8f747050 | |||
| a94c4b7e6a | |||
| bd176e3482 | |||
| a8de3fe4e9 | |||
| 551a7ed8da | |||
| a3cf8dab4e | |||
| 32b58831a6 | |||
| 231c9465ea | |||
| 7e056a0a67 | |||
| 2c1f0effcc | |||
| 598daae259 | |||
| f7d583821a | |||
| 6526d4bb5e | |||
| ba32d34f2f | |||
| 652ad88d7d | |||
| cb2dcf5c50 | |||
| ba5f71baec | |||
| eb66076bb6 | |||
| db751fe29a | |||
| 0c1e1dd2d0 | |||
| 89567bd527 | |||
| 58d9e448a4 | |||
| 91e4478782 | |||
| 0e6cdd5308 | |||
| 3d5efd039c | |||
| 678ce4758b | |||
| e9d6647153 | |||
| 15825bee6d | |||
| 286b0f2be3 | |||
| 95313f83bf | |||
| d85ee0a18c | |||
| f04362e84b | |||
| 4ace586699 | |||
| 339b5cf50a | |||
| 113745bb6b | |||
| 1afa67096d | |||
| a34fb05691 | |||
| 05daa3e278 | |||
| a60df1d1fe | |||
| 590a6b8db8 | |||
| 0f5d8d4a4a | |||
| 38db5f0094 | |||
| ef7d8bd442 | |||
| 95bf53f6b9 | |||
| 2c11c086b8 | |||
| 109a6811ce | |||
| 11dbaed316 | |||
| ef2958c61c | |||
| 521b15da3d | |||
| 1904f04cf7 | |||
| 6cd03ba23e | |||
| 6c69011196 | |||
| ee2a53be4c | |||
| 1aa99c8fa4 | |||
| dbb32bf62e | |||
| 6a9fe7d654 | |||
| dc89350e6d | |||
| 386863c70b | |||
| d8ff74bd43 | |||
| d3e9ede789 | |||
| 54d99d2565 | |||
| fe184e6482 | |||
| e0e6e390ae | |||
| 2befc8283a | |||
| c3fb532eff | |||
| 57e1926e2d | |||
| a96b429e02 | |||
| b698fb0559 | |||
| 4b3470e9b1 | |||
| f9e3e7411e | |||
| 9074f2b4ca | |||
| 07778a8452 | |||
| 6886ad082c | |||
| 26a62372d1 | |||
| 5dd40ea62f | |||
| f42b53edd8 | |||
| 3760f29560 | |||
| 6d717b20ae | |||
| 547336a5f7 | |||
| 1df755159d | |||
| b1036b17c9 | |||
| d04851a287 | |||
| c7425e3236 | |||
| c4630e3389 | |||
| 8b5d12c8a1 | |||
| 24bc8206d2 | |||
| 5563e81bcd | |||
| f28cbc9e5f | |||
| a2b60950f2 | |||
| 5b27951c81 | |||
| 08c24627c3 | |||
| e528f545f6 | |||
| 32c29cfda7 | |||
| bc48b5fcb0 | |||
| 9db08d2d4d | |||
| d4e5dfadf2 | |||
| 4bc9891f04 | |||
| 75e7985c36 | |||
| 26264b038b | |||
| 613b86202d | |||
| 2581f8f938 | |||
| b120d7e58f | |||
| 27d05d46dd | |||
| 8eba75d0ea | |||
| 89a0b0815a | |||
| 98ca1a194f | |||
| 0ad1cf831a | |||
| d36b843580 | |||
| f5780d9f00 | |||
| 1a37dfca5a | |||
| ec1741d702 | |||
| 73574f765d | |||
| edbd2e209d | |||
| 53b399b909 | |||
| edf441b664 | |||
| 26f7822ae6 | |||
| 195f28dbc0 | |||
| ff0acb193e | |||
| 94cdbc3f77 | |||
| 1c2f4d4659 | |||
| ae5a9056a2 | |||
| 7e39fd8544 | |||
| dedf7af4df | |||
| eb08e713e2 | |||
| a21cbd6770 | |||
| 5e25823f2b | |||
| 0e667df52b | |||
| 76f125b4f5 | |||
| 1bf4a9cc88 | |||
| 39d62321fe | |||
| edd46cce3a | |||
| d69b1c3561 | |||
| 34a911df56 | |||
| 47395d4a69 | |||
| a9261a8ed3 | |||
| 44a6353fc7 | |||
| 3543e0bc45 | |||
| e149f381eb | |||
| 8cb7c34a40 | |||
| a19e027b26 | |||
| 608ae37bcf | |||
| 3d2cf2a2fc | |||
| 6122516887 | |||
| 5bf25b77a4 | |||
| d0f66c7842 | |||
| ad9654a6c2 | |||
| 07c8143adf | |||
| 8589ba3b51 | |||
| 66c1597252 | |||
| 9f922105b1 | |||
| ea26e25fcd | |||
| cf617cd226 | |||
| 2c515c9488 | |||
| 0d5fec7707 | |||
| 101291c5f4 | |||
| 7bb431c58e | |||
| d737713328 | |||
| 74bdf047a2 | |||
| 87c61c5cde | |||
| 9ab8b84ea6 | |||
| 29620fde80 | |||
| 0ed5e8903e | |||
| e406f552f8 | |||
| ccc32e73fc | |||
| 5f0b31b4c8 | |||
| 7f4eb6fdae | |||
| e0d16e3a96 | |||
| 09c2b07975 | |||
| e79b410d9e | |||
| a5c971c8b1 | |||
| b4f85a3de1 | |||
| 873a5b11df | |||
| 5e8851a953 | |||
| c1a8483ac9 | |||
| a12a04cafb | |||
| c4100d9c14 | |||
| 45c316b66f | |||
| 4eaec686b3 | |||
| 44e9e56480 | |||
| ac2359ca8a | |||
| d15c183505 | |||
| 4cd15756ae | |||
| 08cf17911b | |||
| 0877e81672 | |||
| 1a6e9137e4 | |||
| 87f9a2367b | |||
| fb0ba07de3 | |||
| 4236712e5f | |||
| f9c83def71 | |||
| 4728d20341 | |||
| a477186e52 | |||
| a98a05f1ac | |||
| e565e8a32d | |||
| d404182164 | |||
| dc79c1385c | |||
| 2048bb224e | |||
| 1996feb1d5 | |||
| f9edc78804 | |||
| f34ff6ace8 | |||
| a2c98b8cf6 | |||
| 874980a079 | |||
| e81cdd43db | |||
| 073426664c | |||
| ed87dc5750 |
+3
-3
@@ -25,9 +25,9 @@
|
||||
"target/"
|
||||
],
|
||||
"plugins": [
|
||||
"https://github.com/dprint/dprint-plugin-typescript/releases/download/0.95.0/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.18.0/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-typescript/releases/download/0.95.15/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-json/releases/download/0.21.3/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-markdown/releases/download/0.21.1/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-toml/releases/download/0.7.0/plugin.wasm"
|
||||
]
|
||||
}
|
||||
|
||||
+6020
-5166
File diff suppressed because it is too large
Load Diff
@@ -7,6 +7,7 @@
|
||||
"group:monorepos",
|
||||
"group:recommended",
|
||||
"workarounds:all",
|
||||
"replacements:all",
|
||||
// automerge minor updates
|
||||
":automergeMinor",
|
||||
":automergeBranch"
|
||||
|
||||
@@ -12,9 +12,9 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Docs | Format
|
||||
uses: dprint/check@v2.2
|
||||
uses: dprint/check@v2.3
|
||||
|
||||
# Validate preset files
|
||||
taplo:
|
||||
@@ -22,9 +22,9 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Install | Taplo
|
||||
run: cargo install --debug --locked --version 0.9.3 taplo-cli
|
||||
run: cargo install --debug --locked --version 0.10.0 taplo-cli
|
||||
- name: Presets | Validate with schema
|
||||
run: taplo lint --schema "file://${GITHUB_WORKSPACE}/.github/config-schema.json" docs/public/presets/toml/*.toml
|
||||
|
||||
@@ -35,11 +35,11 @@ jobs:
|
||||
if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref != 'i18n_master' }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Prevent File Change
|
||||
uses: actions/github-script@v7
|
||||
uses: actions/github-script@v9
|
||||
with:
|
||||
script: |
|
||||
const { execSync } = require('child_process');
|
||||
@@ -62,12 +62,12 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Node
|
||||
uses: actions/setup-node@v4
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 20
|
||||
node-version: 24.15.0
|
||||
cache: 'npm'
|
||||
cache-dependency-path: docs/package-lock.json
|
||||
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
name: Install Script
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- "install/**"
|
||||
pull_request:
|
||||
paths:
|
||||
- "install/**"
|
||||
|
||||
jobs:
|
||||
shellcheck:
|
||||
name: Shellcheck [Linter]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Lint | Run shellcheck
|
||||
run: shellcheck --severity=warning install/**/*.sh
|
||||
|
||||
shfmt:
|
||||
name: Shfmt [Formatter]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Install shfmt
|
||||
run: |
|
||||
curl -sS https://webi.sh/shfmt | sh
|
||||
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
|
||||
|
||||
- name: Format | Check shfmt
|
||||
run: shfmt -d install/**/*.sh
|
||||
|
||||
test_install_script:
|
||||
name: Test Install Script
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-latest, macos-latest]
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Test | Piped execution with curl
|
||||
run: |
|
||||
# Test the installation method described at https://starship.rs/
|
||||
mkdir -p "$HOME/.test-install"
|
||||
curl -sS "file://$(pwd)/install/install.sh" | sh -s -- --yes --bin-dir "$HOME/.test-install"
|
||||
"$HOME/.test-install/starship" --version
|
||||
@@ -7,12 +7,12 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Node
|
||||
uses: actions/setup-node@v4
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 20
|
||||
node-version: 24.15.0
|
||||
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 }}
|
||||
@@ -55,6 +55,10 @@ jobs:
|
||||
os: ubuntu-latest
|
||||
name: starship-arm-unknown-linux-musleabihf.tar.gz
|
||||
|
||||
- target: riscv64gc-unknown-linux-musl
|
||||
os: ubuntu-latest
|
||||
name: starship-riscv64gc-unknown-linux-musl.tar.gz
|
||||
|
||||
- target: x86_64-apple-darwin
|
||||
os: macos-latest
|
||||
name: starship-x86_64-apple-darwin.tar.gz
|
||||
@@ -88,7 +92,7 @@ jobs:
|
||||
RUSTFLAGS: ${{ matrix.rustflags || '' }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@master
|
||||
@@ -128,7 +132,7 @@ jobs:
|
||||
continue-on-error: true
|
||||
if: matrix.os == 'windows-latest'
|
||||
id: unsigned-artifacts
|
||||
uses: actions/upload-artifact@v4
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: unsigned-${{ matrix.name }}
|
||||
path: |
|
||||
@@ -138,7 +142,7 @@ jobs:
|
||||
- name: Sign | Sign [Windows]
|
||||
continue-on-error: true
|
||||
if: matrix.os == 'windows-latest'
|
||||
uses: signpath/github-action-submit-signing-request@v1
|
||||
uses: signpath/github-action-submit-signing-request@v2
|
||||
with:
|
||||
api-token: '${{ secrets.SIGNPATH_API_TOKEN }}'
|
||||
organization-id: '${{ vars.SIGNPATH_ORGANIZATION_ID }}'
|
||||
@@ -163,7 +167,7 @@ jobs:
|
||||
cd -
|
||||
|
||||
- name: Release | Upload artifacts
|
||||
uses: actions/upload-artifact@v4
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: ${{ matrix.name }}
|
||||
path: ${{ matrix.name }}
|
||||
@@ -171,7 +175,7 @@ jobs:
|
||||
- name: Release | Upload installer artifacts [Windows]
|
||||
continue-on-error: true
|
||||
if: matrix.os == 'windows-latest'
|
||||
uses: actions/upload-artifact@v4
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: starship-${{ matrix.target }}.msi
|
||||
path: target/${{ matrix.target }}/release/starship-${{ matrix.target }}.msi
|
||||
@@ -201,7 +205,7 @@ jobs:
|
||||
STARSHIP_VERSION: ${{ needs.release_please.outputs.tag_name }}
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
# Required to include the recently merged Crowdin PR
|
||||
ref: master
|
||||
@@ -238,9 +242,9 @@ jobs:
|
||||
xcrun notarytool store-credentials "$KEYCHAIN_ENTRY" --team-id "$APPLEID_TEAMID" --apple-id "$APPLEID_USERNAME" --password "$APPLEID_PASSWORD" --keychain "$KEYCHAIN_PATH"
|
||||
|
||||
- name: Setup | Node
|
||||
uses: actions/setup-node@v4
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 20
|
||||
node-version: 24.15.0
|
||||
|
||||
- name: Notarize | Build docs
|
||||
run: |
|
||||
@@ -249,7 +253,7 @@ jobs:
|
||||
npm run build
|
||||
|
||||
- name: Notarize | Download artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
name: ${{ matrix.name }}
|
||||
path: artifacts
|
||||
@@ -261,7 +265,7 @@ jobs:
|
||||
run: bash install/macos_packages/build_and_notarize.sh starship docs ${{ matrix.arch }} ${{ matrix.pkgname }}
|
||||
|
||||
- name: Notarize | Upload Notarized Flat Installer
|
||||
uses: actions/upload-artifact@v4
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: ${{ matrix.pkgname }}
|
||||
path: ${{ matrix.pkgname }}
|
||||
@@ -270,7 +274,7 @@ jobs:
|
||||
run: tar czvf ${{ matrix.name }} starship
|
||||
|
||||
- name: Notarize | Upload Notarized Binary
|
||||
uses: actions/upload-artifact@v4
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: ${{ matrix.name }}
|
||||
path: ${{ matrix.name }}
|
||||
@@ -289,7 +293,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
uses: actions/download-artifact@v8
|
||||
|
||||
- name: Setup | Checksums
|
||||
run: for file in starship-*/starship-*; do openssl dgst -sha256 -r "$file" | awk '{print $1}' > "${file}.sha256"; done
|
||||
@@ -300,7 +304,7 @@ jobs:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Build | Add Artifacts to Release
|
||||
uses: softprops/action-gh-release@v2
|
||||
uses: softprops/action-gh-release@v3
|
||||
with:
|
||||
files: starship-*/starship-*
|
||||
tag_name: ${{ needs.release_please.outputs.tag_name }}
|
||||
@@ -311,15 +315,21 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [release_please, upload_artifacts]
|
||||
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
||||
permissions:
|
||||
id-token: write
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
|
||||
- name: Build | Authenticate
|
||||
uses: rust-lang/crates-io-auth-action@v1
|
||||
id: auth
|
||||
|
||||
- name: Build | Publish
|
||||
run: cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
|
||||
run: cargo publish --token ${{ steps.auth.outputs.token }}
|
||||
|
||||
update_brew_formula:
|
||||
name: Update Brew Formula
|
||||
@@ -327,7 +337,7 @@ jobs:
|
||||
needs: [release_please, upload_artifacts]
|
||||
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
||||
steps:
|
||||
- uses: mislav/bump-homebrew-formula-action@v3.2
|
||||
- uses: mislav/bump-homebrew-formula-action@v4.1
|
||||
with:
|
||||
formula-name: starship
|
||||
tag-name: ${{ needs.release_please.outputs.tag_name }}
|
||||
@@ -367,9 +377,9 @@ jobs:
|
||||
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Setup | Artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
uses: actions/download-artifact@v8
|
||||
- run: pwsh ./install/windows/choco/update.ps1
|
||||
env:
|
||||
STARSHIP_VERSION: ${{ needs.release_please.outputs.tag_name }}
|
||||
@@ -383,7 +393,7 @@ jobs:
|
||||
continue-on-error: true
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Merge | Merge Crowdin PR
|
||||
run: gh pr merge i18n_master --squash --repo=starship/starship
|
||||
env:
|
||||
@@ -395,7 +405,7 @@ jobs:
|
||||
needs: merge_crowdin_pr
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Trigger workflow dispatch
|
||||
run: gh workflow run publish-docs.yml
|
||||
env:
|
||||
|
||||
@@ -22,8 +22,8 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Test | Security Audit
|
||||
uses: EmbarkStudios/cargo-deny-action@v2.0.11
|
||||
uses: EmbarkStudios/cargo-deny-action@v2.0.17
|
||||
with:
|
||||
command: check ${{ matrix.checks }}
|
||||
|
||||
@@ -6,5 +6,5 @@ jobs:
|
||||
name: Spell Check with Typos
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: crate-ci/typos@v1.31.1
|
||||
- uses: actions/checkout@v6
|
||||
- uses: crate-ci/typos@v1.45.1
|
||||
|
||||
@@ -24,7 +24,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
@@ -43,7 +43,7 @@ jobs:
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
@@ -62,7 +62,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
@@ -80,7 +80,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
@@ -98,7 +98,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
@@ -120,7 +120,7 @@ jobs:
|
||||
pull-requests: write
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
@@ -132,7 +132,7 @@ jobs:
|
||||
run: cargo run --locked --features config-schema -- config-schema > .github/config-schema.json
|
||||
|
||||
- name: Check | Detect Changes
|
||||
uses: reviewdog/action-suggester@v1.21.0
|
||||
uses: reviewdog/action-suggester@v1.24.0
|
||||
with:
|
||||
tool_name: starship config-schema
|
||||
filter_mode: nofilter
|
||||
@@ -156,7 +156,7 @@ jobs:
|
||||
RUSTFLAGS: ${{ matrix.rustflags || '' }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
# Install all the required dependencies for testing
|
||||
- name: Setup | Rust
|
||||
@@ -181,11 +181,17 @@ jobs:
|
||||
# cargo-wix does not require static crt
|
||||
RUSTFLAGS: ""
|
||||
|
||||
# Install Mercurial (pre-installed on Linux and windows)
|
||||
# Install Mercurial (pre-installed on Linux)
|
||||
- name: Setup | Mercurial (macos)
|
||||
if: matrix.os == 'macOS-latest'
|
||||
run: brew install mercurial
|
||||
|
||||
- name: Setup | Mercurial (windows)
|
||||
if: matrix.os == 'windows-latest'
|
||||
run: |
|
||||
winget install --id Mercurial.Mercurial --silent --exact --disable-interactivity --accept-source-agreements
|
||||
Add-Content -Path $env:GITHUB_PATH -Value "C:\Program Files\Mercurial" -Encoding utf8
|
||||
|
||||
# Run the ignored tests that expect the above setup
|
||||
- name: Build | Test
|
||||
run: "cargo llvm-cov
|
||||
@@ -222,7 +228,7 @@ jobs:
|
||||
STARSHIP_VERSION: v1.2.3
|
||||
|
||||
- name: Sign | Upload Executable [Windows]
|
||||
uses: actions/upload-artifact@v4
|
||||
uses: actions/upload-artifact@v7
|
||||
continue-on-error: true
|
||||
id: unsigned-artifacts
|
||||
if: matrix.os == 'windows-latest' && matrix.rust == 'stable' && github.event_name == 'push' && github.repository == 'starship/starship'
|
||||
@@ -233,7 +239,7 @@ jobs:
|
||||
target/debug/starship-x86_64-pc-windows-msvc.msi
|
||||
|
||||
- name: Sign | Sign [Windows]
|
||||
uses: signpath/github-action-submit-signing-request@v1
|
||||
uses: signpath/github-action-submit-signing-request@v2
|
||||
continue-on-error: true
|
||||
if: matrix.os == 'windows-latest' && matrix.rust == 'stable' && github.event_name == 'push' && github.repository == 'starship/starship'
|
||||
with:
|
||||
@@ -246,7 +252,7 @@ jobs:
|
||||
output-artifact-directory: target/debug
|
||||
|
||||
- name: Upload coverage to Codecov
|
||||
uses: codecov/codecov-action@v5
|
||||
uses: codecov/codecov-action@v6
|
||||
if: github.repository == 'starship/starship'
|
||||
with:
|
||||
token: ${{ secrets.CODECOV_TOKEN }}
|
||||
|
||||
@@ -1,5 +1,104 @@
|
||||
# Changelog
|
||||
|
||||
## [1.25.0](https://github.com/starship/starship/compare/v1.24.2...v1.25.0) (2026-04-18)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add Maven module ([#7189](https://github.com/starship/starship/issues/7189)) ([70b0f73](https://github.com/starship/starship/commit/70b0f7355497715a0e9d480326dc7b721b5314fb))
|
||||
* add statusline subcommand for Claude Code integration ([#7234](https://github.com/starship/starship/issues/7234)) ([b8ee821](https://github.com/starship/starship/commit/b8ee82167c5b49c7e9fd70e5542fad0e56810b39))
|
||||
* **battery:** Update default `unknown_symbol` ([#7278](https://github.com/starship/starship/issues/7278)) ([88d384f](https://github.com/starship/starship/commit/88d384f582de7c49b201bc30739c9ad6620fa174))
|
||||
* **directory:** add support for regexes in substitutions ([#7145](https://github.com/starship/starship/issues/7145)) ([2e8f26e](https://github.com/starship/starship/commit/2e8f26e44846cd52d06563aef98e22b89965dd25))
|
||||
* **env_var:** include $symbol in default format ([#7262](https://github.com/starship/starship/issues/7262)) ([3885e81](https://github.com/starship/starship/commit/3885e81357b04c244c19c0c8b05ccbbd4f797d62))
|
||||
* **git_status:** add variables to track worktree and index changes ([#5655](https://github.com/starship/starship/issues/5655)) ([0110bf5](https://github.com/starship/starship/commit/0110bf59c86f6f0f33f95dc614c231acc19547b8))
|
||||
* **python:** add option to replace generic venv-names with parent dir ([#7112](https://github.com/starship/starship/issues/7112)) ([083ab00](https://github.com/starship/starship/commit/083ab008fc77b982a223af8f4f18020c7a64fec6))
|
||||
* **vcs:** Introduce the VCS module ([#6388](https://github.com/starship/starship/issues/6388)) ([0dd5a4f](https://github.com/starship/starship/commit/0dd5a4f402c8d94524aaaa5632b2d0cba7fe1630))
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **aws:** isolate tests from host AWS config files ([#7196](https://github.com/starship/starship/issues/7196)) ([e910f47](https://github.com/starship/starship/commit/e910f47597f3acec36c1c21bf4204af1a3265b92))
|
||||
* **aws:** support `$duration` for `sso_session` ([#7100](https://github.com/starship/starship/issues/7100)) ([8108cc9](https://github.com/starship/starship/commit/8108cc95cf1b1182f239a3a4cc399d3fcd912187))
|
||||
* **direnv:** accept null loadedRC state ([#7317](https://github.com/starship/starship/issues/7317)) ([56b8901](https://github.com/starship/starship/commit/56b8901f6feaa841de1f38054db7b3ae495a457b))
|
||||
* **docs:** Re-add `style` option to `env_var` module ([#7298](https://github.com/starship/starship/issues/7298)) ([e2277e5](https://github.com/starship/starship/commit/e2277e5958c62a5bb1cc1f4ad76ccd051e22d1c5))
|
||||
* enable std feature for whoami crate ([#7211](https://github.com/starship/starship/issues/7211)) ([9931ab2](https://github.com/starship/starship/commit/9931ab25b28b91b502dae93fc3826fd9a18a01b0))
|
||||
* **format:** allow empty textgroups to set prev_fg/prev_bg ([#7201](https://github.com/starship/starship/issues/7201)) ([9186188](https://github.com/starship/starship/commit/91861886a779805cd8265a85c629e579d513aa75))
|
||||
* **helm:** remove deprecated --client flag from helm version command ([#7193](https://github.com/starship/starship/issues/7193)) ([8a69666](https://github.com/starship/starship/commit/8a69666084d248b8fd76b6c54f38aea12abce6e3))
|
||||
* **hg_state:** avoid false-positive MERGING state ([#7329](https://github.com/starship/starship/issues/7329)) ([7a27475](https://github.com/starship/starship/commit/7a274752d0803960ae25259c8641f6e676f9c7b2))
|
||||
* **install:** improve UX for version option ([#7197](https://github.com/starship/starship/issues/7197)) ([c576625](https://github.com/starship/starship/commit/c576625343a8353ed2e99157d86065c2e713048e))
|
||||
|
||||
## [1.24.2](https://github.com/starship/starship/compare/v1.24.1...v1.24.2) (2025-12-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **cmd_duration:** avoid freezing on notify on macOS 26 ([#7187](https://github.com/starship/starship/issues/7187)) ([0daa8d3](https://github.com/starship/starship/commit/0daa8d3f921f5b7f08445a29e2842928b6e637c4))
|
||||
* **fish:** restore job counting compability with older versions ([#7173](https://github.com/starship/starship/issues/7173)) ([a261b48](https://github.com/starship/starship/commit/a261b48caa4129cd6baa5fa98f364eff66593bc4))
|
||||
* **fish:** use native transient prompt if available ([#7015](https://github.com/starship/starship/issues/7015)) ([cc65e0c](https://github.com/starship/starship/commit/cc65e0c7429068f1123fe5d9844ebebdfa1b9547))
|
||||
* **git:** Basic Reftable compatibility and future-proofing ([#7154](https://github.com/starship/starship/issues/7154)) ([6d9c8ea](https://github.com/starship/starship/commit/6d9c8ea8a9736d2e12bda46c9cdb1f8fc1de630c))
|
||||
* **mise:** align documentation and implementation ([#7131](https://github.com/starship/starship/issues/7131)) ([08824d7](https://github.com/starship/starship/commit/08824d7c6e1f69150cc1c28f3ff46bbb5447a7d0))
|
||||
* Revert "feat(install.sh): handle installation directory prompt case-insensitively ([#7138](https://github.com/starship/starship/issues/7138)) ([d11bc8d](https://github.com/starship/starship/commit/d11bc8d5867d7d7c16850803b4eed7643bf33b20))
|
||||
* **zsh:** fix job counting ([#7124](https://github.com/starship/starship/issues/7124)) ([46ab862](https://github.com/starship/starship/commit/46ab8621a7490bdcea635feb6233ce038264ff4e))
|
||||
|
||||
## [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)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add mercurial state ([#6745](https://github.com/starship/starship/issues/6745)) ([5f0b31b](https://github.com/starship/starship/commit/5f0b31b4c8da64a3dbe27f5966dfbc4ab2b9f7bf))
|
||||
* **aws:** support duration for aws sso ([#6614](https://github.com/starship/starship/issues/6614)) ([44e9e56](https://github.com/starship/starship/commit/44e9e56480a748ccda1a64a9f623dc2b19ecfe98))
|
||||
* **cli:** accept 'powershell' for completions subcommand ([#7028](https://github.com/starship/starship/issues/7028)) ([4caee4a](https://github.com/starship/starship/commit/4caee4a7ca5dbb78c346a84cc39ca3a90a9238a5))
|
||||
* **container:** Add detection of Incus containers ([#6917](https://github.com/starship/starship/issues/6917)) ([6886ad0](https://github.com/starship/starship/commit/6886ad082cd55a5a07160cc847c9c38915dca848))
|
||||
* **fish:** support input-mode detection for helix-keybinds ([#6841](https://github.com/starship/starship/issues/6841)) ([26a6237](https://github.com/starship/starship/commit/26a62372d11a42f7fec0b65c388e585a79d05b04))
|
||||
* Fortran module ([#6685](https://github.com/starship/starship/issues/6685)) ([90d8c4a](https://github.com/starship/starship/commit/90d8c4a256b67bfef9cf33e4d560eb34c390d101))
|
||||
* **git_branch:** add ignore_bare_repo flag ([#6936](https://github.com/starship/starship/issues/6936)) ([87b7ac3](https://github.com/starship/starship/commit/87b7ac342f93b88780863251421283c4874d356c))
|
||||
* **install.sh:** handle installation directory prompt responses case-insensitively ([#6866](https://github.com/starship/starship/issues/6866)) ([bc48b5f](https://github.com/starship/starship/commit/bc48b5fcb07b3ea806127bc6ab13616028e92642))
|
||||
* new module `xmake` ([#6811](https://github.com/starship/starship/issues/6811)) ([ff0acb1](https://github.com/starship/starship/commit/ff0acb193eaa04ab63a8e56e1bd18019444b886f))
|
||||
* **nu:** Add job support for nushell ([#6684](https://github.com/starship/starship/issues/6684)) ([ac2359c](https://github.com/starship/starship/commit/ac2359ca8a020825b5c68b5e3b8da35d4917f46e))
|
||||
* **package:** Add support for Ansible Galaxy ([#6905](https://github.com/starship/starship/issues/6905)) ([07778a8](https://github.com/starship/starship/commit/07778a8452bb565db55e32c32d7c8434a7bda9dd))
|
||||
* **package:** pyproject hatchling dynamic version ([#6656](https://github.com/starship/starship/issues/6656)) ([ef5227e](https://github.com/starship/starship/commit/ef5227eeafa4dd5c99aff1fdab07574bc423d648))
|
||||
* **terraform:** support opentofu for terraform version detection ([#6910](https://github.com/starship/starship/issues/6910)) ([ef7d8bd](https://github.com/starship/starship/commit/ef7d8bd442f659b64cc23fd4b096e696531289ba))
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* consider text-only meta variables in conditionals set if non-empty ([#6338](https://github.com/starship/starship/issues/6338)) ([286b0f2](https://github.com/starship/starship/commit/286b0f2be30db81bc948579c137f0cc646fcde65))
|
||||
* **docker_context:** add `compose.yml` and `compose.yaml` to files ([#6625](https://github.com/starship/starship/issues/6625)) ([a98a05f](https://github.com/starship/starship/commit/a98a05f1ac4dfc215337a266c784cd62256f0c33))
|
||||
* **explain:** Filter out non-printing ANSI escape codes ([#6861](https://github.com/starship/starship/issues/6861)) ([2c11c08](https://github.com/starship/starship/commit/2c11c086b8da5ea43ae795fa0e71a621e983ebcc))
|
||||
* **fossil_metrics:** match single-file ([#6785](https://github.com/starship/starship/issues/6785)) ([5dd40ea](https://github.com/starship/starship/commit/5dd40ea62fb697239c2a84072414bd30059067d9))
|
||||
* **git_metrics:** adhere to `git_status` `use_git_executable` option ([#6927](https://github.com/starship/starship/issues/6927)) ([05daa3e](https://github.com/starship/starship/commit/05daa3e27832dde93f784c2659b31f94bb827f80))
|
||||
* **git_status:** Do not show up-to-date when untracked ([#6755](https://github.com/starship/starship/issues/6755)) ([f42b53e](https://github.com/starship/starship/commit/f42b53edd8bc26ec95dd027d9cf776ec70597cc3))
|
||||
* **hg_branch:** Strip extraneous newlines from hg topic. ([#6766](https://github.com/starship/starship/issues/6766)) ([ccc32e7](https://github.com/starship/starship/commit/ccc32e73fc0a0f99d90cff3a0efb73efecce1d84))
|
||||
* improve adhere to directory scanning timeout ([#6694](https://github.com/starship/starship/issues/6694)) ([109a681](https://github.com/starship/starship/commit/109a6811cee1faae677a24a7d92fa8ed39397485))
|
||||
* **jobs:** Count job groups instead of processes for fish ([#6899](https://github.com/starship/starship/issues/6899)) ([95bf53f](https://github.com/starship/starship/commit/95bf53f6b9f7dbc50708e0f459b6dc7a7b7ebd20))
|
||||
* **modules:** username detect_env_vars logic ([#6934](https://github.com/starship/starship/issues/6934)) ([a60df1d](https://github.com/starship/starship/commit/a60df1d1fe2e670132a86e314971dce2ac4c1607)), closes [#6870](https://github.com/starship/starship/issues/6870)
|
||||
* **nushell:** Startup `cmd_duration` should be 0ms not 823ms ([#6854](https://github.com/starship/starship/issues/6854)) ([0ad1cf8](https://github.com/starship/starship/commit/0ad1cf831a9e7938ed5e3d3262d3647e828ee4de))
|
||||
* **pixi:** Don't trigger pixi module by `.pixi` directory ([#6709](https://github.com/starship/starship/issues/6709)) ([a477186](https://github.com/starship/starship/commit/a477186e52e156eeac780e9b79210a19715f4919))
|
||||
* **preset/nerd-font:** remove double spaces in `gcloud` default value and use Google Cloud-specific icon ([#6822](https://github.com/starship/starship/issues/6822)) ([3b5bbe3](https://github.com/starship/starship/commit/3b5bbe3566583f4549234f89874a3662d67c5012))
|
||||
* **preset/pure:** only enable python module if venv is active ([#6689](https://github.com/starship/starship/issues/6689)) ([5e8851a](https://github.com/starship/starship/commit/5e8851a95364e9713d1c5ddc409248f0705a9410))
|
||||
* **presets/plaint-text:** Add missing entries ([#6929](https://github.com/starship/starship/issues/6929)) ([e593332](https://github.com/starship/starship/commit/e5933327d705cc33951e9bf6ad08a0128720725b))
|
||||
* remove double spaces in default values ([#6649](https://github.com/starship/starship/issues/6649)) ([e406f55](https://github.com/starship/starship/commit/e406f552f84b37631152f34617712085d65c5e7b))
|
||||
* rust-ini 0.21.2 has been yanked from crates.io. ([#6916](https://github.com/starship/starship/issues/6916)) ([b698fb0](https://github.com/starship/starship/commit/b698fb05593c81c1e2f35af0f1e61c00dd85c6ce))
|
||||
* **terraform:** amend module to `exec_cmds_return_first`-changes ([#6956](https://github.com/starship/starship/issues/6956)) ([0f5d8d4](https://github.com/starship/starship/commit/0f5d8d4a4a932b5ed99aece6a6484887d7f4e06a))
|
||||
* **test/git_commit:** avoid spawning an editor lead to timeout if tag signing is enabled ([#6887](https://github.com/starship/starship/issues/6887)) ([32c29cf](https://github.com/starship/starship/commit/32c29cfda784bdcc6a97c0e637f99100af1a0c2d))
|
||||
* **time:** don't print misleading log message ([#7008](https://github.com/starship/starship/issues/7008)) ([5db4ea7](https://github.com/starship/starship/commit/5db4ea7878fb6ad40982021b64a907459cf22577))
|
||||
* **zsh:** check if vars are set before reading them ([#6742](https://github.com/starship/starship/issues/6742)) ([608ae37](https://github.com/starship/starship/commit/608ae37bcfd498b72020689b19debb79d236c411))
|
||||
* **zsh:** do not fail under ERR_EXIT conditions if `STARSHIP_DURATION` computes to 0 ([#6922](https://github.com/starship/starship/issues/6922)) ([38db5f0](https://github.com/starship/starship/commit/38db5f0094d1109b8e7b4332b6c20c2a8b125cf1))
|
||||
|
||||
|
||||
### Performance Improvements
|
||||
|
||||
* **git_status:** avoid gix index load when `core.fsmonitor` is used ([#6817](https://github.com/starship/starship/issues/6817)) ([1c2f4d4](https://github.com/starship/starship/commit/1c2f4d46594d38abd423752efa3b21903e5a1e3b))
|
||||
* Parallelize child modules for env_var|custom ([#6748](https://github.com/starship/starship/issues/6748)) ([7f4eb6f](https://github.com/starship/starship/commit/7f4eb6fdae5218413963f07f86df4e2b340bd05e))
|
||||
|
||||
## [1.23.0](https://github.com/starship/starship/compare/v1.22.1...v1.23.0) (2025-04-27)
|
||||
|
||||
|
||||
|
||||
Generated
+1509
-1287
File diff suppressed because it is too large
Load Diff
+49
-50
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "starship"
|
||||
version = "1.23.0"
|
||||
version = "1.25.0"
|
||||
authors = ["Starship Contributors"]
|
||||
build = "build.rs"
|
||||
categories = ["command-line-utilities"]
|
||||
@@ -23,7 +23,7 @@ license = "ISC"
|
||||
readme = "README.md"
|
||||
repository = "https://github.com/starship/starship"
|
||||
# Note: MSRV is only intended as a hint, and only the latest version is officially supported in starship.
|
||||
rust-version = "1.85"
|
||||
rust-version = "1.90"
|
||||
description = """
|
||||
The minimal, blazing-fast, and infinitely customizable prompt for any shell! ☄🌌️
|
||||
"""
|
||||
@@ -35,62 +35,62 @@ config-schema = ["schemars"]
|
||||
notify = ["notify-rust"]
|
||||
|
||||
[dependencies]
|
||||
chrono = { version = "0.4.40", default-features = false, features = ["clock", "std", "wasmbind"] }
|
||||
clap = { version = "4.5.37", features = ["derive", "cargo", "unicode"] }
|
||||
clap_complete = "4.5.47"
|
||||
clap_complete_nushell = "4.5.5"
|
||||
chrono = { version = "0.4.44", default-features = false, features = ["clock", "std", "wasmbind"] }
|
||||
clap = { version = "4.6.1", features = ["derive", "cargo", "unicode"] }
|
||||
clap_complete = "4.6.2"
|
||||
clap_complete_nushell = "4.6.0"
|
||||
dirs = "6.0.0"
|
||||
dunce = "1.0.5"
|
||||
# default feature restriction addresses https://github.com/starship/starship/issues/4251
|
||||
gix = { version = "0.72.1", default-features = false, features = ["max-performance-safe", "revision", "zlib-rs", "status"] }
|
||||
indexmap = { version = "2.9.0", features = ["serde"] }
|
||||
jsonc-parser = { version = "0.26.2", features = ["serde"] }
|
||||
log = { version = "0.4.27", features = ["std"] }
|
||||
gix = { version = "0.81.0", default-features = false, features = ["max-performance-safe", "revision", "zlib-rs", "status", "sha1"] }
|
||||
indexmap = { version = "2.14.0", features = ["serde"] }
|
||||
jsonc-parser = { version = "0.32.3", features = ["serde"] }
|
||||
log = { version = "0.4.29", 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
|
||||
notify-rust = { version = "4.11.7", optional = true }
|
||||
nu-ansi-term = "0.50.1"
|
||||
open = "5.3.2"
|
||||
notify-rust = { version = "4.15.0", optional = true }
|
||||
nu-ansi-term = "0.50.3"
|
||||
open = "5.3.3"
|
||||
# update os module config and tests when upgrading os_info
|
||||
os_info = "3.10.0"
|
||||
os_info = { version = "3.14.0", features = ["schemars"] }
|
||||
# for efficient shared state between `git_status` and `git_metrics`, allowing parallel printing. This is for poison-free locks.
|
||||
parking_lot = "0.12.3"
|
||||
parking_lot = "0.12.5"
|
||||
path-slash = "0.2.1"
|
||||
pest = "2.8.0"
|
||||
pest_derive = "2.8.0"
|
||||
process_control = "5.0.0"
|
||||
quick-xml = "0.37.5"
|
||||
rand = "0.9.1"
|
||||
rayon = "1.10.0"
|
||||
regex = { version = "1.11.1", default-features = false, features = ["perf", "std", "unicode-perl"] }
|
||||
rust-ini = "0.21.1"
|
||||
semver = "1.0.26"
|
||||
serde = { version = "1.0.219", features = ["derive"] }
|
||||
serde_json = "1.0.140"
|
||||
sha1 = "0.10.6"
|
||||
shadow-rs = { version = "1.1.1", default-features = false, features = ["build"] }
|
||||
pest = "2.8.6"
|
||||
pest_derive = "2.8.6"
|
||||
process_control = "5.2.0"
|
||||
quick-xml = "0.39.2"
|
||||
rand = "0.10.1"
|
||||
rayon = "1.12.0"
|
||||
regex = { version = "1.12.3", default-features = false, features = ["perf", "std", "unicode-perl"] }
|
||||
rust-ini = "0.21.3"
|
||||
semver = "1.0.28"
|
||||
serde = { version = "1.0.228", features = ["derive"] }
|
||||
serde_json = "1.0.149"
|
||||
sha1 = "0.11.0"
|
||||
shadow-rs = { version = "1.7.1", 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.1", optional = true }
|
||||
starship-battery = { version = "0.11.0", optional = true }
|
||||
strsim = "0.11.1"
|
||||
systemstat = "=0.2.4"
|
||||
terminal_size = "0.4.2"
|
||||
toml = { version = "0.8.21", features = ["preserve_order"] }
|
||||
toml_edit = "0.22.25"
|
||||
unicode-segmentation = "1.12.0"
|
||||
unicode-width = "0.2.0"
|
||||
systemstat = "=0.2.6"
|
||||
terminal_size = "0.4.4"
|
||||
toml = { version = "1.1.2", features = ["preserve_order"] }
|
||||
toml_edit = "0.25.11"
|
||||
unicode-segmentation = "1.13.2"
|
||||
unicode-width = "0.2.2"
|
||||
urlencoding = "2.1.3"
|
||||
versions = "7.0.0"
|
||||
which = "7.0.3"
|
||||
whoami = { version = "1.6.0", default-features = false }
|
||||
yaml-rust2 = "0.10.1"
|
||||
which = "8.0.2"
|
||||
whoami = { version = "2.1.1", default-features = false, features = ["std", "wasi-wasite"] }
|
||||
yaml-rust2 = "0.11.0"
|
||||
|
||||
guess_host_triple = "0.1.4"
|
||||
home = "0.5.11"
|
||||
shell-words = "1.1.0"
|
||||
guess_host_triple = "0.1.5"
|
||||
home = "0.5.12"
|
||||
shell-words = "1.1.1"
|
||||
|
||||
[dependencies.schemars]
|
||||
version = "0.8.22"
|
||||
version = "1.2.1"
|
||||
optional = true
|
||||
features = ["preserve_order", "indexmap2"]
|
||||
|
||||
@@ -98,7 +98,7 @@ features = ["preserve_order", "indexmap2"]
|
||||
deelevate = "0.2.0"
|
||||
|
||||
[target.'cfg(windows)'.dependencies.windows]
|
||||
version = "0.61.0"
|
||||
version = "0.62.2"
|
||||
features = [
|
||||
"Win32_Foundation",
|
||||
"Win32_UI_Shell",
|
||||
@@ -108,18 +108,18 @@ features = [
|
||||
]
|
||||
|
||||
[target.'cfg(not(windows))'.dependencies]
|
||||
nix = { version = "0.29.0", default-features = false, features = ["feature", "fs", "user"] }
|
||||
nix = { version = "0.31.2", default-features = false, features = ["feature", "fs", "user"] }
|
||||
|
||||
[build-dependencies]
|
||||
shadow-rs = { version = "1.1.1", default-features = false, features = ["build"] }
|
||||
shadow-rs = { version = "1.7.1", default-features = false, features = ["build"] }
|
||||
dunce = "1.0.5"
|
||||
|
||||
[target.'cfg(windows)'.build-dependencies]
|
||||
winres = "0.1.12"
|
||||
|
||||
[dev-dependencies]
|
||||
mockall = "0.13.1"
|
||||
tempfile = "3.19.1"
|
||||
mockall = "0.14.0"
|
||||
tempfile = "3.27.0"
|
||||
|
||||
[profile.release]
|
||||
codegen-units = 1
|
||||
@@ -131,6 +131,5 @@ codegen-units = 16
|
||||
lto = "thin"
|
||||
strip = false
|
||||
|
||||
[[bin]]
|
||||
name = "starship"
|
||||
path = "src/main.rs"
|
||||
[lints.clippy]
|
||||
use_self = "warn"
|
||||
|
||||
@@ -230,6 +230,7 @@ Alternatively, install Starship using any of the following package managers:
|
||||
| Arch Linux | [Arch Linux Extra] | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr] | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main] | `apt install starship` |
|
||||
| Fedora 40+ | [Copr] | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Gentoo | [Gentoo Packages] | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs] | `nix-env -iA nixpkgs.starship` |
|
||||
@@ -306,13 +307,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>
|
||||
|
||||
@@ -409,7 +410,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/issues?q=state%3Aopen%20label%3A%22%F0%9F%8C%B1%20good%20first%20issue%22).
|
||||
|
||||
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/).
|
||||
|
||||
@@ -462,7 +463,7 @@ This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE)
|
||||
[linuxbrew]: https://formulae.brew.sh/formula/starship
|
||||
[homebrew]: https://formulae.brew.sh/formula/starship
|
||||
[macports]: https://ports.macports.org/port/starship
|
||||
[nixpkgs]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix
|
||||
[nixpkgs]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix
|
||||
[OSS]: https://software.opensuse.org/package/starship
|
||||
[pkgsrc]: https://pkgsrc.se/shells/starship
|
||||
[scoop]: https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json
|
||||
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
# Security Reporting
|
||||
|
||||
If you wish to report a security vulnerability privately, we appreciate your diligence. Please follow the guidelines below to submit your report.
|
||||
|
||||
## Reporting
|
||||
|
||||
To report a security vulnerability, please provide the following information:
|
||||
|
||||
1. **PUBLIC**
|
||||
- Indicate whether this vulnerability has already been publicly discussed or disclosed.
|
||||
- If so, provide relevant links.
|
||||
|
||||
2. **DESCRIPTION**
|
||||
- Provide a detailed description of the security vulnerability.
|
||||
- Include as much information as possible to help us understand and address the issue.
|
||||
|
||||
Report this, along with any additional relevant details in [GitHub Advisory](https://github.com/starship/starship/security/advisories/new).
|
||||
|
||||
## Confidentiality
|
||||
|
||||
We kindly ask you to keep the report confidential until a public announcement is made.
|
||||
|
||||
## Notes
|
||||
|
||||
- Vulnerabilities will be handled on a best-effort basis.
|
||||
- You will be notified, via your GitHub Advisory report, about eventual patches.
|
||||
- We will respond within a few weeks to confirm whether your report has been accepted or rejected.
|
||||
|
||||
Thank you for helping to improve the security of Starship!
|
||||
@@ -42,7 +42,7 @@ fn gen_presets_hook(mut file: &File) -> SdResult<()> {
|
||||
|
||||
writeln!(
|
||||
file,
|
||||
r#"
|
||||
r"
|
||||
use crate::print;
|
||||
|
||||
pub fn get_preset_list<'a>() -> &'a [print::Preset] {{
|
||||
@@ -57,7 +57,7 @@ pub fn get_preset_content(name: &str) -> &[u8] {{
|
||||
_ => unreachable!(),
|
||||
}}
|
||||
}}
|
||||
"#
|
||||
"
|
||||
)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
+8
-15
@@ -105,7 +105,7 @@ onMounted(() => {
|
||||
eval "$(starship init zsh)"
|
||||
```
|
||||
|
||||
#### Powershell
|
||||
#### PowerShell
|
||||
|
||||
Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
|
||||
|
||||
@@ -124,20 +124,17 @@ onMounted(() => {
|
||||
```
|
||||
|
||||
#### Elvish
|
||||
> [!WARNING]
|
||||
> Only elvish v0.18 or higher is supported.
|
||||
|
||||
::: warning
|
||||
|
||||
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
|
||||
|
||||
@@ -150,13 +147,9 @@ 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):
|
||||
|
||||
|
||||
@@ -4,11 +4,8 @@ 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
|
||||
|
||||
@@ -341,6 +338,316 @@ Note: Continuation prompts are only available in the following shells:
|
||||
continuation_prompt = '▶▶ '
|
||||
```
|
||||
|
||||
## Statusline for Claude Code
|
||||
|
||||
Starship supports displaying a custom statusline when running inside Claude Code, Anthropic's CLI tool for interactive coding with Claude. This statusline provides real-time information about your Claude session, including the model being used, context window usage, and session costs.
|
||||
|
||||
For more information about the Claude Code statusline feature, see the [Claude Code statusline documentation](https://code.claude.com/docs/en/statusline).
|
||||
|
||||
### Setup
|
||||
|
||||
To use Starship as your Claude Code statusline:
|
||||
|
||||
1. Run `/statusline` in Claude Code and ask it to configure Starship, or manually add the following to your `.claude/settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusLine": {
|
||||
"type": "command",
|
||||
"command": "starship statusline claude-code"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. Customize the statusline appearance in your `~/.config/starship.toml` (see [Configuration](#configuration) below)
|
||||
|
||||
### Overview
|
||||
|
||||
When invoked with `starship statusline claude-code`, Starship receives Claude Code session data via stdin and renders a statusline using a dedicated profile named `claude-code`.
|
||||
|
||||
The profile includes three specialized modules:
|
||||
|
||||
- `claude_model`: Displays the current Claude model being used
|
||||
- `claude_context`: Shows context window usage with a visual gauge
|
||||
- `claude_cost`: Displays session cost and statistics
|
||||
|
||||
The default profile format is:
|
||||
|
||||
```toml
|
||||
[profiles]
|
||||
claude-code = "$claude_model$git_branch$claude_context$claude_cost"
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
You can customize the Claude Code statusline by modifying the `claude-code` profile and individual module configurations in your `~/.config/starship.toml`:
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
# Customize the claude-code profile
|
||||
[profiles]
|
||||
claude-code = "$claude_model$claude_context$claude_cost"
|
||||
|
||||
# Configure individual modules
|
||||
[claude_model]
|
||||
format = "[$symbol$model]($style) "
|
||||
symbol = "🤖 "
|
||||
style = "bold blue"
|
||||
|
||||
[claude_context]
|
||||
format = "[$gauge $percentage]($style) "
|
||||
gauge_width = 10
|
||||
|
||||
[claude_cost]
|
||||
format = "[$symbol$cost]($style) "
|
||||
symbol = "💰 "
|
||||
```
|
||||
|
||||
### Claude Model
|
||||
|
||||
The `claude_model` module displays the current Claude model being used in the session.
|
||||
|
||||
#### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| --------------- | ---------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `format` | `'[$symbol$model]($style) '` | The format for the module. |
|
||||
| `symbol` | `'🤖 '` | The symbol shown before the model name. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `model_aliases` | `{}` | Map of model IDs or display names to shorter aliases. Checks ID first, then display name. |
|
||||
| `disabled` | `false` | Disables the `claude_model` module. |
|
||||
|
||||
#### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| -------- | ------------------- | ------------------------------------- |
|
||||
| model | `Claude 3.5 Sonnet` | The display name of the current model |
|
||||
| model_id | `claude-3-5-sonnet` | The model ID |
|
||||
| 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
|
||||
|
||||
#### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
# Basic customization
|
||||
[claude_model]
|
||||
format = "on [$symbol$model]($style) "
|
||||
symbol = "🧠 "
|
||||
style = "bold cyan"
|
||||
|
||||
# Using model aliases for vendor-specific model names
|
||||
# You can alias by model ID or display name
|
||||
[claude_model.model_aliases]
|
||||
# Alias by vendor model ID (e.g. AWS Bedrock)
|
||||
"global.anthropic.claude-sonnet-4-5-20250929-v1:0" = "Sonnet 4.5"
|
||||
# Alias by display name
|
||||
"Claude Sonnet 4.5 (Vendor Proxy)" = "Sonnet"
|
||||
```
|
||||
|
||||
### Claude Context
|
||||
|
||||
The `claude_context` module displays context window usage as a percentage and visual gauge. The style automatically changes based on configurable thresholds.
|
||||
|
||||
#### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------------- | --------------------------------- | -------------------------------------------------- |
|
||||
| `format` | `'[$gauge $percentage]($style) '` | The format for the module. |
|
||||
| `symbol` | `''` | The symbol shown before the gauge. |
|
||||
| `gauge_width` | `5` | The width of the gauge in characters. |
|
||||
| `gauge_full_symbol` | `'█'` | The symbol used for filled segments of the gauge. |
|
||||
| `gauge_partial_symbol` | `'▒'` | The symbol used for partial segments of the gauge. |
|
||||
| `gauge_empty_symbol` | `'░'` | The symbol used for empty segments of the gauge. |
|
||||
| `display` | [see below](#display) | Threshold and style configurations. |
|
||||
| `disabled` | `false` | Disables the `claude_context` module. |
|
||||
|
||||
##### Display
|
||||
|
||||
The `display` option is an array of objects that define thresholds and styles for different usage levels. The module uses the style from the highest matching threshold or hides the module if `hidden` is `true`.
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ------------ | ------------------------------------------------------------------------ |
|
||||
| `threshold` | `0.0` | The minimum context windows usage percentage to match this configuration |
|
||||
| `style` | `bold green` | The value of `style` if this display configuration is matched |
|
||||
| `hidden` | `false` | Hide this module if this the configuration is matched. |
|
||||
|
||||
```toml
|
||||
[[claude_context.display]]
|
||||
threshold = 0
|
||||
hidden = true
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 30
|
||||
style = "bold green"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 60
|
||||
style = "bold yellow"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 80
|
||||
style = "bold red"
|
||||
```
|
||||
|
||||
#### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| -------------------------- | ------- | ----------------------------------------------------- |
|
||||
| gauge | `██▒░░` | Visual representation of context usage |
|
||||
| percentage | `65%` | Context usage as a percentage |
|
||||
| input_tokens | `45.2k` | Total input tokens in conversation |
|
||||
| output_tokens | `12.3k` | Total output tokens in conversation |
|
||||
| curr_input_tokens | `5.1k` | Input tokens from most recent API call |
|
||||
| curr_output_tokens | `1.2k` | Output tokens from most recent API call |
|
||||
| curr_cache_creation_tokens | `1.5k` | Cache creation tokens from most recent API call |
|
||||
| curr_cache_read_tokens | `23.4k` | Cache read tokens from most recent API call |
|
||||
| total_tokens | `200k` | Total context window size |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
#### Examples
|
||||
|
||||
**Minimal gauge-only display**
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[claude_context]
|
||||
format = "[$gauge]($style) "
|
||||
gauge_width = 10
|
||||
```
|
||||
|
||||
**Detailed token information**
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[claude_context]
|
||||
format = "[$percentage ($input_tokens in / $output_tokens out)]($style) "
|
||||
```
|
||||
|
||||
**Custom gauge symbols**
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[claude_context]
|
||||
gauge_full_symbol = "▰"
|
||||
gauge_partial_symbol = ""
|
||||
gauge_empty_symbol = "▱"
|
||||
gauge_width = 10
|
||||
format = "[$gauge]($style) "
|
||||
```
|
||||
|
||||
**Custom thresholds**
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 0
|
||||
style = "bold green"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 50
|
||||
style = "bold yellow"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 75
|
||||
style = "bold orange"
|
||||
|
||||
[[claude_context.display]]
|
||||
threshold = 90
|
||||
style = "bold red"
|
||||
```
|
||||
|
||||
### Claude Cost
|
||||
|
||||
The `claude_cost` module displays the total cost of the current Claude Code session in USD. Like `claude_context`, it supports threshold-based styling.
|
||||
|
||||
#### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------- | -------------------------------- | ----------------------------------- |
|
||||
| `format` | `'[$symbol(\\$$cost)]($style) '` | The format for the module. |
|
||||
| `symbol` | `'💰 '` | The symbol shown before the cost. |
|
||||
| `display` | [see below](#display-1) | Threshold and style configurations. |
|
||||
| `disabled` | `false` | Disables the `claude_cost` module. |
|
||||
|
||||
##### Display
|
||||
|
||||
The `display` option is an array of objects that define cost thresholds and styles. The module uses the style from the highest matching threshold or hides the module if `hidden` is `true`.
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | ------------ | ------------------------------------------------------------- |
|
||||
| `threshold` | `0.0` | The minimum cost in USD to match this configuration |
|
||||
| `style` | `bold green` | The value of `style` if this display configuration is matched |
|
||||
| `hidden` | `false` | Hide this module if this configuration is matched. |
|
||||
|
||||
**Default configuration:**
|
||||
|
||||
```toml
|
||||
[[claude_cost.display]]
|
||||
threshold = 0.0
|
||||
hidden = true
|
||||
|
||||
[[claude_cost.display]]
|
||||
threshold = 1.0
|
||||
style = "bold yellow"
|
||||
|
||||
[[claude_cost.display]]
|
||||
threshold = 5.0
|
||||
style = "bold red"
|
||||
```
|
||||
|
||||
#### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------- | -------- | ----------------------------------------------------- |
|
||||
| cost | `1.23` | Total session cost in USD (formatted to 2 decimals) |
|
||||
| duration | `1m 30s` | Total session duration |
|
||||
| api_duration | `45s` | Total API call duration |
|
||||
| lines_added | `1.2k` | Total lines of code added |
|
||||
| lines_removed | `500` | Total lines of code removed |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
#### Examples
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
# Cost with code change statistics
|
||||
[claude_cost]
|
||||
format = "[$symbol$cost (+$lines_added -$lines_removed)]($style) "
|
||||
|
||||
# Hide module until cost exceeds $0.10
|
||||
[[claude_cost.display]]
|
||||
threshold = 0.0
|
||||
hidden = true
|
||||
|
||||
[[claude_cost.display]]
|
||||
threshold = 0.10
|
||||
style = "bold yellow"
|
||||
|
||||
[[claude_cost.display]]
|
||||
threshold = 2.0
|
||||
style = "bold red"
|
||||
|
||||
# Show duration information
|
||||
[claude_cost]
|
||||
format = "[$symbol$cost ($duration)]($style) "
|
||||
```
|
||||
|
||||
## Style Strings
|
||||
|
||||
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
|
||||
|
||||
+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
|
||||
|
||||
|
||||
+371
-192
@@ -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\
|
||||
@@ -328,6 +326,7 @@ $azure\
|
||||
$nats\
|
||||
$direnv\
|
||||
$env_var\
|
||||
$mise\
|
||||
$crystal\
|
||||
$custom\
|
||||
$sudo\
|
||||
@@ -339,6 +338,7 @@ $time\
|
||||
$status\
|
||||
$os\
|
||||
$container\
|
||||
$netns\
|
||||
$shell\
|
||||
$character"""
|
||||
```
|
||||
@@ -440,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 | الافتراضي | الوصف |
|
||||
@@ -618,7 +620,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Examples
|
||||
### مثال
|
||||
|
||||
#### Customize the format
|
||||
|
||||
@@ -629,15 +631,6 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
|
||||
format = 'via [🍔 $version](bold green) '
|
||||
```
|
||||
|
||||
#### Replace Node.js
|
||||
|
||||
You can override the `detect_files` property of [the nodejs module](#nodejs) in your config so as to only show the bun runtime:
|
||||
|
||||
```toml
|
||||
[nodejs]
|
||||
detect_files = ['package.json', '.node-version', '!bunfig.toml', '!bun.lockb']
|
||||
```
|
||||
|
||||
## C
|
||||
|
||||
The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file.
|
||||
@@ -665,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).
|
||||
|
||||
### مثال
|
||||
|
||||
@@ -684,6 +675,53 @@ If a C compiler is not supported by this module, you can request it by [raising
|
||||
format = 'via [$name $version]($style)'
|
||||
```
|
||||
|
||||
## CPP
|
||||
|
||||
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 | الافتراضي | الوصف |
|
||||
| ------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'C++ '` | The symbol used before displaying the compiler details |
|
||||
| `detect_extensions` | `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `commands` | `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `style` | `'bold 149'` | The style for the module. |
|
||||
| `disabled` | `true` | Disables the `cpp` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| -------- | ------- | ------------------------------------ |
|
||||
| name | clang++ | The name of the compiler |
|
||||
| version | 13.0.0 | The version of the compiler |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
### 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/issues/new/choose).
|
||||
|
||||
### مثال
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[cpp]
|
||||
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.
|
||||
@@ -695,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
|
||||
|
||||
@@ -815,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.
|
||||
|
||||
@@ -859,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
|
||||
|
||||
@@ -874,6 +902,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
|
||||
| `ignore_base` | `true` | Ignores `base` environment when activated. |
|
||||
| `detect_env_vars` | `["!PIXI_ENVIRONMENT_NAME"]` | Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. |
|
||||
| `disabled` | `false` | Disables the `conda` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1165,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 | الافتراضي | الوصف |
|
||||
@@ -1211,12 +1242,12 @@ 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_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. |
|
||||
@@ -1385,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
|
||||
|
||||
@@ -1555,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 Fortran. |
|
||||
| `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 | الافتراضي | الوصف |
|
||||
@@ -1595,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 | الافتراضي | الوصف |
|
||||
@@ -1718,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
|
||||
@@ -1825,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
|
||||
|
||||
@@ -1867,16 +1927,12 @@ 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
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| -------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
|
||||
| `conflicted` | `'='` | This branch has merge conflicts. |
|
||||
| `ahead` | `'⇡'` | The format of `ahead` |
|
||||
@@ -1884,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` |
|
||||
@@ -1894,6 +1950,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||||
| `disabled` | `false` | Disables the `git_status` module. |
|
||||
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
|
||||
| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -2350,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
|
||||
|
||||
@@ -2386,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
|
||||
@@ -2397,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:
|
||||
@@ -2488,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 | الافتراضي | الوصف |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2624,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 | الافتراضي | الوصف |
|
||||
@@ -2700,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
|
||||
|
||||
@@ -2784,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 | الافتراضي | الوصف |
|
||||
@@ -2817,6 +2866,78 @@ 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 | الافتراضي | الوصف |
|
||||
| ------------------- | -------------------------------------------------------------------- | ------------------------------------------------ |
|
||||
| `symbol` | `'mise '` | The symbol used before displaying _mise_ health. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `format` | `'on [$symbol$health]($style) '` | The format for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.mise']` | Which folders should trigger this module. |
|
||||
| `healthy_symbol` | `healthy` | The message displayed when _mise_ is healthy. |
|
||||
| `unhealthy_symbol` | `unhealthy` | The message displayed when _mise_ is unhealthy. |
|
||||
| `disabled` | `true` | Disables the `mise` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| health | `healthy` | The health of _mise_ |
|
||||
| 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
|
||||
|
||||
### مثال
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[mise]
|
||||
health = 'ready'
|
||||
```
|
||||
|
||||
## Mojo
|
||||
|
||||
The `mojo` module shows the current version of [Mojo programming language](https://www.modular.com/mojo) installed
|
||||
@@ -2881,6 +3002,37 @@ format = '[$symbol]($style)'
|
||||
style = 'bold purple'
|
||||
```
|
||||
|
||||
## Network Namespace
|
||||
|
||||
The `netns` module shows the current network namespace. This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `/var/run/netns` will be detected.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| ---------- | --------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'[$symbol \[$name\]]($style)'` | The format for the module. |
|
||||
| `symbol` | `'🛜 '` | The symbol used before the network namespace (defaults to empty). |
|
||||
| `style` | `'blue bold dimmed'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `netns` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| --------- | ---------- | ----------------------------------------- |
|
||||
| name | `my-netns` | The name of the current network namespace |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### مثال
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[netns]
|
||||
style = 'bold yellow'
|
||||
symbol = '🌐 '
|
||||
```
|
||||
|
||||
## Nim
|
||||
|
||||
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2975,6 +3127,8 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
|
||||
- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension
|
||||
|
||||
Additionally, the module will be hidden by default if the directory contains a `bunfig.toml`, `bun.lock`, or `bun.lockb` file, overriding the above conditions.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
@@ -3063,10 +3217,10 @@ 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. |
|
||||
| `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. |
|
||||
@@ -3168,17 +3322,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
|
||||
|
||||
@@ -3198,14 +3344,18 @@ AIX = "➿ "
|
||||
Alpaquita = "🔔 "
|
||||
AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
ALTLinux = "Ⓐ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
CachyOS = "🎗️ "
|
||||
CentOS = "💠 "
|
||||
Debian = "🌀 "
|
||||
DragonFly = "🐉 "
|
||||
Elementary = "🍏 "
|
||||
Emscripten = "🔗 "
|
||||
EndeavourOS = "🚀 "
|
||||
Fedora = "🎩 "
|
||||
@@ -3214,6 +3364,8 @@ Garuda = "🦅 "
|
||||
Gentoo = "🗜️ "
|
||||
HardenedBSD = "🛡️ "
|
||||
Illumos = "🐦 "
|
||||
Ios = "📱 "
|
||||
InstantOS = "⏲️ "
|
||||
Kali = "🐉 "
|
||||
Linux = "🐧 "
|
||||
Mabox = "📦 "
|
||||
@@ -3230,6 +3382,7 @@ OpenCloudOS = "☁️ "
|
||||
openEuler = "🦉 "
|
||||
openSUSE = "🦎 "
|
||||
OracleLinux = "🦴 "
|
||||
PikaOS = "🐤 "
|
||||
Pop = "🍭 "
|
||||
Raspbian = "🍓 "
|
||||
Redhat = "🎩 "
|
||||
@@ -3244,6 +3397,7 @@ Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
Zorin = "🔹 "
|
||||
```
|
||||
|
||||
### Variables
|
||||
@@ -3277,9 +3431,10 @@ 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
|
||||
- [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
@@ -3292,6 +3447,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
|
||||
@@ -3413,6 +3569,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 | الافتراضي | الوصف |
|
||||
@@ -3424,15 +3582,50 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `pijul` module. |
|
||||
|
||||
## Pixi
|
||||
|
||||
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 shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| -------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `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. |
|
||||
| `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` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | مثال | الوصف |
|
||||
| ----------- | --------- | ------------------------------------ |
|
||||
| version | `v0.33.0` | The version of `pixi` |
|
||||
| environment | `py311` | The current pixi environment |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
### مثال
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[pixi]
|
||||
format = '[$symbol$environment](yellow) '
|
||||
```
|
||||
|
||||
## Pulumi
|
||||
|
||||
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:
|
||||
|
||||
@@ -3538,7 +3731,6 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a `requirements.txt` file
|
||||
- The current directory contains a `setup.py` file
|
||||
- The current directory contains a `tox.ini` file
|
||||
- The current directory contains a `pixi.toml` file
|
||||
- The current directory contains a file with the `.py` extension.
|
||||
- The current directory contains a file with the `.ipynb` extension.
|
||||
- A virtual environment is currently activated
|
||||
@@ -3546,26 +3738,22 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
### Options
|
||||
|
||||
| Option | الافتراضي | الوصف |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `['py', 'ipynb']` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini', 'pixi.toml']` | Which filenames should trigger this module |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
|
||||
| `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
|
||||
|
||||
@@ -3883,11 +4071,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
|
||||
|
||||
@@ -3935,6 +4119,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 | الافتراضي | الوصف |
|
||||
@@ -3975,11 +4161,10 @@ Using `repeat` and `repeat_offset` along with `character` module, one can get pr
|
||||
|
||||
[shlvl]
|
||||
disabled = false
|
||||
format = '[$symbol$shlvl]($style)'
|
||||
format = '[$symbol]($style)'
|
||||
repeat = true
|
||||
symbol = '❯'
|
||||
repeat_offset = 1
|
||||
threshold = 0
|
||||
```
|
||||
|
||||
## Singularity
|
||||
@@ -4089,11 +4274,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
|
||||
|
||||
@@ -4152,11 +4333,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
|
||||
|
||||
@@ -4238,13 +4415,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:
|
||||
|
||||
@@ -4254,7 +4427,7 @@ 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. |
|
||||
@@ -4263,6 +4436,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `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
|
||||
|
||||
@@ -4283,7 +4457,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
|
||||
@@ -4292,18 +4466,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
|
||||
|
||||
@@ -4384,11 +4554,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
|
||||
|
||||
@@ -4531,6 +4697,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:
|
||||
@@ -4581,31 +4776,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
|
||||
|
||||
@@ -4655,17 +4836,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.
|
||||
|
||||
### مثال
|
||||
|
||||
|
||||
@@ -229,10 +229,13 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
| 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` |
|
||||
| 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` |
|
||||
|
||||
</details>
|
||||
@@ -303,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>
|
||||
|
||||
@@ -405,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/).
|
||||
|
||||
|
||||
@@ -23,16 +23,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### المتطلبات الأساسية
|
||||
|
||||
```sh
|
||||
pkg install getconf
|
||||
```
|
||||
|
||||
### التثبيت
|
||||
|
||||
```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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -75,3 +71,9 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an
|
||||
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||
|
||||
[](./jetpack)
|
||||
|
||||
## [Catppuccin Powerline](./catppuccin-powerline.md)
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||
[](./catppuccin-powerline)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||

|
||||
|
||||
### المتطلبات الأساسية
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
|
||||
### Configuration
|
||||
|
||||
```sh
|
||||
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`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/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
|
||||
|
||||
|
||||
+371
-192
@@ -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\
|
||||
@@ -328,6 +326,7 @@ $azure\
|
||||
$nats\
|
||||
$direnv\
|
||||
$env_var\
|
||||
$mise\
|
||||
$crystal\
|
||||
$custom\
|
||||
$sudo\
|
||||
@@ -339,6 +338,7 @@ $time\
|
||||
$status\
|
||||
$os\
|
||||
$container\
|
||||
$netns\
|
||||
$shell\
|
||||
$character"""
|
||||
```
|
||||
@@ -440,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 |
|
||||
@@ -618,7 +620,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Examples
|
||||
### Example
|
||||
|
||||
#### Customize the format
|
||||
|
||||
@@ -629,15 +631,6 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
|
||||
format = 'via [🍔 $version](bold green) '
|
||||
```
|
||||
|
||||
#### Replace Node.js
|
||||
|
||||
You can override the `detect_files` property of [the nodejs module](#nodejs) in your config so as to only show the bun runtime:
|
||||
|
||||
```toml
|
||||
[nodejs]
|
||||
detect_files = ['package.json', '.node-version', '!bunfig.toml', '!bun.lockb']
|
||||
```
|
||||
|
||||
## C
|
||||
|
||||
The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file.
|
||||
@@ -665,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
|
||||
|
||||
@@ -684,6 +675,53 @@ If a C compiler is not supported by this module, you can request it by [raising
|
||||
format = 'via [$name $version]($style)'
|
||||
```
|
||||
|
||||
## CPP
|
||||
|
||||
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 |
|
||||
| ------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'C++ '` | The symbol used before displaying the compiler details |
|
||||
| `detect_extensions` | `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `commands` | `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `style` | `'bold 149'` | The style for the module. |
|
||||
| `disabled` | `true` | Disables the `cpp` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| -------- | ------- | ------------------------------------ |
|
||||
| name | clang++ | The name of the compiler |
|
||||
| version | 13.0.0 | The version of the compiler |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
### 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/issues/new/choose).
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[cpp]
|
||||
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.
|
||||
@@ -695,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
|
||||
|
||||
@@ -815,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.
|
||||
|
||||
@@ -859,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
|
||||
|
||||
@@ -874,6 +902,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
|
||||
| `ignore_base` | `true` | Ignores `base` environment when activated. |
|
||||
| `detect_env_vars` | `["!PIXI_ENVIRONMENT_NAME"]` | Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. |
|
||||
| `disabled` | `false` | Disables the `conda` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1165,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 |
|
||||
@@ -1211,12 +1242,12 @@ 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_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. |
|
||||
@@ -1385,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
|
||||
|
||||
@@ -1555,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 Fortran. |
|
||||
| `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 |
|
||||
@@ -1595,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 |
|
||||
@@ -1718,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
|
||||
@@ -1825,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
|
||||
|
||||
@@ -1867,16 +1927,12 @@ 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
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| -------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
|
||||
| `conflicted` | `'='` | This branch has merge conflicts. |
|
||||
| `ahead` | `'⇡'` | The format of `ahead` |
|
||||
@@ -1884,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` |
|
||||
@@ -1894,6 +1950,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||||
| `disabled` | `false` | Disables the `git_status` module. |
|
||||
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
|
||||
| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -2350,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
|
||||
|
||||
@@ -2386,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
|
||||
@@ -2397,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:
|
||||
@@ -2488,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 |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2624,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 |
|
||||
@@ -2700,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
|
||||
|
||||
@@ -2784,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 |
|
||||
@@ -2817,6 +2866,78 @@ 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 |
|
||||
| ------------------- | -------------------------------------------------------------------- | ------------------------------------------------ |
|
||||
| `symbol` | `'mise '` | The symbol used before displaying _mise_ health. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `format` | `'on [$symbol$health]($style) '` | The format for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.mise']` | Which folders should trigger this module. |
|
||||
| `healthy_symbol` | `healthy` | The message displayed when _mise_ is healthy. |
|
||||
| `unhealthy_symbol` | `unhealthy` | The message displayed when _mise_ is unhealthy. |
|
||||
| `disabled` | `true` | Disables the `mise` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| health | `healthy` | The health of _mise_ |
|
||||
| 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
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[mise]
|
||||
health = 'ready'
|
||||
```
|
||||
|
||||
## Mojo
|
||||
|
||||
The `mojo` module shows the current version of [Mojo programming language](https://www.modular.com/mojo) installed
|
||||
@@ -2881,6 +3002,37 @@ format = '[$symbol]($style)'
|
||||
style = 'bold purple'
|
||||
```
|
||||
|
||||
## Network Namespace
|
||||
|
||||
The `netns` module shows the current network namespace. This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `/var/run/netns` will be detected.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------- | --------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'[$symbol \[$name\]]($style)'` | The format for the module. |
|
||||
| `symbol` | `'🛜 '` | The symbol used before the network namespace (defaults to empty). |
|
||||
| `style` | `'blue bold dimmed'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `netns` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ---------- | ----------------------------------------- |
|
||||
| name | `my-netns` | The name of the current network namespace |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[netns]
|
||||
style = 'bold yellow'
|
||||
symbol = '🌐 '
|
||||
```
|
||||
|
||||
## Nim
|
||||
|
||||
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2975,6 +3127,8 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
|
||||
- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension
|
||||
|
||||
Additionally, the module will be hidden by default if the directory contains a `bunfig.toml`, `bun.lock`, or `bun.lockb` file, overriding the above conditions.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3063,10 +3217,10 @@ 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. |
|
||||
| `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. |
|
||||
@@ -3168,17 +3322,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
|
||||
|
||||
@@ -3198,14 +3344,18 @@ AIX = "➿ "
|
||||
Alpaquita = "🔔 "
|
||||
AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
ALTLinux = "Ⓐ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
CachyOS = "🎗️ "
|
||||
CentOS = "💠 "
|
||||
Debian = "🌀 "
|
||||
DragonFly = "🐉 "
|
||||
Elementary = "🍏 "
|
||||
Emscripten = "🔗 "
|
||||
EndeavourOS = "🚀 "
|
||||
Fedora = "🎩 "
|
||||
@@ -3214,6 +3364,8 @@ Garuda = "🦅 "
|
||||
Gentoo = "🗜️ "
|
||||
HardenedBSD = "🛡️ "
|
||||
Illumos = "🐦 "
|
||||
Ios = "📱 "
|
||||
InstantOS = "⏲️ "
|
||||
Kali = "🐉 "
|
||||
Linux = "🐧 "
|
||||
Mabox = "📦 "
|
||||
@@ -3230,6 +3382,7 @@ OpenCloudOS = "☁️ "
|
||||
openEuler = "🦉 "
|
||||
openSUSE = "🦎 "
|
||||
OracleLinux = "🦴 "
|
||||
PikaOS = "🐤 "
|
||||
Pop = "🍭 "
|
||||
Raspbian = "🍓 "
|
||||
Redhat = "🎩 "
|
||||
@@ -3244,6 +3397,7 @@ Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
Zorin = "🔹 "
|
||||
```
|
||||
|
||||
### Variables
|
||||
@@ -3277,9 +3431,10 @@ 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
|
||||
- [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
@@ -3292,6 +3447,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
|
||||
@@ -3413,6 +3569,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 |
|
||||
@@ -3424,15 +3582,50 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `pijul` module. |
|
||||
|
||||
## Pixi
|
||||
|
||||
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 shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `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. |
|
||||
| `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` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ----------- | --------- | ------------------------------------ |
|
||||
| version | `v0.33.0` | The version of `pixi` |
|
||||
| environment | `py311` | The current pixi environment |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[pixi]
|
||||
format = '[$symbol$environment](yellow) '
|
||||
```
|
||||
|
||||
## Pulumi
|
||||
|
||||
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:
|
||||
|
||||
@@ -3538,7 +3731,6 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a `requirements.txt` file
|
||||
- The current directory contains a `setup.py` file
|
||||
- The current directory contains a `tox.ini` file
|
||||
- The current directory contains a `pixi.toml` file
|
||||
- The current directory contains a file with the `.py` extension.
|
||||
- The current directory contains a file with the `.ipynb` extension.
|
||||
- A virtual environment is currently activated
|
||||
@@ -3546,26 +3738,22 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `['py', 'ipynb']` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini', 'pixi.toml']` | Which filenames should trigger this module |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
|
||||
| `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
|
||||
|
||||
@@ -3883,11 +4071,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
|
||||
|
||||
@@ -3935,6 +4119,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 |
|
||||
@@ -3975,11 +4161,10 @@ Using `repeat` and `repeat_offset` along with `character` module, one can get pr
|
||||
|
||||
[shlvl]
|
||||
disabled = false
|
||||
format = '[$symbol$shlvl]($style)'
|
||||
format = '[$symbol]($style)'
|
||||
repeat = true
|
||||
symbol = '❯'
|
||||
repeat_offset = 1
|
||||
threshold = 0
|
||||
```
|
||||
|
||||
## Singularity
|
||||
@@ -4089,11 +4274,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
|
||||
|
||||
@@ -4152,11 +4333,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
|
||||
|
||||
@@ -4238,13 +4415,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:
|
||||
|
||||
@@ -4254,7 +4427,7 @@ 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. |
|
||||
@@ -4263,6 +4436,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `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
|
||||
|
||||
@@ -4283,7 +4457,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
|
||||
@@ -4292,18 +4466,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
|
||||
|
||||
@@ -4384,11 +4554,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
|
||||
|
||||
@@ -4531,6 +4697,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:
|
||||
@@ -4581,31 +4776,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
|
||||
|
||||
@@ -4655,17 +4836,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
|
||||
|
||||
|
||||
@@ -229,10 +229,13 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
| 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` |
|
||||
| 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` |
|
||||
|
||||
</details>
|
||||
@@ -303,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>
|
||||
|
||||
@@ -345,7 +348,7 @@ mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
Note: Only Nushell v0.96+ is supported
|
||||
বিঃদ্রঃ শুধুমাত্র Nushell v0.96+ কাজ করবে ।
|
||||
|
||||
</details>
|
||||
|
||||
@@ -405,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/) পেইজ এ গিয়ে আপনার অনুবাদ গুলি যোগ করতে পারবেন ।
|
||||
|
||||
|
||||
@@ -23,16 +23,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### পূর্বশর্ত
|
||||
|
||||
```sh
|
||||
pkg install getconf
|
||||
```
|
||||
|
||||
### ইন্সটল
|
||||
|
||||
```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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -75,3 +71,9 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an
|
||||
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||
|
||||
[](./jetpack)
|
||||
|
||||
## [Catppuccin Powerline](./catppuccin-powerline.md)
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||
[](./catppuccin-powerline)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||

|
||||
|
||||
### পূর্বশর্ত
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
|
||||
### Configuration
|
||||
|
||||
```sh
|
||||
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`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/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
|
||||
|
||||
|
||||
+371
-192
@@ -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\
|
||||
@@ -328,6 +326,7 @@ $azure\
|
||||
$nats\
|
||||
$direnv\
|
||||
$env_var\
|
||||
$mise\
|
||||
$crystal\
|
||||
$custom\
|
||||
$sudo\
|
||||
@@ -339,6 +338,7 @@ $time\
|
||||
$status\
|
||||
$os\
|
||||
$container\
|
||||
$netns\
|
||||
$shell\
|
||||
$character"""
|
||||
```
|
||||
@@ -440,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 |
|
||||
@@ -618,7 +620,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Examples
|
||||
### نموونە
|
||||
|
||||
#### Customize the format
|
||||
|
||||
@@ -629,15 +631,6 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
|
||||
format = 'via [🍔 $version](bold green) '
|
||||
```
|
||||
|
||||
#### Replace Node.js
|
||||
|
||||
You can override the `detect_files` property of [the nodejs module](#nodejs) in your config so as to only show the bun runtime:
|
||||
|
||||
```toml
|
||||
[nodejs]
|
||||
detect_files = ['package.json', '.node-version', '!bunfig.toml', '!bun.lockb']
|
||||
```
|
||||
|
||||
## C
|
||||
|
||||
The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file.
|
||||
@@ -665,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).
|
||||
|
||||
### نموونە
|
||||
|
||||
@@ -684,6 +675,53 @@ If a C compiler is not supported by this module, you can request it by [raising
|
||||
format = 'via [$name $version]($style)'
|
||||
```
|
||||
|
||||
## CPP
|
||||
|
||||
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 |
|
||||
| ------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'C++ '` | The symbol used before displaying the compiler details |
|
||||
| `detect_extensions` | `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `commands` | `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `style` | `'bold 149'` | The style for the module. |
|
||||
| `disabled` | `true` | Disables the `cpp` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| ------- | ------- | ------------------------------------ |
|
||||
| name | clang++ | The name of the compiler |
|
||||
| version | 13.0.0 | The version of the compiler |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
### 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/issues/new/choose).
|
||||
|
||||
### نموونە
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[cpp]
|
||||
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.
|
||||
@@ -695,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
|
||||
|
||||
@@ -815,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.
|
||||
|
||||
@@ -859,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
|
||||
|
||||
@@ -874,6 +902,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
|
||||
| `ignore_base` | `true` | Ignores `base` environment when activated. |
|
||||
| `detect_env_vars` | `["!PIXI_ENVIRONMENT_NAME"]` | Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. |
|
||||
| `disabled` | `false` | Disables the `conda` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1165,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 |
|
||||
@@ -1211,12 +1242,12 @@ 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_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. |
|
||||
@@ -1385,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
|
||||
|
||||
@@ -1555,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 Fortran. |
|
||||
| `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 |
|
||||
@@ -1595,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 |
|
||||
@@ -1718,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
|
||||
@@ -1825,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
|
||||
|
||||
@@ -1867,16 +1927,12 @@ 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
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| -------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
|
||||
| `conflicted` | `'='` | This branch has merge conflicts. |
|
||||
| `ahead` | `'⇡'` | The format of `ahead` |
|
||||
@@ -1884,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` |
|
||||
@@ -1894,6 +1950,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||||
| `disabled` | `false` | Disables the `git_status` module. |
|
||||
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
|
||||
| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -2350,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
|
||||
|
||||
@@ -2386,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
|
||||
@@ -2397,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:
|
||||
@@ -2488,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 |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2624,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 |
|
||||
@@ -2700,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
|
||||
|
||||
@@ -2784,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 |
|
||||
@@ -2817,6 +2866,78 @@ 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 |
|
||||
| ------------------- | -------------------------------------------------------------------- | ------------------------------------------------ |
|
||||
| `symbol` | `'mise '` | The symbol used before displaying _mise_ health. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `format` | `'on [$symbol$health]($style) '` | The format for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.mise']` | Which folders should trigger this module. |
|
||||
| `healthy_symbol` | `healthy` | The message displayed when _mise_ is healthy. |
|
||||
| `unhealthy_symbol` | `unhealthy` | The message displayed when _mise_ is unhealthy. |
|
||||
| `disabled` | `true` | Disables the `mise` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| health | `healthy` | The health of _mise_ |
|
||||
| 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
|
||||
|
||||
### نموونە
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[mise]
|
||||
health = 'ready'
|
||||
```
|
||||
|
||||
## Mojo
|
||||
|
||||
The `mojo` module shows the current version of [Mojo programming language](https://www.modular.com/mojo) installed
|
||||
@@ -2881,6 +3002,37 @@ format = '[$symbol]($style)'
|
||||
style = 'bold purple'
|
||||
```
|
||||
|
||||
## Network Namespace
|
||||
|
||||
The `netns` module shows the current network namespace. This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `/var/run/netns` will be detected.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------- | --------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'[$symbol \[$name\]]($style)'` | The format for the module. |
|
||||
| `symbol` | `'🛜 '` | The symbol used before the network namespace (defaults to empty). |
|
||||
| `style` | `'blue bold dimmed'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `netns` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| --------- | ---------- | ----------------------------------------- |
|
||||
| name | `my-netns` | The name of the current network namespace |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### نموونە
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[netns]
|
||||
style = 'bold yellow'
|
||||
symbol = '🌐 '
|
||||
```
|
||||
|
||||
## Nim
|
||||
|
||||
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2975,6 +3127,8 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
|
||||
- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension
|
||||
|
||||
Additionally, the module will be hidden by default if the directory contains a `bunfig.toml`, `bun.lock`, or `bun.lockb` file, overriding the above conditions.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
@@ -3063,10 +3217,10 @@ 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. |
|
||||
| `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. |
|
||||
@@ -3168,17 +3322,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
|
||||
|
||||
@@ -3198,14 +3344,18 @@ AIX = "➿ "
|
||||
Alpaquita = "🔔 "
|
||||
AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
ALTLinux = "Ⓐ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
CachyOS = "🎗️ "
|
||||
CentOS = "💠 "
|
||||
Debian = "🌀 "
|
||||
DragonFly = "🐉 "
|
||||
Elementary = "🍏 "
|
||||
Emscripten = "🔗 "
|
||||
EndeavourOS = "🚀 "
|
||||
Fedora = "🎩 "
|
||||
@@ -3214,6 +3364,8 @@ Garuda = "🦅 "
|
||||
Gentoo = "🗜️ "
|
||||
HardenedBSD = "🛡️ "
|
||||
Illumos = "🐦 "
|
||||
Ios = "📱 "
|
||||
InstantOS = "⏲️ "
|
||||
Kali = "🐉 "
|
||||
Linux = "🐧 "
|
||||
Mabox = "📦 "
|
||||
@@ -3230,6 +3382,7 @@ OpenCloudOS = "☁️ "
|
||||
openEuler = "🦉 "
|
||||
openSUSE = "🦎 "
|
||||
OracleLinux = "🦴 "
|
||||
PikaOS = "🐤 "
|
||||
Pop = "🍭 "
|
||||
Raspbian = "🍓 "
|
||||
Redhat = "🎩 "
|
||||
@@ -3244,6 +3397,7 @@ Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
Zorin = "🔹 "
|
||||
```
|
||||
|
||||
### Variables
|
||||
@@ -3277,9 +3431,10 @@ 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
|
||||
- [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
@@ -3292,6 +3447,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
|
||||
@@ -3413,6 +3569,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 |
|
||||
@@ -3424,15 +3582,50 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `pijul` module. |
|
||||
|
||||
## Pixi
|
||||
|
||||
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 shell.change-ps1 false`.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `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. |
|
||||
| `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` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| گۆڕاو | نموونە | Description |
|
||||
| ----------- | --------- | ------------------------------------ |
|
||||
| version | `v0.33.0` | The version of `pixi` |
|
||||
| environment | `py311` | The current pixi environment |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
### نموونە
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[pixi]
|
||||
format = '[$symbol$environment](yellow) '
|
||||
```
|
||||
|
||||
## Pulumi
|
||||
|
||||
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:
|
||||
|
||||
@@ -3538,7 +3731,6 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a `requirements.txt` file
|
||||
- The current directory contains a `setup.py` file
|
||||
- The current directory contains a `tox.ini` file
|
||||
- The current directory contains a `pixi.toml` file
|
||||
- The current directory contains a file with the `.py` extension.
|
||||
- The current directory contains a file with the `.ipynb` extension.
|
||||
- A virtual environment is currently activated
|
||||
@@ -3546,26 +3738,22 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
|
||||
| `style` | `'yellow bold'` | The style for the module. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `['py', 'ipynb']` | Which extensions should trigger this module |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini', 'pixi.toml']` | Which filenames should trigger this module |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |
|
||||
| `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
|
||||
|
||||
@@ -3883,11 +4071,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
|
||||
|
||||
@@ -3935,6 +4119,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 |
|
||||
@@ -3975,11 +4161,10 @@ Using `repeat` and `repeat_offset` along with `character` module, one can get pr
|
||||
|
||||
[shlvl]
|
||||
disabled = false
|
||||
format = '[$symbol$shlvl]($style)'
|
||||
format = '[$symbol]($style)'
|
||||
repeat = true
|
||||
symbol = '❯'
|
||||
repeat_offset = 1
|
||||
threshold = 0
|
||||
```
|
||||
|
||||
## Singularity
|
||||
@@ -4089,11 +4274,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
|
||||
|
||||
@@ -4152,11 +4333,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
|
||||
|
||||
@@ -4238,13 +4415,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:
|
||||
|
||||
@@ -4254,7 +4427,7 @@ 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. |
|
||||
@@ -4263,6 +4436,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `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
|
||||
|
||||
@@ -4283,7 +4457,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
|
||||
@@ -4292,18 +4466,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
|
||||
|
||||
@@ -4384,11 +4554,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
|
||||
|
||||
@@ -4531,6 +4697,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:
|
||||
@@ -4581,31 +4776,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
|
||||
|
||||
@@ -4655,17 +4836,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.
|
||||
|
||||
### نموونە
|
||||
|
||||
|
||||
@@ -225,10 +225,13 @@ Alternatively, install Starship using any of the following package managers:
|
||||
| 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` |
|
||||
| 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` |
|
||||
|
||||
</details>
|
||||
@@ -299,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>
|
||||
|
||||
@@ -401,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/).
|
||||
|
||||
|
||||
@@ -23,16 +23,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### پێشمەرجەکان
|
||||
|
||||
```sh
|
||||
pkg install getconf
|
||||
```
|
||||
|
||||
### دامەزراندن
|
||||
|
||||
```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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -75,3 +71,9 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an
|
||||
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||
|
||||
[](./jetpack)
|
||||
|
||||
## [Catppuccin Powerline](./catppuccin-powerline.md)
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||
[](./catppuccin-powerline)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||

|
||||
|
||||
### پێشمەرجەکان
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
|
||||
### ڕێکخستن
|
||||
|
||||
```sh
|
||||
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`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/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
|
||||
|
||||
|
||||
+492
-287
File diff suppressed because it is too large
Load Diff
+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. Only Nushell v0.96+ is supported.
|
||||
|
||||
:::
|
||||
> [!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
|
||||
|
||||
|
||||
+374
-195
File diff suppressed because it is too large
Load Diff
+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
|
||||
|
||||
@@ -229,10 +229,13 @@ Alternatively, install Starship using any of the following package managers:
|
||||
| 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` |
|
||||
| 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` |
|
||||
|
||||
</details>
|
||||
@@ -303,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>
|
||||
|
||||
@@ -345,7 +348,7 @@ mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
Note: Only Nushell v0.96+ is supported
|
||||
Beachte: Nushell wird erst ab v0.96+ unterstützt
|
||||
|
||||
</details>
|
||||
|
||||
@@ -405,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/).
|
||||
|
||||
|
||||
@@ -23,16 +23,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
```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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -75,3 +71,9 @@ Diese Voreinstellung ist stark inspiriert von [Pastel Powerline](./pastel-powerl
|
||||
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||
|
||||
[](./jetpack)
|
||||
|
||||
## [Catppuccin Powerline](./catppuccin-powerline.md)
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||
[](./catppuccin-powerline)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||

|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
|
||||
### Konfiguration
|
||||
|
||||
```sh
|
||||
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`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/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. 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):
|
||||
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.
|
||||
|
||||
|
||||
+387
-208
File diff suppressed because it is too large
Load Diff
+20
-16
@@ -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>
|
||||
|
||||
@@ -222,17 +222,20 @@ 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` |
|
||||
| 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/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 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>
|
||||
@@ -274,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:
|
||||
|
||||
@@ -303,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>
|
||||
|
||||
@@ -338,14 +341,15 @@ 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")
|
||||
|
||||
```
|
||||
|
||||
Note: Only Nushell v0.96+ is supported
|
||||
Nota: Sólo se admite Nushell v0.96+
|
||||
|
||||
</details>
|
||||
|
||||
@@ -405,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/).
|
||||
|
||||
@@ -425,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>
|
||||
|
||||
@@ -23,16 +23,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### Prerequisitos
|
||||
|
||||
```sh
|
||||
pkg install getconf
|
||||
```
|
||||
|
||||
### Instalación
|
||||
|
||||
```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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -75,3 +71,9 @@ Este preajuste está muy inspirado en [Pastel Powerline](./pastel-powerline.md)
|
||||
Este es un preajuste pseudominimalista inspirado en las indicaciones [geometría](https://github.com/geometry-zsh/geometry) y [nave espacial](https://github.com/spaceship-prompt/spaceship-prompt).
|
||||
|
||||
[](./jetpack)
|
||||
|
||||
## [Catppuccin Powerline](./catppuccin-powerline.md)
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||
[](./catppuccin-powerline)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||

|
||||
|
||||
### Prerequisitos
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
|
||||
### Configuración
|
||||
|
||||
```sh
|
||||
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`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/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. 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):
|
||||
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
|
||||
|
||||
|
||||
+376
-197
File diff suppressed because it is too large
Load Diff
@@ -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
|
||||
@@ -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,13 @@ 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 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` |
|
||||
|
||||
</details>
|
||||
@@ -260,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:
|
||||
|
||||
@@ -274,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:
|
||||
|
||||
@@ -303,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>
|
||||
|
||||
@@ -338,14 +341,14 @@ 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")
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
Note: Only Nushell v0.96+ is supported
|
||||
Note: Seul Nushell v0.96+ est supporté
|
||||
|
||||
</details>
|
||||
|
||||
@@ -405,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/).
|
||||
|
||||
|
||||
@@ -23,16 +23,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### Pré-requis
|
||||
|
||||
```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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -75,3 +71,9 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an
|
||||
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||
|
||||
[](./jetpack)
|
||||
|
||||
## [Catppuccin Powerline](./catppuccin-powerline.md)
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||
[](./catppuccin-powerline)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||

|
||||
|
||||
### Pré-requis
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
|
||||
### Configuration
|
||||
|
||||
```sh
|
||||
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`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/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. Only Nushell v0.96+ is supported.
|
||||
|
||||
:::
|
||||
> [!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
|
||||
|
||||
|
||||
+379
-200
File diff suppressed because it is too large
Load Diff
@@ -229,10 +229,13 @@ Alternatively, install Starship using any of the following package managers:
|
||||
| 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` |
|
||||
| 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` |
|
||||
|
||||
</details>
|
||||
@@ -303,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>
|
||||
|
||||
@@ -405,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/).
|
||||
|
||||
|
||||
@@ -23,16 +23,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### Prasyarat
|
||||
|
||||
```sh
|
||||
pkg install getconf
|
||||
```
|
||||
|
||||
### Pemasangan
|
||||
|
||||
```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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -75,3 +71,9 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an
|
||||
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||
|
||||
[](./jetpack)
|
||||
|
||||
## [Catppuccin Powerline](./catppuccin-powerline.md)
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||
[](./catppuccin-powerline)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||

|
||||
|
||||
### Prasyarat
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
|
||||
### Konfigurasi
|
||||
|
||||
```sh
|
||||
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`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/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)
|
||||
|
||||
+5
-12
@@ -58,7 +58,7 @@ onMounted(() => {
|
||||
Con Shell:
|
||||
|
||||
```sh
|
||||
curl -sS https://starship.rs/install.sh | sh
|
||||
curl -sS https://starship.rs/install.sh <unk> sh
|
||||
```
|
||||
|
||||
Per aggiornare Starship stesso, riavviare lo script sopra. Sostituirà la versione corrente senza toccare la configurazione di Starship.
|
||||
@@ -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
|
||||
|
||||
|
||||
+371
-192
@@ -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\
|
||||
@@ -328,6 +326,7 @@ $azure\
|
||||
$nats\
|
||||
$direnv\
|
||||
$env_var\
|
||||
$mise\
|
||||
$crystal\
|
||||
$custom\
|
||||
$sudo\
|
||||
@@ -339,6 +338,7 @@ $time\
|
||||
$status\
|
||||
$os\
|
||||
$container\
|
||||
$netns\
|
||||
$shell\
|
||||
$character"""
|
||||
```
|
||||
@@ -440,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 |
|
||||
@@ -618,7 +620,7 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Examples
|
||||
### Esempio
|
||||
|
||||
#### Customize the format
|
||||
|
||||
@@ -629,15 +631,6 @@ The `bun` module shows the currently installed version of the [bun](https://bun.
|
||||
format = 'via [🍔 $version](bold green) '
|
||||
```
|
||||
|
||||
#### Replace Node.js
|
||||
|
||||
You can override the `detect_files` property of [the nodejs module](#nodejs) in your config so as to only show the bun runtime:
|
||||
|
||||
```toml
|
||||
[nodejs]
|
||||
detect_files = ['package.json', '.node-version', '!bunfig.toml', '!bun.lockb']
|
||||
```
|
||||
|
||||
## C
|
||||
|
||||
The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file.
|
||||
@@ -665,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
|
||||
|
||||
@@ -684,6 +675,53 @@ If a C compiler is not supported by this module, you can request it by [raising
|
||||
format = 'via [$name $version]($style)'
|
||||
```
|
||||
|
||||
## CPP
|
||||
|
||||
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 |
|
||||
| ------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |
|
||||
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'C++ '` | The symbol used before displaying the compiler details |
|
||||
| `detect_extensions` | `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` | Quali estensioni dovrebbero attivare questo modulo. |
|
||||
| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. |
|
||||
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
| `commands` | `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` | How to detect what the compiler is |
|
||||
| `style` | `'bold 149'` | Lo stile per il modulo. |
|
||||
| `disabled` | `true` | Disables the `cpp` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Esempio | Descrizione |
|
||||
| -------- | ------- | ------------------------------------ |
|
||||
| name | clang++ | The name of the compiler |
|
||||
| version | 13.0.0 | The version of the compiler |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
### 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/issues/new/choose).
|
||||
|
||||
### Esempio
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[cpp]
|
||||
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.
|
||||
@@ -695,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
|
||||
|
||||
@@ -815,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.
|
||||
|
||||
@@ -859,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
|
||||
|
||||
@@ -874,6 +902,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
|
||||
| `style` | `'bold green'` | Lo stile per il modulo. |
|
||||
| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |
|
||||
| `ignore_base` | `true` | Ignores `base` environment when activated. |
|
||||
| `detect_env_vars` | `["!PIXI_ENVIRONMENT_NAME"]` | Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. |
|
||||
| `disabled` | `false` | Disables the `conda` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1165,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 |
|
||||
@@ -1211,12 +1242,12 @@ 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_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. |
|
||||
@@ -1385,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
|
||||
|
||||
@@ -1555,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 Fortran. |
|
||||
| `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 |
|
||||
@@ -1595,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 |
|
||||
@@ -1718,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
|
||||
@@ -1825,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
|
||||
|
||||
@@ -1867,16 +1927,12 @@ 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
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| -------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
|
||||
| `conflicted` | `'='` | This branch has merge conflicts. |
|
||||
| `ahead` | `'⇡'` | The format of `ahead` |
|
||||
@@ -1884,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` |
|
||||
@@ -1894,6 +1950,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
|
||||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||||
| `disabled` | `false` | Disables the `git_status` module. |
|
||||
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
|
||||
| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -2350,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
|
||||
|
||||
@@ -2386,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
|
||||
@@ -2397,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:
|
||||
@@ -2488,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 |
|
||||
| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
@@ -2624,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 |
|
||||
@@ -2700,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
|
||||
|
||||
@@ -2784,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 |
|
||||
@@ -2817,6 +2866,78 @@ 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 |
|
||||
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `symbol` | `'mise '` | The symbol used before displaying _mise_ health. |
|
||||
| `style` | `'bold purple'` | Lo stile per il modulo. |
|
||||
| `format` | `'on [$symbol$health]($style) '` | The format for the module. |
|
||||
| `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo. |
|
||||
| `detect_files` | `['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml']` | Quali nomi di file dovrebbero attivare questo modulo. |
|
||||
| `detect_folders` | `['.mise']` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
| `healthy_symbol` | `healthy` | The message displayed when _mise_ is healthy. |
|
||||
| `unhealthy_symbol` | `unhealthy` | The message displayed when _mise_ is unhealthy. |
|
||||
| `disabled` | `true` | Disables the `mise` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Esempio | Descrizione |
|
||||
| --------- | --------- | ------------------------------------ |
|
||||
| health | `healthy` | The health of _mise_ |
|
||||
| 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
|
||||
|
||||
### Esempio
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[mise]
|
||||
health = 'ready'
|
||||
```
|
||||
|
||||
## Mojo
|
||||
|
||||
The `mojo` module shows the current version of [Mojo programming language](https://www.modular.com/mojo) installed
|
||||
@@ -2881,6 +3002,37 @@ format = '[$symbol]($style)'
|
||||
style = 'bold purple'
|
||||
```
|
||||
|
||||
## Network Namespace
|
||||
|
||||
The `netns` module shows the current network namespace. This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `/var/run/netns` will be detected.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| ---------- | --------------------------------- | ----------------------------------------------------------------- |
|
||||
| `format` | `'[$symbol \[$name\]]($style)'` | The format for the module. |
|
||||
| `symbol` | `'🛜 '` | The symbol used before the network namespace (defaults to empty). |
|
||||
| `style` | `'blue bold dimmed'` | Lo stile per il modulo. |
|
||||
| `disabled` | `false` | Disables the `netns` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Esempio | Descrizione |
|
||||
| --------- | ---------- | ----------------------------------------- |
|
||||
| name | `my-netns` | The name of the current network namespace |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
### Esempio
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[netns]
|
||||
style = 'bold yellow'
|
||||
symbol = '🌐 '
|
||||
```
|
||||
|
||||
## Nim
|
||||
|
||||
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met:
|
||||
@@ -2975,6 +3127,8 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
|
||||
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
|
||||
- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension
|
||||
|
||||
Additionally, the module will be hidden by default if the directory contains a `bunfig.toml`, `bun.lock`, or `bun.lockb` file, overriding the above conditions.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
@@ -3063,10 +3217,10 @@ 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. |
|
||||
| `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. |
|
||||
@@ -3168,17 +3322,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
|
||||
|
||||
@@ -3198,14 +3344,18 @@ AIX = "➿ "
|
||||
Alpaquita = "🔔 "
|
||||
AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
ALTLinux = "Ⓐ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
Arch = "🎗️ "
|
||||
Artix = "🎗️ "
|
||||
Bluefin = "🐟 "
|
||||
CachyOS = "🎗️ "
|
||||
CentOS = "💠 "
|
||||
Debian = "🌀 "
|
||||
DragonFly = "🐉 "
|
||||
Elementary = "🍏 "
|
||||
Emscripten = "🔗 "
|
||||
EndeavourOS = "🚀 "
|
||||
Fedora = "🎩 "
|
||||
@@ -3214,6 +3364,8 @@ Garuda = "🦅 "
|
||||
Gentoo = "🗜️ "
|
||||
HardenedBSD = "🛡️ "
|
||||
Illumos = "🐦 "
|
||||
Ios = "📱 "
|
||||
InstantOS = "⏲️ "
|
||||
Kali = "🐉 "
|
||||
Linux = "🐧 "
|
||||
Mabox = "📦 "
|
||||
@@ -3230,6 +3382,7 @@ OpenCloudOS = "☁️ "
|
||||
openEuler = "🦉 "
|
||||
openSUSE = "🦎 "
|
||||
OracleLinux = "🦴 "
|
||||
PikaOS = "🐤 "
|
||||
Pop = "🍭 "
|
||||
Raspbian = "🍓 "
|
||||
Redhat = "🎩 "
|
||||
@@ -3244,6 +3397,7 @@ Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
Zorin = "🔹 "
|
||||
```
|
||||
|
||||
### Variables
|
||||
@@ -3277,9 +3431,10 @@ 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
|
||||
- [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
|
||||
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
|
||||
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
|
||||
@@ -3292,6 +3447,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
|
||||
@@ -3413,6 +3569,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 |
|
||||
@@ -3424,15 +3582,50 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |
|
||||
| `disabled` | `true` | Disables the `pijul` module. |
|
||||
|
||||
## Pixi
|
||||
|
||||
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 shell.change-ps1 false`.
|
||||
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| -------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `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. |
|
||||
| `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` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
|
||||
| `disabled` | `false` | Disables the `pixi` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Esempio | Descrizione |
|
||||
| ----------- | --------- | ------------------------------------ |
|
||||
| version | `v0.33.0` | The version of `pixi` |
|
||||
| environment | `py311` | The current pixi environment |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
### Esempio
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[pixi]
|
||||
format = '[$symbol$environment](yellow) '
|
||||
```
|
||||
|
||||
## Pulumi
|
||||
|
||||
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:
|
||||
|
||||
@@ -3538,7 +3731,6 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
- The current directory contains a `requirements.txt` file
|
||||
- The current directory contains a `setup.py` file
|
||||
- The current directory contains a `tox.ini` file
|
||||
- The current directory contains a `pixi.toml` file
|
||||
- The current directory contains a file with the `.py` extension.
|
||||
- The current directory contains a file with the `.ipynb` extension.
|
||||
- A virtual environment is currently activated
|
||||
@@ -3546,26 +3738,22 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
### Opzioni
|
||||
|
||||
| Opzione | Default | Descrizione |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||
| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` |
|
||||
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
|
||||
| `style` | `'yellow bold'` | Lo stile per il modulo. |
|
||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||
| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
|
||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should execute when getting the version. |
|
||||
| `detect_extensions` | `['py', 'ipynb']` | Quali estensioni dovrebbero attivare questo modulo |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini', 'pixi.toml']` | Quali nomi di file dovrebbero attivare questo modulo |
|
||||
| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Quali nomi di file dovrebbero attivare questo modulo |
|
||||
| `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
|
||||
|
||||
@@ -3883,11 +4071,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
|
||||
|
||||
@@ -3935,6 +4119,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 |
|
||||
@@ -3975,11 +4161,10 @@ Using `repeat` and `repeat_offset` along with `character` module, one can get pr
|
||||
|
||||
[shlvl]
|
||||
disabled = false
|
||||
format = '[$symbol$shlvl]($style)'
|
||||
format = '[$symbol]($style)'
|
||||
repeat = true
|
||||
symbol = '❯'
|
||||
repeat_offset = 1
|
||||
threshold = 0
|
||||
```
|
||||
|
||||
## Singolarità
|
||||
@@ -4089,11 +4274,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
|
||||
|
||||
@@ -4152,11 +4333,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
|
||||
|
||||
@@ -4238,13 +4415,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:
|
||||
|
||||
@@ -4254,7 +4427,7 @@ 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. |
|
||||
@@ -4263,6 +4436,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `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
|
||||
|
||||
@@ -4283,7 +4457,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
|
||||
@@ -4292,18 +4466,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
|
||||
|
||||
@@ -4384,11 +4554,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
|
||||
|
||||
@@ -4531,6 +4697,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:
|
||||
@@ -4581,31 +4776,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
|
||||
|
||||
@@ -4655,17 +4836,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
|
||||
|
||||
|
||||
+30
-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="Supporta l'Ucraina"
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
@@ -180,7 +180,7 @@
|
||||
|
||||
### Prerequisiti
|
||||
|
||||
- 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)).
|
||||
- Un [Nerd Font](https://www.nerdfonts.com/) installato e abilitato nel tuo terminale (per esempio, prova [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)).
|
||||
|
||||
### Fase 1. Installa Starship
|
||||
|
||||
@@ -189,9 +189,9 @@ Selezionare il sistema operativo dall'elenco qui sotto per visualizzare le istru
|
||||
<details>
|
||||
<summary>Android</summary>
|
||||
|
||||
Install Starship using any of the following package managers:
|
||||
Installa Starship utilizzando uno dei seguenti gestori di pacchetti:
|
||||
|
||||
| Repository | Instructions |
|
||||
| Repository | Istruzioni |
|
||||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||||
|
||||
@@ -200,39 +200,42 @@ Install Starship using any of the following package managers:
|
||||
<details>
|
||||
<summary>BSD</summary>
|
||||
|
||||
Install Starship using any of the following package managers:
|
||||
Installa Starship utilizzando uno dei seguenti gestori di pacchetti:
|
||||
|
||||
| Distribution | Repository | Instructions |
|
||||
| ------------ | -------------------------------------------------------- | --------------------------------- |
|
||||
| Distribuzioni | Repository | Istruzioni |
|
||||
| ------------- | -------------------------------------------------------- | --------------------------------- |
|
||||
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
|
||||
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
|
||||
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin installa starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Linux</summary>
|
||||
|
||||
Install the latest version for your system:
|
||||
Installare l'ultima versione per il vostro sistema:
|
||||
|
||||
```sh
|
||||
curl -sS https://starship.rs/install.sh | sh
|
||||
curl -sS https://starship.rs/install.sh <unk> sh
|
||||
```
|
||||
|
||||
Alternatively, install Starship using any of the following package managers:
|
||||
In alternativa, installare Starship utilizzando uno dei seguenti gestori di pacchetti:
|
||||
|
||||
| Distribution | Repository | Instructions |
|
||||
| Distribuzioni | Repository | Istruzioni |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| _Any_ | [forgiatura del conda](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| _Any_ | [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` |
|
||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Debian 11+ | [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 | [Pacchetti 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 Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
|
||||
</details>
|
||||
@@ -240,18 +243,18 @@ Alternatively, install Starship using any of the following package managers:
|
||||
<details>
|
||||
<summary>macOS</summary>
|
||||
|
||||
Install the latest version for your system:
|
||||
Installare l'ultima versione per il vostro sistema:
|
||||
|
||||
```sh
|
||||
curl -sS https://starship.rs/install.sh | sh
|
||||
curl -sS https://starship.rs/install.sh <unk> sh
|
||||
```
|
||||
|
||||
Alternatively, install Starship using any of the following package managers:
|
||||
In alternativa, installare Starship utilizzando uno dei seguenti gestori di pacchetti:
|
||||
|
||||
| Repository | Instructions |
|
||||
| -------------------------------------------------------- | --------------------------------------- |
|
||||
| Repository | Istruzioni |
|
||||
| ----------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| [forgiatura del conda](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| [Homebrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| [MacPorts](https://ports.macports.org/port/starship) | `port install starship` |
|
||||
|
||||
@@ -262,13 +265,13 @@ Alternatively, install Starship using any of the following package managers:
|
||||
|
||||
Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest).
|
||||
|
||||
Install Starship using any of the following package managers:
|
||||
Installa Starship utilizzando uno dei seguenti gestori di pacchetti:
|
||||
|
||||
| Repository | Instructions |
|
||||
| Repository | Istruzioni |
|
||||
| -------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
|
||||
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| [forgiatura del conda](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
|
||||
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
|
||||
|
||||
@@ -303,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>
|
||||
|
||||
@@ -405,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/).
|
||||
|
||||
|
||||
@@ -23,16 +23,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### Prerequisiti
|
||||
|
||||
```sh
|
||||
pkg install getconf
|
||||
```
|
||||
|
||||
### Installazione
|
||||
|
||||
```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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -75,3 +71,9 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an
|
||||
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||
|
||||
[](./jetpack)
|
||||
|
||||
## [Catppuccin Powerline](./catppuccin-powerline.md)
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||
[](./catppuccin-powerline)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
|
||||

|
||||
|
||||
### Prerequisiti
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
|
||||
### Configurazione
|
||||
|
||||
```sh
|
||||
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`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/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
|
||||
|
||||
これは将来的に変更される可能性があります。 Only Nushell v0.96+ is supported.
|
||||
|
||||
:::
|
||||
> [!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` には変数を含まないそのまま文字列を設定する必要があります。
|
||||
|
||||
|
||||
+391
-212
File diff suppressed because it is too large
Load Diff
@@ -80,7 +80,7 @@ env STARSHIP_LOG=trace starship timings
|
||||
|
||||
トレースログおよび、実行に 1 ミリ秒以上かかったか何か出力をした全てのモジュールの個別解析を出力します。
|
||||
|
||||
バグを見つけた場合は、 `bug-report` コマンドを用いて GitHub の問題を作成できます。
|
||||
バグを見つけた場合は、 `bug-report` コマンドを用いて GitHub のissueを作成できます。
|
||||
|
||||
```sh
|
||||
starship bug-report
|
||||
|
||||
@@ -229,10 +229,13 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
| 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` |
|
||||
| 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` |
|
||||
|
||||
</details>
|
||||
@@ -303,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>
|
||||
|
||||
@@ -345,7 +348,7 @@ mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
Note: Only Nushell v0.96+ is supported
|
||||
注意: Nushell v0.96以降でサポートされています
|
||||
|
||||
</details>
|
||||
|
||||
@@ -405,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/) から貢献できます。
|
||||
|
||||
|
||||
@@ -23,16 +23,10 @@ choco install starship
|
||||
|
||||
## [termux](https://termux.com)
|
||||
|
||||
### 必要なもの
|
||||
|
||||
```sh
|
||||
pkg install getconf
|
||||
```
|
||||
|
||||
### インストール
|
||||
|
||||
```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)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user