mirror of
https://github.com/starship/starship.git
synced 2026-06-21 02:02:14 +07:00
Compare commits
533 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b60f62e8f8 | |||
| e60f5da0b8 | |||
| 6d0b2438bb | |||
| 857c47c04f | |||
| 410ecdc56d | |||
| 17cc768479 | |||
| de6d600e57 | |||
| 384205fdf3 | |||
| 50b38d7f77 | |||
| 5ecdafe35e | |||
| a1a94c423a | |||
| 106ee2ec68 | |||
| 7362848262 | |||
| 61671a42a8 | |||
| e7bb02a142 | |||
| 8e0737f891 | |||
| 018d4fc553 | |||
| 6a46358542 | |||
| ac947a2b78 | |||
| ff742b1a43 | |||
| aaf6342812 | |||
| db329a6872 | |||
| 6048794600 | |||
| 1202b1aaf0 | |||
| d2dc3a53d4 | |||
| 48a8a54202 | |||
| b6ec150e1e | |||
| 1678721ce0 | |||
| cee7b58d4c | |||
| e341264158 | |||
| 1d24c4c187 | |||
| a77d0d8993 | |||
| 6ad3e60404 | |||
| 4b14457dce | |||
| 714157bf14 | |||
| 6deb5f0b4d | |||
| 8daca1e036 | |||
| 46538eab27 | |||
| 8bcced8f34 | |||
| 2c79263d87 | |||
| e6a1fad1cc | |||
| d862442907 | |||
| 6d6f42acfe | |||
| fb44afa474 | |||
| fc97fa457a | |||
| 1b81332de4 | |||
| 4dbdd18cdb | |||
| 2793d1b80d | |||
| 0f28d039f9 | |||
| 8251e98d33 | |||
| 9061cf29c6 | |||
| 4dc1ad6f0c | |||
| 35c5c219c9 | |||
| 6f0edf904b | |||
| 320615cba0 | |||
| 2fd3fed296 | |||
| aa6eedb133 | |||
| 18fef6d8c1 | |||
| ae9613d600 | |||
| e7b8b41a72 | |||
| 2dc16f3db1 | |||
| 325e014006 | |||
| 692307b4c8 | |||
| 169961bd51 | |||
| 4f6e2dfea3 | |||
| cfdf7d4f6f | |||
| 11303f20c7 | |||
| 341b7dfdb2 | |||
| 02fb2cc46d | |||
| 1eb80513b3 | |||
| d8b824e1aa | |||
| a319f6475a | |||
| 5e58857b06 | |||
| 7de8574157 | |||
| 89e9e17e4b | |||
| 893a562cd5 | |||
| 98d4acffdb | |||
| 74ff34ad1e | |||
| f1d5f35013 | |||
| 65f0afda7d | |||
| c721311349 | |||
| 5e040f6345 | |||
| 66ff5f89f7 | |||
| 4fd1073e57 | |||
| b2c6698a86 | |||
| e6ffb65430 | |||
| c2865ca48c | |||
| a306544824 | |||
| c77d062304 | |||
| d7411ce6c6 | |||
| b9d78078e0 | |||
| 55b5dab687 | |||
| b2c49a3123 | |||
| fb4e98e9bc | |||
| 157ce42c76 | |||
| 56daee5f5a | |||
| 953b3f771a | |||
| 294bb55001 | |||
| 2f9da92d4c | |||
| f2986cf131 | |||
| 0d3fecfa29 | |||
| 9c4bdd3b61 | |||
| 5704a9a14c | |||
| 09a732cbb0 | |||
| 43580d0463 | |||
| f5379e2899 | |||
| e3d09273c7 | |||
| 9f70e331ed | |||
| d5747059ba | |||
| f4121c87ca | |||
| f1f2a10ef7 | |||
| 9f8847794c | |||
| 26e6650968 | |||
| d551c9486e | |||
| e9514b0a1c | |||
| 9f6939d18f | |||
| 219fb2b6d6 | |||
| 3f19ddb32d | |||
| 0539a1350a | |||
| c373e1ef56 | |||
| 9a601a3e64 | |||
| c366948f70 | |||
| 4432e9980c | |||
| 5319351550 | |||
| 74fc025b86 | |||
| aaa2f149e9 | |||
| 44dc1cf2c8 | |||
| a7b31395eb | |||
| 66b9ca6049 | |||
| 2a06448988 | |||
| caa329041c | |||
| 3aadb2b3c4 | |||
| 96542ecf3c | |||
| f9f98adf9b | |||
| 0c93cdc790 | |||
| cc1870ab7f | |||
| f384dfa964 | |||
| d4449869a8 | |||
| b28bc200f7 | |||
| 43b9e9f613 | |||
| 80ad8d8fde | |||
| 6574316c3e | |||
| 249a607630 | |||
| df0e24e87d | |||
| f602b28380 | |||
| c94b7ae59a | |||
| 8c0b5aeb83 | |||
| 32e019d47f | |||
| a5dfa9614f | |||
| 69007dbebd | |||
| 1f968cb01d | |||
| 2a1ce3d9d2 | |||
| c057159aaf | |||
| b02cc1e1ac | |||
| 7e805a9bc5 | |||
| 97788d1d57 | |||
| cbb1f6f1be | |||
| 2a792a18ad | |||
| d9628a88b9 | |||
| 949b5dcd36 | |||
| cca5f3f43a | |||
| d2125dc0cd | |||
| 29b315e6de | |||
| 240606c88c | |||
| ea81fe501a | |||
| 646c9d1ec2 | |||
| 6b4c52b3ad | |||
| e900db0e67 | |||
| 9e5a4e02e4 | |||
| 7e05bada47 | |||
| 7add060848 | |||
| 4b7ddea7c8 | |||
| fa758ac587 | |||
| 70aeaae775 | |||
| 4c52ec328a | |||
| a89c535065 | |||
| b084365233 | |||
| 814126f0db | |||
| 30d5d69c9f | |||
| bc1668ee52 | |||
| 93a383181f | |||
| 8fe7ffa81c | |||
| 30ac177ba2 | |||
| a7410fadd2 | |||
| 178fe6ed65 | |||
| 93137af013 | |||
| 8f12c4657b | |||
| c8bc1fef5a | |||
| 5783bdc905 | |||
| 8b9c06a46b | |||
| cc57ed66e6 | |||
| 30614bcb72 | |||
| 0f6c303313 | |||
| f15b7a688f | |||
| cae887c16d | |||
| e525da6d37 | |||
| 6022d4c51d | |||
| 79fec5880a | |||
| 4f17821875 | |||
| c33aba2c7d | |||
| 276de8e008 | |||
| 99ec61c472 | |||
| 8f77c9bcc8 | |||
| 9dca93cd57 | |||
| e133f55d5b | |||
| 12cfe12d03 | |||
| 02be3eab9f | |||
| 59e16e21a6 | |||
| 847cdc536c | |||
| 74e1edf6ec | |||
| 927e751972 | |||
| 24936728f9 | |||
| a78e27434c | |||
| 3372f62e89 | |||
| 99d9cbf71f | |||
| 667143eb36 | |||
| b612a5bd8e | |||
| c6e24b39c5 | |||
| 733cca1510 | |||
| 17b4aaa302 | |||
| 4ec8394d17 | |||
| af919f330b | |||
| 7682e3e52d | |||
| 6aca08010d | |||
| fdd86c32c8 | |||
| 498e6f891d | |||
| 48fe673906 | |||
| 3cce1369bf | |||
| c499238a09 | |||
| d696dd072a | |||
| b4dbf61c9f | |||
| 8a5e18e631 | |||
| 671f23140e | |||
| 2ae09e226a | |||
| 91efd25889 | |||
| 49cf2b016f | |||
| dc60c13b0d | |||
| fea4e5155a | |||
| f595899021 | |||
| 2b03c4e721 | |||
| 3dd8c14144 | |||
| 033f20b461 | |||
| da264890e3 | |||
| 57bb99bd0d | |||
| 9a17d3a4e2 | |||
| f28f7791a9 | |||
| 4197977efe | |||
| a496165316 | |||
| 166d7bb30a | |||
| 528332ee61 | |||
| cfd5e7619e | |||
| 26ce2ccf4c | |||
| 712210ecfe | |||
| 3df4a67591 | |||
| dc5c898dd1 | |||
| eb54ec12c8 | |||
| 831cffbb22 | |||
| dacc8e9408 | |||
| db39a6539d | |||
| 96c1f90eeb | |||
| 05ee20141e | |||
| 0d8ca602ad | |||
| 7499e283b3 | |||
| 54e861221c | |||
| 14a5f870af | |||
| e521f39078 | |||
| 17cf5317eb | |||
| 3ebbeae1a7 | |||
| 5162c4159b | |||
| b76e16c38c | |||
| 7d9cbeb5b7 | |||
| 41f2030db1 | |||
| e1d8dea865 | |||
| fe0296bc8f | |||
| ffe59d6787 | |||
| b85b7b9c52 | |||
| d455255e7b | |||
| d0e246802c | |||
| a54b62bfb1 | |||
| e5a1f9c33d | |||
| ed582dd038 | |||
| cd0b573326 | |||
| 10daba00c0 | |||
| c9bacab812 | |||
| 30c7f513d3 | |||
| bea2843088 | |||
| 6a2096608e | |||
| 387c2f6e28 | |||
| 8758daa776 | |||
| 27079d7669 | |||
| 65fb647bc3 | |||
| 3ec9b5c54c | |||
| 53270fb3f6 | |||
| c22100a678 | |||
| aac03c7e3e | |||
| b426db92a1 | |||
| b344ca6180 | |||
| 0cfd6af20f | |||
| a84ad4f4aa | |||
| 02622a1b4a | |||
| ef2c594a4c | |||
| 37fb6af201 | |||
| 9d6247a1c9 | |||
| 53a0e6c3f2 | |||
| fcfff68089 | |||
| c97455d9de | |||
| c8a48cdd97 | |||
| 37ac6b1d48 | |||
| e24aae7751 | |||
| 5fd735f05d | |||
| 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 |
+3
-3
@@ -25,9 +25,9 @@
|
||||
"target/"
|
||||
],
|
||||
"plugins": [
|
||||
"https://github.com/dprint/dprint-plugin-typescript/releases/download/0.95.11/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-json/releases/download/0.20.0/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-markdown/releases/download/0.19.0/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-typescript/releases/download/0.96.1/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.22.1/plugin.wasm",
|
||||
"https://github.com/dprint/dprint-plugin-toml/releases/download/0.7.0/plugin.wasm"
|
||||
]
|
||||
}
|
||||
|
||||
@@ -16,12 +16,27 @@ Closes #
|
||||
<!--- Please describe in detail how you tested your changes. -->
|
||||
<!--- Include details of your testing environment, tests ran to see how -->
|
||||
<!--- your change affects other areas of the code, etc. -->
|
||||
<!--- Most changes do not need to be tested on multiple operating systems. -->
|
||||
- [ ] I have tested using **MacOS**
|
||||
- [ ] I have tested using **Linux**
|
||||
- [ ] I have tested using **Windows**
|
||||
|
||||
#### AI-Assistance
|
||||
<!-- Per our AI Policy (AI_POLICY.md), all AI usage must be declared. -->
|
||||
Have you used AI-assistance to author this PR?
|
||||
|
||||
- [ ] Yes
|
||||
- [ ] No
|
||||
|
||||
If **yes**, describe the scope of assistance:
|
||||
<!--- Describe how you used AI-Assistance -->
|
||||
<!--- Disclosure is required if you have used AI-assistance -->
|
||||
<!--- For example: answering project questions, writing tests, implementation, or documentation -->
|
||||
N/A
|
||||
|
||||
#### Checklist:
|
||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
||||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
||||
- [ ] I have updated the documentation accordingly.
|
||||
- [ ] I have updated the tests accordingly.
|
||||
- [ ] I understand and have read the code I contribute and can answer questions about it.
|
||||
|
||||
+488
-22
@@ -60,7 +60,9 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": {}
|
||||
"default": {
|
||||
"claude-code": "$claude_model$git_branch$claude_context$claude_cost"
|
||||
}
|
||||
},
|
||||
"aws": {
|
||||
"$ref": "#/$defs/AwsConfig",
|
||||
@@ -91,7 +93,7 @@
|
||||
"full_symbol": " ",
|
||||
"charging_symbol": " ",
|
||||
"discharging_symbol": " ",
|
||||
"unknown_symbol": " ",
|
||||
"unknown_symbol": " ",
|
||||
"empty_symbol": " ",
|
||||
"display": [
|
||||
{
|
||||
@@ -182,6 +184,75 @@
|
||||
"disabled": false
|
||||
}
|
||||
},
|
||||
"claude_context": {
|
||||
"$ref": "#/$defs/ClaudeContextConfig",
|
||||
"default": {
|
||||
"format": "[$gauge $percentage]($style) ",
|
||||
"symbol": "",
|
||||
"gauge_width": 5,
|
||||
"gauge_full_symbol": "█",
|
||||
"gauge_partial_symbol": "▒",
|
||||
"gauge_empty_symbol": "░",
|
||||
"display": [
|
||||
{
|
||||
"threshold": 0.0,
|
||||
"style": "bold green",
|
||||
"hidden": true
|
||||
},
|
||||
{
|
||||
"threshold": 30.0,
|
||||
"style": "bold green",
|
||||
"hidden": false
|
||||
},
|
||||
{
|
||||
"threshold": 60.0,
|
||||
"style": "bold yellow",
|
||||
"hidden": false
|
||||
},
|
||||
{
|
||||
"threshold": 80.0,
|
||||
"style": "bold red",
|
||||
"hidden": false
|
||||
}
|
||||
],
|
||||
"disabled": false
|
||||
}
|
||||
},
|
||||
"claude_cost": {
|
||||
"$ref": "#/$defs/ClaudeCostConfig",
|
||||
"default": {
|
||||
"format": "[$symbol(\\$$cost)]($style) ",
|
||||
"symbol": "💰 ",
|
||||
"display": [
|
||||
{
|
||||
"threshold": 0.0,
|
||||
"style": "bold green",
|
||||
"hidden": true
|
||||
},
|
||||
{
|
||||
"threshold": 1.0,
|
||||
"style": "bold yellow",
|
||||
"hidden": false
|
||||
},
|
||||
{
|
||||
"threshold": 5.0,
|
||||
"style": "bold red",
|
||||
"hidden": false
|
||||
}
|
||||
],
|
||||
"disabled": false
|
||||
}
|
||||
},
|
||||
"claude_model": {
|
||||
"$ref": "#/$defs/ClaudeModelConfig",
|
||||
"default": {
|
||||
"format": "[$symbol$model]($style) ",
|
||||
"symbol": "🤖 ",
|
||||
"style": "bold blue",
|
||||
"model_aliases": {},
|
||||
"disabled": false
|
||||
}
|
||||
},
|
||||
"cmake": {
|
||||
"$ref": "#/$defs/CMakeConfig",
|
||||
"default": {
|
||||
@@ -367,7 +438,7 @@
|
||||
"default": {
|
||||
"truncation_length": 3,
|
||||
"truncate_to_repo": true,
|
||||
"substitutions": {},
|
||||
"substitutions": [],
|
||||
"fish_style_pwd_dir_length": 0,
|
||||
"use_logical_path": true,
|
||||
"format": "[$path]($style)[$read_only]($read_only_style) ",
|
||||
@@ -682,6 +753,14 @@
|
||||
"staged": "+",
|
||||
"untracked": "?",
|
||||
"typechanged": "",
|
||||
"worktree_added": "",
|
||||
"worktree_deleted": "",
|
||||
"worktree_modified": "",
|
||||
"worktree_typechanged": "",
|
||||
"index_added": "",
|
||||
"index_deleted": "",
|
||||
"index_modified": "",
|
||||
"index_typechanged": "",
|
||||
"ignore_submodules": false,
|
||||
"disabled": false,
|
||||
"use_git_executable": false
|
||||
@@ -984,6 +1063,22 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"maven": {
|
||||
"$ref": "#/$defs/MavenConfig",
|
||||
"default": {
|
||||
"format": "via [$symbol($version )]($style)",
|
||||
"version_format": "v${raw}",
|
||||
"symbol": "🅼 ",
|
||||
"style": "bold bright-cyan",
|
||||
"disabled": false,
|
||||
"recursive": false,
|
||||
"detect_extensions": [],
|
||||
"detect_files": [
|
||||
"pom.xml"
|
||||
],
|
||||
"detect_folders": []
|
||||
}
|
||||
},
|
||||
"memory_usage": {
|
||||
"$ref": "#/$defs/MemoryConfig",
|
||||
"default": {
|
||||
@@ -1008,7 +1103,7 @@
|
||||
"mise": {
|
||||
"$ref": "#/$defs/MiseConfig",
|
||||
"default": {
|
||||
"format": "[$symbol$health]($style) ",
|
||||
"format": "on [$symbol$health]($style) ",
|
||||
"symbol": "mise ",
|
||||
"style": "bold purple",
|
||||
"disabled": true,
|
||||
@@ -1114,7 +1209,10 @@
|
||||
".nvmrc",
|
||||
"!bunfig.toml",
|
||||
"!bun.lock",
|
||||
"!bun.lockb"
|
||||
"!bun.lockb",
|
||||
"!deno.json",
|
||||
"!deno.jsonc",
|
||||
"!deno.lock"
|
||||
],
|
||||
"detect_folders": [
|
||||
"node_modules"
|
||||
@@ -1200,6 +1298,7 @@
|
||||
"Alpaquita": "🔔 ",
|
||||
"AlmaLinux": "💠 ",
|
||||
"Alpine": "🏔️ ",
|
||||
"ALTLinux": "Ⓐ ",
|
||||
"Amazon": "🙂 ",
|
||||
"Android": "🤖 ",
|
||||
"AOSC": "🐱 ",
|
||||
@@ -1209,6 +1308,7 @@
|
||||
"CachyOS": "🎗️ ",
|
||||
"CentOS": "💠 ",
|
||||
"Debian": "🌀 ",
|
||||
"Elementary": "🍏 ",
|
||||
"DragonFly": "🐉 ",
|
||||
"Emscripten": "🔗 ",
|
||||
"EndeavourOS": "🚀 ",
|
||||
@@ -1218,6 +1318,8 @@
|
||||
"Gentoo": "🗜️ ",
|
||||
"HardenedBSD": "🛡️ ",
|
||||
"Illumos": "🐦 ",
|
||||
"Ios": "📱 ",
|
||||
"InstantOS": "⏲️ ",
|
||||
"Kali": "🐉 ",
|
||||
"Linux": "🐧 ",
|
||||
"Mabox": "📦 ",
|
||||
@@ -1234,6 +1336,7 @@
|
||||
"openEuler": "🦉 ",
|
||||
"openSUSE": "🦎 ",
|
||||
"OracleLinux": "🦴 ",
|
||||
"PikaOS": "🐤 ",
|
||||
"Pop": "🍭 ",
|
||||
"Raspbian": "🍓 ",
|
||||
"Redhat": "🎩 ",
|
||||
@@ -1247,7 +1350,8 @@
|
||||
"Unknown": "❓ ",
|
||||
"Uos": "🐲 ",
|
||||
"Void": " ",
|
||||
"Windows": "🪟 "
|
||||
"Windows": "🪟 ",
|
||||
"Zorin": "🔹 "
|
||||
},
|
||||
"disabled": true
|
||||
}
|
||||
@@ -1404,7 +1508,8 @@
|
||||
"detect_folders": [],
|
||||
"detect_env_vars": [
|
||||
"VIRTUAL_ENV"
|
||||
]
|
||||
],
|
||||
"generic_venv_names": []
|
||||
}
|
||||
},
|
||||
"quarto": {
|
||||
@@ -1743,6 +1848,22 @@
|
||||
"detect_folders": []
|
||||
}
|
||||
},
|
||||
"vcs": {
|
||||
"$ref": "#/$defs/VcsConfig",
|
||||
"default": {
|
||||
"order": [
|
||||
"git",
|
||||
"hg",
|
||||
"pijul",
|
||||
"fossil"
|
||||
],
|
||||
"disabled": false,
|
||||
"fossil_modules": "$fossil_branch$fossil_metrics",
|
||||
"git_modules": "$git_branch$git_commit$git_state$git_metrics$git_status",
|
||||
"hg_modules": "$hg_branch$hg_state",
|
||||
"pijul_modules": "$pijul_channel"
|
||||
}
|
||||
},
|
||||
"vcsh": {
|
||||
"$ref": "#/$defs/VcshConfig",
|
||||
"default": {
|
||||
@@ -1911,7 +2032,7 @@
|
||||
},
|
||||
"unknown_symbol": {
|
||||
"type": "string",
|
||||
"default": " "
|
||||
"default": " "
|
||||
},
|
||||
"empty_symbol": {
|
||||
"type": "string",
|
||||
@@ -2184,6 +2305,160 @@
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ClaudeContextConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"format": {
|
||||
"type": "string",
|
||||
"default": "[$gauge $percentage]($style) "
|
||||
},
|
||||
"symbol": {
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"gauge_width": {
|
||||
"type": "integer",
|
||||
"format": "uint8",
|
||||
"minimum": 0,
|
||||
"maximum": 255,
|
||||
"default": 5
|
||||
},
|
||||
"gauge_full_symbol": {
|
||||
"type": "string",
|
||||
"default": "█"
|
||||
},
|
||||
"gauge_partial_symbol": {
|
||||
"type": "string",
|
||||
"default": "▒"
|
||||
},
|
||||
"gauge_empty_symbol": {
|
||||
"type": "string",
|
||||
"default": "░"
|
||||
},
|
||||
"display": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/$defs/ClaudeDisplayConfig"
|
||||
},
|
||||
"default": [
|
||||
{
|
||||
"threshold": 0.0,
|
||||
"style": "bold green",
|
||||
"hidden": true
|
||||
},
|
||||
{
|
||||
"threshold": 30.0,
|
||||
"style": "bold green",
|
||||
"hidden": false
|
||||
},
|
||||
{
|
||||
"threshold": 60.0,
|
||||
"style": "bold yellow",
|
||||
"hidden": false
|
||||
},
|
||||
{
|
||||
"threshold": 80.0,
|
||||
"style": "bold red",
|
||||
"hidden": false
|
||||
}
|
||||
]
|
||||
},
|
||||
"disabled": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ClaudeDisplayConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"threshold": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"default": 0.0
|
||||
},
|
||||
"style": {
|
||||
"type": "string",
|
||||
"default": "bold green"
|
||||
},
|
||||
"hidden": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ClaudeCostConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"format": {
|
||||
"type": "string",
|
||||
"default": "[$symbol(\\$$cost)]($style) "
|
||||
},
|
||||
"symbol": {
|
||||
"type": "string",
|
||||
"default": "💰 "
|
||||
},
|
||||
"display": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/$defs/ClaudeDisplayConfig"
|
||||
},
|
||||
"default": [
|
||||
{
|
||||
"threshold": 0.0,
|
||||
"style": "bold green",
|
||||
"hidden": true
|
||||
},
|
||||
{
|
||||
"threshold": 1.0,
|
||||
"style": "bold yellow",
|
||||
"hidden": false
|
||||
},
|
||||
{
|
||||
"threshold": 5.0,
|
||||
"style": "bold red",
|
||||
"hidden": false
|
||||
}
|
||||
]
|
||||
},
|
||||
"disabled": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"ClaudeModelConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"format": {
|
||||
"type": "string",
|
||||
"default": "[$symbol$model]($style) "
|
||||
},
|
||||
"symbol": {
|
||||
"type": "string",
|
||||
"default": "🤖 "
|
||||
},
|
||||
"style": {
|
||||
"type": "string",
|
||||
"default": "bold blue"
|
||||
},
|
||||
"model_aliases": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": {}
|
||||
},
|
||||
"disabled": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"CMakeConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -2616,11 +2891,8 @@
|
||||
"default": true
|
||||
},
|
||||
"substitutions": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": {}
|
||||
"$ref": "#/$defs/Either",
|
||||
"default": []
|
||||
},
|
||||
"fish_style_pwd_dir_length": {
|
||||
"type": "integer",
|
||||
@@ -2684,6 +2956,42 @@
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Either": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/$defs/SubstitutionConfig"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"SubstitutionConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"from": {
|
||||
"type": "string"
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
},
|
||||
"regex": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"from",
|
||||
"to"
|
||||
]
|
||||
},
|
||||
"DirenvConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -3001,7 +3309,7 @@
|
||||
},
|
||||
"format": {
|
||||
"type": "string",
|
||||
"default": "with [$env_value]($style) "
|
||||
"default": "with [$symbol$env_value]($style) "
|
||||
},
|
||||
"disabled": {
|
||||
"type": "boolean",
|
||||
@@ -3549,6 +3857,38 @@
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"worktree_added": {
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"worktree_deleted": {
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"worktree_modified": {
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"worktree_typechanged": {
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"index_added": {
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"index_deleted": {
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"index_modified": {
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"index_typechanged": {
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"ignore_submodules": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
@@ -4459,6 +4799,59 @@
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"MavenConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"format": {
|
||||
"type": "string",
|
||||
"default": "via [$symbol($version )]($style)"
|
||||
},
|
||||
"version_format": {
|
||||
"type": "string",
|
||||
"default": "v${raw}"
|
||||
},
|
||||
"symbol": {
|
||||
"type": "string",
|
||||
"default": "🅼 "
|
||||
},
|
||||
"style": {
|
||||
"type": "string",
|
||||
"default": "bold bright-cyan"
|
||||
},
|
||||
"disabled": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"recursive": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"detect_extensions": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": []
|
||||
},
|
||||
"detect_files": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": [
|
||||
"pom.xml"
|
||||
]
|
||||
},
|
||||
"detect_folders": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": []
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"MemoryConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -4523,7 +4916,7 @@
|
||||
"properties": {
|
||||
"format": {
|
||||
"type": "string",
|
||||
"default": "[$symbol$health]($style) "
|
||||
"default": "on [$symbol$health]($style) "
|
||||
},
|
||||
"symbol": {
|
||||
"type": "string",
|
||||
@@ -4809,7 +5202,10 @@
|
||||
".nvmrc",
|
||||
"!bunfig.toml",
|
||||
"!bun.lock",
|
||||
"!bun.lockb"
|
||||
"!bun.lockb",
|
||||
"!deno.json",
|
||||
"!deno.jsonc",
|
||||
"!deno.lock"
|
||||
]
|
||||
},
|
||||
"detect_folders": {
|
||||
@@ -5035,6 +5431,7 @@
|
||||
"Alpaquita": "🔔 ",
|
||||
"AlmaLinux": "💠 ",
|
||||
"Alpine": "🏔️ ",
|
||||
"ALTLinux": "Ⓐ ",
|
||||
"Amazon": "🙂 ",
|
||||
"Android": "🤖 ",
|
||||
"AOSC": "🐱 ",
|
||||
@@ -5044,6 +5441,7 @@
|
||||
"CachyOS": "🎗️ ",
|
||||
"CentOS": "💠 ",
|
||||
"Debian": "🌀 ",
|
||||
"Elementary": "🍏 ",
|
||||
"DragonFly": "🐉 ",
|
||||
"Emscripten": "🔗 ",
|
||||
"EndeavourOS": "🚀 ",
|
||||
@@ -5053,6 +5451,8 @@
|
||||
"Gentoo": "🗜️ ",
|
||||
"HardenedBSD": "🛡️ ",
|
||||
"Illumos": "🐦 ",
|
||||
"Ios": "📱 ",
|
||||
"InstantOS": "⏲️ ",
|
||||
"Kali": "🐉 ",
|
||||
"Linux": "🐧 ",
|
||||
"Mabox": "📦 ",
|
||||
@@ -5069,6 +5469,7 @@
|
||||
"openEuler": "🦉 ",
|
||||
"openSUSE": "🦎 ",
|
||||
"OracleLinux": "🦴 ",
|
||||
"PikaOS": "🐤 ",
|
||||
"Pop": "🍭 ",
|
||||
"Raspbian": "🍓 ",
|
||||
"Redhat": "🎩 ",
|
||||
@@ -5082,7 +5483,8 @@
|
||||
"Unknown": "❓ ",
|
||||
"Uos": "🐲 ",
|
||||
"Void": " ",
|
||||
"Windows": "🪟 "
|
||||
"Windows": "🪟 ",
|
||||
"Zorin": "🔹 "
|
||||
}
|
||||
},
|
||||
"disabled": {
|
||||
@@ -5268,7 +5670,7 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"pixi_binary": {
|
||||
"$ref": "#/$defs/Either",
|
||||
"$ref": "#/$defs/VecOr_string",
|
||||
"default": [
|
||||
"pixi"
|
||||
]
|
||||
@@ -5324,7 +5726,7 @@
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"Either": {
|
||||
"VecOr_string": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
@@ -5432,7 +5834,7 @@
|
||||
"default": "pyenv "
|
||||
},
|
||||
"python_binary": {
|
||||
"$ref": "#/$defs/Either",
|
||||
"$ref": "#/$defs/VecOr_VecOr_string",
|
||||
"default": [
|
||||
[
|
||||
"python"
|
||||
@@ -5505,10 +5907,30 @@
|
||||
"default": [
|
||||
"VIRTUAL_ENV"
|
||||
]
|
||||
},
|
||||
"generic_venv_names": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": []
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"VecOr_VecOr_string": {
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/$defs/VecOr_string"
|
||||
},
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/$defs/VecOr_string"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"QuartoConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -6042,7 +6464,7 @@
|
||||
"default": "S "
|
||||
},
|
||||
"compiler": {
|
||||
"$ref": "#/$defs/Either",
|
||||
"$ref": "#/$defs/VecOr_string",
|
||||
"default": [
|
||||
"solc"
|
||||
]
|
||||
@@ -6506,6 +6928,50 @@
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"VcsConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"order": {
|
||||
"description": "Order in which to discover VCSes.\nThe first one found is the one used.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": [
|
||||
"git",
|
||||
"hg",
|
||||
"pijul",
|
||||
"fossil"
|
||||
]
|
||||
},
|
||||
"disabled": {
|
||||
"description": "Disables the VCS module.",
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"fossil_modules": {
|
||||
"description": "Modules to use when Fossil is matched.\n\nThey are configured separately at the top level.",
|
||||
"type": "string",
|
||||
"default": "$fossil_branch$fossil_metrics"
|
||||
},
|
||||
"git_modules": {
|
||||
"description": "Modules to use when Git is matched.\n\nThey are configured separately at the top level.",
|
||||
"type": "string",
|
||||
"default": "$git_branch$git_commit$git_state$git_metrics$git_status"
|
||||
},
|
||||
"hg_modules": {
|
||||
"description": "Modules to use when Mercurial is matched.\n\nThey are configured separately at the top level.",
|
||||
"type": "string",
|
||||
"default": "$hg_branch$hg_state"
|
||||
},
|
||||
"pijul_modules": {
|
||||
"description": "Modules to use when Pijul is matched.\n\nThey are configured separately at the top level.",
|
||||
"type": "string",
|
||||
"default": "$pijul_channel"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"VcshConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -6703,7 +7169,7 @@
|
||||
"default": false
|
||||
},
|
||||
"shell": {
|
||||
"$ref": "#/$defs/Either",
|
||||
"$ref": "#/$defs/VecOr_string",
|
||||
"default": []
|
||||
},
|
||||
"description": {
|
||||
|
||||
+126
-52
@@ -1,76 +1,150 @@
|
||||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": [
|
||||
// stripped-down config:base
|
||||
":prHourlyLimit2",
|
||||
":prConcurrentLimit10",
|
||||
"group:monorepos",
|
||||
"group:recommended",
|
||||
"workarounds:all",
|
||||
$schema: 'https://docs.renovatebot.com/renovate-schema.json',
|
||||
extends: [
|
||||
'config:best-practices',
|
||||
'security:openssf-scorecard',
|
||||
// automerge minor updates
|
||||
":automergeMinor",
|
||||
":automergeBranch"
|
||||
':automergeMinor',
|
||||
':automergeBranch',
|
||||
],
|
||||
"labels": ["📦 dependencies"],
|
||||
"semanticCommits": "enabled",
|
||||
"semanticCommitType": "build",
|
||||
"rangeStrategy": "bump",
|
||||
"rebaseWhen": "conflicted",
|
||||
"lockFileMaintenance": {
|
||||
"enabled": true,
|
||||
"extends": ["schedule:weekly"],
|
||||
"groupName": "lockfile maintenance",
|
||||
"automerge": true
|
||||
ignorePresets: [
|
||||
':dependencyDashboard',
|
||||
':semanticPrefixFixDepsChoreOthers',
|
||||
],
|
||||
labels: [
|
||||
'📦 dependencies',
|
||||
],
|
||||
minimumReleaseAge: '4 days',
|
||||
semanticCommits: 'enabled',
|
||||
semanticCommitType: 'build',
|
||||
rangeStrategy: 'bump',
|
||||
rebaseWhen: 'conflicted',
|
||||
lockFileMaintenance: {
|
||||
enabled: true,
|
||||
extends: [
|
||||
'schedule:weekly',
|
||||
],
|
||||
groupName: 'lockfile maintenance',
|
||||
automerge: true,
|
||||
},
|
||||
"packageRules": [
|
||||
packageRules: [
|
||||
// group updates to related packages
|
||||
{
|
||||
"groupName": "clap crates",
|
||||
"matchDatasources": ["crate"],
|
||||
"matchPackagePrefixes": ["clap"]
|
||||
groupName: 'clap crates',
|
||||
matchDatasources: [
|
||||
'crate',
|
||||
],
|
||||
matchPackageNames: [
|
||||
'clap{/,}**',
|
||||
],
|
||||
},
|
||||
{
|
||||
"groupName": "gitoxide crates",
|
||||
"matchDatasources": ["crate"],
|
||||
"matchPackagePrefixes": ["gix"]
|
||||
groupName: 'gitoxide crates',
|
||||
matchDatasources: [
|
||||
'crate',
|
||||
],
|
||||
matchPackageNames: [
|
||||
'gix{/,}**',
|
||||
],
|
||||
},
|
||||
{
|
||||
"groupName": "pest crates",
|
||||
"matchDatasources": ["crate"],
|
||||
"matchPackagePrefixes": ["pest"]
|
||||
groupName: 'pest crates',
|
||||
matchDatasources: [
|
||||
'crate',
|
||||
],
|
||||
matchPackageNames: [
|
||||
'pest{/,}**',
|
||||
],
|
||||
},
|
||||
{
|
||||
"groupName": "toml crates",
|
||||
"matchDatasources": ["crate"],
|
||||
"matchPackagePrefixes": ["toml"]
|
||||
groupName: 'toml crates',
|
||||
matchDatasources: [
|
||||
'crate',
|
||||
],
|
||||
matchPackageNames: [
|
||||
'toml{/,}**',
|
||||
],
|
||||
},
|
||||
{
|
||||
"groupName": "unicode crates",
|
||||
"matchDatasources": ["crate"],
|
||||
"matchPackagePrefixes": ["unicode"]
|
||||
groupName: 'unicode crates',
|
||||
matchDatasources: [
|
||||
'crate',
|
||||
],
|
||||
matchPackageNames: [
|
||||
'unicode{/,}**',
|
||||
],
|
||||
},
|
||||
// Prevent too many PRs by grouping certain updates together and only updating them weekly
|
||||
{
|
||||
groupName: 'dprint plugins',
|
||||
extends: [
|
||||
'schedule:weekly',
|
||||
],
|
||||
matchPackageNames: [
|
||||
'dprint{/,}**',
|
||||
],
|
||||
},
|
||||
{
|
||||
"groupName": "dprint plugins",
|
||||
"matchPackagePrefixes": ["dprint"],
|
||||
"extends": ["schedule:weekly"]
|
||||
groupName: 'npm',
|
||||
matchDatasources: [
|
||||
'npm',
|
||||
],
|
||||
extends: [
|
||||
'schedule:weekly',
|
||||
],
|
||||
},
|
||||
// Avoid frequent updates due to pinned digest values in GitHub Actions
|
||||
{
|
||||
"groupName": "npm",
|
||||
"matchDatasources": ["npm"],
|
||||
"extends": ["schedule:weekly"]
|
||||
}
|
||||
matchDepTypes: [
|
||||
'action',
|
||||
],
|
||||
extends: [
|
||||
'schedule:weekly',
|
||||
],
|
||||
},
|
||||
],
|
||||
// custom regex update managers
|
||||
"regexManagers": [
|
||||
customManagers: [
|
||||
{
|
||||
"fileMatch": ["(^|\\/)\\.?dprint.json"],
|
||||
"matchStrings": ["\"https://github.com/(?<depName>.+)/releases/download/(?<currentValue>.+)/plugin.wasm\""],
|
||||
"datasourceTemplate": "github-releases"
|
||||
customType: 'regex',
|
||||
managerFilePatterns: [
|
||||
'/(^|\\/)\\.?dprint.json/',
|
||||
],
|
||||
matchStrings: [
|
||||
'"https://github.com/(?<depName>.+)/releases/download/(?<currentValue>.+)/plugin.wasm"',
|
||||
],
|
||||
datasourceTemplate: 'github-releases',
|
||||
},
|
||||
{
|
||||
"fileMatch": ["^(workflow-templates|\\.github\\/workflows)\\/[^/]+\\.ya?ml$"],
|
||||
"matchStrings": ["cargo install.*--version (?<currentValue>\\S+).*\\s(?<depName>\\S+)"],
|
||||
"datasourceTemplate": "crate"
|
||||
}
|
||||
]
|
||||
customType: 'regex',
|
||||
managerFilePatterns: [
|
||||
'/^(workflow-templates|\\.github\\/workflows)\\/[^/]+\\.ya?ml$/',
|
||||
],
|
||||
matchStrings: [
|
||||
'cargo install.*--version (?<currentValue>\\S+).*\\s(?<depName>\\S+)',
|
||||
],
|
||||
datasourceTemplate: 'crate',
|
||||
},
|
||||
{
|
||||
customType: 'regex',
|
||||
managerFilePatterns: [
|
||||
'/^(workflow-templates|\\.github\\/workflows)\\/[^/]+\\.ya?ml$/',
|
||||
],
|
||||
matchStrings: [
|
||||
'^\\s+tool: (?<depName>[\\w-]+)@(?<currentValue>[^\\s]+)',
|
||||
],
|
||||
datasourceTemplate: 'crate',
|
||||
},
|
||||
{
|
||||
customType: 'regex',
|
||||
managerFilePatterns: [
|
||||
'/^(workflow-templates|\\.github\\/workflows)\\/[^/]+\\.ya?ml$/',
|
||||
],
|
||||
matchStrings: [
|
||||
'ziglang==(?<currentValue>\\S+)',
|
||||
],
|
||||
datasourceTemplate: 'pypi',
|
||||
depNameTemplate: 'ziglang',
|
||||
},
|
||||
],
|
||||
}
|
||||
|
||||
@@ -11,7 +11,7 @@ jobs:
|
||||
# Prevent this workflow from running (and failing) on forks
|
||||
if: github.repository == 'starship/starship'
|
||||
steps:
|
||||
- uses: starship/crowdin-pretranslate-action@v0.1.1
|
||||
- uses: starship/crowdin-pretranslate-action@05f21625b1486f1b77d53002fed82c4609247712 # v0.1.1
|
||||
with:
|
||||
project_id: 372655
|
||||
api_key: ${{ secrets.CROWDIN_API_TOKEN }}
|
||||
|
||||
@@ -12,9 +12,9 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
- name: Docs | Format
|
||||
uses: dprint/check@v2.3
|
||||
uses: dprint/check@9cb3a2b17a8e606d37aae341e49df3654933fc23 # v2.3
|
||||
|
||||
# Validate preset files
|
||||
taplo:
|
||||
@@ -22,9 +22,11 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
- name: Install | Taplo
|
||||
run: cargo install --debug --locked --version 0.10.0 taplo-cli
|
||||
uses: taiki-e/install-action@25435dc8dd3baed7417e0c96d3fe89013a5b2e09 # v2.81.3
|
||||
with:
|
||||
tool: taplo-cli@0.10.0
|
||||
- name: Presets | Validate with schema
|
||||
run: taplo lint --schema "file://${GITHUB_WORKSPACE}/.github/config-schema.json" docs/public/presets/toml/*.toml
|
||||
|
||||
@@ -35,11 +37,11 @@ jobs:
|
||||
if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref != 'i18n_master' }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Prevent File Change
|
||||
uses: actions/github-script@v8
|
||||
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
|
||||
with:
|
||||
script: |
|
||||
const { execSync } = require('child_process');
|
||||
@@ -62,12 +64,12 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Node
|
||||
uses: actions/setup-node@v6
|
||||
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||
with:
|
||||
node-version: 22.21.0
|
||||
node-version: 24.16.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@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- 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@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- 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@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- 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@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Node
|
||||
uses: actions/setup-node@v6
|
||||
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||
with:
|
||||
node-version: 22.21.0
|
||||
node-version: 24.16.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 }}
|
||||
|
||||
@@ -2,7 +2,7 @@ name: Release
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
env:
|
||||
CARGO_INCREMENTAL: 0
|
||||
CARGO_NET_RETRY: 10
|
||||
@@ -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@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5.0.0
|
||||
id: release
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -55,6 +55,11 @@ 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
|
||||
use_zigbuild: true
|
||||
|
||||
- target: x86_64-apple-darwin
|
||||
os: macos-latest
|
||||
name: starship-x86_64-apple-darwin.tar.gz
|
||||
@@ -88,13 +93,10 @@ jobs:
|
||||
RUSTFLAGS: ${{ matrix.rustflags || '' }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: stable
|
||||
target: ${{ matrix.target }}
|
||||
run: rustup toolchain install stable --profile minimal --target ${{ matrix.target }} --no-self-update
|
||||
|
||||
- name: Setup | Install cargo-wix [Windows]
|
||||
continue-on-error: true
|
||||
@@ -105,17 +107,33 @@ jobs:
|
||||
RUSTFLAGS: ""
|
||||
|
||||
- name: Setup | Install cross [Linux]
|
||||
if: matrix.os == 'ubuntu-latest'
|
||||
uses: taiki-e/install-action@cross
|
||||
if: matrix.os == 'ubuntu-latest' && !matrix.use_zigbuild
|
||||
uses: taiki-e/install-action@25435dc8dd3baed7417e0c96d3fe89013a5b2e09 # v2.81.3
|
||||
with:
|
||||
tool: cross@0.2.5
|
||||
|
||||
- name: Setup | Install Zig [riscv64]
|
||||
if: matrix.use_zigbuild
|
||||
run: pip install ziglang==0.16.0
|
||||
|
||||
- name: Setup | Install cargo-zigbuild [riscv64]
|
||||
if: matrix.use_zigbuild
|
||||
uses: taiki-e/install-action@25435dc8dd3baed7417e0c96d3fe89013a5b2e09 # v2.81.3
|
||||
with:
|
||||
tool: cargo-zigbuild
|
||||
|
||||
- name: Build | Build [Cargo]
|
||||
if: matrix.os != 'ubuntu-latest'
|
||||
run: cargo build --release --locked --target ${{ matrix.target }}
|
||||
|
||||
- name: Build | Build [Cross]
|
||||
if: matrix.os == 'ubuntu-latest'
|
||||
if: matrix.os == 'ubuntu-latest' && !matrix.use_zigbuild
|
||||
run: cross build --release --locked --target ${{ matrix.target }}
|
||||
|
||||
- name: Build | Build [Zigbuild]
|
||||
if: matrix.use_zigbuild
|
||||
run: cargo zigbuild --release --locked --target ${{ matrix.target }}
|
||||
|
||||
- name: Build | Installer [Windows]
|
||||
continue-on-error: true
|
||||
if: matrix.os == 'windows-latest'
|
||||
@@ -128,7 +146,7 @@ jobs:
|
||||
continue-on-error: true
|
||||
if: matrix.os == 'windows-latest'
|
||||
id: unsigned-artifacts
|
||||
uses: actions/upload-artifact@v5
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: unsigned-${{ matrix.name }}
|
||||
path: |
|
||||
@@ -138,7 +156,7 @@ jobs:
|
||||
- name: Sign | Sign [Windows]
|
||||
continue-on-error: true
|
||||
if: matrix.os == 'windows-latest'
|
||||
uses: signpath/github-action-submit-signing-request@v2
|
||||
uses: signpath/github-action-submit-signing-request@b9d91eadd323de506c0c81cf0c7fe7438f3360fd # v2.2
|
||||
with:
|
||||
api-token: '${{ secrets.SIGNPATH_API_TOKEN }}'
|
||||
organization-id: '${{ vars.SIGNPATH_ORGANIZATION_ID }}'
|
||||
@@ -163,7 +181,7 @@ jobs:
|
||||
cd -
|
||||
|
||||
- name: Release | Upload artifacts
|
||||
uses: actions/upload-artifact@v5
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: ${{ matrix.name }}
|
||||
path: ${{ matrix.name }}
|
||||
@@ -171,7 +189,7 @@ jobs:
|
||||
- name: Release | Upload installer artifacts [Windows]
|
||||
continue-on-error: true
|
||||
if: matrix.os == 'windows-latest'
|
||||
uses: actions/upload-artifact@v5
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: starship-${{ matrix.target }}.msi
|
||||
path: target/${{ matrix.target }}/release/starship-${{ matrix.target }}.msi
|
||||
@@ -201,10 +219,10 @@ jobs:
|
||||
STARSHIP_VERSION: ${{ needs.release_please.outputs.tag_name }}
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
# Required to include the recently merged Crowdin PR
|
||||
ref: master
|
||||
ref: main
|
||||
|
||||
- name: Notarize | Set up secrets
|
||||
env:
|
||||
@@ -238,9 +256,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@v6
|
||||
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
|
||||
with:
|
||||
node-version: 22.21.0
|
||||
node-version: 24.16.0
|
||||
|
||||
- name: Notarize | Build docs
|
||||
run: |
|
||||
@@ -249,7 +267,7 @@ jobs:
|
||||
npm run build
|
||||
|
||||
- name: Notarize | Download artifacts
|
||||
uses: actions/download-artifact@v6
|
||||
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
|
||||
with:
|
||||
name: ${{ matrix.name }}
|
||||
path: artifacts
|
||||
@@ -261,7 +279,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@v5
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: ${{ matrix.pkgname }}
|
||||
path: ${{ matrix.pkgname }}
|
||||
@@ -270,7 +288,7 @@ jobs:
|
||||
run: tar czvf ${{ matrix.name }} starship
|
||||
|
||||
- name: Notarize | Upload Notarized Binary
|
||||
uses: actions/upload-artifact@v5
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: ${{ matrix.name }}
|
||||
path: ${{ matrix.name }}
|
||||
@@ -289,7 +307,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Artifacts
|
||||
uses: actions/download-artifact@v6
|
||||
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
|
||||
|
||||
- name: Setup | Checksums
|
||||
run: for file in starship-*/starship-*; do openssl dgst -sha256 -r "$file" | awk '{print $1}' > "${file}.sha256"; done
|
||||
@@ -300,10 +318,9 @@ jobs:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Build | Add Artifacts to Release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
files: starship-*/starship-*
|
||||
tag_name: ${{ needs.release_please.outputs.tag_name }}
|
||||
run: gh release upload ${{ needs.release_please.outputs.tag_name }} starship-*/starship-* --repo starship/starship
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
# Publish starship to Crates.io
|
||||
cargo_publish:
|
||||
@@ -311,15 +328,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@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
run: rustup toolchain install stable --profile minimal --no-self-update
|
||||
|
||||
- name: Build | Authenticate
|
||||
uses: rust-lang/crates-io-auth-action@bbd81622f20ce9e2dd9622e3218b975523e45bbe # v1.0.4
|
||||
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 +350,7 @@ jobs:
|
||||
needs: [release_please, upload_artifacts]
|
||||
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
||||
steps:
|
||||
- uses: mislav/bump-homebrew-formula-action@v3.6
|
||||
- uses: mislav/bump-homebrew-formula-action@ccf2332299a883f6af50a1d2d41e5df7904dd769 # v4.1
|
||||
with:
|
||||
formula-name: starship
|
||||
tag-name: ${{ needs.release_please.outputs.tag_name }}
|
||||
@@ -367,9 +390,9 @@ jobs:
|
||||
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
- name: Setup | Artifacts
|
||||
uses: actions/download-artifact@v6
|
||||
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
|
||||
- run: pwsh ./install/windows/choco/update.ps1
|
||||
env:
|
||||
STARSHIP_VERSION: ${{ needs.release_please.outputs.tag_name }}
|
||||
@@ -383,7 +406,7 @@ jobs:
|
||||
continue-on-error: true
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
- name: Merge | Merge Crowdin PR
|
||||
run: gh pr merge i18n_master --squash --repo=starship/starship
|
||||
env:
|
||||
@@ -395,7 +418,7 @@ jobs:
|
||||
needs: merge_crowdin_pr
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
- name: Trigger workflow dispatch
|
||||
run: gh workflow run publish-docs.yml
|
||||
env:
|
||||
|
||||
@@ -22,8 +22,8 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
- name: Test | Security Audit
|
||||
uses: EmbarkStudios/cargo-deny-action@v2.0.13
|
||||
uses: EmbarkStudios/cargo-deny-action@bb137d7af7e4fb67e5f82a49c4fce4fad40782fe # v2.0.20
|
||||
with:
|
||||
command: check ${{ matrix.checks }}
|
||||
|
||||
@@ -6,5 +6,5 @@ jobs:
|
||||
name: Spell Check with Typos
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: crate-ci/typos@v1.38.1
|
||||
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
- uses: crate-ci/typos@37bb98842b0d8c4ffebdb75301a13db0267cef89 # v1.47.2
|
||||
|
||||
@@ -24,12 +24,10 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
components: rustfmt
|
||||
run: rustup toolchain install stable --profile minimal --component rustfmt --no-self-update
|
||||
|
||||
- name: Build | Format
|
||||
run: cargo fmt --all -- --check
|
||||
@@ -43,18 +41,16 @@ jobs:
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
components: clippy
|
||||
run: rustup toolchain install stable --profile minimal --component clippy --no-self-update
|
||||
|
||||
- name: Setup | Cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
|
||||
|
||||
- name: Build | Lint
|
||||
uses: giraffate/clippy-action@94e9bd8deab2618756ec5380f12eb35bcb0a88ca
|
||||
run: cargo clippy --workspace --locked -- -D warnings
|
||||
|
||||
# Ensure that the project could be successfully compiled
|
||||
cargo_check:
|
||||
@@ -62,13 +58,13 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
run: rustup toolchain install stable --profile minimal --no-self-update
|
||||
|
||||
- name: Setup | Cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
|
||||
|
||||
- name: Build | Check
|
||||
run: cargo check --workspace --locked
|
||||
@@ -80,13 +76,13 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
run: rustup toolchain install stable --profile minimal --no-self-update
|
||||
|
||||
- name: Setup | Cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
|
||||
|
||||
- name: Build | Check
|
||||
run: cargo check --workspace --locked --no-default-features
|
||||
@@ -98,13 +94,13 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
run: rustup toolchain install stable --profile minimal --no-self-update
|
||||
|
||||
- name: Setup | Cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
|
||||
|
||||
- name: Build | Check
|
||||
run: cargo check --workspace --locked --all-features
|
||||
@@ -115,28 +111,26 @@ jobs:
|
||||
needs: cargo_check
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
checks: write
|
||||
contents: read
|
||||
pull-requests: write
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
run: rustup toolchain install stable --profile minimal --no-self-update
|
||||
|
||||
- name: Setup | Cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
|
||||
|
||||
- name: Run | Generate Schema
|
||||
run: cargo run --locked --features config-schema -- config-schema > .github/config-schema.json
|
||||
|
||||
- name: Check | Detect Changes
|
||||
uses: reviewdog/action-suggester@v1.24.0
|
||||
with:
|
||||
tool_name: starship config-schema
|
||||
filter_mode: nofilter
|
||||
fail_on_error: 'true'
|
||||
run: |
|
||||
if ! git diff --exit-code .github/config-schema.json; then
|
||||
echo "::error file=.github/config-schema.json::config-schema.json is out of date. Run 'cargo run --features config-schema -- config-schema > .github/config-schema.json' and commit the result."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Run tests on Linux, macOS, and Windows
|
||||
# On both Rust stable and Rust nightly
|
||||
@@ -156,20 +150,21 @@ jobs:
|
||||
RUSTFLAGS: ${{ matrix.rustflags || '' }}
|
||||
steps:
|
||||
- name: Setup | Checkout
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
|
||||
# Install all the required dependencies for testing
|
||||
- name: Setup | Rust
|
||||
uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: ${{ matrix.rust }}
|
||||
components: llvm-tools-preview
|
||||
run: |
|
||||
rustup toolchain install ${{ matrix.rust }} --profile minimal --component llvm-tools-preview --no-self-update
|
||||
rustup default ${{ matrix.rust }}
|
||||
|
||||
- name: Setup | Cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
|
||||
|
||||
- name: Install cargo-llvm-cov
|
||||
uses: taiki-e/install-action@cargo-llvm-cov
|
||||
uses: taiki-e/install-action@25435dc8dd3baed7417e0c96d3fe89013a5b2e09 # v2.81.3
|
||||
with:
|
||||
tool: cargo-llvm-cov@0.8.5
|
||||
|
||||
# For windows installer test
|
||||
# On stable rust & main repo pushes only
|
||||
@@ -228,7 +223,7 @@ jobs:
|
||||
STARSHIP_VERSION: v1.2.3
|
||||
|
||||
- name: Sign | Upload Executable [Windows]
|
||||
uses: actions/upload-artifact@v5
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
continue-on-error: true
|
||||
id: unsigned-artifacts
|
||||
if: matrix.os == 'windows-latest' && matrix.rust == 'stable' && github.event_name == 'push' && github.repository == 'starship/starship'
|
||||
@@ -239,7 +234,7 @@ jobs:
|
||||
target/debug/starship-x86_64-pc-windows-msvc.msi
|
||||
|
||||
- name: Sign | Sign [Windows]
|
||||
uses: signpath/github-action-submit-signing-request@v2
|
||||
uses: signpath/github-action-submit-signing-request@b9d91eadd323de506c0c81cf0c7fe7438f3360fd # v2.2
|
||||
continue-on-error: true
|
||||
if: matrix.os == 'windows-latest' && matrix.rust == 'stable' && github.event_name == 'push' && github.repository == 'starship/starship'
|
||||
with:
|
||||
@@ -252,7 +247,7 @@ jobs:
|
||||
output-artifact-directory: target/debug
|
||||
|
||||
- name: Upload coverage to Codecov
|
||||
uses: codecov/codecov-action@v5
|
||||
uses: codecov/codecov-action@e79a6962e0d4c0c17b229090214935d2e33f8354 # v6.0.1
|
||||
if: github.repository == 'starship/starship'
|
||||
with:
|
||||
token: ${{ secrets.CODECOV_TOKEN }}
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
# AI Usage Policy
|
||||
|
||||
This policy supplements our [Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
This project is maintained by volunteers.
|
||||
This policy exists to keep review burden reasonable.
|
||||
The policy is inspired by the [Ghostty](https://github.com/ghostty-org/ghostty/blob/main/AI_POLICY.md) and [LLVM](https://llvm.org/docs/AIToolPolicy.html) AI policies.
|
||||
|
||||
Contributions that violate this policy may be closed without further notice.
|
||||
|
||||
## Mandatory Disclosure
|
||||
|
||||
Every Pull Request that utilizes AI-assisted tooling (including but not limited to Claude Code, Cursor, GitHub Copilot, ChatGPT, or local LLMs) must disclose its usage.
|
||||
|
||||
### PR Description
|
||||
|
||||
You must complete the **AI-Assistance** section in our Pull Request Template.
|
||||
|
||||
## Human-in-the-Loop
|
||||
|
||||
Contributors must fully understand all submitted contributions.
|
||||
|
||||
### Contributions
|
||||
|
||||
- You must be able to explain what your changes do and defend your implementation choices.
|
||||
- You are expected to have read and understood every line of code you submit.
|
||||
- If your response to a maintainer's question is an unedited copy-paste from an LLM, or if you cannot explain the mechanics of your PR, the PR will be closed.
|
||||
|
||||
### Issue Triage and Discussions
|
||||
|
||||
You are not allowed to reply to user issues or discussions with unverified or raw AI-generated information.
|
||||
|
||||
## "Good First Issue" Protections
|
||||
|
||||
You may not submit contributions to close a `🌱 good first issue` if they were authored with substantial AI assistance.
|
||||
These issues are intentionally triaged as learning opportunities for new developers navigating the codebase for the first time.
|
||||
|
||||
## Low-Effort Contributions & Prohibition of Autonomous Agents
|
||||
|
||||
- Contributions that are overly verbose, contain unsupported or hallucinated claims, or otherwise show the hallmarks of low-effort LLM usage may be closed without further notice.
|
||||
- Contributions via OpenClaw, or any other unsupervised autonomous agent operating in an automated loop, are strictly prohibited.
|
||||
@@ -1,5 +1,62 @@
|
||||
# Changelog
|
||||
|
||||
## [1.25.1](https://github.com/starship/starship/compare/v1.25.0...v1.25.1) (2026-04-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **git:** improve bare repository detection ([#7421](https://github.com/starship/starship/issues/7421)) ([27079d7](https://github.com/starship/starship/commit/27079d7669b3072a944d3610f5dd5fec65321841))
|
||||
* **presets:** Update no-nerd-font to be up-to-date ([#7440](https://github.com/starship/starship/issues/7440)) ([65fb647](https://github.com/starship/starship/commit/65fb647bc38da09fe5d140f055c9f67d740bfa67))
|
||||
* **python:** align `python_binary` schema with argument support ([#7415](https://github.com/starship/starship/issues/7415)) ([3ec9b5c](https://github.com/starship/starship/commit/3ec9b5c54caa828164c710500a25ccd43ef26a64))
|
||||
|
||||
## [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)
|
||||
|
||||
|
||||
|
||||
+2
-2
@@ -273,10 +273,10 @@ Once setup is complete, you can refer to VitePress documentation on the actual i
|
||||
This is our preferred process for opening a PR on GitHub:
|
||||
|
||||
1. Fork this repository
|
||||
2. Create a branch off of `master` for your work: `git checkout -b my-feature-branch`
|
||||
2. Create a branch off of `main` for your work: `git checkout -b my-feature-branch`
|
||||
3. Make some changes, committing them along the way
|
||||
4. When your changes are ready for review, push your branch: `git push origin my-feature-branch`
|
||||
5. Create a pull request from your branch to `starship/master`
|
||||
5. Create a pull request from your branch to `starship/main`
|
||||
6. No need to assign the pull request to anyone, we'll review it when we can
|
||||
7. When the changes have been reviewed and approved, someone will squash and merge for you
|
||||
|
||||
|
||||
Generated
+1063
-1124
File diff suppressed because it is too large
Load Diff
+38
-38
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "starship"
|
||||
version = "1.24.0"
|
||||
version = "1.25.1"
|
||||
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,63 @@ config-schema = ["schemars"]
|
||||
notify = ["notify-rust"]
|
||||
|
||||
[dependencies]
|
||||
chrono = { version = "0.4.42", default-features = false, features = ["clock", "std", "wasmbind"] }
|
||||
clap = { version = "4.5.50", features = ["derive", "cargo", "unicode"] }
|
||||
clap_complete = "4.5.59"
|
||||
clap_complete_nushell = "4.5.9"
|
||||
clap = { version = "4.6.1", features = ["derive", "cargo", "unicode"] }
|
||||
clap_complete = "4.6.5"
|
||||
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.74.1", default-features = false, features = ["max-performance-safe", "revision", "zlib-rs", "status"] }
|
||||
indexmap = { version = "2.12.0", features = ["serde"] }
|
||||
jsonc-parser = { version = "0.27.0", features = ["serde"] }
|
||||
log = { version = "0.4.28", features = ["std"] }
|
||||
gix = { version = "0.84.0", default-features = false, features = ["max-performance-safe", "revision", "zlib-rs", "status", "sha1"] }
|
||||
indexmap = { version = "2.14.0", features = ["serde"] }
|
||||
jiff = { version = "0.2.28", features = ["serde"] }
|
||||
jsonc-parser = { version = "0.32.4", features = ["serde"] }
|
||||
log = { version = "0.4.30", 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 }
|
||||
notify-rust = { version = "4.17.0", optional = true }
|
||||
nu-ansi-term = "0.50.3"
|
||||
open = "5.3.2"
|
||||
open = "5.3.5"
|
||||
# update os module config and tests when upgrading os_info
|
||||
os_info = "3.12.0"
|
||||
os_info = { version = "3.15.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.5"
|
||||
path-slash = "0.2.1"
|
||||
pest = "2.8.3"
|
||||
pest_derive = "2.8.3"
|
||||
pest = "2.8.6"
|
||||
pest_derive = "2.8.6"
|
||||
process_control = "5.2.0"
|
||||
quick-xml = "0.38.3"
|
||||
rand = "0.9.2"
|
||||
rayon = "1.11.0"
|
||||
regex = { version = "1.12.2", default-features = false, features = ["perf", "std", "unicode-perl"] }
|
||||
quick-xml = "0.40.1"
|
||||
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.27"
|
||||
semver = "1.0.28"
|
||||
serde = { version = "1.0.228", features = ["derive"] }
|
||||
serde_json = "1.0.145"
|
||||
sha1 = "0.10.6"
|
||||
shadow-rs = { version = "1.4.0", default-features = false, features = ["build"] }
|
||||
serde_json = "1.0.150"
|
||||
sha1 = "0.11.0"
|
||||
shadow-rs = { version = "2.0.0", default-features = false, features = ["build"] }
|
||||
# battery is optional (on by default) because the crate doesn't currently build for Termux
|
||||
# see: https://github.com/svartalf/rust-battery/issues/33
|
||||
starship-battery = { version = "0.10.2", optional = true }
|
||||
starship-battery = { version = "0.11.0", optional = true }
|
||||
strsim = "0.11.1"
|
||||
systemstat = "=0.2.5"
|
||||
terminal_size = "0.4.3"
|
||||
toml = { version = "0.9.8", features = ["preserve_order"] }
|
||||
toml_edit = "0.23.7"
|
||||
unicode-segmentation = "1.12.0"
|
||||
systemstat = "=0.2.7"
|
||||
tempfile = "3.27.0"
|
||||
terminal_size = "0.4.4"
|
||||
toml = { version = "1.1.2", features = ["preserve_order"] }
|
||||
toml_edit = "0.25.12"
|
||||
unicode-segmentation = "1.13.3"
|
||||
unicode-width = "0.2.2"
|
||||
urlencoding = "2.1.3"
|
||||
versions = "7.0.0"
|
||||
which = "8.0.0"
|
||||
whoami = { version = "1.6.1", default-features = false }
|
||||
yaml-rust2 = "0.10.4"
|
||||
which = "8.0.3"
|
||||
whoami = { version = "2.1.2", default-features = false, features = ["std", "wasi-wasite"] }
|
||||
yaml-rust2 = "0.11.0"
|
||||
|
||||
guess_host_triple = "0.1.5"
|
||||
home = "0.5.12"
|
||||
shell-words = "1.1.0"
|
||||
shell-words = "1.1.1"
|
||||
|
||||
[dependencies.schemars]
|
||||
version = "1.0.4"
|
||||
version = "1.2.1"
|
||||
optional = true
|
||||
features = ["preserve_order", "indexmap2"]
|
||||
|
||||
@@ -108,18 +109,17 @@ features = [
|
||||
]
|
||||
|
||||
[target.'cfg(not(windows))'.dependencies]
|
||||
nix = { version = "0.30.1", default-features = false, features = ["feature", "fs", "user"] }
|
||||
nix = { version = "0.31.3", default-features = false, features = ["feature", "fs", "user"] }
|
||||
|
||||
[build-dependencies]
|
||||
shadow-rs = { version = "1.4.0", default-features = false, features = ["build"] }
|
||||
shadow-rs = { version = "2.0.0", 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.23.0"
|
||||
mockall = "=0.14.0"
|
||||
|
||||
[profile.release]
|
||||
codegen-units = 1
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<p align="center">
|
||||
<img
|
||||
width="400"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/logo.png"
|
||||
alt="Starship – Cross-shell prompt"
|
||||
/>
|
||||
</p>
|
||||
@@ -9,7 +9,7 @@
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/actions"
|
||||
><img
|
||||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=main&label=workflow&style=flat-square"
|
||||
alt="GitHub Actions workflow status"
|
||||
/></a>
|
||||
<a href="https://crates.io/crates/starship"
|
||||
@@ -48,114 +48,125 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
<a href="https://github.com/starship/starship/blob/main/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-us.png"
|
||||
alt="English"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/de-DE/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/de-DE/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-de.png"
|
||||
alt="Deutsch"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/es-ES/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-es.png"
|
||||
alt="Español"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/fr-FR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-fr.png"
|
||||
alt="Français"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/id-ID/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/id-ID/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-id.png"
|
||||
alt="Bahasa Indonesia"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/it-IT/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/it-IT/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-it.png"
|
||||
alt="Italiano"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/ja-JP/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/ja-JP/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-jp.png"
|
||||
alt="日本語"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/pt-BR/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/pt-BR/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-br.png"
|
||||
alt="Português do Brasil"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/ru-RU/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/ru-RU/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-ru.png"
|
||||
alt="Русский"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/uk-UA/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/uk-UA/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ua.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-ua.png"
|
||||
alt="Українська"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/vi-VN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-vn.png"
|
||||
alt="Tiếng Việt"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/zh-CN/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/zh-CN/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-cn.png"
|
||||
alt="简体中文"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://github.com/starship/starship/blob/master/docs/zh-TW/guide/README.md"
|
||||
href="https://github.com/starship/starship/blob/main/docs/zh-TW/guide/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/flag-tw.png"
|
||||
alt="繁體中文"
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
<h1></h1>
|
||||
|
||||
> [!WARNING]
|
||||
> **The default branch has been renamed from `master` to `main`.**
|
||||
> If you have a local clone, update it by running:
|
||||
>
|
||||
> ```sh
|
||||
> git branch -m master main
|
||||
> git fetch origin
|
||||
> git branch -u origin/main main
|
||||
> git remote set-head origin -a
|
||||
> ```
|
||||
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/demo.gif"
|
||||
alt="Starship with iTerm2 and the Snazzy theme"
|
||||
width="50%"
|
||||
align="right"
|
||||
@@ -410,11 +421,11 @@ 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/).
|
||||
|
||||
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋
|
||||
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/main/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋
|
||||
|
||||
## 💭 Inspired By
|
||||
|
||||
@@ -443,13 +454,13 @@ This program will not transfer any information to other networked systems unless
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon">
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/main/media/icon.png" alt="Starship rocket icon">
|
||||
</p>
|
||||
|
||||
## 📝 License
|
||||
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
|
||||
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.
|
||||
This project is [ISC](https://github.com/starship/starship/blob/main/LICENSE) licensed.
|
||||
|
||||
[alpine linux packages]: https://pkgs.alpinelinux.org/packages?name=starship
|
||||
[arch linux extra]: https://archlinux.org/packages/extra/x86_64/starship
|
||||
|
||||
@@ -37,7 +37,7 @@ fn gen_presets_hook(mut file: &File) -> SdResult<()> {
|
||||
.and_then(|v| v.strip_suffix(".toml"))
|
||||
.expect("Failed to process filename");
|
||||
presets.push_str(format!("print::Preset(\"{name}\"),\n").as_str());
|
||||
match_arms.push_str(format!(r#""{name}" => include_bytes!(r"{full_path}"),"#).as_str());
|
||||
match_arms.push_str(format!(r#""{name}" => include_str!(r"{full_path}"),"#).as_str());
|
||||
}
|
||||
|
||||
writeln!(
|
||||
@@ -51,7 +51,7 @@ pub fn get_preset_list<'a>() -> &'a [print::Preset] {{
|
||||
]
|
||||
}}
|
||||
|
||||
pub fn get_preset_content(name: &str) -> &[u8] {{
|
||||
pub fn get_preset_content(name: &str) -> &str {{
|
||||
match name {{
|
||||
{match_arms}
|
||||
_ => unreachable!(),
|
||||
|
||||
+1
-1
@@ -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.
|
||||
|
||||
|
||||
@@ -315,6 +315,12 @@ Produces a prompt like the following:
|
||||
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
|
||||
```
|
||||
|
||||
When using `zsh` (v5.0.5+), the shell adds a default trailing space to the right prompt. This can cause alignment issues specifically when using the Starship `$fill` module. To remove this gap, add the following to your `.zshrc`:
|
||||
|
||||
```zsh
|
||||
ZLE_RPROMPT_INDENT=0
|
||||
```
|
||||
|
||||
## Continuation Prompt
|
||||
|
||||
Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote).
|
||||
@@ -338,6 +344,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:
|
||||
|
||||
+14
-34
@@ -2,25 +2,22 @@
|
||||
layout: home
|
||||
hero:
|
||||
image: /logo.svg
|
||||
text:
|
||||
text: null
|
||||
tagline: التخصيص البسيط و السريع و الغير محدود لي ال"shell"!
|
||||
actions:
|
||||
-
|
||||
theme: brand
|
||||
- theme: brand
|
||||
text: البدء مع Starship ←
|
||||
link: ./guide/
|
||||
features:
|
||||
-
|
||||
title: التوافق أولاً
|
||||
- title: التوافق أولاً
|
||||
details: يعمل على أكثر موجهات الأوامر شيوعاً في أكثر نظم التشغيل شيوعاً. استخدمه في كل مكان!
|
||||
-
|
||||
title: Rust-Powered
|
||||
- title: Rust-Powered
|
||||
details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
|
||||
-
|
||||
title: قابل للتخصيص
|
||||
- title: قابل للتخصيص
|
||||
details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.
|
||||
footer: ISC Licensed | Copyright © 2019-present Starship Contributors
|
||||
#Used for the description meta tag, for SEO
|
||||
|
||||
# Used for the description meta tag, for SEO
|
||||
metaTitle: "Starship: Cross-Shell Prompt"
|
||||
description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell.
|
||||
---
|
||||
@@ -52,7 +49,6 @@ onMounted(() => {
|
||||
|
||||
1. تثبيت **starship**:
|
||||
|
||||
|
||||
#### تثبيت أحدث إصدار
|
||||
|
||||
بإستخدام Shell:
|
||||
@@ -63,7 +59,6 @@ onMounted(() => {
|
||||
|
||||
لتحديث Starship نفسه، أعد تشغيل البرنامج النصي أعلاه. سيتم استبدال الإصدار الحالي بدون لمس تكوين Starship.
|
||||
|
||||
|
||||
#### التثبيت عبر مدير الحزم
|
||||
|
||||
بإستخدام [Homebrew](https://brew.sh/):
|
||||
@@ -78,8 +73,7 @@ onMounted(() => {
|
||||
winget install starship
|
||||
```
|
||||
|
||||
1. أضف ما يلي إلى ملف تكوين موجه الأوامر الخاص بك:
|
||||
|
||||
2. أضف ما يلي إلى ملف تكوين موجه الأوامر الخاص بك:
|
||||
|
||||
#### Bash
|
||||
|
||||
@@ -91,7 +85,6 @@ onMounted(() => {
|
||||
eval "$(starship init bash)"
|
||||
```
|
||||
|
||||
|
||||
#### Fish
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.config/fish/config.fish`:
|
||||
@@ -102,7 +95,6 @@ onMounted(() => {
|
||||
starship init fish | source
|
||||
```
|
||||
|
||||
|
||||
#### Zsh
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.zshrc`:
|
||||
@@ -113,8 +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.
|
||||
|
||||
@@ -122,7 +113,6 @@ onMounted(() => {
|
||||
Invoke-Expression (&starship init powershell)
|
||||
```
|
||||
|
||||
|
||||
#### Ion
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.config/ion/initrc`:
|
||||
@@ -133,16 +123,11 @@ onMounted(() => {
|
||||
eval $(starship init ion)
|
||||
```
|
||||
|
||||
|
||||
#### 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
|
||||
@@ -150,6 +135,7 @@ onMounted(() => {
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
#### Tcsh
|
||||
|
||||
@@ -161,14 +147,10 @@ onMounted(() => {
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
#### 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):
|
||||
|
||||
@@ -177,7 +159,6 @@ onMounted(() => {
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
|
||||
#### Xonsh
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.xonshrc`:
|
||||
@@ -188,7 +169,6 @@ onMounted(() => {
|
||||
execx($(starship init xonsh))
|
||||
```
|
||||
|
||||
|
||||
#### Cmd
|
||||
|
||||
عليك بإستخدام [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) مع Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -84,7 +80,9 @@ enable_transience
|
||||
|
||||
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. This is useful in cases where all the prompt information is not always needed. To enable this, put this in `~/.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.
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
@@ -126,7 +124,9 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
## Custom pre-prompt and pre-execution Commands in Bash
|
||||
|
||||
Bash does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `bash`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
|
||||
Bash does not have a formal preexec/precmd framework like most other shells.
|
||||
Because of this, it is difficult to provide fully customizable hooks in `bash`.
|
||||
However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
|
||||
|
||||
- To run a custom function right before the prompt is drawn, define a new function and then assign its name to `starship_precmd_user_func`. For example, to draw a rocket before the prompt, you would do
|
||||
|
||||
@@ -137,7 +137,9 @@ function blastoff(){
|
||||
starship_precmd_user_func="blastoff"
|
||||
```
|
||||
|
||||
- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal _before_ initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
|
||||
- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/).
|
||||
However, you **must** trap the DEBUG signal _before_ initializing Starship!
|
||||
Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
|
||||
|
||||
```bash
|
||||
function blastoff(){
|
||||
@@ -151,7 +153,9 @@ set +o functrace
|
||||
|
||||
## Custom pre-prompt and pre-execution Commands in PowerShell
|
||||
|
||||
PowerShell does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `powershell`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
|
||||
PowerShell does not have a formal preexec/precmd framework like most other shells.
|
||||
Because of this, it is difficult to provide fully customizable hooks in `powershell`.
|
||||
However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
|
||||
|
||||
Create a function named `Invoke-Starship-PreCommand`
|
||||
|
||||
@@ -163,7 +167,8 @@ function Invoke-Starship-PreCommand {
|
||||
|
||||
## Change Window Title
|
||||
|
||||
Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish even does it by default. Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`.
|
||||
Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish even does it by default.
|
||||
Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`.
|
||||
|
||||
First, define a window title change function (identical in bash and zsh):
|
||||
|
||||
@@ -247,6 +252,12 @@ Produces a prompt like the following:
|
||||
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
|
||||
```
|
||||
|
||||
When using `zsh` (v5.0.5+), the shell adds a default trailing space to the right prompt. This can cause alignment issues specifically when using the Starship `$fill` module. To remove this gap, add the following to your `.zshrc`:
|
||||
|
||||
```zsh
|
||||
ZLE_RPROMPT_INDENT=0
|
||||
```
|
||||
|
||||
## Continuation Prompt
|
||||
|
||||
Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote).
|
||||
@@ -270,6 +281,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 | الافتراضي | الوصف |
|
||||
| --------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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 | مثال | الوصف |
|
||||
| ----------------------------- | ------------------- | ------------------------------------- |
|
||||
| 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 | الافتراضي | الوصف |
|
||||
| ---------------------- | --------------------------------- | ------------------------------------------------------------------ |
|
||||
| `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 | الافتراضي | الوصف |
|
||||
| ----------- | ------------ | ------------------------------------------------------------------------ |
|
||||
| `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 | مثال | الوصف |
|
||||
| ----------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------- |
|
||||
| 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 | الافتراضي | الوصف |
|
||||
| ---------- | ---------------------------------- | --------------------------------------------------- |
|
||||
| `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 | الافتراضي | الوصف |
|
||||
| ----------- | ------------ | ------------------------------------------------------------------ |
|
||||
| `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 | مثال | الوصف |
|
||||
| ---------------------------------- | -------- | ---------------------------------------------------------------------- |
|
||||
| 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:
|
||||
@@ -287,7 +608,9 @@ Style strings are a list of words, separated by whitespace. The words are not ca
|
||||
- `<color>`
|
||||
- `none`
|
||||
|
||||
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing, though this may change in the future. `<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` swaps the background and foreground colors. The order of words in the string does not matter.
|
||||
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing, though this may change in the future.
|
||||
`<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` swaps the background and foreground colors. The order of words in the string does not matter.
|
||||
|
||||
The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. It may become an error to use `none` in conjunction with other tokens in the future.
|
||||
|
||||
|
||||
+1894
-1603
File diff suppressed because it is too large
Load Diff
@@ -103,14 +103,15 @@ echo -e "\xee\x82\xa0"
|
||||
|
||||
The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
|
||||
|
||||
If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
|
||||
If either symbol fails to display correctly, your system is still misconfigured.
|
||||
Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
|
||||
|
||||
## How do I uninstall Starship?
|
||||
|
||||
Starship is just as easy to uninstall as it is to install in the first place.
|
||||
|
||||
1. Remove any lines in your shell config (e.g. `~/.bashrc`) used to initialize Starship.
|
||||
1. Delete the Starship binary.
|
||||
2. Delete the Starship binary.
|
||||
|
||||
If Starship was installed using a package manager, please refer to their docs for uninstallation instructions.
|
||||
|
||||
|
||||
+106
-88
@@ -1,13 +1,12 @@
|
||||
<p align="center">
|
||||
<img
|
||||
width="400"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/logo.png"
|
||||
alt="Starship – Cross-shell prompt"
|
||||
/>
|
||||
/>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/actions"
|
||||
<p align="center"><a href="https://github.com/starship/starship/actions"
|
||||
><img
|
||||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||||
alt="GitHub Actions workflow status"
|
||||
@@ -39,16 +38,14 @@
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs">الموقع</a>
|
||||
<p align="center"><a href="https://starship.rs">الموقع</a>
|
||||
·
|
||||
<a href="#🚀-installation">التثبيت</a>
|
||||
·
|
||||
<a href="https://starship.rs/config/">الإعدادات</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
<p align="center"><a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||||
@@ -154,24 +151,34 @@
|
||||
|
||||
<h1></h1>
|
||||
|
||||
> [!WARNING]
|
||||
> **The default branch has been renamed from `master` to `main`.**
|
||||
> If you have a local clone, update it by running:
|
||||
>
|
||||
> ```sh
|
||||
> git branch -m master main
|
||||
> git fetch origin
|
||||
> git branch -u origin/main main
|
||||
> git remote set-head origin -a
|
||||
> ```
|
||||
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship with iTerm2 and the Snazzy theme"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship with iTerm2 and the Snazzy theme"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
|
||||
**التخصيص البسيط و السريع و الغير محدود لي ال"shell"!**
|
||||
|
||||
- **Fast:** إنها _في غاية_ السرعة! 🚀
|
||||
- ** Customizable:** قم بتهيئة ال"prompt" من كل النواحي.
|
||||
- \*\* Customizable:\*\* قم بتهيئة ال"prompt" من كل النواحي.
|
||||
- **Universal:** يعمل على أي shell، على أي نظام تشغيل.
|
||||
- ** Customizable:** تظهر المعلومات ذات الصلة في لمح البصر.
|
||||
- \*\* Customizable:\*\* تظهر المعلومات ذات الصلة في لمح البصر.
|
||||
- **Feature rich:** تدعم جميع الأدوات المفضلة لديك.
|
||||
- **Easy:** سريع التثبيت – استخدمها في دقائق معدودة.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs/config/"><strong>تصفّح مستندات Starship ▶</strong></a>
|
||||
<p align="center"><a href="https://starship.rs/config/"><strong>تصفّح مستندات Starship ▶</strong></a>
|
||||
</p>
|
||||
|
||||
<a name="🚀-installation"></a>
|
||||
@@ -186,32 +193,29 @@
|
||||
|
||||
حدد نظام التشغيل الخاص بك من القائمة أدناه لعرض تعليمات التثبيت:
|
||||
|
||||
<details>
|
||||
<summary>Android</summary>
|
||||
<details><summary>Android</summary>
|
||||
|
||||
يمكنك تثبيت starship باستخدام احد ال package managers التالية:
|
||||
|
||||
| Repository | Instructions |
|
||||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||||
| Repository | Instructions |
|
||||
| ---------- | ---------------------- |
|
||||
| [Termux] | `pkg install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>BSD</summary>
|
||||
<details><summary>BSD</summary>
|
||||
|
||||
يمكنك تثبيت starship باستخدام احد ال package managers التالية:
|
||||
|
||||
| Distribution | Repository | Instructions |
|
||||
| ------------ | -------------------------------------------------------- | --------------------------------- |
|
||||
| **_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` |
|
||||
| Distribution | Repository | Instructions |
|
||||
| ------------ | --------------- | --------------------------------- |
|
||||
| **_Any_** | **[crates.io]** | `cargo install starship --locked` |
|
||||
| FreeBSD | [FreshPorts] | `pkg install starship` |
|
||||
| NetBSD | [pkgsrc] | `pkgin install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Linux</summary>
|
||||
<details><summary>Linux</summary>
|
||||
|
||||
قم بتثبيت أحدث إصدار للنظام الخاص بك:
|
||||
|
||||
@@ -221,26 +225,26 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
يمكنك تثبيت starship باستخدام احد ال package managers التالية:
|
||||
|
||||
| Distribution | Repository | Instructions |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| **_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_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS +7 | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Gentoo | [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` |
|
||||
| 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` |
|
||||
| Distribution | Repository | Instructions |
|
||||
| ---------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| **_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_ | [Linuxbrew] | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages] | `apk add starship` |
|
||||
| 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` |
|
||||
| openSUSE | [OSS] | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe] | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages] | `xbps-install -S starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>macOS</summary>
|
||||
<details><summary>macOS</summary>
|
||||
|
||||
قم بتثبيت أحدث إصدار للنظام الخاص بك:
|
||||
|
||||
@@ -254,25 +258,24 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
| -------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [Homebrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| [MacPorts](https://ports.macports.org/port/starship) | `port install starship` |
|
||||
| [Homebrew] | `brew install starship` |
|
||||
| [MacPorts] | `port install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Windows</summary>
|
||||
<details><summary>Windows</summary>
|
||||
|
||||
قم بتثبيت أحدث إصدار للنظام الخاص بك مع MSI-installers من قسم الإصدارات [](https://github.com/starship/starship/releases/latest).
|
||||
|
||||
يمكنك تثبيت starship باستخدام احد ال package managers التالية:
|
||||
|
||||
| Repository | Instructions |
|
||||
| -------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [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` |
|
||||
| Repository | Instructions |
|
||||
| ------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| [Chocolatey] | `choco install starship` |
|
||||
| [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `conda install -c conda-forge starship` |
|
||||
| [Scoop] | `scoop install starship` |
|
||||
| [winget] | `winget install --id Starship.Starship` |
|
||||
|
||||
</details>
|
||||
|
||||
@@ -280,8 +283,7 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
لإعداد ال starship قم بإعداد ال shell الخاص بك. اختر ما يناسبك من هذه القائمة:
|
||||
|
||||
<details>
|
||||
<summary>Bash</summary>
|
||||
<details><summary>Bash</summary>
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.bashrc`:
|
||||
|
||||
@@ -291,10 +293,10 @@ eval "$(starship init bash)"
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Cmd</summary>
|
||||
<details><summary>Cmd</summary>
|
||||
|
||||
عليك بإستخدام [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) مع Cmd. قم بإنشاء ملف في المسار `%LocalAppData%\clink\starship.lua` و ضع فيه المحتوى التالي:
|
||||
عليك بإستخدام [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) مع Cmd.
|
||||
قم بإنشاء ملف في المسار `%LocalAppData%\clink\starship.lua` و ضع فيه المحتوى التالي:
|
||||
|
||||
```lua
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
@@ -302,21 +304,19 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
<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>
|
||||
|
||||
<details>
|
||||
<summary>Fish</summary>
|
||||
<details><summary>Fish</summary>
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.config/fish/config.fish`:
|
||||
|
||||
@@ -326,8 +326,7 @@ starship init fish | source
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Ion</summary>
|
||||
<details><summary>Ion</summary>
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.config/ion/initrc`:
|
||||
|
||||
@@ -337,8 +336,7 @@ eval $(starship init ion)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Nushell</summary>
|
||||
<details><summary>Nushell</summary>
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
@@ -351,8 +349,7 @@ Note: Only Nushell v0.96+ is supported
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>PowerShell</summary>
|
||||
<details><summary>PowerShell</summary>
|
||||
|
||||
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`):
|
||||
|
||||
@@ -362,8 +359,7 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Tcsh</summary>
|
||||
<details><summary>Tcsh</summary>
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.tcshrc`:
|
||||
|
||||
@@ -373,8 +369,7 @@ eval `starship init tcsh`
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Xonsh</summary>
|
||||
<details><summary>Xonsh</summary>
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.xonshrc`:
|
||||
|
||||
@@ -384,8 +379,7 @@ execx($(starship init xonsh))
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Zsh</summary>
|
||||
<details><summary>Zsh</summary>
|
||||
|
||||
أضف ما يلي إلى نهاية `~/.zshrc`:
|
||||
|
||||
@@ -397,7 +391,8 @@ eval "$(starship init zsh)"
|
||||
|
||||
### الخطوة الثالثة. تهيئة starship
|
||||
|
||||
Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy!
|
||||
Start a new shell instance, and you should see your beautiful new shell prompt.
|
||||
If you're happy with the defaults, enjoy!
|
||||
|
||||
If you're looking to further customize Starship:
|
||||
|
||||
@@ -407,7 +402,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/issues?q=state%3Aopen%20label%3A%22%F0%9F%8C%B1%20good%20first%20issue%22).
|
||||
|
||||
إذا كنت تتحدث بطلاقة بلغة غير إنجليزية، فإننا نقدر أي مساعدة للحفاظ على ترجمة المستندات وتحديثها بلغات أخرى. إذا كنت ترغب في المساعدة، يمكن المساهمة بالترجمة على [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
@@ -438,11 +433,34 @@ Code Signing Roles:
|
||||
|
||||
This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon">
|
||||
<p align="center"><br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/main/media/icon.png" alt="Starship rocket icon">
|
||||
</p>
|
||||
|
||||
## 📝 الترخيص
|
||||
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br /> This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
|
||||
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.
|
||||
|
||||
[alpine linux packages]: <[Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship)>
|
||||
[arch linux extra]: <[Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship)>
|
||||
[chocolatey]: [Chocolatey]\(https://community.chocolatey.org/packages/starship\)
|
||||
[conda-forge]: [conda-forge]\(https://anaconda.org/conda-forge/starship\)
|
||||
[copr]: [Copr]\(https://copr.fedorainfracloud.org/coprs/atim/starship\)
|
||||
[crates.io]: **[crates.io]\(https://crates.io/crates/starship\)**
|
||||
[debian main]: <[Debian Main](https://sources.debian.org/src/starship/1.22.1-1/)>
|
||||
[freshports]: [FreshPorts]\(https://www.freshports.org/shells/starship\)
|
||||
[gentoo packages]: <[Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship)>
|
||||
[linuxbrew]: [Homebrew]\(https://formulae.brew.sh/formula/starship\)
|
||||
[homebrew]: [Linuxbrew]\(https://formulae.brew.sh/formula/starship\)
|
||||
[macports]: [MacPorts]\(https://ports.macports.org/port/starship\)
|
||||
[nixpkgs]: [nixpkgs]\(https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix\)
|
||||
[OSS]: [OSS]\(https://software.opensuse.org/package/starship\)
|
||||
[pkgsrc]: [pkgsrc]\(https://pkgsrc.se/shells/starship\)
|
||||
[scoop]: [Scoop]\(https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json\)
|
||||
[SignPath Foundation]: https://signpath.org
|
||||
[SignPath.io]: https://signpath.io
|
||||
[termux]: [Termux]\(https://github.com/termux/termux-packages/tree/master/packages/starship\)
|
||||
[ubuntu universe]: <[Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship)>
|
||||
[void linux packages]: <[Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship)>
|
||||
[winget]: [winget]\(https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship\)
|
||||
|
||||
@@ -3,11 +3,11 @@
|
||||
لثتبيت starship تحتاج للقيام بشيئين هما:
|
||||
|
||||
1. ثبت ملفات **starship** على جهازك
|
||||
1. تنبيه موجه الأوامر بإن يقوم بجعل سطر الأوامر ل starship وذلك بتعديل كود الإبتداء
|
||||
2. تنبيه موجه الأوامر بإن يقوم بجعل سطر الأوامر ل starship وذلك بتعديل كود الإبتداء
|
||||
|
||||
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. لكن، من أجل الاستخدام المتقدم، هناك حاجة لتوجيهات أخرى.
|
||||
|
||||
هناك العديد من الحالات التي لا تلبي المعلومات في ملف README.md احتياجها ولذلك هذه بعض إرشادات التثبيت الإضافية مقدمة من مجتمع starship. إذا كانت لديك ملاحظة وقمت بحلها ولم تجد هذا الحل لها ضمن الحلول التالية، الرجاء أضفها هنا!
|
||||
هناك العديد من الحالات التي لا تلبي المعلومات في ملف README.md احتياجها ولذلك هذه بعض إرشادات التثبيت الإضافية مقدمة من مجتمع starship. إذا كانت لديك ملاحظة وقمت بحلها ولم تجد هذا الحل لها ضمن الحلول التالية، الرجاء أضفها هنا! إذا كانت لديك ملاحظة وقمت بحلها ولم تجد هذا الحل لها ضمن الحلول التالية، الرجاء أضفها هنا!
|
||||
|
||||
## [Chocolatey](https://chocolatey.org)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
هذا الدليل هو جولة خلال التغييرات الرئيسية التي قمنا بها.
|
||||
|
||||
## `prompt_order`تم استبداله بتنسيق root-level ``
|
||||
## `prompt_order`تم استبداله بتنسيق root-level \`\`
|
||||
|
||||
Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship.
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# Presets
|
||||
|
||||
Here is a collection of community-submitted configuration presets for Starship. If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊
|
||||
Here is a collection of community-submitted configuration presets for Starship.
|
||||
If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊
|
||||
|
||||
To get details on how to use a preset, simply click on the image.
|
||||
|
||||
@@ -14,11 +15,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)
|
||||
|
||||
@@ -54,7 +51,8 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
|
||||
|
||||
## [Pastel Powerline](./pastel-powerline.md)
|
||||
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
It also shows how path substitution works in starship.
|
||||
|
||||
[](./pastel-powerline)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -8,7 +8,7 @@ This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainb
|
||||
|
||||
### المتطلبات الأساسية
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
- تثبيت [Nerd Font](https://www.nerdfonts.com/) وتمكينه في موجه الأوامر الخاصة بك
|
||||
|
||||
### Configuration
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
# Pastel Powerline Preset
|
||||
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
It also shows how path substitution works in starship.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
+15
-35
@@ -2,25 +2,22 @@
|
||||
layout: home
|
||||
hero:
|
||||
image: /logo.svg
|
||||
text:
|
||||
text: null
|
||||
tagline: আপনার টার্মিনাল এর জন্য একটি সহজ, প্রচণ্ড দ্রুত এবং অশেষভাবে কাস্টমাইজ করার মতো সুবিধাসম্পন্ন একটি প্রম্প্ট!
|
||||
actions:
|
||||
-
|
||||
theme: brand
|
||||
- theme: brand
|
||||
text: Get Started →
|
||||
link: ./guide/
|
||||
features:
|
||||
-
|
||||
title: Compatibility First
|
||||
- title: Compatibility First
|
||||
details: Works on the most common shells on the most common operating systems. Use it everywhere!
|
||||
-
|
||||
title: Rust-Powered
|
||||
- title: Rust-Powered
|
||||
details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
|
||||
-
|
||||
title: Customizable
|
||||
- title: Customizable
|
||||
details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.
|
||||
footer: ISC Licensed | Copyright © 2019-present Starship Contributors
|
||||
#Used for the description meta tag, for SEO
|
||||
|
||||
# Used for the description meta tag, for SEO
|
||||
metaTitle: "Starship: Cross-Shell Prompt"
|
||||
description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell.
|
||||
---
|
||||
@@ -52,7 +49,6 @@ onMounted(() => {
|
||||
|
||||
1. Install the **starship** binary:
|
||||
|
||||
|
||||
#### Install Latest Version
|
||||
|
||||
With Shell:
|
||||
@@ -63,7 +59,6 @@ onMounted(() => {
|
||||
|
||||
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
|
||||
|
||||
|
||||
#### Install via Package Manager
|
||||
|
||||
With [Homebrew](https://brew.sh/):
|
||||
@@ -78,8 +73,7 @@ onMounted(() => {
|
||||
winget install starship
|
||||
```
|
||||
|
||||
1. Add the init script to your shell's config file:
|
||||
|
||||
2. Add the init script to your shell's config file:
|
||||
|
||||
#### Bash
|
||||
|
||||
@@ -91,7 +85,6 @@ onMounted(() => {
|
||||
eval "$(starship init bash)"
|
||||
```
|
||||
|
||||
|
||||
#### Fish
|
||||
|
||||
`~/.config/fish/config.fish` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
@@ -102,7 +95,6 @@ onMounted(() => {
|
||||
starship init fish | source
|
||||
```
|
||||
|
||||
|
||||
#### Zsh
|
||||
|
||||
`~/.zshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
@@ -113,8 +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.
|
||||
|
||||
@@ -122,7 +113,6 @@ onMounted(() => {
|
||||
Invoke-Expression (&starship init powershell)
|
||||
```
|
||||
|
||||
|
||||
#### Ion
|
||||
|
||||
`~/.config/ion/initrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
@@ -133,16 +123,11 @@ onMounted(() => {
|
||||
eval $(starship init ion)
|
||||
```
|
||||
|
||||
|
||||
#### 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
|
||||
@@ -150,6 +135,7 @@ onMounted(() => {
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
#### Tcsh
|
||||
|
||||
@@ -161,14 +147,10 @@ onMounted(() => {
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
#### 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):
|
||||
|
||||
@@ -177,7 +159,6 @@ onMounted(() => {
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
|
||||
#### Xonsh
|
||||
|
||||
`~/.xonshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
@@ -188,10 +169,9 @@ onMounted(() => {
|
||||
execx($(starship init xonsh))
|
||||
```
|
||||
|
||||
|
||||
#### Cmd
|
||||
|
||||
আপনাকে Cmd এর সাথে [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) ব্যবহার করতে হবে । Add the following to a file `starship.lua` and place this file in Clink scripts directory:
|
||||
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory:
|
||||
|
||||
```lua
|
||||
-- starship.lua
|
||||
|
||||
@@ -1,18 +1,22 @@
|
||||
# Advanced Configuration
|
||||
|
||||
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.
|
||||
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
|
||||
|
||||
It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `Enable-TransientPrompt` in the shell session. To make it permanent, put this statement in your `$PROFILE`. Transience can be disabled on-the-fly with `Disable-TransientPrompt`.
|
||||
It is possible to replace the previous-printed prompt with a custom string. This
|
||||
is useful in cases where all the prompt information is not always needed. To enable
|
||||
this, run `Enable-TransientPrompt` in the shell session. To make it permanent, put
|
||||
this statement in your `$PROFILE`. Transience can be disabled on-the-fly with
|
||||
`Disable-TransientPrompt`.
|
||||
|
||||
By default, the left side of input gets replaced with `>`. To customize this, define a new function called `Invoke-Starship-TransientFunction`. For example, to display Starship's `character` module here, you would do
|
||||
By default, the left side of input gets replaced with `>`. To customize this,
|
||||
define a new function called `Invoke-Starship-TransientFunction`. For example, to
|
||||
display Starship's `character` module here, you would do
|
||||
|
||||
```powershell
|
||||
function Invoke-Starship-TransientFunction {
|
||||
@@ -26,15 +30,21 @@ Enable-TransientPrompt
|
||||
|
||||
## TransientPrompt and TransientRightPrompt in Cmd
|
||||
|
||||
Clink allows you to replace the previous-printed prompt with custom strings. This is useful in cases where all the prompt information is not always needed. To enable this, run `clink set prompt.transient <value>` where \<value\> can be one of:
|
||||
Clink allows you to replace the previous-printed prompt with custom strings. This
|
||||
is useful in cases where all the prompt information is not always needed. To enable
|
||||
this, run `clink set prompt.transient <value>` where \<value\> can be one of:
|
||||
|
||||
- `always`: always replace the previous prompt
|
||||
- `same_dir`: replace the previous prompt only if the working directory is same
|
||||
- `off`: do not replace the prompt (i.e. turn off transience)
|
||||
|
||||
You need to do this only once. Make the following changes to your `starship.lua` to customize what gets displayed on the left and on the right:
|
||||
You need to do this only once. Make the following changes to your `starship.lua`
|
||||
to customize what gets displayed on the left and on the right:
|
||||
|
||||
- By default, the left side of input gets replaced with `>`. To customize this, define a new function called `starship_transient_prompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display Starship's `character` module here, you would do
|
||||
- By default, the left side of input gets replaced with `>`. To customize this,
|
||||
define a new function called `starship_transient_prompt_func`. This function
|
||||
receives the current prompt as a string that you can utilize. For example, to
|
||||
display Starship's `character` module here, you would do
|
||||
|
||||
```lua
|
||||
function starship_transient_prompt_func(prompt)
|
||||
@@ -45,7 +55,10 @@ end
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
```
|
||||
|
||||
- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display the time at which the last command was started here, you would do
|
||||
- By default, the right side of input is empty. To customize this, define a new
|
||||
function called `starship_transient_rprompt_func`. This function receives the
|
||||
current prompt as a string that you can utilize. For example, to display
|
||||
the time at which the last command was started here, you would do
|
||||
|
||||
```lua
|
||||
function starship_transient_rprompt_func(prompt)
|
||||
@@ -56,11 +69,17 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
## TransientPrompt and TransientRightPrompt in Fish
|
||||
|
||||
It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `enable_transience` in the shell session. To make it permanent, put this statement in your `~/.config/fish/config.fish`. Transience can be disabled on-the-fly with `disable_transience`.
|
||||
It is possible to replace the previous-printed prompt with a custom string. This
|
||||
is useful in cases where all the prompt information is not always needed. To enable
|
||||
this, run `enable_transience` in the shell session. To make it permanent, put
|
||||
this statement in your `~/.config/fish/config.fish`. Transience can be disabled on-the-fly with
|
||||
`disable_transience`.
|
||||
|
||||
Note that in case of Fish, the transient prompt is only printed if the commandline is non-empty, and syntactically correct.
|
||||
|
||||
- By default, the left side of input gets replaced with a bold-green `❯`. To customize this, define a new function called `starship_transient_prompt_func`. For example, to display Starship's `character` module here, you would do
|
||||
- By default, the left side of input gets replaced with a bold-green `❯`. To customize this,
|
||||
define a new function called `starship_transient_prompt_func`. For example, to
|
||||
display Starship's `character` module here, you would do
|
||||
|
||||
```fish
|
||||
function starship_transient_prompt_func
|
||||
@@ -70,7 +89,9 @@ starship init fish | source
|
||||
enable_transience
|
||||
```
|
||||
|
||||
- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. For example, to display the time at which the last command was started here, you would do
|
||||
- By default, the right side of input is empty. To customize this, define a new
|
||||
function called `starship_transient_rprompt_func`. For example, to display
|
||||
the time at which the last command was started here, you would do
|
||||
|
||||
```fish
|
||||
function starship_transient_rprompt_func
|
||||
@@ -82,19 +103,33 @@ enable_transience
|
||||
|
||||
## TransientPrompt and TransientRightPrompt in 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. This is useful in cases where all the prompt information is not always needed. To enable this, put this in `~/.bashrc` `bleopt prompt_ps1_transient=<value>`:
|
||||
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. This is useful in cases where all
|
||||
the prompt information is not always needed. To enable this, put this in `~/.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.
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
- 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
|
||||
- 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
|
||||
|
||||
```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. For example, to display the time at which the last command was started here, you would do
|
||||
- To customize what the right side of input gets replaced with, configure the
|
||||
`prompt_rps1_final` Ble.sh option. For example, to display
|
||||
the time at which the last command was started here, you would do
|
||||
|
||||
```bash
|
||||
bleopt prompt_rps1_final='$(starship module time)'
|
||||
@@ -102,9 +137,14 @@ bleopt prompt_rps1_final='$(starship module time)'
|
||||
|
||||
## Custom pre-prompt and pre-execution Commands in Cmd
|
||||
|
||||
Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands in Cmd shell. It is fairly simple to use with Starship. Make the following changes to your `starship.lua` file as per your requirements:
|
||||
Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands
|
||||
in Cmd shell. It is fairly simple to use with Starship. Make the following changes
|
||||
to your `starship.lua` file as per your requirements:
|
||||
|
||||
- To run a custom function right before the prompt is drawn, define a new function called `starship_preprompt_user_func`. This function receives the current prompt as a string that you can utilize. For example, to draw a rocket before the prompt, you would do
|
||||
- To run a custom function right before the prompt is drawn, define a new
|
||||
function called `starship_preprompt_user_func`. This function receives
|
||||
the current prompt as a string that you can utilize. For example, to
|
||||
draw a rocket before the prompt, you would do
|
||||
|
||||
```lua
|
||||
function starship_preprompt_user_func(prompt)
|
||||
@@ -114,7 +154,10 @@ end
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
```
|
||||
|
||||
- To run a custom function right before a command is executed, define a new function called `starship_precmd_user_func`. This function receives the current commandline as a string that you can utilize. For example, to print the command that's about to be executed, you would do
|
||||
- To run a custom function right before a command is executed, define a new
|
||||
function called `starship_precmd_user_func`. This function receives
|
||||
the current commandline as a string that you can utilize. For example, to
|
||||
print the command that's about to be executed, you would do
|
||||
|
||||
```lua
|
||||
function starship_precmd_user_func(line)
|
||||
@@ -126,9 +169,14 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
## Custom pre-prompt and pre-execution Commands in Bash
|
||||
|
||||
Bash does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `bash`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
|
||||
Bash does not have a formal preexec/precmd framework like most other shells.
|
||||
Because of this, it is difficult to provide fully customizable hooks in `bash`.
|
||||
However, Starship does give you limited ability to insert your own functions
|
||||
into the prompt-rendering procedure:
|
||||
|
||||
- To run a custom function right before the prompt is drawn, define a new function and then assign its name to `starship_precmd_user_func`. For example, to draw a rocket before the prompt, you would do
|
||||
- To run a custom function right before the prompt is drawn, define a new
|
||||
function and then assign its name to `starship_precmd_user_func`. For example,
|
||||
to draw a rocket before the prompt, you would do
|
||||
|
||||
```bash
|
||||
function blastoff(){
|
||||
@@ -137,7 +185,11 @@ function blastoff(){
|
||||
starship_precmd_user_func="blastoff"
|
||||
```
|
||||
|
||||
- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal _before_ initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
|
||||
- To run a custom function right before a command runs, you can use the
|
||||
[`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/).
|
||||
However, you **must** trap the DEBUG signal _before_ initializing Starship!
|
||||
Starship can preserve the value of the DEBUG trap, but if the trap is overwritten
|
||||
after starship starts up, some functionality will break.
|
||||
|
||||
```bash
|
||||
function blastoff(){
|
||||
@@ -151,7 +203,10 @@ set +o functrace
|
||||
|
||||
## Custom pre-prompt and pre-execution Commands in PowerShell
|
||||
|
||||
PowerShell does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `powershell`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
|
||||
PowerShell does not have a formal preexec/precmd framework like most other shells.
|
||||
Because of this, it is difficult to provide fully customizable hooks in `powershell`.
|
||||
However, Starship does give you limited ability to insert your own functions
|
||||
into the prompt-rendering procedure:
|
||||
|
||||
Create a function named `Invoke-Starship-PreCommand`
|
||||
|
||||
@@ -163,7 +218,10 @@ function Invoke-Starship-PreCommand {
|
||||
|
||||
## Change Window Title
|
||||
|
||||
Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish even does it by default. Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`.
|
||||
Some shell prompts will automatically change the window title for you (e.g. to
|
||||
reflect your working directory). Fish even does it by default.
|
||||
Starship does not do this, but it's fairly straightforward to add this
|
||||
functionality to `bash`, `zsh`, `cmd` or `powershell`.
|
||||
|
||||
First, define a window title change function (identical in bash and zsh):
|
||||
|
||||
@@ -221,9 +279,13 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
## Enable Right Prompt
|
||||
|
||||
Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`.
|
||||
Some shells support a right prompt which renders on the same line as the input. Starship can
|
||||
set the content of the right prompt using the `right_format` option. Any module that can be used
|
||||
in `format` is also supported in `right_format`. The `$all` variable will only contain modules
|
||||
not explicitly used in either `format` or `right_format`.
|
||||
|
||||
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](../config/#fill).
|
||||
Note: The right prompt is a single line following the input location. To right align modules above
|
||||
the input line in a multi-line prompt, see the [`fill` module](../config/#fill).
|
||||
|
||||
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.
|
||||
|
||||
@@ -247,6 +309,12 @@ Produces a prompt like the following:
|
||||
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
|
||||
```
|
||||
|
||||
When using `zsh` (v5.0.5+), the shell adds a default trailing space to the right prompt. This can cause alignment issues specifically when using the Starship `$fill` module. To remove this gap, add the following to your `.zshrc`:
|
||||
|
||||
```zsh
|
||||
ZLE_RPROMPT_INDENT=0
|
||||
```
|
||||
|
||||
## Continuation Prompt
|
||||
|
||||
Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote).
|
||||
@@ -270,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:
|
||||
@@ -287,14 +665,19 @@ Style strings are a list of words, separated by whitespace. The words are not ca
|
||||
- `<color>`
|
||||
- `none`
|
||||
|
||||
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing, though this may change in the future. `<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` swaps the background and foreground colors. The order of words in the string does not matter.
|
||||
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing, though this may change in the future.
|
||||
`<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` swaps the background and foreground colors. The order of words in the string does not matter.
|
||||
|
||||
The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. It may become an error to use `none` in conjunction with other tokens in the future.
|
||||
|
||||
A color specifier can be one of the following:
|
||||
|
||||
- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`).
|
||||
- A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
|
||||
- One of the standard terminal colors: `black`, `red`, `green`, `blue`,
|
||||
`yellow`, `purple`, `cyan`, `white`. You can optionally prefix these
|
||||
with `bright-` to get the bright version (e.g. `bright-white`).
|
||||
- A `#` followed by a six-digit hexadecimal number. This specifies an
|
||||
[RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
|
||||
- A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
|
||||
|
||||
If multiple colors are specified for foreground/background, the last one in the string will take priority.
|
||||
|
||||
+2048
-1627
File diff suppressed because it is too large
Load Diff
@@ -58,7 +58,15 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
||||
|
||||
## Why do I see `Executing command "..." timed out.` warnings?
|
||||
|
||||
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](../config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
|
||||
Starship 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?
|
||||
|
||||
@@ -66,7 +74,11 @@ If you see symbols that you don't recognise you can use `starship explain` to ex
|
||||
|
||||
## 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.
|
||||
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.
|
||||
|
||||
```sh
|
||||
env STARSHIP_LOG=trace starship module rust
|
||||
@@ -88,10 +100,14 @@ starship bug-report
|
||||
|
||||
## Why don't I see a glyph symbol in my prompt?
|
||||
|
||||
The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that:
|
||||
The most common cause of this is system misconfiguration. Some Linux distros in
|
||||
particular do not come with font support out-of-the-box. You need to ensure that:
|
||||
|
||||
- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value, [you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/).
|
||||
- You have an emoji font installed. Most systems come with an emoji font by default, but some (notably Arch Linux) do not. You can usually install one through your system's package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice.
|
||||
- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value,
|
||||
[you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/).
|
||||
- You have an emoji font installed. Most systems come with an emoji font by default, but
|
||||
some (notably Arch Linux) do not. You can usually install one through your system's
|
||||
package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice.
|
||||
- You are using a [Nerd Font](https://www.nerdfonts.com/).
|
||||
|
||||
To test your system, run the following commands in a terminal:
|
||||
@@ -103,14 +119,17 @@ echo -e "\xee\x82\xa0"
|
||||
|
||||
The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
|
||||
|
||||
If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
|
||||
If either symbol fails to display correctly, your system is still misconfigured.
|
||||
Unfortunately, getting font configuration correct is sometimes difficult. Users
|
||||
on the Discord may be able to help. If both symbols display correctly, but
|
||||
you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
|
||||
|
||||
## How do I uninstall Starship?
|
||||
|
||||
Starship is just as easy to uninstall as it is to install in the first place.
|
||||
|
||||
1. Remove any lines in your shell config (e.g. `~/.bashrc`) used to initialize Starship.
|
||||
1. Delete the Starship binary.
|
||||
2. Delete the Starship binary.
|
||||
|
||||
If Starship was installed using a package manager, please refer to their docs for uninstallation instructions.
|
||||
|
||||
|
||||
+126
-108
@@ -1,13 +1,12 @@
|
||||
<p align="center">
|
||||
<img
|
||||
width="400"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/logo.png"
|
||||
alt="Starship – Cross-shell prompt"
|
||||
/>
|
||||
/>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/actions"
|
||||
<p align="center"><a href="https://github.com/starship/starship/actions"
|
||||
><img
|
||||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||||
alt="GitHub Actions workflow status"
|
||||
@@ -39,16 +38,14 @@
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs">ওয়েবসাইট</a>
|
||||
<p align="center"><a href="https://starship.rs">ওয়েবসাইট</a>
|
||||
·
|
||||
<a href="#🚀-installation">ইন্সটল</a>
|
||||
·
|
||||
<a href="https://starship.rs/config/"> কনফিগ</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
<p align="center"><a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||||
@@ -154,64 +151,71 @@
|
||||
|
||||
<h1></h1>
|
||||
|
||||
> [!WARNING]
|
||||
> **The default branch has been renamed from `master` to `main`.**
|
||||
> If you have a local clone, update it by running:
|
||||
>
|
||||
> ```sh
|
||||
> git branch -m master main
|
||||
> git fetch origin
|
||||
> git branch -u origin/main main
|
||||
> git remote set-head origin -a
|
||||
> ```
|
||||
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship with iTerm2 and the Snazzy theme"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/demo.gif"
|
||||
alt="Starship with iTerm2 and the Snazzy theme"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
|
||||
**আপনার টার্মিনাল এর জন্য একটি সহজ, প্রচণ্ড দ্রুত এবং অশেষভাবে কাস্টমাইজ করার মতো সুবিধাসম্পন্ন একটি প্রম্প্ট!**
|
||||
**The minimal, blazing-fast, and infinitely customizable prompt for any shell!**
|
||||
|
||||
- **দ্রুত:** দ্রুত - সত্যি সত্যিই _অনেক_ দ্রুত! 🚀
|
||||
- **কাস্টমাইজ করার সুবিধা:** প্রম্পটের প্রতিটি দিক কনফিগ করুন মন মত ।
|
||||
- **ব্যতিক্রমহীন:** যেকোনো অপারেটিং সিস্টেম ও শেলে কাজ করে ।
|
||||
- **চালাক:** এক নজরে দরকারি সকল তথ্য দেখা যায় ।
|
||||
- **ফিচার সমৃদ্ধ:** আপনার প্রিয় সকল টুল ব্যবহার করতে পারবেন ।
|
||||
- **সহজ:** অনায়াসে ইন্সটল করুন – মিনিটের মধ্যে ব্যবহার শুরু করে দিন ।
|
||||
- **Fast:** it's fast – _really really_ fast! 🚀
|
||||
- **Customizable:** configure every aspect of your prompt.
|
||||
- **Universal:** works on any shell, on any operating system.
|
||||
- **Intelligent:** shows relevant information at a glance.
|
||||
- **Feature rich:** support for all your favorite tools.
|
||||
- **Easy:** quick to install – start using it in minutes.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs/config/"><strong>Starship এর ডকুমেন্টেশন ঘুরে দেখুন ▶</strong></a>
|
||||
<p align="center"><a href="https://starship.rs/config/"><strong>Explore the Starship docs ▶</strong></a>
|
||||
</p>
|
||||
|
||||
<a name="🚀-installation"></a>
|
||||
|
||||
## 🚀 ইন্সটল
|
||||
## পূর্বশর্ত
|
||||
|
||||
### পূর্বশর্ত
|
||||
|
||||
- আপনার থেকে টার্মিনালে একটি [Nerd Font](https://www.nerdfonts.com/) ব্যবহার করতে হবে (উদাহরণস্বরূপ আপনি [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) টি ব্যবহার করতে পারেন) ।
|
||||
- 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)).
|
||||
|
||||
### ধাপ ১. Starship ইন্সটল করুন
|
||||
|
||||
ইনস্টলেশন নির্দেশিকা দেখতে নিচের তালিকা থেকে আপনার অপারেটিং সিস্টেম বাছাই করুন:
|
||||
|
||||
<details>
|
||||
<summary>অ্যান্ড্রয়েড</summary>
|
||||
<details><summary>Android</summary>
|
||||
|
||||
নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
|
||||
|
||||
| রিপোজিটরি | নির্দেশাবলী |
|
||||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||||
| রিপোজিটরি | নির্দেশাবলী |
|
||||
| --------- | ---------------------- |
|
||||
| [Termux] | `pkg install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>বিএসডি</summary>
|
||||
<details><summary>BSD</summary>
|
||||
|
||||
নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
|
||||
|
||||
| ডিস্ট্রিবিউশন | রিপোজিটরি | নির্দেশাবলী |
|
||||
| ------------- | -------------------------------------------------------- | --------------------------------- |
|
||||
| **_যেকোনো_** | **[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` |
|
||||
| ডিস্ট্রিবিউশন | রিপোজিটরি | নির্দেশাবলী |
|
||||
| ------------- | --------------- | --------------------------------- |
|
||||
| **_Any_** | **[crates.io]** | `cargo install starship --locked` |
|
||||
| FreeBSD | [FreshPorts] | `pkg install starship` |
|
||||
| NetBSD | [pkgsrc] | `pkgin install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>লিনাক্স </summary>
|
||||
<details><summary>Linux</summary>
|
||||
|
||||
আপনার সিস্টেম এর জন্য লেটেস্ট সংস্করণটি ইন্সটল করুন:
|
||||
|
||||
@@ -221,26 +225,26 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
অথবা, নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
|
||||
|
||||
| ডিস্ট্রিবিউশন | রিপোজিটরি | নির্দেশাবলী |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| **_যেকোনো_** | **[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` |
|
||||
| _যেকোনো_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Gentoo | [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` |
|
||||
| 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` |
|
||||
| ডিস্ট্রিবিউশন | রিপোজিটরি | নির্দেশাবলী |
|
||||
| ---------------------------------- | ----------------------- | ------------------------------------------------------------- |
|
||||
| **_Any_** | **[crates.io]** | `cargo install starship --locked` |
|
||||
| _Any_ | [conda-forge] | `conda install -c conda-forge starship` |
|
||||
| _Any_ | [Linuxbrew] | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages] | `apk add starship` |
|
||||
| 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` |
|
||||
| openSUSE | [OSS] | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe] | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages] | `xbps-install -S starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>ম্যাক ওএস </summary>
|
||||
<details><summary>macOS</summary>
|
||||
|
||||
আপনার সিস্টেম এর জন্য লেটেস্ট সংস্করণটি ইন্সটল করুন:
|
||||
|
||||
@@ -250,29 +254,28 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
অথবা, নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
|
||||
|
||||
| রিপোজিটরি | নির্দেশাবলী |
|
||||
| -------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [Homebrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| [MacPorts](https://ports.macports.org/port/starship) | `port install starship` |
|
||||
| রিপোজিটরি | নির্দেশাবলী |
|
||||
| --------------- | --------------------------------------- |
|
||||
| **[crates.io]** | `cargo install starship --locked` |
|
||||
| [conda-forge] | `conda install -c conda-forge starship` |
|
||||
| [Homebrew] | `brew install starship` |
|
||||
| [MacPorts] | `port install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>উইন্ডোজ</summary>
|
||||
|
||||
আপনার সিস্টেম এর জন্য লেটেস্ট সংস্করণটি [রিলিজ সেকশনে](https://github.com/starship/starship/releases/latest) থাকা MSI-ইন্সটলার ব্যবহার করে ইন্সটল করুন ।
|
||||
<details><summary>Windows</summary>
|
||||
|
||||
নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
|
||||
|
||||
| রিপোজিটরি | নির্দেশাবলী |
|
||||
| -------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [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` |
|
||||
নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
|
||||
|
||||
| রিপোজিটরি | নির্দেশাবলী |
|
||||
| --------------- | --------------------------------------- |
|
||||
| **[crates.io]** | `cargo install starship --locked` |
|
||||
| [Chocolatey] | `choco install starship` |
|
||||
| [conda-forge] | `conda install -c conda-forge starship` |
|
||||
| [Scoop] | `scoop install starship` |
|
||||
| [winget] | `winget install --id Starship.Starship` |
|
||||
|
||||
</details>
|
||||
|
||||
@@ -280,8 +283,7 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
Starship চালু করতে আপনার শেল কে ঠিক মতো কনফিগার করুন । নিম্নলিখিত তালিকা থেকে আপনার শেল বাছাই করুন:
|
||||
|
||||
<details>
|
||||
<summary>Bash</summary>
|
||||
<details><summary>Bash</summary>
|
||||
|
||||
`~/.bashrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
|
||||
@@ -291,10 +293,10 @@ eval "$(starship init bash)"
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Cmd</summary>
|
||||
<details><summary>Cmd</summary>
|
||||
|
||||
আপনাকে Cmd এর সাথে [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) ব্যবহার করতে হবে । `%LocalAppData%\clink\starship.lua` ফাইল টি তৈরি করে তার মধ্যে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd.
|
||||
Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:
|
||||
|
||||
```lua
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
@@ -302,21 +304,19 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
<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>
|
||||
|
||||
<details>
|
||||
<summary>Fish</summary>
|
||||
<details><summary>Fish</summary>
|
||||
|
||||
`~/.config/fish/config.fish` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
|
||||
@@ -326,8 +326,7 @@ starship init fish | source
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Ion</summary>
|
||||
<details><summary>Ion</summary>
|
||||
|
||||
`~/.config/ion/initrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
|
||||
@@ -337,8 +336,7 @@ eval $(starship init ion)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Nushell</summary>
|
||||
<details><summary>Nushell</summary>
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
@@ -351,10 +349,9 @@ starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.n
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>PowerShell</summary>
|
||||
<details><summary>PowerShell</summary>
|
||||
|
||||
আপনার PowerShell কনফিগের (PowerShell এ `$PROFILE` কমান্ডটি রান করে ফাইলটি খুঁজে বের করুন) শেষে নিম্নলিখিত লাইনটি যোগ করুন:
|
||||
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`):
|
||||
|
||||
```powershell
|
||||
Invoke-Expression (&starship init powershell)
|
||||
@@ -362,8 +359,7 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Tcsh</summary>
|
||||
<details><summary>Tcsh</summary>
|
||||
|
||||
`~/.tcshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
|
||||
@@ -373,8 +369,7 @@ eval `starship init tcsh`
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Xonsh</summary>
|
||||
<details><summary>Xonsh</summary>
|
||||
|
||||
`~/.xonshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
|
||||
@@ -384,8 +379,7 @@ execx($(starship init xonsh))
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Zsh</summary>
|
||||
<details><summary>Zsh</summary>
|
||||
|
||||
`~/.zshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||
|
||||
@@ -397,21 +391,22 @@ eval "$(starship init zsh)"
|
||||
|
||||
### ধাপ ৩. Starship কনফিগার করুন
|
||||
|
||||
নতুন একটি শেল চালু করুন, এরপর আপনি আপনার সুন্দর নতুন শেল প্রম্প্ট দেখতে পাবেন । পূর্ব নির্ধারিত কনফিগ যদি ভালো লেগে থাকে, তাহলে উপভোগ করুন!
|
||||
নতুন একটি শেল চালু করুন, এরপর আপনি আপনার সুন্দর নতুন শেল প্রম্প্ট দেখতে পাবেন ।
|
||||
পূর্ব নির্ধারিত কনফিগ যদি ভালো লেগে থাকে, তাহলে উপভোগ করুন!
|
||||
|
||||
আপনি যদি Starship কে নিজের মতো করে কাস্টমাইজ করতে চান:
|
||||
|
||||
- **[কনফিগারেশন](https://starship.rs/config/)** – আপনার নিজের ইচ্ছা মতো নিজের প্রম্প্টকে পরিবর্তন করতে শিখুন
|
||||
- **[Configuration](https://starship.rs/config/)** – learn how to configure Starship to tweak your prompt to your liking
|
||||
|
||||
- **[অন্যদের তৈরি কনফিগ](https://starship.rs/presets/)** – অন্যদের তৈরি করা সুন্দর কনফিগ দেখে অনুপ্রাণিত হন
|
||||
- **[Presets](https://starship.rs/presets/)** – get inspired by the pre-built configuration of others
|
||||
|
||||
## 🤝 নিজে অবদান রাখুন
|
||||
|
||||
আমরা সবসময় **সকল দক্ষতা স্তরের** অবদানকারীদের খুঁজছি! আপনি যদি সহজ ভাবে এই প্রোজেক্টে অবদান রাখতে চান তাইলে ["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).
|
||||
|
||||
আপনি যদি ইংরেজি ছাড়া অন্য কোন ভাষায় সাবলীল হন, তাহলে আপনি আমাদের ডকুমেন্টেশন অনুবাদে এবং আপ-টু-ডেট রাখতে সহায়তা করতে পারেন, আমরা খুবই কৃতজ্ঞ হব । যদি এক্ষেত্রে সাহায্য করতে চান, তাহলে [Starship Crowdin](https://translate.starship.rs/) পেইজ এ গিয়ে আপনার অনুবাদ গুলি যোগ করতে পারবেন ।
|
||||
আপনি যদি ইংরেজি ছাড়া অন্য কোন ভাষায় সাবলীল হন, তাহলে আপনি আমাদের ডকুমেন্টেশন অনুবাদে এবং আপ-টু-ডেট রাখতে সহায়তা করতে পারেন, আমরা খুবই কৃতজ্ঞ হব । If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
আপনি যদি Starship এ অবদান রাখতে আগ্রহী হন, অনুগ্রহ করে আমাদের অবদান রাখার [নির্দেশিকা ও নিয়মকানুন](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) দেখে নিবেন । এছাড়াও, নির্দ্বিধায় আমাদের [Discord](https://discord.gg/8Jzqu3T) সার্ভারে এসে হাই বলে যান । 👋
|
||||
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/main/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋
|
||||
|
||||
## 💭 অনুপ্রেরণা
|
||||
|
||||
@@ -425,11 +420,11 @@ eval "$(starship init zsh)"
|
||||
|
||||
## ❤️ স্পনসর
|
||||
|
||||
[একজন স্পনসর হয়ে](https://github.com/sponsors/starship) এই প্রোজেক্টটিকে আর্থিক ভাবে সহায়তা করুন । আপনার নাম অথবা লোগো নিম্নে দেখা যাবে আপনার ওয়েবসাইট এর লিঙ্ক সহ ।
|
||||
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). আপনার নাম অথবা লোগো নিম্নে দেখা যাবে আপনার ওয়েবসাইট এর লিঙ্ক সহ ।
|
||||
|
||||
## 🔒 Code Signing Policy
|
||||
|
||||
Free code signing provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org).
|
||||
Free code signing provided by [SignPath.io], certificate by [SignPath Foundation].
|
||||
|
||||
Code Signing Roles:
|
||||
|
||||
@@ -438,11 +433,34 @@ Code Signing Roles:
|
||||
|
||||
This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon">
|
||||
<p align="center"><br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/main/media/icon.png" alt="Starship rocket icon">
|
||||
</p>
|
||||
|
||||
## 📝 লাইসেন্স
|
||||
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br /> এই প্রোজেক্টটি [ISC](https://github.com/starship/starship/blob/master/LICENSE) লাইসেন্সের অধিনে রয়েছে ।
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
|
||||
This project is [ISC](https://github.com/starship/starship/blob/main/LICENSE) licensed.
|
||||
|
||||
[alpine linux packages]: https://pkgs.alpinelinux.org/packages?name=starship
|
||||
[arch linux extra]: https://archlinux.org/packages/extra/x86_64/starship
|
||||
[chocolatey]: https://community.chocolatey.org/packages/starship
|
||||
[conda-forge]: https://anaconda.org/conda-forge/starship
|
||||
[copr]: https://copr.fedorainfracloud.org/coprs/atim/starship
|
||||
[crates.io]: https://crates.io/crates/starship
|
||||
[debian main]: https://sources.debian.org/src/starship/1.22.1-1/
|
||||
[freshports]: https://www.freshports.org/shells/starship
|
||||
[gentoo packages]: https://packages.gentoo.org/packages/app-shells/starship
|
||||
[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/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
|
||||
[SignPath Foundation]: https://signpath.org
|
||||
[SignPath.io]: https://signpath.io
|
||||
[termux]: https://github.com/termux/termux-packages/tree/master/packages/starship
|
||||
[ubuntu universe]: https://packages.ubuntu.com/source/plucky/starship
|
||||
[void linux packages]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship
|
||||
[winget]: https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship
|
||||
|
||||
@@ -3,11 +3,15 @@
|
||||
To install starship, you need to do two things:
|
||||
|
||||
1. Get the **starship** binary onto your computer
|
||||
1. Tell your shell to use the starship binary as its prompt by modifying its init scripts
|
||||
2. Tell your shell to use the starship binary as its prompt by modifying its init scripts
|
||||
|
||||
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
|
||||
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. However,
|
||||
for some more specialized platforms, different instructions are needed.
|
||||
|
||||
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
|
||||
There are so many platforms out there that they didn't fit into the main
|
||||
README.md file, so here are some installation instructions for other platforms
|
||||
from the community. Is yours not here? Please do add it here if you figure it
|
||||
out!
|
||||
|
||||
## [Chocolatey](https://chocolatey.org)
|
||||
|
||||
@@ -23,16 +27,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)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# Presets
|
||||
|
||||
Here is a collection of community-submitted configuration presets for Starship. If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊
|
||||
Here is a collection of community-submitted configuration presets for Starship.
|
||||
If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊
|
||||
|
||||
To get details on how to use a preset, simply click on the image.
|
||||
|
||||
@@ -14,11 +15,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)
|
||||
|
||||
@@ -30,7 +27,8 @@ This preset changes the format of all the built-in modules to show their segment
|
||||
|
||||
## [Plain Text Symbols](./plain-text.md)
|
||||
|
||||
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
|
||||
This preset changes the symbols for each module into plain text. Great if you
|
||||
don't have access to Unicode.
|
||||
|
||||
[](./plain-text)
|
||||
|
||||
@@ -54,7 +52,8 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
|
||||
|
||||
## [Pastel Powerline](./pastel-powerline.md)
|
||||
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
It also shows how path substitution works in starship.
|
||||
|
||||
[](./pastel-powerline)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
# Pastel Powerline Preset
|
||||
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
It also shows how path substitution works in starship.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
## Plain Text Symbols Preset
|
||||
|
||||
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
|
||||
This preset changes the symbols for each module into plain text. Great if you
|
||||
don't have access to Unicode.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
+16
-36
@@ -2,27 +2,24 @@
|
||||
layout: home
|
||||
hero:
|
||||
image: /logo.svg
|
||||
text:
|
||||
text: null
|
||||
tagline: promptـێکی سوکەڵە، خێرا، و بێسنور دڵخوازکراو بۆ هەر شێڵێک!
|
||||
actions:
|
||||
-
|
||||
theme: brand
|
||||
- theme: brand
|
||||
text: دەستپێبکە ←
|
||||
link: ./guide/
|
||||
features:
|
||||
-
|
||||
title: سەرەتا گونجان
|
||||
- title: سەرەتا گونجان
|
||||
details: کاردەکات لەسەر زۆربەی شێڵە باوەکان لەسەر زۆربەی سیستەمە باوەکان. لە هەموو شوێنێک بەکاری بهێنە!
|
||||
-
|
||||
title: Rust لە پشتە
|
||||
- title: Rust لە پشتە
|
||||
details: باشترینی هاوتاکانی لە خێرایی و سەلامەتی Rust بەکارئەهێنێ بۆ ئەوەی promptـەکەت خێراترین و پشت پێبەستراوین بێ.
|
||||
-
|
||||
title: دڵخوازکراو
|
||||
- title: دڵخوازکراو
|
||||
details: هەموو وردەکارییەکی دڵخواز ئەکرێ بەوجۆرەی حەزت لێیە، بۆ ئەوەی promptـەکە سوکەڵە بێ و پڕ تایبەتمەندی بێت بەوجۆرەی حەزت لێیە ببێ.
|
||||
footer: لەژێر مۆڵەتی ISCـە | مافی پارێزراوە © 2019-ئێستا بەژداریکەرانی Starship
|
||||
#Used for the description meta tag, for SEO
|
||||
|
||||
# Used for the description meta tag, for SEO
|
||||
metaTitle: "Starship: یەکێ لە Promptـە شێڵ نەناسەکان"
|
||||
description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و بێسنور دڵخوازکراوەکان بۆ هەر شێڵێک! ئەو زانیارییانە پشان دەدات کە پێویستە، لەوکاتەیا بە ئارامی و سوکەڵەیی ئەمێنێتەوە. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell.'
|
||||
description: "Starship: یەکێ لە promptـە سوکەڵە، خێرا، و بێسنور دڵخوازکراوەکان بۆ هەر شێڵێک! ئەو زانیارییانە پشان دەدات کە پێویستە، لەوکاتەیا بە ئارامی و سوکەڵەیی ئەمێنێتەوە. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell."
|
||||
---
|
||||
|
||||
<script setup>
|
||||
@@ -52,7 +49,6 @@ onMounted(() => {
|
||||
|
||||
1. باینەری **starship** دابمەزرێنە:
|
||||
|
||||
|
||||
#### کۆتا وەشان دابمەزرێنە
|
||||
|
||||
لەگەڵ شێڵ:
|
||||
@@ -63,7 +59,6 @@ onMounted(() => {
|
||||
|
||||
بۆ نوێکردنەوەی Starship خۆی، نووسینەکەی سەرەوە ڕەن بکەوە. وەشانی ئێستا دەگۆڕێت بێ ئەوەی دەسکاری ڕێکخستنەکانی Starship بکات.
|
||||
|
||||
|
||||
#### دابمەزرێنە لەڕێگەی بەڕێوبەری گورزەوە
|
||||
|
||||
لەگەڵ [Homebrew](https://brew.sh/):
|
||||
@@ -78,8 +73,7 @@ onMounted(() => {
|
||||
winget install starship
|
||||
```
|
||||
|
||||
1. نوسینی init زیادبکە بۆ فایلی ڕێکخستنی شێڵەکەت:
|
||||
|
||||
2. نوسینی init زیادبکە بۆ فایلی ڕێکخستنی شێڵەکەت:
|
||||
|
||||
#### Bash
|
||||
|
||||
@@ -91,7 +85,6 @@ onMounted(() => {
|
||||
eval "$(starship init bash)"
|
||||
```
|
||||
|
||||
|
||||
#### Fish
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.config/fish/config.fish`:
|
||||
@@ -102,7 +95,6 @@ onMounted(() => {
|
||||
starship init fish | source
|
||||
```
|
||||
|
||||
|
||||
#### Zsh
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.zshrc`:
|
||||
@@ -113,16 +105,14 @@ onMounted(() => {
|
||||
eval "$(starship init zsh)"
|
||||
```
|
||||
|
||||
#### PowerShell
|
||||
|
||||
#### Powershell
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `Microsoft.PowerShell_profile.ps1`. ئەتوانی شوێنی ئەم فایلە ببینیتەوە بە سەیرکردنی گۆڕاوی `$PROFILE` لە PowerShell. ئاسایی ڕێڕەوەکە بریتیە لە `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` یان `/.config/powershell/Microsoft.PowerShell_profile.ps1` لەسەر -Nix.
|
||||
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.
|
||||
|
||||
```sh
|
||||
Invoke-Expression (&starship init powershell)
|
||||
```
|
||||
|
||||
|
||||
#### Ion
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.config/ion/initrc`:
|
||||
@@ -133,16 +123,11 @@ onMounted(() => {
|
||||
eval $(starship init ion)
|
||||
```
|
||||
|
||||
|
||||
#### 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
|
||||
@@ -150,6 +135,7 @@ onMounted(() => {
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
#### Tcsh
|
||||
|
||||
@@ -161,14 +147,10 @@ onMounted(() => {
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
#### 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):
|
||||
|
||||
@@ -177,7 +159,6 @@ onMounted(() => {
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
|
||||
#### Xonsh
|
||||
|
||||
ئەمەی دێت زیادبکە بۆ کۆتایی پەڕگەی `~/.xonshrc`:
|
||||
@@ -188,7 +169,6 @@ onMounted(() => {
|
||||
execx($(starship init xonsh))
|
||||
```
|
||||
|
||||
|
||||
#### Cmd
|
||||
|
||||
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory:
|
||||
|
||||
@@ -1,18 +1,21 @@
|
||||
# ڕێکخستنی پێشکەوتوو
|
||||
|
||||
لەگەڵ ئەوەی Starship شێڵێکە بەکارهێنانی زۆرە، هەندێک جار دەسکاری کردنی `starship.toml` بەس نییە بۆ ئەوەی وای لێبکەی هەندێک شتی دیاریکراو ئەنجام بدات. ئەم پەڕەیە ووردەکاری زیاتر ئەدات لەسەر هەندێک لە شێوازە ڕێکخستنە پێشکەوتووترەکان کە لە Starshipـدا بەکارهاتووە.
|
||||
While Starship is a versatile shell, sometimes you need to do more than edit
|
||||
`starship.toml` to get it to do certain things. ئەم پەڕەیە ووردەکاری زیاتر ئەدات لەسەر هەندێک لە شێوازە ڕێکخستنە پێشکەوتووترەکان کە لە Starshipـدا بەکارهاتووە.
|
||||
|
||||
::: ئاگادارکردنەوە
|
||||
|
||||
ڕێکخستنەکانی ئەم بەشە شایەنی گۆڕانن لە وەشانەکانی داهاتووی Starshipدا.
|
||||
|
||||
:::
|
||||
> [!WARNING] The configurations in this section are subject to change in future releases of Starship.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `Enable-TransientPrompt` in the shell session. To make it permanent, put this statement in your `$PROFILE`. Transience can be disabled on-the-fly with `Disable-TransientPrompt`.
|
||||
It is possible to replace the previous-printed prompt with a custom string. This
|
||||
is useful in cases where all the prompt information is not always needed. To enable
|
||||
this, run `Enable-TransientPrompt` in the shell session. To make it permanent, put
|
||||
this statement in your `$PROFILE`. Transience can be disabled on-the-fly with
|
||||
`Disable-TransientPrompt`.
|
||||
|
||||
By default, the left side of input gets replaced with `>`. To customize this, define a new function called `Invoke-Starship-TransientFunction`. For example, to display Starship's `character` module here, you would do
|
||||
By default, the left side of input gets replaced with `>`. To customize this,
|
||||
define a new function called `Invoke-Starship-TransientFunction`. For example, to
|
||||
display Starship's `character` module here, you would do
|
||||
|
||||
```powershell
|
||||
function Invoke-Starship-TransientFunction {
|
||||
@@ -26,15 +29,21 @@ Enable-TransientPrompt
|
||||
|
||||
## TransientPrompt and TransientRightPrompt in Cmd
|
||||
|
||||
Clink allows you to replace the previous-printed prompt with custom strings. This is useful in cases where all the prompt information is not always needed. To enable this, run `clink set prompt.transient <value>` where \<value\> can be one of:
|
||||
Clink allows you to replace the previous-printed prompt with custom strings. This
|
||||
is useful in cases where all the prompt information is not always needed. To enable
|
||||
this, run `clink set prompt.transient <value>` where \<value\> can be one of:
|
||||
|
||||
- `always`: always replace the previous prompt
|
||||
- `same_dir`: replace the previous prompt only if the working directory is same
|
||||
- `off`: do not replace the prompt (i.e. turn off transience)
|
||||
|
||||
You need to do this only once. Make the following changes to your `starship.lua` to customize what gets displayed on the left and on the right:
|
||||
You need to do this only once. Make the following changes to your `starship.lua`
|
||||
to customize what gets displayed on the left and on the right:
|
||||
|
||||
- By default, the left side of input gets replaced with `>`. To customize this, define a new function called `starship_transient_prompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display Starship's `character` module here, you would do
|
||||
- By default, the left side of input gets replaced with `>`. To customize this,
|
||||
define a new function called `starship_transient_prompt_func`. This function
|
||||
receives the current prompt as a string that you can utilize. For example, to
|
||||
display Starship's `character` module here, you would do
|
||||
|
||||
```lua
|
||||
function starship_transient_prompt_func(prompt)
|
||||
@@ -45,7 +54,10 @@ end
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
```
|
||||
|
||||
- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display the time at which the last command was started here, you would do
|
||||
- By default, the right side of input is empty. To customize this, define a new
|
||||
function called `starship_transient_rprompt_func`. This function receives the
|
||||
current prompt as a string that you can utilize. For example, to display
|
||||
the time at which the last command was started here, you would do
|
||||
|
||||
```lua
|
||||
function starship_transient_rprompt_func(prompt)
|
||||
@@ -56,11 +68,17 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
## TransientPrompt and TransientRightPrompt in Fish
|
||||
|
||||
It is possible to replace the previous-printed prompt with a custom string. This is useful in cases where all the prompt information is not always needed. To enable this, run `enable_transience` in the shell session. To make it permanent, put this statement in your `~/.config/fish/config.fish`. Transience can be disabled on-the-fly with `disable_transience`.
|
||||
It is possible to replace the previous-printed prompt with a custom string. This
|
||||
is useful in cases where all the prompt information is not always needed. To enable
|
||||
this, run `enable_transience` in the shell session. To make it permanent, put
|
||||
this statement in your `~/.config/fish/config.fish`. Transience can be disabled on-the-fly with
|
||||
`disable_transience`.
|
||||
|
||||
Note that in case of Fish, the transient prompt is only printed if the commandline is non-empty, and syntactically correct.
|
||||
|
||||
- By default, the left side of input gets replaced with a bold-green `❯`. To customize this, define a new function called `starship_transient_prompt_func`. For example, to display Starship's `character` module here, you would do
|
||||
- By default, the left side of input gets replaced with a bold-green `❯`. To customize this,
|
||||
define a new function called `starship_transient_prompt_func`. For example, to
|
||||
display Starship's `character` module here, you would do
|
||||
|
||||
```fish
|
||||
function starship_transient_prompt_func
|
||||
@@ -70,7 +88,9 @@ starship init fish | source
|
||||
enable_transience
|
||||
```
|
||||
|
||||
- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. For example, to display the time at which the last command was started here, you would do
|
||||
- By default, the right side of input is empty. To customize this, define a new
|
||||
function called `starship_transient_rprompt_func`. For example, to display
|
||||
the time at which the last command was started here, you would do
|
||||
|
||||
```fish
|
||||
function starship_transient_rprompt_func
|
||||
@@ -82,19 +102,33 @@ enable_transience
|
||||
|
||||
## TransientPrompt and TransientRightPrompt in 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. This is useful in cases where all the prompt information is not always needed. To enable this, put this in `~/.bashrc` `bleopt prompt_ps1_transient=<value>`:
|
||||
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. This is useful in cases where all
|
||||
the prompt information is not always needed. To enable this, put this in `~/.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.
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
- 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
|
||||
- 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
|
||||
|
||||
```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. For example, to display the time at which the last command was started here, you would do
|
||||
- To customize what the right side of input gets replaced with, configure the
|
||||
`prompt_rps1_final` Ble.sh option. For example, to display
|
||||
the time at which the last command was started here, you would do
|
||||
|
||||
```bash
|
||||
bleopt prompt_rps1_final='$(starship module time)'
|
||||
@@ -102,9 +136,14 @@ bleopt prompt_rps1_final='$(starship module time)'
|
||||
|
||||
## Custom pre-prompt and pre-execution Commands in Cmd
|
||||
|
||||
Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands in Cmd shell. It is fairly simple to use with Starship. Make the following changes to your `starship.lua` file as per your requirements:
|
||||
Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands
|
||||
in Cmd shell. It is fairly simple to use with Starship. Make the following changes
|
||||
to your `starship.lua` file as per your requirements:
|
||||
|
||||
- To run a custom function right before the prompt is drawn, define a new function called `starship_preprompt_user_func`. This function receives the current prompt as a string that you can utilize. For example, to draw a rocket before the prompt, you would do
|
||||
- To run a custom function right before the prompt is drawn, define a new
|
||||
function called `starship_preprompt_user_func`. This function receives
|
||||
the current prompt as a string that you can utilize. For example, to
|
||||
draw a rocket before the prompt, you would do
|
||||
|
||||
```lua
|
||||
function starship_preprompt_user_func(prompt)
|
||||
@@ -114,7 +153,10 @@ end
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
```
|
||||
|
||||
- To run a custom function right before a command is executed, define a new function called `starship_precmd_user_func`. This function receives the current commandline as a string that you can utilize. For example, to print the command that's about to be executed, you would do
|
||||
- To run a custom function right before a command is executed, define a new
|
||||
function called `starship_precmd_user_func`. This function receives
|
||||
the current commandline as a string that you can utilize. For example, to
|
||||
print the command that's about to be executed, you would do
|
||||
|
||||
```lua
|
||||
function starship_precmd_user_func(line)
|
||||
@@ -126,9 +168,14 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
## فرمانە کڕیاڕخوازەکانی pre-prompt و pre-execution لە Bashـدا
|
||||
|
||||
بەپێچەوانەی شێلەکانی دیکە Bash هیچ چوارچێوەیەکی فەرمی preexec/precmdـی نییە. لەبەر ئەوە، دابین کردنی قولابە تەواو کڕیارخوازکراوەکان ئاسان نییە لە `Bash`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
|
||||
بەپێچەوانەی شێلەکانی دیکە Bash هیچ چوارچێوەیەکی فەرمی preexec/precmdـی نییە.
|
||||
Because of this, it is difficult to provide fully customizable hooks in `bash`.
|
||||
However, Starship does give you limited ability to insert your own functions
|
||||
into the prompt-rendering procedure:
|
||||
|
||||
- To run a custom function right before the prompt is drawn, define a new function and then assign its name to `starship_precmd_user_func`. For example, to draw a rocket before the prompt, you would do
|
||||
- To run a custom function right before the prompt is drawn, define a new
|
||||
function and then assign its name to `starship_precmd_user_func`. For example,
|
||||
to draw a rocket before the prompt, you would do
|
||||
|
||||
```bash
|
||||
function blastoff(){
|
||||
@@ -137,7 +184,11 @@ function blastoff(){
|
||||
starship_precmd_user_func="blastoff"
|
||||
```
|
||||
|
||||
- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal _before_ initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
|
||||
- To run a custom function right before a command runs, you can use the
|
||||
[`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/).
|
||||
However, you **must** trap the DEBUG signal _before_ initializing Starship!
|
||||
Starship can preserve the value of the DEBUG trap, but if the trap is overwritten
|
||||
after starship starts up, some functionality will break.
|
||||
|
||||
```bash
|
||||
function blastoff(){
|
||||
@@ -151,7 +202,10 @@ set +o functrace
|
||||
|
||||
## Custom pre-prompt and pre-execution Commands in PowerShell
|
||||
|
||||
PowerShell does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `powershell`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
|
||||
PowerShell does not have a formal preexec/precmd framework like most other shells.
|
||||
Because of this, it is difficult to provide fully customizable hooks in `powershell`.
|
||||
However, Starship does give you limited ability to insert your own functions
|
||||
into the prompt-rendering procedure:
|
||||
|
||||
Create a function named `Invoke-Starship-PreCommand`
|
||||
|
||||
@@ -163,7 +217,10 @@ function Invoke-Starship-PreCommand {
|
||||
|
||||
## Change Window Title
|
||||
|
||||
Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish even does it by default. Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`.
|
||||
Some shell prompts will automatically change the window title for you (e.g. to
|
||||
reflect your working directory). Fish even does it by default.
|
||||
Starship does not do this, but it's fairly straightforward to add this
|
||||
functionality to `bash`, `zsh`, `cmd` or `powershell`.
|
||||
|
||||
First, define a window title change function (identical in bash and zsh):
|
||||
|
||||
@@ -221,9 +278,13 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
## Enable Right Prompt
|
||||
|
||||
Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`.
|
||||
Some shells support a right prompt which renders on the same line as the input. Starship can
|
||||
set the content of the right prompt using the `right_format` option. Any module that can be used
|
||||
in `format` is also supported in `right_format`. The `$all` variable will only contain modules
|
||||
not explicitly used in either `format` or `right_format`.
|
||||
|
||||
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](../config/#fill).
|
||||
Note: The right prompt is a single line following the input location. To right align modules above
|
||||
the input line in a multi-line prompt, see the [`fill` module](../config/#fill).
|
||||
|
||||
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.
|
||||
|
||||
@@ -247,6 +308,12 @@ Produces a prompt like the following:
|
||||
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
|
||||
```
|
||||
|
||||
When using `zsh` (v5.0.5+), the shell adds a default trailing space to the right prompt. This can cause alignment issues specifically when using the Starship `$fill` module. To remove this gap, add the following to your `.zshrc`:
|
||||
|
||||
```zsh
|
||||
ZLE_RPROMPT_INDENT=0
|
||||
```
|
||||
|
||||
## Continuation Prompt
|
||||
|
||||
Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote).
|
||||
@@ -270,31 +337,346 @@ 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"
|
||||
```
|
||||
|
||||
### ڕێکخستن
|
||||
|
||||
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
|
||||
|
||||
| گۆڕاو | نموونە | 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
|
||||
|
||||
| گۆڕاو | نموونە | 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
|
||||
|
||||
| گۆڕاو | نموونە | 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:
|
||||
|
||||
- `تۆخ`
|
||||
- `لار`
|
||||
- `بنهێڵ`
|
||||
- `کاڵ کراو`
|
||||
- `پێچەوانە کراو`
|
||||
- `bold`
|
||||
- `italic`
|
||||
- `underline`
|
||||
- `dimmed`
|
||||
- `inverted`
|
||||
- `blink`
|
||||
- `hidden`
|
||||
- `strikethrough`
|
||||
- `bg:<color>`
|
||||
- `fg:<color>`
|
||||
- `<color>`
|
||||
- `هیچ`
|
||||
- `none`
|
||||
|
||||
کە `<color>` دیاریکەری ڕەنگێکە (لە ژێرەوە باسکراوە). `fg:<color>` و `<color>` لە ئێستادا هەمان شت ئەکەن، بەڵام ئەمە ڕەنگە لە داهاتووا بگۆڕێت. `<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` ڕەنگی پاشبنەما و پێشبنەما ئەگۆڕێتەوە. ڕیزبەندی ووشەکان لە زنجیرەکەدا گرنگ نییە.
|
||||
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing, though this may change in the future.
|
||||
`<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` swaps the background and foreground colors. ڕیزبەندی ووشەکان لە زنجیرەکەدا گرنگ نییە.
|
||||
|
||||
The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. It may become an error to use `none` in conjunction with other tokens in the future.
|
||||
|
||||
A color specifier can be one of the following:
|
||||
|
||||
- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`).
|
||||
- A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
|
||||
- One of the standard terminal colors: `black`, `red`, `green`, `blue`,
|
||||
`yellow`, `purple`, `cyan`, `white`. You can optionally prefix these
|
||||
with `bright-` to get the bright version (e.g. `bright-white`).
|
||||
- A `#` followed by a six-digit hexadecimal number. This specifies an
|
||||
[RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
|
||||
- A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
|
||||
|
||||
If multiple colors are specified for foreground/background, the last one in the string will take priority.
|
||||
|
||||
+1994
-1573
File diff suppressed because it is too large
Load Diff
@@ -58,7 +58,15 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
||||
|
||||
## Why do I see `Executing command "..." timed out.` warnings?
|
||||
|
||||
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](../config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
|
||||
Starship 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?
|
||||
|
||||
@@ -66,7 +74,11 @@ If you see symbols that you don't recognise you can use `starship explain` to ex
|
||||
|
||||
## 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.
|
||||
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.
|
||||
|
||||
```sh
|
||||
env STARSHIP_LOG=trace starship module rust
|
||||
@@ -88,10 +100,14 @@ starship bug-report
|
||||
|
||||
## Why don't I see a glyph symbol in my prompt?
|
||||
|
||||
The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that:
|
||||
The most common cause of this is system misconfiguration. Some Linux distros in
|
||||
particular do not come with font support out-of-the-box. You need to ensure that:
|
||||
|
||||
- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value, [you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/).
|
||||
- You have an emoji font installed. Most systems come with an emoji font by default, but some (notably Arch Linux) do not. You can usually install one through your system's package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice.
|
||||
- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value,
|
||||
[you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/).
|
||||
- You have an emoji font installed. Most systems come with an emoji font by default, but
|
||||
some (notably Arch Linux) do not. You can usually install one through your system's
|
||||
package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice.
|
||||
- You are using a [Nerd Font](https://www.nerdfonts.com/).
|
||||
|
||||
To test your system, run the following commands in a terminal:
|
||||
@@ -103,14 +119,17 @@ echo -e "\xee\x82\xa0"
|
||||
|
||||
The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
|
||||
|
||||
If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
|
||||
If either symbol fails to display correctly, your system is still misconfigured.
|
||||
Unfortunately, getting font configuration correct is sometimes difficult. Users
|
||||
on the Discord may be able to help. If both symbols display correctly, but
|
||||
you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
|
||||
|
||||
## How do I uninstall Starship?
|
||||
|
||||
Starship is just as easy to uninstall as it is to install in the first place.
|
||||
|
||||
1. Remove any lines in your shell config (e.g. `~/.bashrc`) used to initialize Starship.
|
||||
1. Delete the Starship binary.
|
||||
2. Delete the Starship binary.
|
||||
|
||||
If Starship was installed using a package manager, please refer to their docs for uninstallation instructions.
|
||||
|
||||
|
||||
+120
-102
@@ -1,13 +1,12 @@
|
||||
<p align="center">
|
||||
<img
|
||||
width="400"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||||
alt="Starship - یەکێ لە promptـە شێڵ نەناسەکان"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/logo.png"
|
||||
alt="Starship – Cross-shell prompt"
|
||||
/>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/actions"
|
||||
<p align="center"><a href="https://github.com/starship/starship/actions"
|
||||
><img
|
||||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||||
alt="دۆخی ڕێڕەوی کارەکان لە GitHub Actions"
|
||||
@@ -39,12 +38,10 @@
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs">ماڵپەڕ</a> · <a href="#🚀-installation">دامەزراندن</a> · <a href="https://starship.rs/config/">رێکخستن</a>
|
||||
<p align="center"><a href="https://starship.rs">ماڵپەڕ</a> · <a href="#🚀-installation">دامەزراندن</a> · <a href="https://starship.rs/config/">رێکخستن</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
<p align="center"><a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||||
@@ -150,29 +147,39 @@
|
||||
|
||||
<h1></h1>
|
||||
|
||||
> [!WARNING]
|
||||
> **The default branch has been renamed from `master` to `main`.**
|
||||
> If you have a local clone, update it by running:
|
||||
>
|
||||
> ```sh
|
||||
> git branch -m master main
|
||||
> git fetch origin
|
||||
> git branch -u origin/main main
|
||||
> git remote set-head origin -a
|
||||
> ```
|
||||
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship لەگەڵ iTerm2 و ڕووکاری Snazzy"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/demo.gif"
|
||||
alt="Starship with iTerm2 and the Snazzy theme"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
|
||||
**promptـێکی سوکەڵە، خێرا، و بێسنور دڵخوازکراو بۆ هەر شێڵێک!**
|
||||
**The minimal, blazing-fast, and infinitely customizable prompt for any shell!**
|
||||
|
||||
- **خێرا:** خێرایە – _زۆر زۆر_ خێرایە! 🚀
|
||||
- **دڵخوازکراو:** هەموو سوچێکی promptـەکەت ڕێکبخە.
|
||||
- **گشتگیر:** لەسەر هەر شێڵێک، هەر سیستەمێک ئیش ئەکات.
|
||||
- **زیرەک:** زانیاری پەیوەندیدار لە چاوتروکانێک نیشان دەدات.
|
||||
- **دەوڵەمەند بە تایبەتمەندی:** پشتگیری هەموو ئامرازە دڵخوازەکانت ئەکات.
|
||||
- **ئاسان:** خێرا لە دامەزراندن – دەست ئەکەیت بە بەکارهێنانی لە چەند خولەکێکدا.
|
||||
- **Fast:** it's fast – _really really_ fast! 🚀
|
||||
- **Customizable:** configure every aspect of your prompt.
|
||||
- **Universal:** works on any shell, on any operating system.
|
||||
- **Intelligent:** shows relevant information at a glance.
|
||||
- **Feature rich:** support for all your favorite tools.
|
||||
- **Easy:** quick to install – start using it in minutes.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs/config/"><strong>بەڵگەنامەکانی Starship بگەڕێ ◀</strong></a>
|
||||
<p align="center"><a href="https://starship.rs/config/"><strong>Explore the Starship docs ▶</strong></a>
|
||||
</p>
|
||||
|
||||
<a name="🚀-installation"></a>
|
||||
|
||||
## 🚀 دامەزراندن
|
||||
## پێشمەرجەکان
|
||||
|
||||
### پێشمەرجەکان
|
||||
|
||||
@@ -182,32 +189,29 @@
|
||||
|
||||
Select your operating system from the list below to view installation instructions:
|
||||
|
||||
<details>
|
||||
<summary>Android</summary>
|
||||
<details><summary>Android</summary>
|
||||
|
||||
Install Starship using any of the following package managers:
|
||||
|
||||
| Repository | Instructions |
|
||||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||||
| Repository | Instructions |
|
||||
| ---------- | ---------------------- |
|
||||
| [Termux] | `pkg install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>BSD</summary>
|
||||
<details><summary>BSD</summary>
|
||||
|
||||
Install Starship using any of the following package managers:
|
||||
|
||||
| Distribution | Repository | Instructions |
|
||||
| ------------ | -------------------------------------------------------- | --------------------------------- |
|
||||
| **_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` |
|
||||
| Distribution | Repository | Instructions |
|
||||
| ------------ | --------------- | --------------------------------- |
|
||||
| **_Any_** | **[crates.io]** | `cargo install starship --locked` |
|
||||
| FreeBSD | [FreshPorts] | `pkg install starship` |
|
||||
| NetBSD | [pkgsrc] | `pkgin install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Linux</summary>
|
||||
<details><summary>Linux</summary>
|
||||
|
||||
Install the latest version for your system:
|
||||
|
||||
@@ -217,26 +221,26 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
Alternatively, install Starship using any of the following package managers:
|
||||
|
||||
| Distribution | Repository | Instructions |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| **_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_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Gentoo | [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` |
|
||||
| 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` |
|
||||
| Distribution | Repository | Instructions |
|
||||
| ---------------------------------- | ----------------------- | ------------------------------------------------------------- |
|
||||
| **_Any_** | **[crates.io]** | `cargo install starship --locked` |
|
||||
| _Any_ | [conda-forge] | `conda install -c conda-forge starship` |
|
||||
| _Any_ | [Linuxbrew] | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages] | `apk add starship` |
|
||||
| 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` |
|
||||
| openSUSE | [OSS] | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe] | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages] | `xbps-install -S starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>macOS</summary>
|
||||
<details><summary>macOS</summary>
|
||||
|
||||
Install the latest version for your system:
|
||||
|
||||
@@ -246,29 +250,28 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
Alternatively, install Starship using any of the following package managers:
|
||||
|
||||
| Repository | Instructions |
|
||||
| -------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [Homebrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| [MacPorts](https://ports.macports.org/port/starship) | `port install starship` |
|
||||
| Repository | Instructions |
|
||||
| --------------- | --------------------------------------- |
|
||||
| **[crates.io]** | `cargo install starship --locked` |
|
||||
| [conda-forge] | `conda install -c conda-forge starship` |
|
||||
| [Homebrew] | `brew install starship` |
|
||||
| [MacPorts] | `port install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Windows</summary>
|
||||
<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).
|
||||
|
||||
Install Starship using any of the following package managers:
|
||||
|
||||
| Repository | Instructions |
|
||||
| -------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [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` |
|
||||
| Repository | Instructions |
|
||||
| --------------- | --------------------------------------- |
|
||||
| **[crates.io]** | `cargo install starship --locked` |
|
||||
| [Chocolatey] | `choco install starship` |
|
||||
| [conda-forge] | `conda install -c conda-forge starship` |
|
||||
| [Scoop] | `scoop install starship` |
|
||||
| [winget] | `winget install --id Starship.Starship` |
|
||||
|
||||
</details>
|
||||
|
||||
@@ -276,8 +279,7 @@ Install Starship using any of the following package managers:
|
||||
|
||||
Configure your shell to initialize starship. Select yours from the list below:
|
||||
|
||||
<details>
|
||||
<summary>Bash</summary>
|
||||
<details><summary>Bash</summary>
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.bashrc`:
|
||||
|
||||
@@ -287,10 +289,10 @@ eval "$(starship init bash)"
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Cmd</summary>
|
||||
<details><summary>Cmd</summary>
|
||||
|
||||
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:
|
||||
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd.
|
||||
Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:
|
||||
|
||||
```lua
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
@@ -298,21 +300,19 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
<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>
|
||||
|
||||
<details>
|
||||
<summary>Fish</summary>
|
||||
<details><summary>Fish</summary>
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.config/fish/config.fish`:
|
||||
|
||||
@@ -322,8 +322,7 @@ starship init fish | source
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Ion</summary>
|
||||
<details><summary>Ion</summary>
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.config/ion/initrc`:
|
||||
|
||||
@@ -333,8 +332,7 @@ eval $(starship init ion)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Nushell</summary>
|
||||
<details><summary>Nushell</summary>
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
@@ -347,8 +345,7 @@ Note: Only Nushell v0.96+ is supported
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>PowerShell</summary>
|
||||
<details><summary>PowerShell</summary>
|
||||
|
||||
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`):
|
||||
|
||||
@@ -358,8 +355,7 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Tcsh</summary>
|
||||
<details><summary>Tcsh</summary>
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.tcshrc`:
|
||||
|
||||
@@ -369,8 +365,7 @@ eval `starship init tcsh`
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Xonsh</summary>
|
||||
<details><summary>Xonsh</summary>
|
||||
|
||||
ئەمەی دێت زیادبکە بۆ کۆتایی پەڕگەی `~/.xonshrc`:
|
||||
|
||||
@@ -380,8 +375,7 @@ execx($(starship init xonsh))
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Zsh</summary>
|
||||
<details><summary>Zsh</summary>
|
||||
|
||||
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.zshrc`:
|
||||
|
||||
@@ -393,7 +387,8 @@ eval "$(starship init zsh)"
|
||||
|
||||
### Step 3. Configure Starship
|
||||
|
||||
Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy!
|
||||
Start a new shell instance, and you should see your beautiful new shell prompt.
|
||||
If you're happy with the defaults, enjoy!
|
||||
|
||||
If you're looking to further customize Starship:
|
||||
|
||||
@@ -403,11 +398,11 @@ If you're looking to further customize Starship:
|
||||
|
||||
## 🤝 بەژداریکردن
|
||||
|
||||
ئێمە هەموو کات ئەگەڕێین بۆ بەژداریکەرێک لە هەر **ئاست و توانایەکدا بێت**! ئەگەر بەدوای ئەوەوەی کە بێیتە ئەم پڕۆژەیەوە [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).
|
||||
|
||||
ئەگەر پاراویت لە زمانێک جگە لە ئینگلیزی، ئێمە زۆر خۆشحاڵدەبین بە هەر یارمەتییەک کە بەڵگەنامەکانمان بە وەرگێڕدراوی بهێڵێتەوە و نوێکراوی بهێڵێتەوە بە زمانەکانی دیکە. ئەگەر نیازت هەیە یارمەتی بدەیت، ئەتوانی بەژداری لە وەرگێڕاندا بکەیت لەسەر [Starship Crowdin](https://translate.starship.rs/).
|
||||
ئەگەر پاراویت لە زمانێک جگە لە ئینگلیزی، ئێمە زۆر خۆشحاڵدەبین بە هەر یارمەتییەک کە بەڵگەنامەکانمان بە وەرگێڕدراوی بهێڵێتەوە و نوێکراوی بهێڵێتەوە بە زمانەکانی دیکە. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/).
|
||||
|
||||
ئەگەر حەزئەکەیت یارمەتی بدەیت بە بەژداریکردن لە starship، تکایە سەیری [ڕێبەری بەژداریکردن](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)ـەکەمان بکە. هەروەها، شەرم مەکە وەرە نێوە [ڕاژەی Discord](https://discord.gg/8Jzqu3T)ـەکەمانەوە و سڵاوێک بکە. 👋
|
||||
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/main/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋
|
||||
|
||||
## 💭 ئیلهامبەخشەکان
|
||||
|
||||
@@ -425,7 +420,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi
|
||||
|
||||
## 🔒 Code Signing Policy
|
||||
|
||||
Free code signing provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org).
|
||||
Free code signing provided by [SignPath.io], certificate by [SignPath Foundation].
|
||||
|
||||
Code Signing Roles:
|
||||
|
||||
@@ -434,11 +429,34 @@ Code Signing Roles:
|
||||
|
||||
This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="ئایکۆنی مووشەکی Starship">
|
||||
<p align="center"><br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/main/media/icon.png" alt="Starship rocket icon">
|
||||
</p>
|
||||
|
||||
## 📝 مۆڵەتنامە
|
||||
|
||||
هەموو مافێکی پارێزراوە © 2019-ئێستا، [بەژداریکەرانی Starship](https://github.com/starship/starship/graphs/contributors). <br />ئەم پڕۆژەیە لە ژێر مۆڵەتنامەی [ISC](https://github.com/starship/starship/blob/master/LICENSE)ـە.
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
|
||||
This project is [ISC](https://github.com/starship/starship/blob/main/LICENSE) licensed.
|
||||
|
||||
[alpine linux packages]: https://pkgs.alpinelinux.org/packages?name=starship
|
||||
[arch linux extra]: https://archlinux.org/packages/extra/x86_64/starship
|
||||
[chocolatey]: https://community.chocolatey.org/packages/starship
|
||||
[conda-forge]: https://anaconda.org/conda-forge/starship
|
||||
[copr]: https://copr.fedorainfracloud.org/coprs/atim/starship
|
||||
[crates.io]: https://crates.io/crates/starship
|
||||
[debian main]: https://sources.debian.org/src/starship/1.22.1-1/
|
||||
[freshports]: https://www.freshports.org/shells/starship
|
||||
[gentoo packages]: https://packages.gentoo.org/packages/app-shells/starship
|
||||
[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/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
|
||||
[SignPath Foundation]: https://signpath.org
|
||||
[SignPath.io]: https://signpath.io
|
||||
[termux]: https://github.com/termux/termux-packages/tree/master/packages/starship
|
||||
[ubuntu universe]: https://packages.ubuntu.com/source/plucky/starship
|
||||
[void linux packages]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship
|
||||
[winget]: https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship
|
||||
|
||||
@@ -3,11 +3,15 @@
|
||||
To install starship, you need to do two things:
|
||||
|
||||
1. Get the **starship** binary onto your computer
|
||||
1. Tell your shell to use the starship binary as its prompt by modifying its init scripts
|
||||
2. Tell your shell to use the starship binary as its prompt by modifying its init scripts
|
||||
|
||||
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
|
||||
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. However,
|
||||
for some more specialized platforms, different instructions are needed.
|
||||
|
||||
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
|
||||
There are so many platforms out there that they didn't fit into the main
|
||||
README.md file, so here are some installation instructions for other platforms
|
||||
from the community. Is yours not here? Please do add it here if you figure it
|
||||
out!
|
||||
|
||||
## [Chocolatey](https://chocolatey.org)
|
||||
|
||||
@@ -23,16 +27,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)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# پێش ڕێکخستنەکان
|
||||
|
||||
ئەمە کۆکراوەیەکە لەو پێش ڕێکخستنانەی کە لەلایەن کۆمەڵگاوە نێردراون بۆ Starship. ئەگەر پێش ڕێکخستنێکت هەیە بۆ هاوبەشکردن، تکایە [PRـێک بنێرە](https://github.com/starship/starship/edit/master/docs/presets/README.md) کە ئەم پەڕگەیە نوێبکاتەوە! 😊
|
||||
ئەمە کۆکراوەیەکە لەو پێش ڕێکخستنانەی کە لەلایەن کۆمەڵگاوە نێردراون بۆ Starship.
|
||||
If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊
|
||||
|
||||
To get details on how to use a preset, simply click on the image.
|
||||
|
||||
@@ -14,11 +15,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)
|
||||
|
||||
@@ -30,7 +27,8 @@ This preset changes the format of all the built-in modules to show their segment
|
||||
|
||||
## [هێما نووسینەکییە ئاساییەکان](./plain-text.md)
|
||||
|
||||
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
|
||||
This preset changes the symbols for each module into plain text. Great if you
|
||||
don't have access to Unicode.
|
||||
|
||||
[](./plain-text)
|
||||
|
||||
@@ -54,7 +52,8 @@ This preset does not show icons if the toolset is not found.
|
||||
|
||||
## [Pastel Powerline](./pastel-powerline.md)
|
||||
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
It also shows how path substitution works in starship.
|
||||
|
||||
[](./pastel-powerline)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Return to Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -8,7 +8,7 @@ This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainb
|
||||
|
||||
### پێشمەرجەکان
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
- [فۆنتێکی Nerd](https://www.nerdfonts.com/) دامەزراوە و چالاککراوە لە تێرمیناڵەکەتا
|
||||
|
||||
### ڕێکخستن
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
# Pastel Powerline Preset
|
||||
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
It also shows how path substitution works in starship.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
## Plain Text Symbols Preset
|
||||
|
||||
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
|
||||
This preset changes the symbols for each module into plain text. Great if you
|
||||
don't have access to Unicode.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
+278
-107
@@ -268,6 +268,7 @@ $localip\
|
||||
$shlvl\
|
||||
$singularity\
|
||||
$kubernetes\
|
||||
$nats\
|
||||
$directory\
|
||||
$vcsh\
|
||||
$fossil_branch\
|
||||
@@ -282,9 +283,11 @@ $hg_state\
|
||||
$pijul_channel\
|
||||
$docker_context\
|
||||
$package\
|
||||
$bun\
|
||||
$c\
|
||||
$cmake\
|
||||
$cobol\
|
||||
$cpp\
|
||||
$daml\
|
||||
$dart\
|
||||
$deno\
|
||||
@@ -296,18 +299,20 @@ $fennel\
|
||||
$fortran\
|
||||
$gleam\
|
||||
$golang\
|
||||
$guix_shell\
|
||||
$gradle\
|
||||
$haskell\
|
||||
$haxe\
|
||||
$helm\
|
||||
$java\
|
||||
$julia\
|
||||
$kotlin\
|
||||
$gradle\
|
||||
$lua\
|
||||
$maven\
|
||||
$mojo\
|
||||
$nim\
|
||||
$nodejs\
|
||||
$ocaml\
|
||||
$odin\
|
||||
$opa\
|
||||
$perl\
|
||||
$php\
|
||||
@@ -327,10 +332,13 @@ $terraform\
|
||||
$typst\
|
||||
$vlang\
|
||||
$vagrant\
|
||||
$xmake\
|
||||
$zig\
|
||||
$buf\
|
||||
$guix_shell\
|
||||
$nix_shell\
|
||||
$conda\
|
||||
$pixi\
|
||||
$meson\
|
||||
$spack\
|
||||
$memory_usage\
|
||||
@@ -338,7 +346,6 @@ $aws\
|
||||
$gcloud\
|
||||
$openstack\
|
||||
$azure\
|
||||
$nats\
|
||||
$direnv\
|
||||
$env_var\
|
||||
$mise\
|
||||
@@ -351,9 +358,9 @@ $jobs\
|
||||
$battery\
|
||||
$time\
|
||||
$status\
|
||||
$os\
|
||||
$container\
|
||||
$netns\
|
||||
$os\
|
||||
$shell\
|
||||
$character"""
|
||||
```
|
||||
@@ -526,7 +533,7 @@ The module is only visible when the device's battery is below 10%.
|
||||
| `full_symbol` | `' '` | The symbol shown when the battery is full. |
|
||||
| `charging_symbol` | `' '` | The symbol shown when the battery is charging. |
|
||||
| `discharging_symbol` | `' '` | The symbol shown when the battery is discharging. |
|
||||
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
|
||||
| `unknown_symbol` | `' '` | The symbol shown when the battery state is unknown. |
|
||||
| `empty_symbol` | `' '` | The symbol shown when the battery state is empty. |
|
||||
| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |
|
||||
| `display` | [link](#battery-display) | Display threshold and style for the module. |
|
||||
@@ -595,7 +602,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
|
||||
| `symbol` | `'🐃 '` | The symbol used before displaying the version of Buf. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `elixir` module. |
|
||||
|
||||
@@ -1205,12 +1212,34 @@ it would have been `nixpkgs/pkgs`.
|
||||
|
||||
| Advanced Option | Default | Description |
|
||||
| --------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `substitutions` | | A table of substitutions to be made to the path. |
|
||||
| `substitutions` | | An Array or table of substitutions to be made to the path. |
|
||||
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
|
||||
| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |
|
||||
|
||||
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network
|
||||
prefixes or development directories of Java. Note that this will disable the fish style PWD.
|
||||
prefixes or development directories of Java. Note that this will disable the fish style PWD. It takes an array of the following
|
||||
key/value pairs:
|
||||
|
||||
| Value | Type | Description |
|
||||
| ------- | ------- | ---------------------------------------- |
|
||||
| `from` | String | The value to substitute |
|
||||
| `to` | String | The replacement for that value, if found |
|
||||
| `regex` | Boolean | (Optional) Whether `from` is a regex |
|
||||
|
||||
By using `regex = true`, you can use [Rust's regular expressions](https://docs.rs/regex/latest/regex/#syntax) in `from`.
|
||||
For instance you can replace every slash except the first with the following:
|
||||
|
||||
```toml
|
||||
substitutions = [
|
||||
{ from = "^/", to = "<root>/", regex = true },
|
||||
{ from = "/", to = " | " },
|
||||
{ from = "^<root>", to = "/", regex = true },
|
||||
]
|
||||
```
|
||||
|
||||
This will replace `/var/log` to `/ | var | log`.
|
||||
|
||||
The old syntax still works, although it doesn't support regular expressions:
|
||||
|
||||
```toml
|
||||
[directory.substitutions]
|
||||
@@ -1386,7 +1415,7 @@ when there is a `.csproj` file in the current directory.
|
||||
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
|
||||
| `detect_extensions` | `['csproj', 'fsproj', 'xproj']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `dotnet` module. |
|
||||
|
||||
@@ -1428,7 +1457,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `symbol` | `'💧 '` | The symbol used before displaying the version of Elixir/Erlang. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['mix.exs']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `elixir` module. |
|
||||
|
||||
@@ -1472,7 +1501,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `symbol` | `'🌳 '` | A format string representing the symbol of Elm. |
|
||||
| `detect_extensions` | `['elm']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['elm.json', 'elm-package.json', '.elm-version']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['elm-stuff']` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `['elm-stuff']` | Which folders should trigger this module. |
|
||||
| `style` | `'cyan bold'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `elm` module. |
|
||||
|
||||
@@ -1523,14 +1552,15 @@ The module will be shown only if any of the following conditions are met:
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
|
||||
| `symbol` | `""` | The symbol used before displaying the variable value. |
|
||||
| `variable` | | The environment variable to be displayed. |
|
||||
| `default` | | The default value to be displayed when the selected variable is not defined. |
|
||||
| `format` | `"with [$env_value]($style) "` | The format for the module. |
|
||||
| `description` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
|
||||
| `disabled` | `false` | Disables the `env_var` module. |
|
||||
| Option | Default | Description |
|
||||
| ------------- | ------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `symbol` | `""` | The symbol used before displaying the variable value. |
|
||||
| `variable` | | The environment variable to be displayed. |
|
||||
| `default` | | The default value to be displayed when the selected variable is not defined. |
|
||||
| `format` | `"with [$symbol$env_value]($style) "` | The format for the module. |
|
||||
| `description` | `"<env_var module>"` | The description of the module that is shown when running `starship explain`. |
|
||||
| `disabled` | `false` | Disables the `env_var` module. |
|
||||
| `style` | `"black bold dimmed"` | The style for the module. |
|
||||
|
||||
### Variables
|
||||
|
||||
@@ -1538,7 +1568,7 @@ The module will be shown only if any of the following conditions are met:
|
||||
| --------- | ------------------------------------------- | ------------------------------------------ |
|
||||
| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | `black bold dimmed` | Mirrors the value of option `style` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
@@ -1582,7 +1612,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `style` | `'bold red'` | The style for the module. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['rebar.config', 'elang.mk']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `erlang` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1621,7 +1651,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `style` | `'bold green'` | The style for the module. |
|
||||
| `detect_extensions` | `['fnl']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `disabled` | `false` | Disables the `fennel` module. |
|
||||
|
||||
### Variables
|
||||
@@ -1682,7 +1712,7 @@ The `fortran` module shows the current compiler version of Fortran.
|
||||
|
||||
| Option | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `symbol` | `' '` | The symbol used before displaying the version of COBOL. |
|
||||
| `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. |
|
||||
@@ -1794,6 +1824,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
|
||||
|
||||
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI.
|
||||
This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
|
||||
The `CLOUDSDK_CORE_PROJECT` and `CLOUDSDK_COMPUTE_REGION` environment variables, when set, override the `project` and `region` values from the active configuration, mirroring the behavior of `gcloud` itself.
|
||||
|
||||
When the module is enabled it will always be active, unless `detect_env_vars` has
|
||||
been set in which case the module will only be active when one of the
|
||||
@@ -2044,44 +2075,60 @@ current directory.
|
||||
|
||||
### 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` |
|
||||
| `behind` | `'⇣'` | The format of `behind` |
|
||||
| `diverged` | `'⇕'` | The format of `diverged` |
|
||||
| `up_to_date` | `''` | The format of `up_to_date` |
|
||||
| `untracked` | `'?'` | The format of `untracked` |
|
||||
| `stashed` | `'\$'` | The format of `stashed` |
|
||||
| `modified` | `'!'` | The format of `modified` |
|
||||
| `staged` | `'+'` | The format of `staged` |
|
||||
| `renamed` | `'»'` | The format of `renamed` |
|
||||
| `deleted` | `'✘'` | The format of `deleted` |
|
||||
| `typechanged` | `""` | The format of `typechanged` |
|
||||
| `style` | `'bold red'` | The style for the module. |
|
||||
| `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. |
|
||||
| Option | Default | Description |
|
||||
| ---------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
|
||||
| `conflicted` | `'='` | The format shown when this branch has merge conflicts. |
|
||||
| `ahead` | `'⇡'` | The format shown when this branch is ahead of the branch being tracked. |
|
||||
| `behind` | `'⇣'` | The format shown when this branch is behind the branch being tracked. |
|
||||
| `diverged` | `'⇕'` | The format shown when this branch has diverged from the branch being tracked. |
|
||||
| `up_to_date` | `''` | The format shown when this branch is up to date with the branch being tracked. |
|
||||
| `untracked` | `'?'` | The format shown when there are untracked files in the working directory. |
|
||||
| `stashed` | `'\$'` | The format shown when a stash exists for the local repository. |
|
||||
| `modified` | `'!'` | The format shown when there are file modifications in the working directory. |
|
||||
| `staged` | `'+'` | The format shown when a new file has been added to the staging area. |
|
||||
| `renamed` | `'»'` | The format shown when a renamed file has been added to the staging area. |
|
||||
| `deleted` | `'✘'` | The format shown when a file's deletion has been added to the staging area. |
|
||||
| `typechanged` | `""` | The format shown when a file's type has been changed in the staging area. |
|
||||
| `style` | `'bold red'` | The style for the module. |
|
||||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||||
| `worktree_added` | `""` | The format shown when a new file has been added in the working directory. |
|
||||
| `worktree_deleted` | `""` | The format shown when a file has been deleted in the working directory. |
|
||||
| `worktree_modified` | `""` | The format shown when a file has been modified in the working directory. |
|
||||
| `worktree_typechanged` | `""` | The format shown when a file's type has been changed in the working directory. |
|
||||
| `index_added` | `""` | The format shown when a new file has been added to the staging area. |
|
||||
| `index_deleted` | `""` | The format shown when a file has been deleted from the staging area. |
|
||||
| `index_modified` | `""` | The format shown when a file has been modified in the staging area. |
|
||||
| `index_typechanged` | `""` | The format shown when a file's type has been changed in the staging area. |
|
||||
| `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
|
||||
|
||||
The following variables can be used in `format`:
|
||||
|
||||
| Variable | Description |
|
||||
| -------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked` |
|
||||
| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. |
|
||||
| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |
|
||||
| `untracked` | Displays `untracked` when there are untracked files in the working directory. |
|
||||
| `stashed` | Displays `stashed` when a stash exists for the local repository. |
|
||||
| `modified` | Displays `modified` when there are file modifications in the working directory. |
|
||||
| `staged` | Displays `staged` when a new file has been added to the staging area. |
|
||||
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
|
||||
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
|
||||
| `typechanged` | Displays `typechanged` when a file's type has been changed in the staging area. |
|
||||
| style\* | Mirrors the value of option `style` |
|
||||
| Variable | Description |
|
||||
| ---------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `all_status` | Shortcut for `$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked`. |
|
||||
| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. |
|
||||
| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |
|
||||
| `untracked` | Displays `untracked` when there are untracked files in the working directory. |
|
||||
| `stashed` | Displays `stashed` when a stash exists for the local repository. |
|
||||
| `modified` | Displays `modified` when there are file modifications in the working directory. |
|
||||
| `staged` | Displays `staged` when a new file has been added to the staging area. |
|
||||
| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |
|
||||
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
|
||||
| `typechanged` | Displays `typechanged` when a file's type has been changed in the staging area. |
|
||||
| `worktree_added` | Displays `worktree_added` when a new file has been added in the working directory. |
|
||||
| `worktree_deleted` | Displays `worktree_deleted` when a file's been deleted in the working directory. |
|
||||
| `worktree_modified` | Displays `worktree_modified` when a file's been modified in the working directory. |
|
||||
| `worktree_typechanged` | Displays `worktree_typechanged` when a file's type has been changed in the working directory. |
|
||||
| `index_added` | Displays `index_added` when a new file has been added to the staging area. |
|
||||
| `index_deleted` | Displays `index_deleted` when a file has been deleted from the staging area. |
|
||||
| `index_modified` | Displays `index_modified` when a file has been modified in the staging area. |
|
||||
| `index_typechanged` | Displays `index_typechanged` when a file's type has been changed in the staging area. |
|
||||
| style\* | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
@@ -2092,7 +2139,7 @@ The following variables can be used in `diverged`:
|
||||
| `ahead_count` | Number of commits ahead of the tracking branch |
|
||||
| `behind_count` | Number of commits behind the tracking branch |
|
||||
|
||||
The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`:
|
||||
The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed`, `deleted`, `typechanged`, `worktree_added`, `worktree_deleted`, `worktree_modified`, `worktree_typechanged`, `index_added`, `index_deleted`, `index_modified`, and `index_typechanged`:
|
||||
|
||||
| Variable | Description |
|
||||
| -------- | ------------------------ |
|
||||
@@ -2353,7 +2400,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `['hx', 'hxml']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this module. |
|
||||
| `symbol` | `'⌘ '` | A format string representing the symbol of Haxe. |
|
||||
| `style` | `'bold fg:202'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `haxe` module. |
|
||||
@@ -2393,7 +2440,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `symbol` | `'⎈ '` | A format string representing the symbol of Helm. |
|
||||
| `style` | `'bold white'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `helm` module. |
|
||||
@@ -2493,7 +2540,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `symbol` | `'☕ '` | A format string representing the symbol of Java |
|
||||
| `style` | `'red dimmed'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `java` module. |
|
||||
@@ -2603,7 +2650,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `['jl']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['Project.toml', 'Manifest.toml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. |
|
||||
| `style` | `'bold purple'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `julia` module. |
|
||||
@@ -2642,7 +2689,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `['kt', 'kts']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. |
|
||||
| `style` | `'bold blue'` | The style for the module. |
|
||||
| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. |
|
||||
@@ -2708,7 +2755,7 @@ If the `$KUBECONFIG` env var is set the module will use that if not it will use
|
||||
| `user_aliases`* | `{}` | Table of user aliases to display. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
|
||||
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
|
||||
| `disabled` | `true` | Disables the `kubernetes` module. |
|
||||
@@ -2899,6 +2946,41 @@ By default the module will be shown if any of the following conditions are met:
|
||||
format = 'via [🌕 $version](bold blue) '
|
||||
```
|
||||
|
||||
## Maven
|
||||
|
||||
The `maven` module indicates the presence of a Maven project in the current directory. If the [Maven Wrapper](https://maven.apache.org/wrapper/) is enabled, the Maven version will be parsed from `.mvn/wrapper/maven-wrapper.properties` and shown.
|
||||
|
||||
By default the module will be shown if any of the following conditions are met:
|
||||
|
||||
- The current directory contains a `pom.xml` file.
|
||||
- The current directory contains a `.mvn/wrapper/maven-wrapper.properties` file.
|
||||
|
||||
If you use an alternate POM syntax (for example `pom.hocon`), add its filename to `detect_files`.
|
||||
|
||||
### 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` | `'🅼 '` | A format string representing the symbol of Maven. |
|
||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['pom.xml']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.mvn']` | Which folders should trigger this module. |
|
||||
| `style` | `'bold bright-cyan'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `maven` module. |
|
||||
| `recursive` | `false` | Enables recursive finding for the `.mvn` directory. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| -------- | -------- | ------------------------------------ |
|
||||
| version | `v3.2.0` | The version of `maven` |
|
||||
| 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
|
||||
|
||||
## Memory Usage
|
||||
|
||||
The `memory_usage` module shows current system memory and swap usage.
|
||||
@@ -3072,14 +3154,17 @@ The `mise` module shows the current mise health as reported by running `mise doc
|
||||
|
||||
### 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. |
|
||||
| `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. |
|
||||
| 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
|
||||
|
||||
@@ -3259,12 +3344,13 @@ The module will be shown when inside a nix-shell environment.
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| -------- | ------- | ------------------------------------ |
|
||||
| state | `pure` | The state of the nix-shell |
|
||||
| name | `lorri` | The name of the nix-shell |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
| Variable | Example | Description |
|
||||
| -------- | ------- | ----------------------------------------------------------------------------- |
|
||||
| state | `pure` | The state of the nix-shell |
|
||||
| name | `lorri` | The name of the nix-shell |
|
||||
| level | `1` | The depth level of the nix-shell (Only when using [Lix](https://lix.systems)) |
|
||||
| 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
|
||||
|
||||
@@ -3293,7 +3379,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
- 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.
|
||||
Additionally, the module will be hidden by default if the directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `bunfig.toml`, `bun.lock`, or `bun.lockb` file, overriding the above conditions.
|
||||
|
||||
### Options
|
||||
|
||||
@@ -3522,6 +3608,7 @@ AIX = "➿ "
|
||||
Alpaquita = "🔔 "
|
||||
AlmaLinux = "💠 "
|
||||
Alpine = "🏔️ "
|
||||
ALTLinux = "Ⓐ "
|
||||
Amazon = "🙂 "
|
||||
Android = "🤖 "
|
||||
AOSC = "🐱 "
|
||||
@@ -3532,6 +3619,7 @@ CachyOS = "🎗️ "
|
||||
CentOS = "💠 "
|
||||
Debian = "🌀 "
|
||||
DragonFly = "🐉 "
|
||||
Elementary = "🍏 "
|
||||
Emscripten = "🔗 "
|
||||
EndeavourOS = "🚀 "
|
||||
Fedora = "🎩 "
|
||||
@@ -3540,6 +3628,8 @@ Garuda = "🦅 "
|
||||
Gentoo = "🗜️ "
|
||||
HardenedBSD = "🛡️ "
|
||||
Illumos = "🐦 "
|
||||
Ios = "📱 "
|
||||
InstantOS = "⏲️ "
|
||||
Kali = "🐉 "
|
||||
Linux = "🐧 "
|
||||
Mabox = "📦 "
|
||||
@@ -3556,6 +3646,7 @@ OpenCloudOS = "☁️ "
|
||||
openEuler = "🦉 "
|
||||
openSUSE = "🦎 "
|
||||
OracleLinux = "🦴 "
|
||||
PikaOS = "🐤 "
|
||||
Pop = "🍭 "
|
||||
Raspbian = "🍓 "
|
||||
Redhat = "🎩 "
|
||||
@@ -3570,6 +3661,7 @@ Unknown = "❓ "
|
||||
Uos = "🐲 "
|
||||
Void = " "
|
||||
Windows = "🪟 "
|
||||
Zorin = "🔹 "
|
||||
```
|
||||
|
||||
### Variables
|
||||
@@ -3766,7 +3858,8 @@ The `pijul_channel` module shows the active channel of the repo in your current
|
||||
|
||||
## Pixi
|
||||
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.
|
||||
The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as the activated
|
||||
environment and project name, 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`.
|
||||
@@ -3788,12 +3881,13 @@ The `pixi` module shows the installed [pixi](https://pixi.sh) version as well as
|
||||
|
||||
### 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` |
|
||||
| Variable | Example | Description |
|
||||
| ------------ | ------------ | ------------------------------------ |
|
||||
| version | `v0.33.0` | The version of `pixi` |
|
||||
| environment | `py311` | The current pixi environment |
|
||||
| project_name | `my-project` | The current pixi project name |
|
||||
| symbol | | Mirrors the value of option `symbol` |
|
||||
| style | | Mirrors the value of option `style` |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -3937,13 +4031,20 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
| `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']` | Which filenames should trigger this module |
|
||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||
| `generic_venv_names` | `[]` | Which venv names should be replaced with the parent directory name. |
|
||||
| `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 `python_binary` variable accepts either:
|
||||
>
|
||||
> - a string (e.g. `'python3'`),
|
||||
> - a list of strings (e.g. `['python', 'python3']`)
|
||||
> - a list of lists of strings, representing commands with optional arguments (e.g.
|
||||
> `[['mise', 'exec', '--', 'python'], ['python3']]`)
|
||||
>
|
||||
> Starship will try executing each configured command 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
|
||||
@@ -3956,13 +4057,13 @@ By default, the module will be shown if any of the following conditions are met:
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| ------------ | --------------- | ------------------------------------------ |
|
||||
| version | `'v3.8.1'` | The version of `python` |
|
||||
| symbol | `'🐍 '` | Mirrors the value of option `symbol` |
|
||||
| style | `'yellow bold'` | Mirrors the value of option `style` |
|
||||
| pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `'venv'` | The current `virtualenv` name |
|
||||
| Variable | Example | Description |
|
||||
| ------------ | --------------- | --------------------------------------------------------------------------- |
|
||||
| version | `'v3.8.1'` | The version of `python` |
|
||||
| symbol | `'🐍 '` | Mirrors the value of option `symbol` |
|
||||
| style | `'yellow bold'` | Mirrors the value of option `style` |
|
||||
| pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` |
|
||||
| virtualenv | `'venv'` | The current `virtualenv` name or the parent if matches `generic_venv_names` |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -3985,6 +4086,22 @@ python_binary = 'python3'
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[python]
|
||||
# Use `mise` to get the version.
|
||||
python_binary = [['mise', 'exec', '--', 'python']]
|
||||
```
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[python]
|
||||
# Potentially dangerous: `uv` can run any binary at `.venv/bin/python` without interaction
|
||||
python_binary = [['uv', 'run', '--no-python-downloads', '--no-project', 'python']]
|
||||
```
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[python]
|
||||
# Don't trigger for files with the py extension
|
||||
detect_extensions = []
|
||||
@@ -4248,7 +4365,7 @@ By default the module will be shown if any of the following conditions are met:
|
||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||
| `detect_extensions` | `['sbt', 'scala']` | Which extensions should trigger this module. |
|
||||
| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Which filenames should trigger this module. |
|
||||
| `detect_folders` | `['.metals']` | Which folders should trigger this modules. |
|
||||
| `detect_folders` | `['.metals']` | Which folders should trigger this module. |
|
||||
| `symbol` | `'🆂 '` | A format string representing the symbol of Scala. |
|
||||
| `style` | `'red dimmed'` | The style for the module. |
|
||||
| `disabled` | `false` | Disables the `scala` module. |
|
||||
@@ -4697,7 +4814,7 @@ 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.
|
||||
The `format` configuration value is used by the [`jiff`](https://crates.io/crates/jiff) crate to control how the time is displayed. Take a look [at the jiff strftime docs](https://docs.rs/jiff/latest/jiff/fmt/strtime/index.html) to see what options are available.
|
||||
|
||||
> [!TIP]
|
||||
> This module is disabled by default.
|
||||
@@ -4705,15 +4822,15 @@ The `format` configuration value is used by the [`chrono`](https://crates.io/cra
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'at [$time]($style) '` | The format string for the module. |
|
||||
| `use_12hr` | `false` | Enables 12 hour formatting |
|
||||
| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
|
||||
| `style` | `'bold yellow'` | The style for the module time |
|
||||
| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
|
||||
| `disabled` | `true` | Disables the `time` module. |
|
||||
| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
|
||||
| Option | Default | Description |
|
||||
| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'at [$time]($style) '` | The format string for the module. |
|
||||
| `use_12hr` | `false` | Enables 12 hour formatting |
|
||||
| `time_format` | see below | The [jiff format string](https://docs.rs/jiff/latest/jiff/fmt/strtime/index.html) used to format the time. |
|
||||
| `style` | `'bold yellow'` | The style for the module time |
|
||||
| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Either an IANA time zone name or a range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
|
||||
| `disabled` | `true` | Disables the `time` module. |
|
||||
| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
|
||||
|
||||
If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`.
|
||||
Manually setting `time_format` will override the `use_12hr` setting.
|
||||
@@ -4729,6 +4846,8 @@ Manually setting `time_format` will override the `use_12hr` setting.
|
||||
|
||||
### Example
|
||||
|
||||
#### With UTC offset
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
@@ -4740,6 +4859,17 @@ utc_time_offset = '-5'
|
||||
time_range = '10:00:00-14:00:00'
|
||||
```
|
||||
|
||||
#### With Timezone name
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[time]
|
||||
disabled = false
|
||||
time_format = '%T'
|
||||
utc_time_offset = 'Europe/Berlin'
|
||||
```
|
||||
|
||||
## Typst
|
||||
|
||||
The `typst` module shows the current installed version of Typst used in a project.
|
||||
@@ -4900,6 +5030,47 @@ By default the module will be shown if any of the following conditions are met:
|
||||
format = 'via [V $version](blue bold) '
|
||||
```
|
||||
|
||||
## VCS
|
||||
|
||||
> Note the module is enabled by default but **not** included in the default list because that would be a breaking change.
|
||||
> Additionally, the exact format of the module may change in the future, for example to handle right-aligned prompt.
|
||||
|
||||
The `vcs` module displays the current active Version Control System (VCS).
|
||||
The module will be shown only if a configured VCS is currently in use.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------------- | ----------------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `order` | `["git", "hg", "pijul", "fossil"]` | The order in which to search VCSes. |
|
||||
| `fossil_modules` | `"$fossil_branch$fossil_metrics"` | Modules to show when a Fossil repository is found. |
|
||||
| `git_modules` | `"$git_branch$git_commit$git_state$git_metrics$git_status"` | Modules to show when a Git repository is found. |
|
||||
| `hg_modules` | `"$hg_branch$hg_state"` | Modules to show when a Mercurial repository is found. |
|
||||
| `pijul_modules` | `"$pijul_channel"` | Modules to show when a Pijul repository is found. |
|
||||
| `disabled` | `false` | Disables the `vcs` module. |
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[vcs]
|
||||
# Will look for Git then Pijul if not found but not for other VCSes at all
|
||||
order = [
|
||||
"git",
|
||||
"pijul",
|
||||
]
|
||||
# Any module (except `$vcs` itself to avoid infinite loops) can be included here
|
||||
git_modules = "$git_branch${custom.foo}"
|
||||
|
||||
# See documentation for custom modules
|
||||
[custom.foo]
|
||||
command = 'echo foo'
|
||||
detect_files = ['foo']
|
||||
when = ''' test "$HOME" = "$PWD" '''
|
||||
format = ' transcending [$output]($style)'
|
||||
```
|
||||
|
||||
## VCSH
|
||||
|
||||
The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository.
|
||||
|
||||
+15
-35
@@ -1,26 +1,23 @@
|
||||
---
|
||||
layout: home
|
||||
layout: Home
|
||||
hero:
|
||||
image: /logo.svg
|
||||
text:
|
||||
text: null
|
||||
tagline: Der minimalistische, super schnelle und unendlich anpassbare Prompt für jede Shell!
|
||||
actions:
|
||||
-
|
||||
theme: brand
|
||||
- theme: brand
|
||||
text: Loslegen →
|
||||
link: ./de-DE/guide/
|
||||
features:
|
||||
-
|
||||
title: Kompatibel
|
||||
- title: Kompatibel
|
||||
details: Läuft mit den beliebtesten Shells auf den beliebtesten Betriebssystemen. Überall einsetzbar!
|
||||
-
|
||||
title: Rust-Powered
|
||||
- title: Rust-Powered
|
||||
details: Bringt die Schnelligkeit und Sicherheit von Rust in deine Shell-Prompt.
|
||||
-
|
||||
title: Individualisierbar
|
||||
- title: Individualisierbar
|
||||
details: Jedes noch so kleine Detail kann nach Deinen Wünschen angepasst werden, um die Eingabeaufforderung so minimal oder funktionsreich zu gestalten, wie Du es möchtest.
|
||||
footer: ICS lizenziert | Copyright © 2019-heute Starship-Mitwirkende
|
||||
#Used for the description meta tag, for SEO
|
||||
|
||||
# Used for the description meta tag, for SEO
|
||||
metaTitle: "Starship: Cross-Shell Prompt"
|
||||
description: Starship ist eine minimale, super schnelle, und extrem anpassbare Prompt für jede Shell! Sie zeigt die Information, die man benötigt an, während sie schnell und minimal bleibt. Schnell-Installation verfügbar für Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, und PowerShell.
|
||||
---
|
||||
@@ -52,7 +49,6 @@ onMounted(() => {
|
||||
|
||||
1. Installiere die Binärversion von **starship**:
|
||||
|
||||
|
||||
#### Neueste Version installieren
|
||||
|
||||
Mit Shell:
|
||||
@@ -63,7 +59,6 @@ onMounted(() => {
|
||||
|
||||
Führe das Skript oben erneut aus, um Starship selbst zu aktualisieren. Die vorhandene Version wird ersetzt, ohne dass deine Starship-Konfiguration verloren geht.
|
||||
|
||||
|
||||
#### Installation mithilfe eines Paket-Managers
|
||||
|
||||
Mit [Homebrew](https://brew.sh/):
|
||||
@@ -78,8 +73,7 @@ onMounted(() => {
|
||||
winget install starship
|
||||
```
|
||||
|
||||
1. Füge das init-Skript zur Konfigurationsdatei deiner Shell hinzu:
|
||||
|
||||
2. Füge das init-Skript zur Konfigurationsdatei deiner Shell hinzu:
|
||||
|
||||
#### Bash
|
||||
|
||||
@@ -91,7 +85,6 @@ onMounted(() => {
|
||||
eval "$(starship init bash)"
|
||||
```
|
||||
|
||||
|
||||
#### Fish
|
||||
|
||||
Trage folgendes am Ende der `~/.config/fish/config.fish` ein:
|
||||
@@ -102,7 +95,6 @@ onMounted(() => {
|
||||
starship init fish | source
|
||||
```
|
||||
|
||||
|
||||
#### Zsh
|
||||
|
||||
Trage folgendes am Ende der `~/.zshrc` ein:
|
||||
@@ -113,8 +105,7 @@ onMounted(() => {
|
||||
eval "$(starship init zsh)"
|
||||
```
|
||||
|
||||
|
||||
#### Powershell
|
||||
#### PowerShell
|
||||
|
||||
Füge das Folgende ans Ende von `Microsoft.PowerShell_profile.ps1` an. Du kannst den Speicherort dieser Datei überprüfen, indem du die `$PROFILE` Variable in PowerShell abfragst. Normalerweise ist der Pfad `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` oder `~/.config/powershell/Microsoft.PowerShell_profile.ps1` auf -Nix.
|
||||
|
||||
@@ -122,7 +113,6 @@ onMounted(() => {
|
||||
Invoke-Expression (&starship init powershell)
|
||||
```
|
||||
|
||||
|
||||
#### Ion
|
||||
|
||||
Trage folgendes am Ende der `~/.config/ion/initrc` ein:
|
||||
@@ -133,16 +123,11 @@ onMounted(() => {
|
||||
eval $(starship init ion)
|
||||
```
|
||||
|
||||
|
||||
#### Elvish
|
||||
|
||||
::: warning
|
||||
> [!WARNUNG] Nur elvish v0.18 oder höher wird unterstützt.
|
||||
|
||||
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
|
||||
@@ -150,6 +135,7 @@ onMounted(() => {
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
#### Tcsh
|
||||
|
||||
@@ -161,14 +147,10 @@ onMounted(() => {
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
|
||||
Das wird sich in Zukunft ändern. Nur Nushell v0.96+ wird unterstützt.
|
||||
|
||||
:::
|
||||
> [!WARNUNG] Dies wird sich in Zukunft ändern.
|
||||
> 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):
|
||||
|
||||
@@ -177,7 +159,6 @@ onMounted(() => {
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
|
||||
#### Xonsh
|
||||
|
||||
Füge folgendes an das Ende von `~/.xonshrc` hinzu:
|
||||
@@ -188,7 +169,6 @@ onMounted(() => {
|
||||
execx($(starship init xonsh))
|
||||
```
|
||||
|
||||
|
||||
#### ⌘ Cmd
|
||||
|
||||
Du musst [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) mit Cmd verwenden. Trage folgendes in eine neue Datei namens `starship.lua` hinzu und lege diese Datei im Clink Scripts Verzeichnis ab:
|
||||
|
||||
@@ -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] Die Konfigurationen in diesem Abschnitt können in zukünftigen Releases von Starship Änderungen unterliegen.
|
||||
|
||||
## TransientPrompt in PowerShell
|
||||
|
||||
@@ -32,7 +28,7 @@ Clink allows you to replace the previous-printed prompt with custom strings. Das
|
||||
- `same_dir`: replace the previous prompt only if the working directory is same
|
||||
- `off`: do not replace the prompt (i.e. turn off transience)
|
||||
|
||||
You need to do this only once. Make the following changes to your `starship.lua` to customize what gets displayed on the left and on the right:
|
||||
Sie müssen dies nur einmal tun. Make the following changes to your `starship.lua` to customize what gets displayed on the left and on the right:
|
||||
|
||||
- By default, the left side of input gets replaced with `>`. To customize this, define a new function called `starship_transient_prompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display Starship's `character` module here, you would do
|
||||
|
||||
@@ -45,7 +41,7 @@ end
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
```
|
||||
|
||||
- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display the time at which the last command was started here, you would do
|
||||
- Standardmäßig ist die rechte Seite de Eingabe leer. To customize this, define a new function called `starship_transient_rprompt_func`. This function receives the current prompt as a string that you can utilize. For example, to display the time at which the last command was started here, you would do
|
||||
|
||||
```lua
|
||||
function starship_transient_rprompt_func(prompt)
|
||||
@@ -70,7 +66,7 @@ starship init fish | source
|
||||
enable_transience
|
||||
```
|
||||
|
||||
- By default, the right side of input is empty. To customize this, define a new function called `starship_transient_rprompt_func`. For example, to display the time at which the last command was started here, you would do
|
||||
- Standardmäßig ist die rechte Seite de Eingabe leer. To customize this, define a new function called `starship_transient_rprompt_func`. For example, to display the time at which the last command was started here, you would do
|
||||
|
||||
```fish
|
||||
function starship_transient_rprompt_func
|
||||
@@ -80,11 +76,13 @@ starship init fish | source
|
||||
enable_transience
|
||||
```
|
||||
|
||||
## TransientPrompt and TransientRightPrompt in Bash
|
||||
## „TransientPrompt“ und „TransientRightPrompt“ in 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. This is useful in cases where all the prompt information is not always needed. To enable this, put this in `~/.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.
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
@@ -126,9 +124,11 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
## Benutzerdefinierte Pre-Prompt- und Pre-Execution-Befehle in der Bash
|
||||
|
||||
Die Bash Shell hat, im Gegensatz zu vielen anderen Shells, kein konventionelles preexec/precmd Framework. Daher gestaltet es sich schwierig, vollständig anpassbare Hooks für `bash` anzubieten. Starship bietet daher die begrenzte Möglichkeit, eigene Funktionen in das prompt rendering Verfahren einzufügen:
|
||||
PowerShell does not have a formal preexec/precmd framework like most other shells.
|
||||
Because of this, it is difficult to provide fully customizable hooks in `powershell`.
|
||||
Starship bietet daher die begrenzte Möglichkeit, eigene Funktionen in das prompt rendering Verfahren einzufügen:
|
||||
|
||||
- Um eine benutzerdefinierte Funktion kurz vor Anzeige der Eingabeaufforderung auszuführen, definiere eine neue Funktion und weise den Namen `starship_precmd_user_func` zu. Um beispielsweise eine Rakete anzuzeigen, bevor die Eingabeaufforderung erscheint, würde man folgendes tun
|
||||
- Um eine benutzerdefinierte Funktion kurz vor Anzeige der Eingabeaufforderung auszuführen, definiere eine neue Funktion und weise den Namen `starship_precmd_user_func` zu. Zum Beispiel, um vor der Eingabeaufforderung eine Rakete zu zeichnen, würden Sie Folgendes tun
|
||||
|
||||
```bash
|
||||
function blastoff(){
|
||||
@@ -137,7 +137,9 @@ function blastoff(){
|
||||
starship_precmd_user_func="blastoff"
|
||||
```
|
||||
|
||||
- Um eine benutzerdefinierte Funktion direkt vor der Ausführung eines Befehls auszulösen, kann man den [`DEBUG` trap](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/) Mechanismus verwenden. Allerdings **muss** das DEBUG Signal _vor_ der Initialisierung von Starship getrapped werden! Starship kann den Wert der DEBUG-trap speichern. Wenn der Wert der DEBUG-trap überschrieben wird nachdem Starship gestartet ist kann es zu Fehlern im Bezug auf die verwendete DEBUG-trap kommen.
|
||||
- Um eine benutzerdefinierte Funktion direkt vor der Ausführung eines Befehls auszulösen, kann man den [`DEBUG` trap](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/) Mechanismus verwenden.
|
||||
Allerdings **muss** das DEBUG Signal _vor_ der Initialisierung von Starship getrapped werden!
|
||||
Starship kann den Wert der DEBUG-trap speichern. Wenn der Wert der DEBUG-trap überschrieben wird nachdem Starship gestartet ist kann es zu Fehlern im Bezug auf die verwendete DEBUG-trap kommen.
|
||||
|
||||
```bash
|
||||
function blastoff(){
|
||||
@@ -151,7 +153,9 @@ set +o functrace
|
||||
|
||||
## Benutzerdefinierte Pre-Prompt- und Pre-Execution-Befehle in PowerShell
|
||||
|
||||
PowerShell does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `powershell`. Starship bietet daher die begrenzte Möglichkeit, eigene Funktionen in das prompt rendering Verfahren einzufügen:
|
||||
Die Bash Shell hat, im Gegensatz zu vielen anderen Shells, kein konventionelles preexec/precmd Framework.
|
||||
Daher gestaltet es sich schwierig, vollständig anpassbare Hooks für `bash` anzubieten.
|
||||
Starship bietet daher die begrenzte Möglichkeit, eigene Funktionen in das prompt rendering Verfahren einzufügen:
|
||||
|
||||
Create a function named `Invoke-Starship-PreCommand`
|
||||
|
||||
@@ -163,7 +167,8 @@ function Invoke-Starship-PreCommand {
|
||||
|
||||
## Fenstertitel anpassen
|
||||
|
||||
Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish ist standardmäßig so konfiguriert. Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`.
|
||||
Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish ist standardmäßig so konfiguriert.
|
||||
Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`.
|
||||
|
||||
Zuerst wird eine Funktion definiert um den Fenstertitel zu ändern ( für bash und zsh ist die Funktion identisch):
|
||||
|
||||
@@ -189,7 +194,7 @@ precmd_functions+=(set_win_title)
|
||||
|
||||
If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zshrc`) to make it permanent.
|
||||
|
||||
Zum Beispiel, wenn sie ihr aktuelles Verzeichnis als Terminal Title anzeigen wollen, fügen Sie folgenden Code-Schnipsel zu ihrer `~/.bashrc` oder `~/.zshrc` hinzu:
|
||||
Zum Beispiel, wenn Sie ihr aktuelles Verzeichnis im Titel Ihrer Terminal-Registerkarte anzeigen möchten, fügen Sie folgenden Code-Schnipsel zu Ihrer `~/.bashrc` oder `~/.zshrc` hinzu:
|
||||
|
||||
```bash
|
||||
function set_win_title(){
|
||||
@@ -247,6 +252,12 @@ Produces a prompt like the following:
|
||||
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
|
||||
```
|
||||
|
||||
When using `zsh` (v5.0.5+), the shell adds a default trailing space to the right prompt. This can cause alignment issues specifically when using the Starship `$fill` module. To remove this gap, add the following to your `.zshrc`:
|
||||
|
||||
```zsh
|
||||
ZLE_RPROMPT_INDENT=0
|
||||
```
|
||||
|
||||
## Fortsetzungsprompt
|
||||
|
||||
Einige Shells unterstützen einen speziellen Fortsetzungsprompt zusätzlich zum normalen Prompt. Dieser Prompt wird anstelle des normalen Prompts ausgegeben, wenn der Benutzer ein unvollständiges Kommando eingegeben hat (etwa wie eine einzelne linke Klammer oder ein einzelnes Anführungszeichen).
|
||||
@@ -270,12 +281,322 @@ Hinweis: Fortsetzungs-Prompts sind nur für folgende Shells verfügbar:
|
||||
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"
|
||||
```
|
||||
|
||||
### Konfiguration
|
||||
|
||||
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.
|
||||
|
||||
#### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| --------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'[$symbol$model]($style) '` | Das Format für das Modul. |
|
||||
| `Symbol` | `'🤖 '` | The symbol shown before the model name. |
|
||||
| `style` | `'bold blue'` | Stil für dieses Modul. |
|
||||
| `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 | Beispiel | Beschreibung |
|
||||
| ----------------------------- | ------------------- | ------------------------------------- |
|
||||
| model | `Claude 3.5 Sonnet` | The display name of the current model |
|
||||
| model_id | `claude-3-5-sonnet` | The model ID |
|
||||
| Symbol | | Spiegelt den Wert der Option `symbol` |
|
||||
| style\* | | Spiegelt den Wert der Option `style` |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
#### Beispiele
|
||||
|
||||
```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.
|
||||
|
||||
#### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ---------------------- | --------------------------------- | ------------------------------------------------------------------ |
|
||||
| `format` | `'[$gauge $percentage]($style) '` | Das Format für das Modul. |
|
||||
| `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` | [siehe unten](#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 | Standartwert | Beschreibung |
|
||||
| ----------- | ------------ | ------------------------------------------------------------------------ |
|
||||
| `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 | Beispiel | Beschreibung |
|
||||
| ----------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------- |
|
||||
| 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 | | Spiegelt den Wert der Option `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
#### Beispiele
|
||||
|
||||
**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.
|
||||
|
||||
#### Optionen
|
||||
|
||||
| Option | Standartwert | Beschreibung |
|
||||
| ---------- | ---------------------------------- | --------------------------------------------------- |
|
||||
| `format` | `'[$symbol(\\$$cost)]($style) '` | Das Format für das Modul. |
|
||||
| `Symbol` | `'💰 '` | The symbol shown before the cost. |
|
||||
| `display` | [siehe unten](#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 | Standartwert | Beschreibung |
|
||||
| ----------- | ------------ | ------------------------------------------------------------------ |
|
||||
| `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 | Beispiel | Beschreibung |
|
||||
| ---------------------------------- | -------- | ---------------------------------------------------------------------- |
|
||||
| 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 | | Spiegelt den Wert der Option `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\*: This variable can only be used as a part of a style string
|
||||
|
||||
#### Beispiele
|
||||
|
||||
```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
|
||||
|
||||
Stil-Zeichenketten sind eine Liste von Wörtern, getrennt durch Leerzeichen. Die Wörter haben keine Groß- und Kleinschreibung (z.B. `bold` und `BoLd` werden als dieselbe Zeichenkette betrachtet). Jedes Wort kann eines der folgenden sein:
|
||||
|
||||
- `fett`
|
||||
- `kursiv`
|
||||
- `italic`
|
||||
- `unterstrichen`
|
||||
- `gedimmt`
|
||||
- `invertiert`
|
||||
@@ -287,7 +608,9 @@ Stil-Zeichenketten sind eine Liste von Wörtern, getrennt durch Leerzeichen. Die
|
||||
- `<color>`
|
||||
- `keins`
|
||||
|
||||
wobei `<color>` eine Farbspezifikation ist (siehe unten). `fg:<color>` und `<color>` tun derzeit dasselbe, das kann sich in Zukunft aber ändern. `<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` tauscht Hinter- und Vordergrundfarben. Die Reihenfolge der Wörter in der Liste spielt keine Rolle.
|
||||
wobei `<color>` eine Farbspezifikation ist (siehe unten). `fg:<color>` und `<color>` tun derzeit dasselbe, das kann sich in Zukunft aber ändern.
|
||||
`<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` tauscht Hinter- und Vordergrundfarben. Die Reihenfolge der Wörter in der Liste spielt keine Rolle.
|
||||
|
||||
`none` überschreibt alle anderen Tokens in einem String wenn es nicht ein Teil einer `bg:` Zeichenkette ist, so dass z.B. über die Zeichenkette `fg:red none fg:blue` kein Styling mehr anzeigt wird. `bg:none` setzt den Hintergrund auf die Standardfarbe, so `fg:red bg:none` entspricht `rot` oder `fg:red` und `bg:green fg:red bg:none` entspricht auch `fg:red` oder `rot`. In der Zukunft könnte die Unterstützung von `none` in Verbindung mit anderen Tokens fallen gelassen werden.
|
||||
|
||||
|
||||
+1931
-1640
File diff suppressed because it is too large
Load Diff
+14
-13
@@ -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
|
||||
@@ -86,7 +86,7 @@ Finally if you find a bug you can use the `bug-report` command to create a GitHu
|
||||
starship bug-report
|
||||
```
|
||||
|
||||
## Why don't I see a glyph symbol in my prompt?
|
||||
## Warum sehe ich in meiner Eingabeaufforderung kein Glyphe-Symbol?
|
||||
|
||||
The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. Sie müssen sicherstellen, dass:
|
||||
|
||||
@@ -103,14 +103,15 @@ echo -e "\xee\x82\xa0"
|
||||
|
||||
The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
|
||||
|
||||
If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Benutzer auf dem Discord können vielleicht helfen. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
|
||||
If either symbol fails to display correctly, your system is still misconfigured.
|
||||
Unfortunately, getting font configuration correct is sometimes difficult. Benutzer auf dem Discord können vielleicht helfen. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
|
||||
|
||||
## Wie deinstalliere ich Starship?
|
||||
|
||||
Starship ist genauso einfach zu deinstallieren wie zu installieren.
|
||||
|
||||
1. Remove any lines in your shell config (e.g. `~/.bashrc`) used to initialize Starship.
|
||||
1. Löschen Sie die Starship-Binary.
|
||||
2. Löschen Sie die Starship-Binary.
|
||||
|
||||
If Starship was installed using a package manager, please refer to their docs for uninstallation instructions.
|
||||
|
||||
|
||||
+109
-91
@@ -1,13 +1,12 @@
|
||||
<p align="center">
|
||||
<img
|
||||
width="400"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||||
alt="Starship – Cross-Shell Prompt"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/logo.png"
|
||||
alt="Starship – Cross-shell prompt"
|
||||
/>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/actions"
|
||||
<p align="center"><a href="https://github.com/starship/starship/actions"
|
||||
><img
|
||||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||||
alt="Workflow-Status der GitHub Actions"
|
||||
@@ -39,16 +38,14 @@
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs">Website</a>
|
||||
<p align="center"><a href="https://starship.rs">Website</a>
|
||||
·
|
||||
<a href="#🚀-installation">Installation</a>
|
||||
·
|
||||
<a href="https://starship.rs/config/">Konfiguration</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
<p align="center"><a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||||
@@ -154,12 +151,23 @@
|
||||
|
||||
<h1></h1>
|
||||
|
||||
> [!WARNING]
|
||||
> **The default branch has been renamed from `master` to `main`.**
|
||||
> If you have a local clone, update it by running:
|
||||
>
|
||||
> ```sh
|
||||
> git branch -m master main
|
||||
> git fetch origin
|
||||
> git branch -u origin/main main
|
||||
> git remote set-head origin -a
|
||||
> ```
|
||||
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship mit iTem2 und dem Theme „Snazzy“"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship mit iTem2 und dem Theme „Snazzy“"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
|
||||
**Der minimalistische, super schnelle und unendlich anpassbare Prompt für jede Shell!**
|
||||
|
||||
@@ -170,8 +178,7 @@
|
||||
- **Funktionsreich:** unterstützt alle deine Lieblingswerkzeuge.
|
||||
- **Einfach:** schnell zu installieren – Betriebsbereit in nur wenigen Minuten.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs/config/"><strong>Schau dir die Starship-Dokumentation an ▶</strong></a>
|
||||
<p align="center"><a href="https://starship.rs/config/"><strong>Schau dir die Starship-Dokumentation an ▶</strong></a>
|
||||
</p>
|
||||
|
||||
<a name="🚀-installation"></a>
|
||||
@@ -186,32 +193,29 @@
|
||||
|
||||
Wähle dein Betriebssystem aus der Liste für detaillierte Installationsanweisungen:
|
||||
|
||||
<details>
|
||||
<summary>Android</summary>
|
||||
<details><summary>Android</summary>
|
||||
|
||||
Install Starship using any of the following package managers:
|
||||
Starship unter Verwendung einer der folgenden Paketmanager installieren:
|
||||
|
||||
| Repository | Instructions |
|
||||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||||
| Repository | Anweisungen |
|
||||
| ---------- | ---------------------- |
|
||||
| [Termux] | `pkg install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>BSD</summary>
|
||||
<details><summary>BSD</summary>
|
||||
|
||||
Install Starship using any of the following package managers:
|
||||
Starship unter Verwendung einer der folgenden Paketmanager installieren:
|
||||
|
||||
| Distribution | Repository | Instructions |
|
||||
| ------------ | -------------------------------------------------------- | --------------------------------- |
|
||||
| **_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` |
|
||||
| Distribution | Repository | Anweisungen |
|
||||
| ------------ | -------------------------------------------------- | --------------------------------- |
|
||||
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| FreeBSD | [FreshPorts] | `pkg install starship` |
|
||||
| NetBSD | [pkgsrc] | `pkgin install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Linux</summary>
|
||||
<details><summary>Linux</summary>
|
||||
|
||||
Install the latest version for your system:
|
||||
|
||||
@@ -221,26 +225,26 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
Alternatively, install Starship using any of the following package managers:
|
||||
|
||||
| Distribution | Repository | Instructions |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| **_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_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Gentoo | [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` |
|
||||
| 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` |
|
||||
| Distribution | Repository | Anweisungen |
|
||||
| ---------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| _Any_ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `conda install -c conda-forge starship` |
|
||||
| _Any_ | [Linuxbrew] | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages] | `apk add starship` |
|
||||
| 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` |
|
||||
| openSUSE | [OSS] | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe] | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages] | `xbps-install -S starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>macOS</summary>
|
||||
<details><summary>macOS</summary>
|
||||
|
||||
Install the latest version for your system:
|
||||
|
||||
@@ -250,29 +254,28 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
Alternatively, install Starship using any of the following package managers:
|
||||
|
||||
| Repository | Instructions |
|
||||
| Repository | Anweisungen |
|
||||
| -------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [Homebrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| [MacPorts](https://ports.macports.org/port/starship) | `port install starship` |
|
||||
| [Homebrew] | `brew install starship` |
|
||||
| [MacPorts] | `port install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Windows</summary>
|
||||
<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).
|
||||
|
||||
Install Starship using any of the following package managers:
|
||||
Starship unter Verwendung einer der folgenden Paketmanager installieren:
|
||||
|
||||
| Repository | Instructions |
|
||||
| -------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [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` |
|
||||
| Repository | Anweisungen |
|
||||
| -------------------------------------------------------- | --------------------------------------- |
|
||||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| [Chocolatey] | `choco install starship` |
|
||||
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| [Scoop] | `scoop install starship` |
|
||||
| [winget] | `winget install --id Starship.Starship` |
|
||||
|
||||
</details>
|
||||
|
||||
@@ -280,8 +283,7 @@ Install Starship using any of the following package managers:
|
||||
|
||||
Konfiguriere deine Shell, um Starship automatisch zu starten. Wähle dafür deine Shell aus der Liste aus:
|
||||
|
||||
<details>
|
||||
<summary>Bash</summary>
|
||||
<details><summary>Bash</summary>
|
||||
|
||||
Füge dies ans Ende von `~/.bashrc`:
|
||||
|
||||
@@ -291,10 +293,10 @@ eval "$(starship init bash)"
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>⌘ Cmd</summary>
|
||||
<details><summary>⌘ Cmd</summary>
|
||||
|
||||
Du musst [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) mit Cmd verwenden. Erstelle eine Datei in diesem Pfad `%LocalAppData%\clink\starship.lua` mit dem folgenden Inhalt:
|
||||
Du musst [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) mit Cmd verwenden.
|
||||
Erstelle eine Datei in diesem Pfad `%LocalAppData%\clink\starship.lua` mit dem folgenden Inhalt:
|
||||
|
||||
```lua
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
@@ -302,21 +304,19 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
<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>
|
||||
|
||||
<details>
|
||||
<summary>Fish</summary>
|
||||
<details><summary>Fish</summary>
|
||||
|
||||
Trage folgendes am Ende der `~/.config/fish/config.fish` ein:
|
||||
|
||||
@@ -326,8 +326,7 @@ starship init fish | source
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Ion</summary>
|
||||
<details><summary>Ion</summary>
|
||||
|
||||
Trage folgendes am Ende der `~/.config/ion/initrc` ein:
|
||||
|
||||
@@ -337,8 +336,7 @@ eval $(starship init ion)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Nushell</summary>
|
||||
<details><summary>Nushell</summary>
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
|
||||
@@ -351,8 +349,7 @@ Beachte: Nushell wird erst ab v0.96+ unterstützt
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>PowerShell</summary>
|
||||
<details><summary>PowerShell</summary>
|
||||
|
||||
Füge Folgendes am Ende deiner PowerShell-Konfiguration hinzu (finde sie, indem du folgenden Befehl ausführst `$PROFILE`):
|
||||
|
||||
@@ -362,8 +359,7 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Tcsh</summary>
|
||||
<details><summary>Tcsh</summary>
|
||||
|
||||
Füge Folgendes am Ende von `~/.tcshrc` ein:
|
||||
|
||||
@@ -373,8 +369,7 @@ eval `starship init tcsh`
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Xonsh</summary>
|
||||
<details><summary>Xonsh</summary>
|
||||
|
||||
Füge folgendes an das Ende von `~/.xonshrc` hinzu:
|
||||
|
||||
@@ -384,8 +379,7 @@ execx($(starship init xonsh))
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Zsh</summary>
|
||||
<details><summary>Zsh</summary>
|
||||
|
||||
Trage folgendes am Ende der `~/.zshrc` ein:
|
||||
|
||||
@@ -397,7 +391,8 @@ eval "$(starship init zsh)"
|
||||
|
||||
### Schritt 3. Starship konfigurieren
|
||||
|
||||
Starte eine neue Shell, um deinen neuen und schönen Prompt zu sehen. Wenn du mit den Defaults zufrieden bist, bist du bereits fertig!
|
||||
Starte eine neue Shell, um deinen neuen und schönen Prompt zu sehen.
|
||||
Wenn du mit den Defaults zufrieden bist, bist du bereits fertig!
|
||||
|
||||
Falls du Starship weiter anpassen möchtest:
|
||||
|
||||
@@ -407,7 +402,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/issues?q=state%3Aopen%20label%3A%22%F0%9F%8C%B1%20good%20first%20issue%22).
|
||||
|
||||
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/).
|
||||
|
||||
@@ -438,11 +433,34 @@ Code Signing Roles:
|
||||
|
||||
This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship Raketen-Symbol">
|
||||
<p align="center"><br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/main/media/icon.png" alt="Starship rocket icon">
|
||||
</p>
|
||||
|
||||
## 📝 Lizenz
|
||||
|
||||
Copyright © 2019-heute [Starship-Mitwirkende](https://github.com/starship/starship/graphs/contributors).<br /> Dieses Projekt ist [ISC](https://github.com/starship/starship/blob/master/LICENSE) lizenziert.
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
|
||||
Dieses Projekt ist [ISC](https://github.com/starship/starship/blob/master/LICENSE) lizenziert.
|
||||
|
||||
[alpine linux packages]: <[Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship)>
|
||||
[arch linux extra]: <[Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship)>
|
||||
[chocolatey]: [Chocolatey]\(https://community.chocolatey.org/packages/starship\)
|
||||
[conda-forge]: [conda-forge]\(https://anaconda.org/conda-forge/starship\)
|
||||
[copr]: [Copr]\(https://copr.fedorainfracloud.org/coprs/atim/starship\)
|
||||
[crates.io]: **[crates.io]\(https://crates.io/crates/starship\)**
|
||||
[debian main]: <[Debian Main](https://sources.debian.org/src/starship/1.22.1-1/)>
|
||||
[freshports]: [FreshPorts]\(https://www.freshports.org/shells/starship\)
|
||||
[gentoo packages]: <[Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship)>
|
||||
[linuxbrew]: [Linuxbrew]\(https://formulae.brew.sh/formula/starship\)
|
||||
[homebrew]: [Homebrew]\(https://formulae.brew.sh/formula/starship\)
|
||||
[macports]: [MacPorts]\(https://ports.macports.org/port/starship\)
|
||||
[nixpkgs]: [nixpkgs]\(https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix\)
|
||||
[OSS]: [OSS]\(https://software.opensuse.org/package/starship\)
|
||||
[pkgsrc]: [pkgsrc]\(https://pkgsrc.se/shells/starship\)
|
||||
[scoop]: [Scoop]\(https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json\)
|
||||
[SignPath Foundation]: https://signpath.org
|
||||
[SignPath.io]: https://signpath.io
|
||||
[termux]: [Termux]\(https://github.com/termux/termux-packages/tree/master/packages/starship\)
|
||||
[ubuntu universe]: <[Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship)>
|
||||
[void linux packages]: <[Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship)>
|
||||
[winget]: [winget]\(https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship\)
|
||||
|
||||
@@ -2,18 +2,18 @@
|
||||
|
||||
Um Starship zu installieren, musst du zwei Dinge tun:
|
||||
|
||||
1. Lade die **starship** Datei auf den Computer herunter
|
||||
1. Weise deine Shell an die Starship Datei als Eingabeaufforderung zu nutzen, indem du eines der Initialisierungs-Skripte benutzt
|
||||
1. Laden Sie die **starship** Binärdatei auf Ihren Computer herunter
|
||||
2. Weisen Sie Ihre Shell an, die Starship-Binärdatei als Eingabeaufforderung zu verwenden, indem Sie die Init-Skripte entsprechend anpassen
|
||||
|
||||
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. Für einige speziellere Plattformen wird jedoch eine speziellere Anleitung benötigt.
|
||||
Für die meisten Benutzer funktionieren die Anweisungen auf [der Hauptseite](../guide/#🚀-installation) hervorragend. Für einige speziellere Plattformen sind jedoch andere Anweisungen erforderlich.
|
||||
|
||||
Es gibt sehr viele Plattformen, sodass diese nicht alle in die Hauptanleitung passen, aus diesem Grund sind hier ein paar Installationsanweisungen für ein paar Plattformen von der Community. Ist deine Platform nicht dabei? Dann füge bitte deine hinzu, sobald du herausgefunden hast wie man starship mit dieser benutzt!
|
||||
Es gibt so viele Plattformen, dass sie nicht alle in die Hauptdatei README.md passten; daher finden Sie hier einige Installationsanweisungen für andere Plattformen aus der Community. Ist Ihre nicht dabei? Bitte fügen Sie es hier hinzu, wenn Sie es herausgefunden haben!
|
||||
|
||||
## [Chocolatey](https://chocolatey.org)
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
Gehe zur [Chocolatey's Installations-Seite](https://chocolatey.org/install) und folge den Anweisungen um Chocolatey zu installieren.
|
||||
Gehen Sie zu [Chocolatey Installations-Seite](https://chocolatey.org/install) und folgen Sie den Anweisungen, um Chocolatey zu installieren.
|
||||
|
||||
### Installation
|
||||
|
||||
@@ -23,23 +23,17 @@ 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)
|
||||
|
||||
### Installation
|
||||
|
||||
Unter Funtoo Linux kann starship von [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) über Portage installiert werden:
|
||||
Unter Funtoo Linux kann starship aus [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) über Portage installiert werden:
|
||||
|
||||
```sh
|
||||
emerge app-shells/starship
|
||||
@@ -47,7 +41,7 @@ emerge app-shells/starship
|
||||
|
||||
## [Nix](https://wiki.nixos.org/wiki/Nix)
|
||||
|
||||
### Das Binary holen
|
||||
### Abrufen der Binärdatei
|
||||
|
||||
#### Imperativ
|
||||
|
||||
@@ -78,7 +72,7 @@ Aktiviere das Modul `programs.starship` in deiner `home.nix`-Datei und füge dei
|
||||
}
|
||||
```
|
||||
|
||||
führe danach folgendes aus
|
||||
Danach ausführen
|
||||
|
||||
```sh
|
||||
home-manager switch
|
||||
@@ -86,7 +80,7 @@ home-manager switch
|
||||
|
||||
#### Deklarativ, systemweit, mit NixOS
|
||||
|
||||
Füge `pkgs.starship` zu der Sektion `environment.systemPackages` in deiner `configuration.nix` hinzu, und führe folgenden Befehl aus
|
||||
Fügen Sie `pkgs.starship` zu `environment.systemPackages` in Ihrer `configuration.nix` hinzu, danach führen Sie aus
|
||||
|
||||
```sh
|
||||
sudo nixos-rebuild switch
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Migration auf v0.45.0
|
||||
|
||||
Starship v0.45.0 is a release containing breaking changes, in preparation for the big v1.0.0. We have made some major changes around how configuration is done on the prompt, to allow for a greater degree of customization.
|
||||
Starship v0.45.0 ist ein Release mit bahnbrechenden Änderungen in Vorbereitung auf das große v1.0.0. Wir haben einige wichtige Änderungen vorgenommen, wie die Konfiguration auf der Eingabeaufforderung durchgeführt wird, um einen höheren Grad an Individualisierung zu ermöglichen.
|
||||
|
||||
This guide is intended to walk you through the breaking changes.
|
||||
|
||||
@@ -10,7 +10,7 @@ Previously to v0.45.0, `prompt_order` would accept an array of module names in t
|
||||
|
||||
Starship v0.45.0 instead accepts a `format` value, allowing for customization of the prompt outside of the modules themselves.
|
||||
|
||||
**Example pre-v0.45.0 configuration**
|
||||
**Beispiel für Pre-v0.45.0 Konfiguration**
|
||||
|
||||
```toml
|
||||
prompt_order = [
|
||||
@@ -31,7 +31,7 @@ prompt_order = [
|
||||
]
|
||||
```
|
||||
|
||||
**Example v0.45.0 configuration**
|
||||
**Beispiel für v0.45.0 Konfiguration**
|
||||
|
||||
```toml
|
||||
format = """\
|
||||
@@ -58,14 +58,14 @@ Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in ord
|
||||
|
||||
Starship v0.45.0 instead accepts a `format` value, allowing for further customization of how modules are rendered. Instead of defining a prefix and suffix for the context-based variables, the variables can now be substituted from within a format string, which represents the module's output.
|
||||
|
||||
**Example pre-v0.45.0 configuration**
|
||||
**Beispiel für Pre-v0.45.0 Konfiguration**
|
||||
|
||||
```toml
|
||||
[cmd_duration]
|
||||
prefix = "took "
|
||||
```
|
||||
|
||||
**Example v0.45.0 configuration**
|
||||
**Beispiel für v0.45.0 Konfiguration**
|
||||
|
||||
```toml
|
||||
[cmd_duration]
|
||||
@@ -74,13 +74,13 @@ prefix = "took "
|
||||
format = "took [$duration]($style) "
|
||||
```
|
||||
|
||||
### Affected Modules
|
||||
### Betroffene Module
|
||||
|
||||
#### Zeichen
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| ----------------------- | ---------------- |
|
||||
| `symbol` | `success_symbol` |
|
||||
| `Symbol` | `success_symbol` |
|
||||
| `use_symbol_for_status` | `error_symbol` |
|
||||
| `style_success` | `success_symbol` |
|
||||
| `style_failure` | `error_symbol` |
|
||||
@@ -113,9 +113,9 @@ _Note:_ The `character` element automatically adds a space after, so unlike the
|
||||
|
||||
#### Befehlsdauer
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| --------------------- | --------- |
|
||||
| `prefix` | `format` |
|
||||
|
||||
**Änderungen an der Standardkonfiguration**
|
||||
|
||||
@@ -127,9 +127,9 @@ _Note:_ The `character` element automatically adds a space after, so unlike the
|
||||
|
||||
#### Verzeichnis
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| --------------------- | --------- |
|
||||
| `prefix` | `format` |
|
||||
|
||||
**Änderungen an der Standardkonfiguration**
|
||||
|
||||
@@ -141,10 +141,10 @@ _Note:_ The `character` element automatically adds a space after, so unlike the
|
||||
|
||||
#### Umgebungsvariablen
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| --------------------- | --------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Änderungen an der Standardkonfiguration**
|
||||
|
||||
@@ -155,12 +155,12 @@ _Note:_ The `character` element automatically adds a space after, so unlike the
|
||||
++ format = "with [$env_value]($style) "
|
||||
```
|
||||
|
||||
#### Git Commit
|
||||
#### Git-Commit
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| --------------------- | --------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Änderungen an der Standardkonfiguration**
|
||||
|
||||
@@ -173,11 +173,11 @@ _Note:_ The `character` element automatically adds a space after, so unlike the
|
||||
|
||||
#### Git-Status
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ----------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| `show_sync_count` | `format` |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| --------------------- | --------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| `show_sync_count` | `format` |
|
||||
|
||||
**Änderungen an der Standardkonfiguration**
|
||||
|
||||
@@ -204,10 +204,10 @@ behind = "⇣${count}"
|
||||
|
||||
#### Hostname
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| --------------------- | --------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Änderungen an der Standardkonfiguration**
|
||||
|
||||
@@ -218,13 +218,13 @@ behind = "⇣${count}"
|
||||
++ format = "[$hostname]($style) in "
|
||||
```
|
||||
|
||||
#### Singularity
|
||||
#### Singularität
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `label` | `format` |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| --------------------- | --------- |
|
||||
| `Label` | `format` |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Änderungen an der Standardkonfiguration**
|
||||
|
||||
@@ -237,9 +237,9 @@ behind = "⇣${count}"
|
||||
|
||||
#### Uhrzeit
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ------------- |
|
||||
| `format` | `time_format` |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| --------------------- | ------------- |
|
||||
| `format` | `time_format` |
|
||||
|
||||
**Änderungen an der Standardkonfiguration**
|
||||
|
||||
@@ -250,12 +250,12 @@ behind = "⇣${count}"
|
||||
++ format = "at 🕙[$time]($style) "
|
||||
```
|
||||
|
||||
#### Custom Commands
|
||||
#### Benutzerdefinierte Befehle
|
||||
|
||||
| Removed Property | Replacement |
|
||||
| ---------------- | ----------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
| Entfernte Eigenschaft | Ersetzung |
|
||||
| --------------------- | --------- |
|
||||
| `prefix` | `format` |
|
||||
| `suffix` | `format` |
|
||||
|
||||
**Änderungen an der Standardkonfiguration**
|
||||
|
||||
|
||||
@@ -1,83 +1,81 @@
|
||||
# Presets
|
||||
# Presets (Voreinstellungen)
|
||||
|
||||
Here is a collection of community-submitted configuration presets for Starship. If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊
|
||||
Hier eine Sammlung von Konfigurations-Presets für Starship, die von der Community eingereicht wurden.
|
||||
Wenn Sie ein Preset zum Teilen haben, bitte [reichen Sie einen PR ein](https://github.com/starship/starship/edit/master/docs/presets/README.md), um diese Datei zu aktualisieren! 😊
|
||||
|
||||
To get details on how to use a preset, simply click on the image.
|
||||
Um weitere Details zur Verwendung eines Presets zu erhalten, klicken Sie einfach auf das Bild.
|
||||
|
||||
## [Nerd Font Symbole](./nerd-font.md)
|
||||
## [Nerd Font-Symbole](./nerd-font.md)
|
||||
|
||||
This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
Dieses Preset ändert die Symbole für jedes Modul, um Nerd Font-Symbole zu verwenden.
|
||||
|
||||
[](./nerd-font)
|
||||
[](./nerd-font)
|
||||
|
||||
## [No Nerd Fonts](./no-nerd-font.md)
|
||||
## [Keine Nerd Fonts](./no-nerd-font.md)
|
||||
|
||||
This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt.
|
||||
Dieses Preset ändert die Symbole für mehrere Module, sodass überall im Prompt No Nerd Font-Symbole verwendet werden.
|
||||
|
||||
::: tip
|
||||
> [!TIPP] Dieses Preset wird in einem zukünftigen Release von Starship zu einem per Default vorgegebenem Preset [werden](https://github.com/starship/starship/pull/3544).
|
||||
|
||||
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)
|
||||
[Klicken Sie hier, um das Preset „No Nerd Font“ anzusehen](./no-nerd-font)
|
||||
|
||||
## [Bracketed Segments](./bracketed-segments.md)
|
||||
|
||||
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
|
||||
Dieses Preset ändert das Format aller integrierten Module, um deren Segment in Klammern zu zeigen, anstatt der Verwendung der Standardformulierung ("via", "on", etc.) von Starship.
|
||||
|
||||
[](./bracketed-segments)
|
||||
[](./bracketed-segments)
|
||||
|
||||
## [Plain Text Symbols](./plain-text.md)
|
||||
## [Plain Text-Symbols](./plain-text.md)
|
||||
|
||||
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
|
||||
Dieses Preset ändert die Symbole für jedes Modul in Plain Text. Großartig, wenn Sie keinen Zugriff auf Unicode haben.
|
||||
|
||||
[](./plain-text)
|
||||
[](./plain-text)
|
||||
|
||||
## [No Runtime Versions](./no-runtimes.md)
|
||||
|
||||
This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you!
|
||||
Dieses Preset blendet die Version der Sprachlaufzeiten aus. Wenn Sie in Containern oder virtualisierten Umgebungen arbeiten, dann ist dies für Sie!
|
||||
|
||||
[](./no-runtimes)
|
||||
[](./no-runtimes)
|
||||
|
||||
## [No Empty Icons](./no-empty-icons.md)
|
||||
## [Keine leeren Icons](./no-empty-icons.md)
|
||||
|
||||
This preset does not show icons if the toolset is not found.
|
||||
Dieses Preset zeigt keine Icons, wenn das Toolset nicht gefunden wird.
|
||||
|
||||
[](./no-empty-icons.md)
|
||||
[](./no-empty-icons.md)
|
||||
|
||||
## [Pure Prompt](./pure-preset.md)
|
||||
|
||||
Diese Voreinstellung emuliert das Aussehen und das Verhalten von [Pure](https://github.com/sindresorhus/pure).
|
||||
Dieses Preset emuliert das Aussehen und Verhalten von [Pure](https://github.com/sindresorhus/pure).
|
||||
|
||||
[](./pure-preset)
|
||||
[](./pure-preset)
|
||||
|
||||
## [Pastel Powerline](./pastel-powerline.md)
|
||||
## [Pastell Powerline](./pastel-powerline.md)
|
||||
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
|
||||
Dieses Preset ist inspiriert von [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
Es zeigt außerdem, wie Pfadsubstitution in Starship funktioniert.
|
||||
|
||||
[](./pastel-powerline)
|
||||
[](./pastel-powerline)
|
||||
|
||||
## [Tokyo Night](./tokyo-night.md)
|
||||
|
||||
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
||||
Dieses Preset ist inspiriert von [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
||||
|
||||
[](./tokyo-night)
|
||||
[](./tokyo-night)
|
||||
|
||||
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
|
||||
|
||||
Diese Voreinstellung ist stark inspiriert von [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||
Dieses Preset ist stark inspiriert von [Pastel Powerline](./pastel-powerline.md) und [Tokyo Night](./tokyo-night.md).
|
||||
|
||||
[](./gruvbox-rainbow)
|
||||
[](./gruvbox-rainbow)
|
||||
|
||||
## [Jetpack](./jetpack.md)
|
||||
|
||||
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.
|
||||
Dies ist ein pseudo-minimalistisches Preset, inspiriert von den Prompts [geometry](https://github.com/geometry-zsh/geometry) und [spaceship](https://github.com/spaceship-prompt/spaceship-prompt).
|
||||
|
||||
[](./jetpack)
|
||||
[](./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.
|
||||
Dieses Preset ist eine minimal modifizierte Version von [Gruvbox Rainbow](./gruvbox-rainbow.md) unter Verwendung der Theme-Palette [Catppuccin](https://github.com/catppuccin/catppuccin).
|
||||
|
||||
[](./catppuccin-powerline)
|
||||
[](./catppuccin-powerline)
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
[Zurück zu den Voreinstellungen](./#bracketed-segments)
|
||||
|
||||
# Bracketed Segments Preset
|
||||
# Preset - Bracketed Segments
|
||||
|
||||
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
|
||||
Dieses Preset ändert das Format aller integrierten Module, um deren Segment in Klammern zu zeigen, anstatt der Verwendung der Standardformulierung ("via", "on", etc.) von Starship.
|
||||
|
||||

|
||||

|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -12,6 +12,6 @@ This preset changes the format of all the built-in modules to show their segment
|
||||
starship preset bracketed-segments -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/bracketed-segments.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/bracketed-segments.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/bracketed-segments.toml
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Zurück zu Presets](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
# Preset - Catppuccin Powerline
|
||||
|
||||
This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainbow.md) using the [Catppuccin](https://github.com/catppuccin/catppuccin) theme palette.
|
||||
Dieses Preset ist eine minimal modifizierte Version von [Gruvbox Rainbow](./gruvbox-rainbow.md) unter Verwendung der Theme-Palette [Catppuccin](https://github.com/catppuccin/catppuccin).
|
||||
|
||||

|
||||

|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
- Ein [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in Ihrem Terminal
|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -16,13 +16,13 @@ This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainb
|
||||
starship preset catppuccin-powerline -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
By default this preset uses the Mocha flavour of Catppucin, but you can specify any of the flavours by modifying the value of `palette`:
|
||||
Standardmäßig verwendet dieses Preset die Note „Mocha“ von Catppucin, aber Sie können jede beliebige Note festlegen, indem Sie den Wert von `palette` modifizieren:
|
||||
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/presets/toml/catppuccin-powerline.toml
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
[Zurück zu den Voreinstellungen](./#gruvbox-rainbow)
|
||||
[Zurück zu Presets](./#gruvbox-rainbow)
|
||||
|
||||
# Gruvbox Regenbogen
|
||||
# Preset - Gruvbox Rainbow
|
||||
|
||||
Diese Voreinstellung ist stark inspiriert von [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||
Dieses Preset ist stark inspiriert von [Pastel Powerline](./pastel-powerline.md) und [Tokyo Night](./tokyo-night.md).
|
||||
|
||||

|
||||

|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- Eine [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in deinem Terminal
|
||||
- Ein [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in Ihrem Terminal
|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -16,6 +16,6 @@ Diese Voreinstellung ist stark inspiriert von [Pastel Powerline](./pastel-powerl
|
||||
starship preset gruvbox-rainbow -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/gruvbox-rainbow.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/gruvbox-rainbow.toml
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
[Zurück zu den Voreinstellungen](./#jetpack)
|
||||
[Zurück zu Presets](./#jetpack)
|
||||
|
||||
# Jetpack Preset
|
||||
# Preset - Jetpack
|
||||
|
||||
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.
|
||||
Dies ist ein pseudo-minimalistisches Preset, inspiriert von den Prompts [geometry](https://github.com/geometry-zsh/geometry) und [spaceship](https://github.com/spaceship-prompt/spaceship-prompt).
|
||||
|
||||
> Jetpack uses the terminal's color theme.
|
||||
> Jetpack verwendet das Farbschema des Terminals.
|
||||
|
||||

|
||||

|
||||
|
||||
### Prerequisite
|
||||
### Voraussetzung
|
||||
|
||||
- Requires a shell with [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt) support.
|
||||
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) is recommended.
|
||||
- Erfordert eine Shell mit Unterstützung für [`right-prompt`](https://starship.rs/advanced-config/#enable-right-prompt).
|
||||
- [Jetbrains Mono](https://www.jetbrains.com/lp/mono/) wird empfohlen.
|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -19,6 +19,6 @@ This is a pseudo minimalist preset inspired by the [geometry](https://github.com
|
||||
starship preset jetpack -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/jetpack.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/jetpack.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/jetpack.toml
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
[Zurück zu den Voreinstellungen](./#nerd-font-symbols)
|
||||
[Zurück zu Presets](./#nerd-font-symbols)
|
||||
|
||||
# Nerd Font Symbols Preset
|
||||
# Preset - Nerd Font Symbols
|
||||
|
||||
This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
Dieses Preset ändert die Symbole für jedes Modul, um Nerd-Font-Symbole zu verwenden.
|
||||
|
||||

|
||||

|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font)
|
||||
- Ein [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in Ihrem Terminal (das Beispiel verwendet Fira Code Nerd Font)
|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -16,6 +16,6 @@ This preset changes the symbols for each module to use Nerd Font symbols.
|
||||
starship preset nerd-font-symbols -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/nerd-font-symbols.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/nerd-font-symbols.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/nerd-font-symbols.toml
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
[Zurück zu den Voreinstellungen](./#no-empty-icons)
|
||||
[Zurück zu Presets](./#no-empty-icons)
|
||||
|
||||
# No Empty Icons Preset
|
||||
# Preset - No Empty Icons
|
||||
|
||||
If toolset files are identified the toolset icon is displayed. If the toolset is not found to determine its version number, it is not displayed. This preset changes the behavior to display the icon only if the toolset information can be determined.
|
||||
Wenn Toolset-Dateien identifiziert werden, wird das Toolset-Icon angezeigt. Wenn das Toolset nicht gefunden wird, um dessen Versionsnummer zu bestimmen, wird dies nicht angezeigt. Dieses Preset ändert das Verhalten zum Anzeigen des Icons nur, wenn die Informationen des Toolsets bestimmt werden können.
|
||||
|
||||

|
||||

|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -12,6 +12,6 @@ If toolset files are identified the toolset icon is displayed. If the toolset is
|
||||
starship preset no-empty-icons -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/no-empty-icons.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/no-empty-icons.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/no-empty-icons.toml
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
[Zurück zu den Voreinstellungen](./#no-nerd-fonts)
|
||||
[Zurück zu Presets](./#no-nerd-fonts)
|
||||
|
||||
# No Nerd Fonts Preset
|
||||
# Preset - No Nerd Fonts
|
||||
|
||||
This preset restricts the use of symbols to those from emoji and powerline sets.
|
||||
Dieses Preset beschränkt die Verwendung von Symbolen auf solche aus den Emoji- und Powerline-Sets.
|
||||
|
||||
This means that even without a Nerd Font installed, you should be able to view all module symbols.
|
||||
Dies bedeutet, dass Sie auch ohne einen installierten Nerd-Font in der Lage sein sollten, alle Modulsymbole anzusehen.
|
||||
|
||||
This preset will become the default preset in a future release of starship.
|
||||
Dieses Preset wird in einem zukünftigen Release von Starship zu einem per Default vorgegebenen Preset.
|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -14,6 +14,6 @@ This preset will become the default preset in a future release of starship.
|
||||
starship preset no-nerd-font -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/no-nerd-font.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/no-nerd-font.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/no-nerd-font.toml
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
[Zurück zu den Voreinstellungen](./#no-runtime-versions)
|
||||
[Zurück zu Presets](./#no-runtime-versions)
|
||||
|
||||
# No Runtime Versions Preset
|
||||
# Preset - No Runtime Versions
|
||||
|
||||
This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you!
|
||||
Dieses Preset blendet die Version der Sprachlaufzeiten aus. Wenn Sie in Containern oder virtualisierten Umgebungen arbeiten, dann ist dies für Sie!
|
||||
|
||||

|
||||

|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -12,6 +12,6 @@ This preset hides the version of language runtimes. If you work in containers or
|
||||
starship preset no-runtime-versions -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/no-runtime-versions.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/no-runtime-versions.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/no-runtime-versions.toml
|
||||
|
||||
@@ -1,14 +1,15 @@
|
||||
[Zurück zu den Voreinstellungen](./#pastel-powerline)
|
||||
[Zurück zu Presets](./#pastel-powerline)
|
||||
|
||||
# Pastel Powerline Preset
|
||||
# Preset - Pastel Powerline
|
||||
|
||||
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
|
||||
Dieses Preset ist inspiriert von [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
Es zeigt außerdem, wie Pfadsubstitution in Starship funktioniert.
|
||||
|
||||

|
||||

|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font)
|
||||
- Ein [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in Ihrem Terminal (das Beispiel verwendet die Caskaydia Cove Nerd Font)
|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -16,6 +17,6 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
|
||||
starship preset pastel-powerline -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/pastel-powerline.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/pastel-powerline.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/pastel-powerline.toml
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
[Zurück zu den Voreinstellungen](./#plain-text-symbols)
|
||||
[Zurück zu Presets](./#plain-text-symbols)
|
||||
|
||||
## Plain Text Symbols Preset
|
||||
## Preset - Plain Text Symbols
|
||||
|
||||
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
|
||||
Dieses Preset ändert die Symbole für jedes Modul in Plain Text. Großartig, wenn Sie keinen Zugriff auf Unicode haben.
|
||||
|
||||

|
||||

|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -12,6 +12,6 @@ This preset changes the symbols for each module into plain text. Great if you do
|
||||
starship preset plain-text-symbols -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/plain-text-symbols.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/plain-text-symbols.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/plain-text-symbols.toml
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
[Zurück zu den Voreinstellungen](./#pure)
|
||||
[Zurück zu Presets](./#pure-prompt)
|
||||
|
||||
# Pure Voreinstellung
|
||||
# Preset - Pure
|
||||
|
||||
Diese Voreinstellung emuliert das Aussehen und das Verhalten von [Pure](https://github.com/sindresorhus/pure).
|
||||
Dieses Preset emuliert das Aussehen und Verhalten von [Pure](https://github.com/sindresorhus/pure).
|
||||
|
||||

|
||||

|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -12,6 +12,6 @@ Diese Voreinstellung emuliert das Aussehen und das Verhalten von [Pure](https://
|
||||
starship preset pure-preset -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/pure-preset.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/pure-preset.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/pure-preset.toml
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
[Zurück zu den Voreinstellungen](./#pastel-powerline)
|
||||
[Zurück zu Presets](./#tokyo-night)
|
||||
|
||||
# Tokyo Night Preset
|
||||
# Preset - Tokyo Night
|
||||
|
||||
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
||||
Dieses Preset ist inspiriert von [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
||||
|
||||

|
||||

|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- Eine [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in deinem Terminal
|
||||
- Ein [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in Ihrem Terminal
|
||||
|
||||
### Konfiguration
|
||||
|
||||
@@ -16,6 +16,6 @@ This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/t
|
||||
starship preset tokyo-night -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/tokyo-night.toml){download}
|
||||
[Klicken, um TOML herunterzuladen](/presets/toml/tokyo-night.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/tokyo-night.toml
|
||||
|
||||
+18
-37
@@ -2,27 +2,24 @@
|
||||
layout: home
|
||||
hero:
|
||||
image: /logo.svg
|
||||
text:
|
||||
tagline: '¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!'
|
||||
text: null
|
||||
tagline: ¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!
|
||||
actions:
|
||||
-
|
||||
theme: brand
|
||||
- theme: brand
|
||||
text: Comenzar →
|
||||
link: ./guide/
|
||||
features:
|
||||
-
|
||||
title: Compatibilidad primero
|
||||
- title: Compatibilidad primero
|
||||
details: Funciona en los intérprete de comandos más comunes de los sistemas operativos más comunes. ¡Úsalo en todas partes!
|
||||
-
|
||||
title: Desarrollado en Rust
|
||||
- title: Desarrollado en Rust
|
||||
details: Obtén la mayor velocidad y seguridad de Rust, para hacer tu prompt lo más rápida y segura posible.
|
||||
-
|
||||
title: Personalizable
|
||||
- title: Personalizable
|
||||
details: Puedes personalizar cada pequeño detalle a tu gusto, de manera que puedes tener un prompt minimalista o rico en funcionalidades.
|
||||
footer: Bajo una licencia ISC | Derechos de autor © 2019-presente Colaboradores de Starship
|
||||
#Used for the description meta tag, for SEO
|
||||
|
||||
# Used for the description meta tag, for SEO
|
||||
metaTitle: "Starship: el prompt multi-intérprete"
|
||||
description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos! Muestra la información que necesitas, a la par que es elegante y minimalista. Instalación rápida disponible para Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, y PowerShell.'
|
||||
description: ¡Starship es el prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos! Muestra la información que necesitas, a la par que es elegante y minimalista. Instalación rápida disponible para Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, y PowerShell.
|
||||
---
|
||||
|
||||
<script setup>
|
||||
@@ -52,7 +49,6 @@ onMounted(() => {
|
||||
|
||||
1. Instala el binario de **Starship**:
|
||||
|
||||
|
||||
#### Instalar la última versión
|
||||
|
||||
Con el intérprete de comandos:
|
||||
@@ -63,7 +59,6 @@ onMounted(() => {
|
||||
|
||||
Para actualizar Starship, vuelve a ejecutar el guión anterior. Reemplazará la versión actual sin tocar la configuración de Starship.
|
||||
|
||||
|
||||
#### Instalar vía un gestor de paquetes
|
||||
|
||||
Con [Homebew](https://brew.sh/):
|
||||
@@ -78,8 +73,7 @@ onMounted(() => {
|
||||
winget install starship
|
||||
```
|
||||
|
||||
1. Añade el guión de inicio al archivo de configuración de tu intérprete de comandos:
|
||||
|
||||
2. Añade el guión de inicio al archivo de configuración de tu intérprete de comandos:
|
||||
|
||||
#### Bash
|
||||
|
||||
@@ -91,7 +85,6 @@ onMounted(() => {
|
||||
eval "$(starship init bash)"
|
||||
```
|
||||
|
||||
|
||||
#### Fish
|
||||
|
||||
Añade el siguiente código al final de `~/.config/fish/config.fish`:
|
||||
@@ -102,7 +95,6 @@ onMounted(() => {
|
||||
starship init fish | source
|
||||
```
|
||||
|
||||
|
||||
#### Zsh
|
||||
|
||||
Añade el siguiente código al final de `~/.zshrc`:
|
||||
@@ -113,8 +105,7 @@ onMounted(() => {
|
||||
eval "$(starship init zsh)"
|
||||
```
|
||||
|
||||
|
||||
#### Powershell
|
||||
#### PowerShell
|
||||
|
||||
Añade lo siguiente al final de `Microsoft.PowerShell_profile.ps1`. Puedes comprobar la ubicación de este archivo consultando la variable `$PROFILE` en PowerShell. Normalmente la ruta es `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` o `~/.config/powershell/Microsoft.PowerShell_profile.ps1` en -Nix.
|
||||
|
||||
@@ -122,7 +113,6 @@ onMounted(() => {
|
||||
Invoke-Expression (&starship init powershell)
|
||||
```
|
||||
|
||||
|
||||
#### Ion
|
||||
|
||||
Añade el siguiente código al final de `~/.config/ion/initrc`:
|
||||
@@ -133,16 +123,11 @@ onMounted(() => {
|
||||
eval $(starship init ion)
|
||||
```
|
||||
|
||||
|
||||
#### 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
|
||||
@@ -150,6 +135,7 @@ onMounted(() => {
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
#### Tcsh
|
||||
|
||||
@@ -161,22 +147,18 @@ onMounted(() => {
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This will change in the future.
|
||||
> Sólo se admite Nushell v0.96+.
|
||||
|
||||
Esto cambiará en el futuro. Sólo se admite Nushell v0.96+.
|
||||
|
||||
:::
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
Agregue lo siguiente al final de su configuración de Nushell (encuéntrelo ejecutando `$nu.config-path` en Nushell):
|
||||
|
||||
```sh
|
||||
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
#### Xonsh
|
||||
|
||||
@@ -188,7 +170,6 @@ onMounted(() => {
|
||||
execx($(starship init xonsh))
|
||||
```
|
||||
|
||||
|
||||
#### Cmd
|
||||
|
||||
Necesitas usar [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) con Cmd. Añade lo siguiente a un archivo `starship.lua` y coloca este archivo en el directorio de scripts de Clink:
|
||||
|
||||
@@ -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,23 @@ 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)'
|
||||
@@ -126,7 +124,9 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
## Comandos pre-prompt y pre-ejecucución personalizados en Bash
|
||||
|
||||
Bash no posee un framework oficial de preexec/precmd como la mayoría de los demás intérpretes de comandos. Debido a esto, es difícil proporcionar "hooks" totalmente personalizables en `Bash`. Sin embargo, Starship te da la posibilidad de insertar de forma limitada tus propias funciones en el proceso de renderizado del prompt:
|
||||
Bash no posee un framework oficial de preexec/precmd como la mayoría de los demás intérpretes de comandos.
|
||||
Debido a esto, es difícil proporcionar "hooks" totalmente personalizables en `Bash`.
|
||||
Sin embargo, Starship te da la posibilidad de insertar de forma limitada tus propias funciones en el proceso de renderizado del prompt:
|
||||
|
||||
- Para ejecutar una función personalizada previa al renderizado del prompt, define una nueva función y asigna su nombre a `starship_precmd_user_func`. Por ejemplo, para dibujar un cohete antes del prompt, se puede realizar así:
|
||||
|
||||
@@ -137,7 +137,9 @@ function blastoff(){
|
||||
starship_precmd_user_func="blastoff"
|
||||
```
|
||||
|
||||
- Para ejecutar una función personalizada antes de que un comando sea ejecutado, es posible usar el [mecanismo de trampa `DEBUG`](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). No obstante, ¡**debes** atrapar la señal DEBUG _antes_ de inicializar Starship! Starship puede preservar el valor de la trampa DEBUG, pero si la trampa es reemplazada después de que Starship inicie, alguna funcionalidad fallará.
|
||||
- Para ejecutar una función personalizada antes de que un comando sea ejecutado, es posible usar el [mecanismo de trampa `DEBUG`](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/).
|
||||
No obstante, ¡**debes** atrapar la señal DEBUG _antes_ de inicializar Starship!
|
||||
Starship puede preservar el valor de la trampa DEBUG, pero si la trampa es reemplazada después de que Starship inicie, alguna funcionalidad fallará.
|
||||
|
||||
```bash
|
||||
function blastoff(){
|
||||
@@ -151,7 +153,9 @@ set +o functrace
|
||||
|
||||
## Comandos pre-prompt y pre-ejecución personalizados en PowerShell
|
||||
|
||||
Powershell no posee un framework oficial de preexec/precmd como la mayoría de los demás intérpretes de comandos. Debido a esto, es difícil proporcionar "hooks" totalmente personalizables en `Powershell`. Sin embargo, Starship te da la posibilidad de insertar de forma limitada tus propias funciones en el proceso de renderizado del prompt:
|
||||
Powershell no posee un framework oficial de preexec/precmd como la mayoría de los demás intérpretes de comandos.
|
||||
Debido a esto, es difícil proporcionar "hooks" totalmente personalizables en `Powershell`.
|
||||
Sin embargo, Starship te da la posibilidad de insertar de forma limitada tus propias funciones en el proceso de renderizado del prompt:
|
||||
|
||||
Crea una función llamada `Invoke-Starship-PreCommand`
|
||||
|
||||
@@ -163,7 +167,8 @@ function Invoke-Starship-PreCommand {
|
||||
|
||||
## Cambiar título de la ventana
|
||||
|
||||
Algunos intérpretes de comandos van a cambiar automáticamente el título de la ventana por ti (p. ej., para mostrar tu directorio actual). Fish incluso lo hace por defecto. Starship no hace esto, pero es bastante sencillo añadir esta funcionalidad a `bash`, `zsh`, `cmd` o `powershell`.
|
||||
Algunos intérpretes de comandos van a cambiar automáticamente el título de la ventana por ti (p. ej., para mostrar tu directorio actual). Fish incluso lo hace por defecto.
|
||||
Starship no hace esto, pero es bastante sencillo añadir esta funcionalidad a `bash`, `zsh`, `cmd` o `powershell`.
|
||||
|
||||
Primero, define una función para el cambio de título de la ventana (idéntico en Bash y zsh):
|
||||
|
||||
@@ -225,9 +230,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
|
||||
|
||||
@@ -247,6 +252,12 @@ Produce un prompt como el siguiente:
|
||||
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
|
||||
```
|
||||
|
||||
When using `zsh` (v5.0.5+), the shell adds a default trailing space to the right prompt. This can cause alignment issues specifically when using the Starship `$fill` module. To remove this gap, add the following to your `.zshrc`:
|
||||
|
||||
```zsh
|
||||
ZLE_RPROMPT_INDENT=0
|
||||
```
|
||||
|
||||
## Prompt de continuación
|
||||
|
||||
Algunos intérpretes de comandos admiten un prompt de continuacion junto con el prompt normal. Este prompt es renderizado en lugar del prompt normal cuando el usuario ha introducido una orden incompleta (como solamente un paréntesis izquierdo o comilla).
|
||||
@@ -266,16 +277,326 @@ 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 = '▶▶ '
|
||||
```
|
||||
|
||||
## 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"
|
||||
```
|
||||
|
||||
### Configuración
|
||||
|
||||
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.
|
||||
|
||||
#### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| --------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'[$symbol$model]($style) '` | El formato del módulo. |
|
||||
| `simbol` | `'🤖 '` | The symbol shown before the model name. |
|
||||
| `style` | `'bold blue'` | El estilo del módulo. |
|
||||
| `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 | Ejemplo | Descripción |
|
||||
| ----------------------------- | ------------------- | -------------------------------------- |
|
||||
| model | `Claude 3.5 Sonnet` | The display name of the current model |
|
||||
| model_id | `claude-3-5-sonnet` | The model ID |
|
||||
| symbol | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | | Refleja el valor de la opción `style` |
|
||||
|
||||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||||
|
||||
#### Ejemplos
|
||||
|
||||
```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.
|
||||
|
||||
#### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ---------------------- | --------------------------------- | ------------------------------------------------------------------ |
|
||||
| `format` | `'[$gauge $percentage]($style) '` | El formato del módulo. |
|
||||
| `simbol` | `''` | 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`.
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ----------- | -------------- | ------------------------------------------------------------------------ |
|
||||
| `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 | Ejemplo | Descripción |
|
||||
| ----------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------- |
|
||||
| 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 | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||||
|
||||
#### Ejemplos
|
||||
|
||||
**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.
|
||||
|
||||
#### Opciones
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ---------- | ---------------------------------- | --------------------------------------------------- |
|
||||
| `format` | `'[$symbol(\\$$cost)]($style) '` | El formato del módulo. |
|
||||
| `simbol` | `'💰 '` | 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`.
|
||||
|
||||
| Opción | Predeterminado | Descripción |
|
||||
| ----------- | -------------- | ------------------------------------------------------------------ |
|
||||
| `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 | Ejemplo | Descripción |
|
||||
| ---------------------------------- | -------- | ---------------------------------------------------------------------- |
|
||||
| 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 | | Refleja el valor de la opción `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
|
||||
|
||||
#### Ejemplos
|
||||
|
||||
```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) "
|
||||
```
|
||||
|
||||
## Cadenas de Estilo
|
||||
|
||||
Las cadenas de estilo son una lista de palabras, separadas por espacios en blanco. Las palabras no son sensibles a mayúsculas (es decir, `bold` y `BoLd` se consideran la misma cadena). Cada palabra puede ser una de las siguientes:
|
||||
|
||||
- `negrita`
|
||||
- `cursiva`
|
||||
- `bold`
|
||||
- `italic`
|
||||
- `subrayado`
|
||||
- `atenuado`
|
||||
- `invertido`
|
||||
@@ -287,7 +608,9 @@ 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.
|
||||
|
||||
|
||||
+2410
-1963
File diff suppressed because it is too large
Load Diff
@@ -103,14 +103,15 @@ echo -e "\xee\x82\xa0"
|
||||
|
||||
La primera línea debe producir un [emoji snake](https://emojipedia.org/snake/), mientras que la segunda debe producir un [símbolo de rama de Powerline(e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
|
||||
|
||||
Si cualquiera de los dos símbolos no se puede mostrar correctamente, su sistema todavía está mal configurado. Desafortunadamente, obtener la configuración correcta de las fuentes es a veces difícil. Los usuarios en el Discord pueden ayudar. Si ambos símbolos se muestran correctamente, pero todavía no los ves en Starship, [¡envía un informe de error!](https://github.com/starship/starship/issues/new/choose)
|
||||
Si cualquiera de los dos símbolos no se puede mostrar correctamente, su sistema todavía está mal configurado.
|
||||
Desafortunadamente, obtener la configuración correcta de las fuentes es a veces difícil. Los usuarios en el Discord pueden ayudar. Si ambos símbolos se muestran correctamente, pero todavía no los ves en Starship, [¡envía un informe de error!](https://github.com/starship/starship/issues/new/choose)
|
||||
|
||||
## ¿Cómo puedo desinstalar Starship?
|
||||
|
||||
Starship es tan fácil de desinstalar como de instalar en primer lugar.
|
||||
|
||||
1. Elimina cualquier línea de tu configuración de intérprete de comandos (por ejemplo, `~/.bashrc`) usada para inicializar Starship.
|
||||
1. Elimina el binario de Starship.
|
||||
2. Elimina el binario de Starship.
|
||||
|
||||
Si Starship fue instalado usando un gestor de paquetes, por favor refiérete a sus documentos para instrucciones de desinstalación.
|
||||
|
||||
|
||||
+120
-101
@@ -1,13 +1,12 @@
|
||||
<p align="center">
|
||||
<img
|
||||
width="400"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||||
alt="Starship - Prompt multi-intérprete de comandos"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/logo.png"
|
||||
alt="Starship – Cross-shell prompt"
|
||||
/>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/actions"
|
||||
<p align="center"><a href="https://github.com/starship/starship/actions"
|
||||
><img
|
||||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||||
alt="Estado del flujo de trabajo de GitHub Actions"
|
||||
@@ -35,20 +34,18 @@
|
||||
<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>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs">Sitio web</a>
|
||||
|
||||
<a href="#🚀-installation">Instalación</a>
|
||||
|
||||
<a href="https://starship.rs/config/">Configuración</a>
|
||||
<p align="center"><a href="https://starship.rs">Website</a>
|
||||
·
|
||||
<a href="#🚀-installation">Installation</a>
|
||||
·
|
||||
<a href="https://starship.rs/config/">Configuration</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
<p align="center"><a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||||
@@ -124,7 +121,7 @@
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ua.png"
|
||||
alt="Українська"
|
||||
alt=""
|
||||
/></a>
|
||||
|
||||
<a
|
||||
@@ -154,12 +151,23 @@
|
||||
|
||||
<h1></h1>
|
||||
|
||||
> [!WARNING]
|
||||
> **The default branch has been renamed from `master` to `main`.**
|
||||
> If you have a local clone, update it by running:
|
||||
>
|
||||
> ```sh
|
||||
> git branch -m master main
|
||||
> git fetch origin
|
||||
> git branch -u origin/main main
|
||||
> git remote set-head origin -a
|
||||
> ```
|
||||
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship con iTerm 2 y el tema Snazzy"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship con iTerm 2 y el tema Snazzy"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
|
||||
**¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!**
|
||||
|
||||
@@ -170,8 +178,7 @@
|
||||
- **Repleto de funciones**: con soporte para tus herramientas favoritas.
|
||||
- **Fácil:** rápido de instalar – empieza a usarlo en minutos.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs/config/"><strong>Explora la documentación de Starship ▶</strong></a>
|
||||
<p align="center"><a href="https://starship.rs/config/"><strong>Explora la documentación de Starship ▶</strong></a>
|
||||
</p>
|
||||
|
||||
<a name="🚀-installation"></a>
|
||||
@@ -186,32 +193,29 @@
|
||||
|
||||
Seleccione su sistema operativo de la lista de abajo para ver las instrucciones de instalación:
|
||||
|
||||
<details>
|
||||
<summary>Android</summary>
|
||||
<details><summary>Android</summary>
|
||||
|
||||
Instalar Starship usando cualquiera de los siguientes gestores de paquetes:
|
||||
|
||||
| Repositorio | Instrucciones |
|
||||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||||
| Repositorio | Instrucciones |
|
||||
| ----------- | ---------------------- |
|
||||
| [Termux] | `pkg install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>BSD</summary>
|
||||
<details><summary>BSD</summary>
|
||||
|
||||
Instalar 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` |
|
||||
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
|
||||
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
|
||||
| Distribución | Repositorio | Instrucciones |
|
||||
| ---------------- | -------------------------------------------------- | --------------------------------- |
|
||||
| **_Cualquiera_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| FreeBSD | [FreshPorts] | `pkg install starship` |
|
||||
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Linux</summary>
|
||||
<details><summary>Linux</summary>
|
||||
|
||||
Instale la última versión para su sistema:
|
||||
|
||||
@@ -221,26 +225,26 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
Alternativamente, instale Starship usando cualquiera de los siguientes gestores de paquetes:
|
||||
|
||||
| Distribución | Repositorio | Instrucciones |
|
||||
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| **_Cualquiera_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| _Cualquiera_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| _Cualquiera_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| Gentoo | [Paquetes Gentoo](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||
| Manjaro | | `pacman -S starship` |
|
||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | [Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship) | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||
| Distribución | Repositorio | Instrucciones |
|
||||
| ---------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| **_Cualquiera_** | : | `cargo install starship --locked` |
|
||||
| _Cualquiera_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| _Cualquiera_ | [Linuxbrew] | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv` | `apk add starship` |
|
||||
| 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` |
|
||||
| openSUSE | [OSS] | `zypper in starship` |
|
||||
| Ubuntu 25.04 o más nuevo | [Ubuntu Universe] | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages] | `xbps-install -S starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>macOS</summary>
|
||||
<details><summary>macOS</summary>
|
||||
|
||||
Instale la última versión para su sistema:
|
||||
|
||||
@@ -254,34 +258,32 @@ Alternativamente, instale Starship usando cualquiera de los siguientes gestores
|
||||
| -------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [Homebrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| [MacPorts](https://ports.macports.org/port/starship) | `port install starship` |
|
||||
| [Homebrew] | `brew install starship` |
|
||||
| [MacPorts] | `port install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Windows</summary>
|
||||
<details><summary>Windows</summary>
|
||||
|
||||
Instale la última versión para su sistema con los MSI-Installers de la sección [lanzamientos](https://github.com/starship/starship/releases/latest).
|
||||
|
||||
Instalar Starship usando cualquiera de los siguientes gestores de paquetes:
|
||||
|
||||
| Repositorio | Instrucciones |
|
||||
| -------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [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` |
|
||||
| Repositorio | Instrucciones |
|
||||
| ------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| [Chocolatey] | `choco install starship` |
|
||||
| [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `conda install -c conda-forge starship` |
|
||||
| [Scoop] | `scoop install starship` |
|
||||
| [winget] | `winget install --id Starship.Starship` |
|
||||
|
||||
</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:
|
||||
|
||||
<details>
|
||||
<summary>Bash</summary>
|
||||
<details><summary>Bash</summary>
|
||||
|
||||
Añade la siguiente línea al final de `~/.bashrc`:
|
||||
|
||||
@@ -291,10 +293,10 @@ eval "$(starship init bash)"
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Cmd</summary>
|
||||
<details><summary>Cmd</summary>
|
||||
|
||||
Necesitas usar [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) con Cmd. Crea un archivo en esta ruta `%LocalAppData%\clink\starship.lua` con el siguiente contenido:
|
||||
Necesitas usar [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) con Cmd.
|
||||
Crea un archivo en esta ruta `%LocalAppData%\clink\starship.lua` con el siguiente contenido:
|
||||
|
||||
```lua
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
@@ -302,21 +304,19 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
<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+
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Fish</summary>
|
||||
<details><summary>Fish</summary>
|
||||
|
||||
Añade el siguiente código al final de `~/.config/fish/config.fish`:
|
||||
|
||||
@@ -326,8 +326,7 @@ starship init fish | source
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Ion</summary>
|
||||
<details><summary>Ion</summary>
|
||||
|
||||
Añade el siguiente código al final de `~/.config/ion/initrc`:
|
||||
|
||||
@@ -337,22 +336,21 @@ eval $(starship init ion)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Nushell</summary>
|
||||
<details><summary>Nushell</summary>
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
Agregue lo siguiente al final de su configuración de Nushell (encuéntrelo ejecutando `$nu.config-path` en Nushell):
|
||||
|
||||
```sh
|
||||
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
|
||||
```
|
||||
|
||||
Nota: Sólo se admite Nushell v0.96+
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>PowerShell</summary>
|
||||
<details><summary>PowerShell</summary>
|
||||
|
||||
Añade lo siguiente al final de tu configuración de PowerShell (encuéntrala ejecutando `$PROFILE`):
|
||||
|
||||
@@ -362,8 +360,7 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Tcsh</summary>
|
||||
<details><summary>Tcsh</summary>
|
||||
|
||||
Añade el siguiente código al final de `~/.tcshrc`:
|
||||
|
||||
@@ -373,8 +370,7 @@ eval `starship init tcsh`
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Xonsh</summary>
|
||||
<details><summary>Xonsh</summary>
|
||||
|
||||
Añade lo siguiente al final de `~/.xonshrc`:
|
||||
|
||||
@@ -384,8 +380,7 @@ execx($(starship init xonsh))
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Zsh</summary>
|
||||
<details><summary>Zsh</summary>
|
||||
|
||||
Añade el siguiente código al final de `~/.zshrc`:
|
||||
|
||||
@@ -397,7 +392,8 @@ eval "$(starship init zsh)"
|
||||
|
||||
### Paso 3. Configurar Starship
|
||||
|
||||
Inicia una nueva instancia de shell, y deberías ver tu nuevo y hermoso prompt para shell. Si está contento con los valores por defecto, ¡disfrútelos!
|
||||
Inicia una nueva instancia de shell, y deberías ver tu nuevo y hermoso prompt para shell.
|
||||
Si está contento con los valores por defecto, ¡disfrútelos!
|
||||
|
||||
Si estás buscando personalizar Starship:
|
||||
|
||||
@@ -407,7 +403,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**! 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).
|
||||
|
||||
Si habla con fluidez en un idioma que no es inglés, agradecemos mucho cualquier ayuda para mantener nuestros documentos traducidos y actualizados en otros idiomas. Si quieres ayudar, puedes contribuir con las traducciones en el [Crowdin de Starship](https://translate.starship.rs/).
|
||||
|
||||
@@ -427,22 +423,45 @@ 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>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon">
|
||||
<p align="center"><br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/main/media/icon.png" alt="Starship rocket icon">
|
||||
</p>
|
||||
|
||||
## 📝 Licencia
|
||||
|
||||
Derechos de autor © 2019-presente, [Colaboradores de Starship](https://github.com/starship/starship/graphs/contributors).<br /> Este proyecto está bajo una licencia [ISC](https://github.com/starship/starship/blob/master/LICENSE).
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
|
||||
Este proyecto está bajo una licencia [ISC](https://github.com/starship/starship/blob/master/LICENSE).
|
||||
|
||||
[alpine linux packages]: <[Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship)>
|
||||
[arch linux extra]: <[Extra de Archi Linux](https://archlinux.org/packages/extra/x86_64/starship)>
|
||||
[chocolatey]: [Chocolatey]\(https://community.chocolatey.org/packages/starship\)
|
||||
[conda-forge]: [conda-forge]\(https://anaconda.org/conda-forge/starship\)
|
||||
[copr]: [Copr]\(https://copr.fedorainfracloud.org/coprs/atim/starship\)
|
||||
[crates.io]: **[crates.io]\(https://crates.io/crates/starship\)**
|
||||
[debian main]: <[Debian Main](https://sources.debian.org/src/starship/1.22.1-1/)>
|
||||
[freshports]: [FreshPorts]\(https://www.freshports.org/shells/starship\)
|
||||
[gentoo packages]: <[Paquetes Gentoo](https://packages.gentoo.org/packages/app-shells/starship)>
|
||||
[linuxbrew]: [Linuxbrew]\(https://formulae.brew.sh/formula/starship\)
|
||||
[homebrew]: [Homebrew]\(https://formulae.brew.sh/formula/starship\)
|
||||
[macports]: [MacPorts]\(https://ports.macports.org/port/starship\)
|
||||
[nixpkgs]: [nixpkgs]\(https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix\)
|
||||
[OSS]: [OSS]\(https://software.opensuse.org/package/starship\)
|
||||
[pkgsrc]: https://pkgsrc.se/shells/starship
|
||||
[scoop]: [Scoop]\(https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json\)
|
||||
[SignPath Foundation]: https://signpath.org
|
||||
[SignPath.io]: https://signpath.io
|
||||
[termux]: [Termux]\(https://github.com/termux/termux-packages/tree/master/packages/starship\)
|
||||
[ubuntu universe]: <[Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship)>
|
||||
[void linux packages]: <[Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship)>
|
||||
[winget]: [winget]\(https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship\)
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
Para instalar Starship, necesitas hacer dos cosas:
|
||||
|
||||
1. Consigue el binario de **Starship** en tu ordenador
|
||||
1. Decirle a tu intérprete de comandos que use el binario de Starship como su prompt modificando sus guiones de inicio
|
||||
2. Decirle a tu intérprete de comandos que use el binario de Starship como su prompt modificando sus guiones de inicio
|
||||
|
||||
Para la mayoría de los usuarios, las instrucciones en [la página principal](../guide/#🚀-installation) funcionarán genial. Sin embargo, para algunas plataformas más especializadas, se necesitan diferentes instrucciones.
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -80,7 +80,7 @@ format = "tomó [$duration]($style) "
|
||||
|
||||
| Propiedad eliminada | Reemplazo |
|
||||
| ----------------------- | ---------------- |
|
||||
| `symbol` | `success_symbol` |
|
||||
| `simbol` | `success_symbol` |
|
||||
| `use_symbol_for_status` | `error_symbol` |
|
||||
| `style_success` | `success_symbol` |
|
||||
| `style_failure` | `error_symbol` |
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# Preajustes
|
||||
|
||||
Aqui tienes una colección de preajustes creados por la comunidad de Starship. ¡Si quieres compartir un preajuste, por favor, [envía un PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) actualizando este archivo! 😊
|
||||
Aqui tienes una colección de preajustes creados por la comunidad de Starship.
|
||||
¡Si quieres compartir un preajuste, por favor, [envía un PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) actualizando este archivo! 😊
|
||||
|
||||
Para obtener detalles sobre cómo utilizar un preajuste, simplemente haga clic en la imagen.
|
||||
|
||||
@@ -14,11 +15,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)
|
||||
|
||||
@@ -54,7 +51,8 @@ Esta preajuste emula la apariencia y el comportamiento de [Pure](https://github.
|
||||
|
||||
## [Pastel Powerline](./pastel-powerline.md)
|
||||
|
||||
Este preajuste está inspirado en [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). También muestra cómo funciona la sustitución de rutas en Starship.
|
||||
Este preajuste está inspirado en [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
También muestra cómo funciona la sustitución de rutas en Starship.
|
||||
|
||||
[](./pastel-powerline)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Volver a Preajustes](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -8,7 +8,7 @@ This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainb
|
||||
|
||||
### Prerequisitos
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
- Una [Nerd Font](https://www.nerdfonts.com/) instalada y habilitada en tu terminal
|
||||
|
||||
### Configuración
|
||||
|
||||
@@ -21,7 +21,7 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
# Preajuste Pastel Powerline
|
||||
|
||||
Este preajuste está inspirado en [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). También muestra cómo funciona la sustitución de rutas en Starship.
|
||||
Este preajuste está inspirado en [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
También muestra cómo funciona la sustitución de rutas en Starship.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
+18
-38
@@ -2,25 +2,22 @@
|
||||
layout: home
|
||||
hero:
|
||||
image: /logo.svg
|
||||
text:
|
||||
text: null
|
||||
tagline: L'invite minimaliste, ultra-rapide et personnalisable à l'infini pour n'importe quel shell !
|
||||
actions:
|
||||
-
|
||||
theme: brand
|
||||
- theme: brand
|
||||
text: Commencez →
|
||||
link: ./guide/
|
||||
features:
|
||||
-
|
||||
title: Compatibilité avant tout
|
||||
- title: Compatibilité avant tout
|
||||
details: Fonctionne sur tous les principaux shells et système d'exploitation. Utilisez-le partout !
|
||||
-
|
||||
title: Propulsé par Rust
|
||||
- title: Propulsé par Rust
|
||||
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.
|
||||
- title: Personnalisable
|
||||
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
|
||||
|
||||
# Used for the description meta tag, for SEO
|
||||
metaTitle: "Starship : Invite Multi-Shell"
|
||||
description: Starship est une invite minimaliste, ultra-rapide et hautement personnalisable pour n'importe quel shell ! Montre les informations dont vous avez besoin tout en restant élégante et minimaliste. Installation rapide disponible pour Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, et PowerShell.
|
||||
---
|
||||
@@ -46,13 +43,12 @@ 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
|
||||
|
||||
1. Installer le binaire **starship** :
|
||||
|
||||
|
||||
#### Installer la dernière version
|
||||
|
||||
Avec Shell:
|
||||
@@ -63,7 +59,6 @@ onMounted(() => {
|
||||
|
||||
Pour mettre à jour Starship, relancez le script ci-dessus. Cela remplacera la version actuelle sans toucher à la configuration de Starship.
|
||||
|
||||
|
||||
#### Installer via le gestionnaire de paquets
|
||||
|
||||
Avec [Homebrew](https://brew.sh/):
|
||||
@@ -72,14 +67,13 @@ onMounted(() => {
|
||||
brew install starship
|
||||
```
|
||||
|
||||
With [Winget](https://github.com/microsoft/winget-cli):
|
||||
Avec [Winget](https://github.com/microsoft/winget-cli):
|
||||
|
||||
```powershell
|
||||
winget install starship
|
||||
```
|
||||
|
||||
1. Ajouter le script d’initialisation au fichier configuration de votre shell:
|
||||
|
||||
2. Ajouter le script d’initialisation au fichier configuration de votre shell:
|
||||
|
||||
#### Bash
|
||||
|
||||
@@ -91,7 +85,6 @@ onMounted(() => {
|
||||
eval "$(starship init bash)"
|
||||
```
|
||||
|
||||
|
||||
#### Fish
|
||||
|
||||
Ajoute ce qui suit à la fin de `~/.config/fish/config.fish`:
|
||||
@@ -102,7 +95,6 @@ onMounted(() => {
|
||||
starship init fish | source
|
||||
```
|
||||
|
||||
|
||||
#### Zsh
|
||||
|
||||
Ajouter ce qui suit à la fin de `~/.zshrc`:
|
||||
@@ -113,8 +105,7 @@ onMounted(() => {
|
||||
eval "$(starship init zsh)"
|
||||
```
|
||||
|
||||
|
||||
#### Powershell
|
||||
#### PowerShell
|
||||
|
||||
Ajouter ce qui suit à la fin de `Microsoft.PowerShell_profile.ps1`. Vous pouvez vérifier l'emplacement de ce fichier en regardant la variable `$PROFILE` dans PowerShell. Habituellement, son chemin est `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` ou `~/.config/powershell/Microsoft.PowerShell_profile.ps1` sur -Nix.
|
||||
|
||||
@@ -122,7 +113,6 @@ onMounted(() => {
|
||||
Invoke-Expression (&starship init powershell)
|
||||
```
|
||||
|
||||
|
||||
#### Ion
|
||||
|
||||
Ajouter ce qui suit à la fin de `~/.config/ion/initrc`:
|
||||
@@ -133,16 +123,11 @@ onMounted(() => {
|
||||
eval $(starship init ion)
|
||||
```
|
||||
|
||||
|
||||
#### 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
|
||||
@@ -150,6 +135,7 @@ onMounted(() => {
|
||||
eval (starship init elvish)
|
||||
```
|
||||
|
||||
For elvish versions prior to v0.21.0 the config file might instead be `~/.elvish/rc.elv`
|
||||
|
||||
#### Tcsh
|
||||
|
||||
@@ -161,23 +147,18 @@ onMounted(() => {
|
||||
eval `starship init tcsh`
|
||||
```
|
||||
|
||||
|
||||
#### Nushell
|
||||
|
||||
::: warning
|
||||
> [!WARNING] This will change in the future.
|
||||
> Seul Nushell v0.96+ est supporté.
|
||||
|
||||
Ceci va changer dans le futur. Seul Nushell v0.96+ est supporté.
|
||||
|
||||
:::
|
||||
|
||||
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||
Ajoutez la ligne suivante à la fin de votre configuration Nushell (trouvable en exécutant `$nu.config-path` dans Nushell) :
|
||||
|
||||
```sh
|
||||
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||
```
|
||||
|
||||
|
||||
#### Xonsh
|
||||
|
||||
Ajouter ce qui suit à la fin de `~/.xonshrc`:
|
||||
@@ -188,7 +169,6 @@ onMounted(() => {
|
||||
execx($(starship init xonsh))
|
||||
```
|
||||
|
||||
|
||||
#### Cmd
|
||||
|
||||
Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd. Ajoutez le code ci-dessous dans un fichier `starship.lua` et placez-le dans le dossier des scripts Clink:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -84,7 +80,9 @@ enable_transience
|
||||
|
||||
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. This is useful in cases where all the prompt information is not always needed. To enable this, put this in `~/.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.
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
@@ -126,7 +124,9 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
## Commandes pré-invite et pré-exécution personnalisées en Bash
|
||||
|
||||
Bash n'a pas de structure officielle préexec/précmd comme la plupart des autres shells. C'est pourquoi il est difficile de fournir des hooks entièrement personnalisables dans `bash`. Cependant, Starship vous permet dans une certaine mesure d'insérer vos propres fonctions dans la procédure de rendu du prompt :
|
||||
Bash n'a pas de structure officielle préexec/précmd comme la plupart des autres shells.
|
||||
C'est pourquoi il est difficile de fournir des hooks entièrement personnalisables dans `bash`.
|
||||
Cependant, Starship vous permet dans une certaine mesure d'insérer vos propres fonctions dans la procédure de rendu du prompt :
|
||||
|
||||
- Pour exécuter une fonction personnalisée juste avant que le prompt ne soit dessiné, définissez une nouvelle fonction et assignez son nom à `starship_precmd_user_func`. Par exemple, pour dessiner une fusée avant la commande, vous feriez
|
||||
|
||||
@@ -137,7 +137,9 @@ function blastoff(){
|
||||
starship_precmd_user_func="blastoff"
|
||||
```
|
||||
|
||||
- Pour exécuter une fonction personnalisée juste avant l'exécution d'une commande, vous pouvez utiliser le [ mécanisme d'interruption du signal ` DEBUG`](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). Cependant, vous **devez** piéger le signal DEBUG _avant_ l'initialisation de Starship ! Starship peut préserver la valeur du piège DEBUG, mais si le piège est écrasé après le démarrage de Starship, certaines fonctionnalités vont casser.
|
||||
- Pour exécuter une fonction personnalisée juste avant l'exécution d'une commande, vous pouvez utiliser le [ mécanisme d'interruption du signal ` DEBUG`](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/).
|
||||
Cependant, vous **devez** piéger le signal DEBUG _avant_ l'initialisation de Starship !
|
||||
Starship peut préserver la valeur du piège DEBUG, mais si le piège est écrasé après le démarrage de Starship, certaines fonctionnalités vont casser.
|
||||
|
||||
```bash
|
||||
function blastoff(){
|
||||
@@ -151,7 +153,9 @@ set +o functrace
|
||||
|
||||
## Commandes pré-invite et pré-exécution personnalisées dans PowerShell
|
||||
|
||||
Powershell n'a pas de système de préexec/précmd officiel comme la plupart des autres shells. C'est pourquoi il est difficile de fournir des hooks entièrement personnalisables dans `powershell`. Cependant, Starship vous permet dans une certaine mesure d'insérer vos propres fonctions dans la procédure de rendu du prompt :
|
||||
Powershell n'a pas de système de préexec/précmd officiel comme la plupart des autres shells.
|
||||
C'est pourquoi il est difficile de fournir des hooks entièrement personnalisables dans `powershell`.
|
||||
Cependant, Starship vous permet dans une certaine mesure d'insérer vos propres fonctions dans la procédure de rendu du prompt :
|
||||
|
||||
Créez une fonction nommée `Invoke-Starship-PreCommand`
|
||||
|
||||
@@ -163,7 +167,8 @@ function Invoke-Starship-PreCommand {
|
||||
|
||||
## Changer le titre de la fenêtre
|
||||
|
||||
Certaines commandes du shell changeront automatiquement le titre de la fenêtre (par exemple, pour refléter le dossier courant). Fish le fait même par défaut. Starship ne fait pas ça, mais c’est assez facile d’ajouter cette fonctionnalité à `bash`, `zsh`, `cmd` ou `powershell`.
|
||||
Certaines commandes du shell changeront automatiquement le titre de la fenêtre (par exemple, pour refléter le dossier courant). Fish le fait même par défaut.
|
||||
Starship ne fait pas ça, mais c’est assez facile d’ajouter cette fonctionnalité à `bash`, `zsh`, `cmd` ou `powershell`.
|
||||
|
||||
Tout d'abord, définissez une fonction de changement de titre de fenêtre (identique en bash et zsh) :
|
||||
|
||||
@@ -247,6 +252,12 @@ Génère l’invite suivante:
|
||||
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
|
||||
```
|
||||
|
||||
When using `zsh` (v5.0.5+), the shell adds a default trailing space to the right prompt. This can cause alignment issues specifically when using the Starship `$fill` module. To remove this gap, add the following to your `.zshrc`:
|
||||
|
||||
```zsh
|
||||
ZLE_RPROMPT_INDENT=0
|
||||
```
|
||||
|
||||
## Invite de continuation
|
||||
|
||||
Certains shells gèrent une invite de continuation en plus de l’invite normale. Cette invite est affichée à la place de l’invite normale quand l’utilisateur a entré une expression incomplète (par exemple, une parenthèse gauche ou une apostrophe seule).
|
||||
@@ -270,6 +281,316 @@ Note: les invites de confirmation sont uniquement disponibles pour les shells su
|
||||
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 | Défaut | Description |
|
||||
| --------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | `'[$symbol$model]($style) '` | Format du module. |
|
||||
| `symbole` | `'🤖 '` | The symbol shown before the model name. |
|
||||
| `style` | `'bold blue'` | Le style pour le 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 | Exemple | Description |
|
||||
| ----------------------------- | ------------------- | -------------------------------------- |
|
||||
| model | `Claude 3.5 Sonnet` | The display name of the current model |
|
||||
| model_id | `claude-3-5-sonnet` | The model ID |
|
||||
| symbole | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Reflète la valeur de l'option `style` |
|
||||
|
||||
\* : Cette variable ne peut être utilisée que comme partie d'un style
|
||||
|
||||
#### Exemples
|
||||
|
||||
```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 | Défaut | Description |
|
||||
| ---------------------- | --------------------------------- | ------------------------------------------------------------------ |
|
||||
| `format` | `'[$gauge $percentage]($style) '` | Format du module. |
|
||||
| `symbole` | `''` | 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` | [voir plus bas](#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 | Défaut | 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 | Exemple | 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 |
|
||||
| symbole | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\* : Cette variable ne peut être utilisée que comme partie d'un style
|
||||
|
||||
#### Exemples
|
||||
|
||||
**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 | Défaut | Description |
|
||||
| ---------- | ---------------------------------- | --------------------------------------------------- |
|
||||
| `format` | `'[$symbol(\\$$cost)]($style) '` | Format du module. |
|
||||
| `symbole` | `'💰 '` | The symbol shown before the cost. |
|
||||
| `display` | [voir plus bas](#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 | Défaut | 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 | Exemple | 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 |
|
||||
| symbole | | Reflète la valeur de l'option `symbol` |
|
||||
| style\* | | Mirrors the style from the matching display threshold |
|
||||
|
||||
\* : Cette variable ne peut être utilisée que comme partie d'un style
|
||||
|
||||
#### Exemples
|
||||
|
||||
```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) "
|
||||
```
|
||||
|
||||
## Chaînes de style
|
||||
|
||||
Les chaines de style sont une liste de mots séparés par des espaces. Les mots ne sont pas sensibles à la casse (`bold` et `boLd` sont considérés comme la même chaine). Les mots peuvent être :
|
||||
@@ -287,7 +608,9 @@ Les chaines de style sont une liste de mots séparés par des espaces. Les mots
|
||||
- `<color>`
|
||||
- `none (aucun)`
|
||||
|
||||
où `<color>` spécifie une couleur (voir ci-dessous). `fg:<color>` and `<color>` font la même chose actuellement, mais cela pourrait changer dans le futur. `<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` inverse les couleurs d’arrière-plan et d’avant-plan. L’ordre des mots dans la chaine n’a pas d’importance.
|
||||
où `<color>` spécifie une couleur (voir ci-dessous). `fg:<color>` and `<color>` font la même chose actuellement, mais cela pourrait changer dans le futur.
|
||||
`<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` inverse les couleurs d’arrière-plan et d’avant-plan. L’ordre des mots dans la chaine n’a pas d’importance.
|
||||
|
||||
La valeur `none` écrase toutes les autres dans une chaine si elle ne fait pas partie d’une déclaration `bg:`, donc par exemple `fg:red none fg:blue` va créer une chaine sans style. `bg:none` définit comme arrière-plan la couleur par défaut donc `fg:red bg:none` équivaut à `red` ou `fg:red` et `bg:green fg:red bg:none` équivaut aussi à `fg:red` or `red`. Cela pourrait devenir une erreur d’utiliser `none` avec d’autres mots dans le futur.
|
||||
|
||||
|
||||
+2350
-1896
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
|
||||
@@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l)
|
||||
PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
|
||||
```
|
||||
|
||||
L' [implémentation Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) intégrée à Starship est légèrement plus complexe pour permettre des fonctionnalités avancées comme le [module de durée de commande](https://starship.rs/config/#command-duration) et pour s'assurer que Starship est compatible avec les configurations Bash pré-installées.
|
||||
L'[implémentation Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) intégrée à Starship est légèrement plus complexe pour permettre des fonctionnalités avancées comme le [module de durée de commande](https://starship.rs/config/#command-duration) et pour s'assurer que Starship est compatible avec les configurations Bash pré-installées.
|
||||
|
||||
Pour une liste de tous les flags acceptés par `starship prompt`, utilisez la commande suivante :
|
||||
|
||||
@@ -72,7 +72,7 @@ Vous pouvez activer les journaux de débogage en utilisant la variable d’envir
|
||||
env STARSHIP_LOG=trace starship module rust
|
||||
```
|
||||
|
||||
If starship is being slow you can try using the `timings` command to see if there is a particular module or command that is to blame.
|
||||
Si Starship est lent, vous pouvez utiliser la commande `timings` pour vérifier si un module ou une commande en particulier est à l'origine du ralentissement.
|
||||
|
||||
```sh
|
||||
env STARSHIP_LOG=trace starship timings
|
||||
@@ -103,14 +103,15 @@ echo -e "\xee\x82\xa0"
|
||||
|
||||
La première ligne doit produire un emoji [serpent](https://emojipedia.org/snake/), tandis que la seconde doit produire un symbole [de branche powerline (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
|
||||
|
||||
Si l'un ou l'autre des symboles ne parvient pas à s'afficher correctement, votre système est toujours mal configuré. Malheureusement, il est parfois difficile d'obtenir une configuration correcte. Les utilisateurs sur Discord peuvent être en mesure d'aider. Si les deux symboles s'affichent correctement, mais vous ne les voyez toujours pas dans starship, [soumettez un rapport de bogue !](https://github.com/starship/starship/issues/new/choose)
|
||||
Si l'un ou l'autre des symboles ne parvient pas à s'afficher correctement, votre système est toujours mal configuré.
|
||||
Malheureusement, il est parfois difficile d'obtenir une configuration correcte. Les utilisateurs sur Discord peuvent être en mesure d'aider. Si les deux symboles s'affichent correctement, mais vous ne les voyez toujours pas dans starship, [soumettez un rapport de bogue !](https://github.com/starship/starship/issues/new/choose)
|
||||
|
||||
## Comment désinstaller Starship ?
|
||||
|
||||
Starship est tout aussi facile à désinstaller qu'à installer.
|
||||
|
||||
1. Supprimez les lignes de la configuration de votre shell (par exemple `~/.bashrc`) utilisées pour initialiser Starship.
|
||||
1. Supprimez l'exécutable de Starship.
|
||||
2. Supprimez l'exécutable de Starship.
|
||||
|
||||
Si Starship a été installé à l'aide d'un gestionnaire de paquets, veuillez vous référer à leur documentation pour les instructions de désinstallation.
|
||||
|
||||
@@ -121,10 +122,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`.
|
||||
|
||||
+117
-99
@@ -1,13 +1,12 @@
|
||||
<p align="center">
|
||||
<img
|
||||
width="400"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||||
alt="Starship – Prompt Shell multi-platformes"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/main/media/logo.png"
|
||||
alt="Starship – Cross-shell prompt"
|
||||
/>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/actions"
|
||||
<p align="center"><a href="https://github.com/starship/starship/actions"
|
||||
><img
|
||||
src="https://img.shields.io/github/actions/workflow/status/starship/starship/workflow.yml?branch=master&label=workflow&style=flat-square"
|
||||
alt="Statut du workflow actions GitHub"
|
||||
@@ -39,16 +38,14 @@
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs">Site web</a>
|
||||
<p align="center"><a href="https://starship.rs">Site web</a>
|
||||
·
|
||||
<a href="#🚀-installation">Installation</a>
|
||||
·
|
||||
<a href="https://starship.rs/config/">Configuration</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
<p align="center"><a href="https://github.com/starship/starship/blob/master/README.md"
|
||||
><img
|
||||
height="20"
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||||
@@ -154,12 +151,23 @@
|
||||
|
||||
<h1></h1>
|
||||
|
||||
> [!WARNING]
|
||||
> **The default branch has been renamed from `master` to `main`.**
|
||||
> If you have a local clone, update it by running:
|
||||
>
|
||||
> ```sh
|
||||
> git branch -m master main
|
||||
> git fetch origin
|
||||
> git branch -u origin/main main
|
||||
> git remote set-head origin -a
|
||||
> ```
|
||||
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship avec iTerm2 et le thème Snazzy"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||
alt="Starship avec iTerm2 et le thème Snazzy"
|
||||
width="50%"
|
||||
align="right"
|
||||
/>
|
||||
|
||||
**L'invite minimaliste, ultra-rapide et personnalisable à l'infini pour n'importe quel shell !**
|
||||
|
||||
@@ -170,8 +178,7 @@
|
||||
- **Riche en fonctionnalités:** supporte tous vos outils favoris.
|
||||
- **Facile:** rapide à installer – commencez à l'utiliser en quelques minutes.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs/config/"><strong>Consultez la documentation de Starship ▶</strong></a>
|
||||
<p align="center"><a href="https://starship.rs/config/"><strong>Consultez la documentation de Starship ▶</strong></a>
|
||||
</p>
|
||||
|
||||
<a name="🚀-installation"></a>
|
||||
@@ -180,38 +187,35 @@
|
||||
|
||||
### 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
|
||||
|
||||
Sélectionnez votre système d'exploitation dans la liste ci-dessous pour voir les instructions d'installation:
|
||||
|
||||
<details>
|
||||
<summary>Android</summary>
|
||||
<details><summary>Android</summary>
|
||||
|
||||
Installez Starship en utilisant l’un de ces gestionnaires de paquets:
|
||||
|
||||
| Dépôt | Instructions |
|
||||
| --------------------------------------------------------------------------------- | ---------------------- |
|
||||
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||||
| Dépôt | Instructions |
|
||||
| -------- | ---------------------- |
|
||||
| [Termux] | `pkg install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>BSD</summary>
|
||||
<details><summary>BSD</summary>
|
||||
|
||||
Installez Starship en utilisant l’un de ces gestionnaires de paquets:
|
||||
|
||||
| Distribution | Dépôt | Instructions |
|
||||
| ------------ | -------------------------------------------------------- | --------------------------------- |
|
||||
| **_Toutes_** | **[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` |
|
||||
| Distribution | Dépôt | Instructions |
|
||||
| ------------ | -------------------------------------------------- | --------------------------------- |
|
||||
| **_Toutes_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| FreeBSD | [FreshPorts] | `pkg install starship` |
|
||||
| NetBSD | Dépôt | `pkgin install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Linux</summary>
|
||||
<details><summary>Linux</summary>
|
||||
|
||||
Installez la dernière version pour votre système:
|
||||
|
||||
@@ -221,26 +225,26 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
Vous pouvez aussi installer Starship en utilisant l’un de ces gestionnaires de paquets:
|
||||
|
||||
| Distribution | Dépôt | Instructions |
|
||||
| ------------------ | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| **_Toutes_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| _Toutes_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| _Toutes_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Paquets Alpine Linux](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
|
||||
| Arch Linux | [Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship) | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | [Debian Main](https://sources.debian.org/src/starship/1.22.1-1/) | `apt install starship` |
|
||||
| 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` |
|
||||
| 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` |
|
||||
| Distribution | Dépôt | Instructions |
|
||||
| ---------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| **_Toutes_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| _Toutes_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
|
||||
| _Toutes_ | [Linuxbrew] | `brew install starship` |
|
||||
| Alpine Linux 3.13+ | [Alpine Linux Packages] | `apk add starship` |
|
||||
| Arch Linux | [Arch Linux Extra] | `pacman -S starship` |
|
||||
| CentOS 7+ | [Copr] | `dnf copr enable atim/starship` <br /> `dnf install starship` |
|
||||
| Debian 13+ | Dépôt | `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` |
|
||||
| openSUSE | [OSS] | `zypper in starship` |
|
||||
| Ubuntu 25.04+ | Dépôt | `apt install starship` |
|
||||
| Void Linux | [Void Linux Packages] | `xbps-install -S starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>macOS</summary>
|
||||
<details><summary>macOS</summary>
|
||||
|
||||
Installez la dernière version pour votre système:
|
||||
|
||||
@@ -250,38 +254,36 @@ curl -sS https://starship.rs/install.sh | sh
|
||||
|
||||
Vous pouvez aussi installer Starship en utilisant l’un de ces gestionnaires de paquets:
|
||||
|
||||
| Dépôt | Instructions |
|
||||
| -------------------------------------------------- | --------------------------------------- |
|
||||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| Dépôt | `conda install -c conda-forge starship` |
|
||||
| [Homebrew] | `brew install starship` |
|
||||
| Dépôt | `port install starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Windows</summary>
|
||||
|
||||
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:
|
||||
|
||||
| Dépôt | Instructions |
|
||||
| -------------------------------------------------------- | --------------------------------------- |
|
||||
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
|
||||
| [Chocolatey] | `choco install starship` |
|
||||
| [conda-forge](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` |
|
||||
| [Scoop] | `scoop install starship` |
|
||||
| [winget] | `winget install --id Starship.Starship` |
|
||||
|
||||
</details>
|
||||
|
||||
<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 Starship en utilisant l’un de ces gestionnaires de paquets:
|
||||
|
||||
| Dépôt | Instructions |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| **[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` |
|
||||
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
|
||||
| [aileron](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
|
||||
|
||||
</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:
|
||||
|
||||
<details>
|
||||
<summary>Bash</summary>
|
||||
<details><summary>Bash</summary>
|
||||
|
||||
Ajouter ce qui suit à la fin de `~/.bashrc`:
|
||||
|
||||
@@ -291,10 +293,10 @@ eval "$(starship init bash)"
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Cmd</summary>
|
||||
<details><summary>Cmd</summary>
|
||||
|
||||
Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd. Créez le fichier `%LocalAppData%\clink\starship.lua` avec le contenu suivant:
|
||||
Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd.
|
||||
Créez le fichier `%LocalAppData%\clink\starship.lua` avec le contenu suivant:
|
||||
|
||||
```lua
|
||||
load(io.popen('starship init cmd'):read("*a"))()
|
||||
@@ -302,21 +304,19 @@ load(io.popen('starship init cmd'):read("*a"))()
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Elvish</summary>
|
||||
<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>
|
||||
|
||||
<details>
|
||||
<summary>Fish</summary>
|
||||
<details><summary>Fish</summary>
|
||||
|
||||
Ajoute ce qui suit à la fin de `~/.config/fish/config.fish`:
|
||||
|
||||
@@ -326,8 +326,7 @@ starship init fish | source
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Ion</summary>
|
||||
<details><summary>Ion</summary>
|
||||
|
||||
Ajouter ce qui suit à la fin de `~/.config/ion/initrc`:
|
||||
|
||||
@@ -337,10 +336,9 @@ eval $(starship init ion)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Nushell</summary>
|
||||
<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")
|
||||
@@ -351,8 +349,7 @@ Note: Seul Nushell v0.96+ est supporté
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>PowerShell</summary>
|
||||
<details><summary>PowerShell</summary>
|
||||
|
||||
Ajoutez le code suivant à la fin de votre configuration de PowerShell (trouvez-la en exécutant `$PROFILE`):
|
||||
|
||||
@@ -362,8 +359,7 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Tcsh</summary>
|
||||
<details><summary>Tcsh</summary>
|
||||
|
||||
Ajoutez ce qui suit à la fin de `~/.tcshrc`:
|
||||
|
||||
@@ -373,8 +369,7 @@ eval `starship init tcsh`
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Xonsh</summary>
|
||||
<details><summary>Xonsh</summary>
|
||||
|
||||
Ajouter ce qui suit à la fin de `~/.xonshrc`:
|
||||
|
||||
@@ -384,8 +379,7 @@ execx($(starship init xonsh))
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Zsh</summary>
|
||||
<details><summary>Zsh</summary>
|
||||
|
||||
Ajouter ce qui suit à la fin de `~/.zshrc`:
|
||||
|
||||
@@ -397,7 +391,8 @@ eval "$(starship init zsh)"
|
||||
|
||||
### Étape 3. Configurer Starship
|
||||
|
||||
Démarrez une nouvelle instance de votre shell, et vous devriez voir votre magnifique nouveau prompt. Si vous êtes satisfait des valeurs par défaut, profitez-en !
|
||||
Démarrez une nouvelle instance de votre shell, et vous devriez voir votre magnifique nouveau prompt.
|
||||
Si vous êtes satisfait des valeurs par défaut, profitez-en !
|
||||
|
||||
Si vous cherchez à personnaliser davantage Starship :
|
||||
|
||||
@@ -407,7 +402,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**! Si vous cherchez à faciliter votre entrée dans le projet, essayez un [good first issue](https://github.com/starship/starship/issues?q=state%3Aopen%20label%3A%22%F0%9F%8C%B1%20good%20first%20issue%22).
|
||||
|
||||
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/).
|
||||
|
||||
@@ -427,7 +422,7 @@ Voyez ces travaux précédents qui ont contribué à inspirer la création de St
|
||||
|
||||
Soutenez ce projet en [devenant un collaborateur](https://github.com/sponsors/starship). Votre nom ou logo apparaîtra ici avec un lien vers votre site Web.
|
||||
|
||||
## 🔒 Code Signing Policy
|
||||
## 🔒 Politique de signature de code
|
||||
|
||||
Free code signing provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org).
|
||||
|
||||
@@ -438,11 +433,34 @@ Code Signing Roles:
|
||||
|
||||
This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Icône de roquette de Starship">
|
||||
<p align="center"><br>
|
||||
<img width="100" src="https://raw.githubusercontent.com/starship/starship/main/media/icon.png" alt="Starship rocket icon">
|
||||
</p>
|
||||
|
||||
## 📝 License
|
||||
|
||||
Copyright © 2019-présent, [contributeurs de Starship](https://github.com/starship/starship/graphs/contributors).<br /> Ce projet est sous licence [ISC](https://github.com/starship/starship/blob/master/LICENSE).
|
||||
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
|
||||
Ce projet est sous licence [ISC](https://github.com/starship/starship/blob/master/LICENSE).
|
||||
|
||||
[alpine linux packages]: <[Paquets Alpine Linux](https://pkgs.alpinelinux.org/packages?name=starship)>
|
||||
[arch linux extra]: <[Arch Linux Extra](https://archlinux.org/packages/extra/x86_64/starship)>
|
||||
[chocolatey]: [Chocolatey]\(https://community.chocolatey.org/packages/starship\)
|
||||
[conda-forge]: [conda-forge]\(https://anaconda.org/conda-forge/starship\)
|
||||
[copr]: [Copr]\(https://copr.fedorainfracloud.org/coprs/atim/starship\)
|
||||
[crates.io]: [Copr]\(https://copr.fedorainfracloud.org/coprs/atim/starship\)
|
||||
[debian main]: <[Debian principal](https://sources.debian.org/src/starship/1.22.1-1/)>
|
||||
[freshports]: [FreshPorts]\(https://www.freshports.org/shells/starship\)
|
||||
[gentoo packages]: <[Paquets Gentoo](https://packages.gentoo.org/packages/app-shells/starship)>
|
||||
[linuxbrew]: [Homebrew]\(https://formulae.brew.sh/formula/starship\)
|
||||
[homebrew]: [Linuxbrew]\(https://formulae.brew.sh/formula/starship\)
|
||||
[macports]: [MacPorts]\(https://ports.macports.org/port/starship\)
|
||||
[nixpkgs]: [nixpkgs]\(https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/st/starship/package.nix\)
|
||||
[OSS]: [OSS]\(https://software.opensuse.org/package/starship\)
|
||||
[pkgsrc]: [pkgsrc]\(https://pkgsrc.se/shells/starship\)
|
||||
[scoop]: [Scoop]\(https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json\)
|
||||
[SignPath Foundation]: https://signpath.org
|
||||
[SignPath.io]: https://signpath.io
|
||||
[termux]: [Termux]\(https://github.com/termux/termux-packages/tree/master/packages/starship\)
|
||||
[ubuntu universe]: <[Ubuntu Universe](https://packages.ubuntu.com/source/plucky/starship)>
|
||||
[void linux packages]: <[Paquets Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship)>
|
||||
[winget]: [aileron]\(https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship\)
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
Pour installer starship, vous devez faire deux choses:
|
||||
|
||||
1. Installez le binaire **starship** sur votre ordinateur
|
||||
1. Dire à votre shell d'utiliser le binaire de starship comme invite en modifiant ses scripts d'initialisation
|
||||
2. Dire à votre shell d'utiliser le binaire de starship comme invite en modifiant ses scripts d'initialisation
|
||||
|
||||
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. Cependant, pour certaines plateformes plus spécialisées, des instructions différentes sont nécessaires.
|
||||
Pour la plupart des utilisateurs, les instructions sur [la page principale](../guide/#🚀-installation) fonctionneront bien. Cependant, pour certaines plateformes plus spécialisées, des instructions différentes sont nécessaires.
|
||||
|
||||
Il y a tellement de plates-formes, qu'il aurait été déraisonnable de les faire apparaître dans le README principal, voici donc quelques instructions d'installation supplémentaires pour celles-ci, écrites par la communauté. La vôtre n'est pas là ? S'il vous plaît, ajoutez-la ici pour les suivants !
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# Préréglages
|
||||
|
||||
Voici un ensemble de préréglages pour Starship soumis par la communauté. Si vous avez un préréglage à partager, veuillez [proposer une PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) pour mettre à jour ce fichier! 😊
|
||||
Voici un ensemble de préréglages pour Starship soumis par la communauté.
|
||||
Si vous avez un préréglage à partager, veuillez [proposer une PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) pour mettre à jour ce fichier! 😊
|
||||
|
||||
Pour obtenir des détails sur comment utiliser un préréglage, cliquez simplement sur l’image.
|
||||
|
||||
@@ -14,11 +15,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)
|
||||
|
||||
@@ -54,7 +51,8 @@ Ce préréglage émule l'apparence et le comportement de [Pure](https://github.c
|
||||
|
||||
## [Pastel Powerline](./pastel-powerline.md)
|
||||
|
||||
Ce préréglage s'inspire de [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). Il montre également comment fonctionne la substitution de chemin dans starship.
|
||||
Ce préréglage s'inspire de [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json).
|
||||
Il montre également comment fonctionne la substitution de chemin dans starship.
|
||||
|
||||
[](./pastel-powerline)
|
||||
|
||||
|
||||
@@ -12,6 +12,6 @@ Ce préréglage modifie le format de tous les modules intégrés pour afficher l
|
||||
starship preset bracketed-segments -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/bracketed-segments.toml){download}
|
||||
[Cliquez pour télécharger TOML](/presets/toml/bracketed-segments.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/bracketed-segments.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#catppuccin-powerline)
|
||||
[Retourner aux préréglages](./#catppuccin-powerline)
|
||||
|
||||
# Catppuccin Powerline Preset
|
||||
|
||||
@@ -8,7 +8,7 @@ This preset is a minimally modified version of [Gruvbox Rainbow](./gruvbox-rainb
|
||||
|
||||
### Pré-requis
|
||||
|
||||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||
- Une [Nerd Font](https://www.nerdfonts.com/) est installée et activée dans votre terminal
|
||||
|
||||
### Configuration
|
||||
|
||||
@@ -21,8 +21,8 @@ By default this preset uses the Mocha flavour of Catppucin, but you can specify
|
||||
- `catppuccin_mocha`
|
||||
- `catppuccin_frappe`
|
||||
- `catppuccin_macchiato`
|
||||
- `catppucin_latte`
|
||||
- `catppuccin_latte`
|
||||
|
||||
[Click to download TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
[Cliquez pour télécharger TOML](/presets/toml/catppuccin-powerline.toml)
|
||||
|
||||
<<< @/public/presets/toml/catppuccin-powerline.toml
|
||||
|
||||
@@ -16,6 +16,6 @@ This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), an
|
||||
starship preset gruvbox-rainbow -o ~/.config/starship.toml
|
||||
```
|
||||
|
||||
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml){download}
|
||||
[Cliquez pour télécharger TOML](/presets/toml/gruvbox-rainbow.toml){download}
|
||||
|
||||
<<< @/public/presets/toml/gruvbox-rainbow.toml
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user