mirror of
https://github.com/Llewellynvdm/starship.git
synced 2025-01-15 11:17:00 +00:00
Merge a13e8d1f3d
into a2112d4bad
This commit is contained in:
commit
7fc281cb15
34
.dprint.json
34
.dprint.json
@ -14,36 +14,20 @@
|
|||||||
],
|
],
|
||||||
"excludes": [
|
"excludes": [
|
||||||
"CHANGELOG.md",
|
"CHANGELOG.md",
|
||||||
"docs/.vuepress/dist/**",
|
"docs/.vitepress/dist/**",
|
||||||
"**/node_modules",
|
"**/node_modules",
|
||||||
"**/*-lock.json",
|
"**/*-lock.json",
|
||||||
".github/*",
|
".github/*",
|
||||||
"docs/ar-SA/**",
|
"docs/??-??/**",
|
||||||
"docs/ckb-IR/**",
|
"docs/??-???/**",
|
||||||
"docs/de-DE/**",
|
"docs/???-??/**",
|
||||||
"docs/es-ES/**",
|
"docs/???-???/**",
|
||||||
"docs/fr-FR/**",
|
|
||||||
"docs/id-ID/**",
|
|
||||||
"docs/it-IT/**",
|
|
||||||
"docs/ja-JP/**",
|
|
||||||
"docs/ko-KR/**",
|
|
||||||
"docs/nl-NL/**",
|
|
||||||
"docs/no-NO/**",
|
|
||||||
"docs/pl-PL/**",
|
|
||||||
"docs/pt-BR/**",
|
|
||||||
"docs/pt-PT/**",
|
|
||||||
"docs/ru-RU/**",
|
|
||||||
"docs/tr-TR/**",
|
|
||||||
"docs/uk-UA/**",
|
|
||||||
"docs/vi-VN/**",
|
|
||||||
"docs/zh-CN/**",
|
|
||||||
"docs/zh-TW/**",
|
|
||||||
"target/"
|
"target/"
|
||||||
],
|
],
|
||||||
"plugins": [
|
"plugins": [
|
||||||
"https://github.com/dprint/dprint-plugin-typescript/releases/download/0.88.3/plugin.wasm",
|
"https://github.com/dprint/dprint-plugin-typescript/releases/download/0.93.3/plugin.wasm",
|
||||||
"https://github.com/dprint/dprint-plugin-json/releases/download/0.19.0/plugin.wasm",
|
"https://github.com/dprint/dprint-plugin-json/releases/download/0.19.4/plugin.wasm",
|
||||||
"https://github.com/dprint/dprint-plugin-markdown/releases/download/0.16.2/plugin.wasm",
|
"https://github.com/dprint/dprint-plugin-markdown/releases/download/0.17.8/plugin.wasm",
|
||||||
"https://github.com/dprint/dprint-plugin-toml/releases/download/0.5.4/plugin.wasm"
|
"https://github.com/dprint/dprint-plugin-toml/releases/download/0.6.4/plugin.wasm"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
606
.github/config-schema.json
vendored
606
.github/config-schema.json
vendored
@ -87,6 +87,7 @@
|
|||||||
"default": {
|
"default": {
|
||||||
"detect_extensions": [],
|
"detect_extensions": [],
|
||||||
"detect_files": [
|
"detect_files": [
|
||||||
|
"bun.lock",
|
||||||
"bun.lockb",
|
"bun.lockb",
|
||||||
"bunfig.toml"
|
"bunfig.toml"
|
||||||
],
|
],
|
||||||
@ -94,7 +95,7 @@
|
|||||||
"disabled": false,
|
"disabled": false,
|
||||||
"format": "via [$symbol($version )]($style)",
|
"format": "via [$symbol($version )]($style)",
|
||||||
"style": "bold red",
|
"style": "bold red",
|
||||||
"symbol": "🍞 ",
|
"symbol": "🥟 ",
|
||||||
"version_format": "v${raw}"
|
"version_format": "v${raw}"
|
||||||
},
|
},
|
||||||
"allOf": [
|
"allOf": [
|
||||||
@ -311,6 +312,7 @@
|
|||||||
"detect_files": [
|
"detect_files": [
|
||||||
"deno.json",
|
"deno.json",
|
||||||
"deno.jsonc",
|
"deno.jsonc",
|
||||||
|
"deno.lock",
|
||||||
"mod.ts",
|
"mod.ts",
|
||||||
"deps.ts",
|
"deps.ts",
|
||||||
"mod.js",
|
"mod.js",
|
||||||
@ -354,6 +356,32 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"direnv": {
|
||||||
|
"default": {
|
||||||
|
"allowed_msg": "allowed",
|
||||||
|
"denied_msg": "denied",
|
||||||
|
"detect_env_vars": [
|
||||||
|
"DIRENV_FILE"
|
||||||
|
],
|
||||||
|
"detect_extensions": [],
|
||||||
|
"detect_files": [
|
||||||
|
".envrc"
|
||||||
|
],
|
||||||
|
"detect_folders": [],
|
||||||
|
"disabled": true,
|
||||||
|
"format": "[$symbol$loaded/$allowed]($style) ",
|
||||||
|
"loaded_msg": "loaded",
|
||||||
|
"not_allowed_msg": "not allowed",
|
||||||
|
"style": "bold bright-yellow",
|
||||||
|
"symbol": "direnv ",
|
||||||
|
"unloaded_msg": "not loaded"
|
||||||
|
},
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/DirenvConfig"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"docker_context": {
|
"docker_context": {
|
||||||
"default": {
|
"default": {
|
||||||
"detect_extensions": [],
|
"detect_extensions": [],
|
||||||
@ -644,6 +672,27 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"gleam": {
|
||||||
|
"default": {
|
||||||
|
"detect_extensions": [
|
||||||
|
"gleam"
|
||||||
|
],
|
||||||
|
"detect_files": [
|
||||||
|
"gleam.toml"
|
||||||
|
],
|
||||||
|
"detect_folders": [],
|
||||||
|
"disabled": false,
|
||||||
|
"format": "via [$symbol($version )]($style)",
|
||||||
|
"style": "bold #FFAFF3",
|
||||||
|
"symbol": "⭐ ",
|
||||||
|
"version_format": "v${raw}"
|
||||||
|
},
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/GleamConfig"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"golang": {
|
"golang": {
|
||||||
"default": {
|
"default": {
|
||||||
"detect_extensions": [
|
"detect_extensions": [
|
||||||
@ -798,6 +847,7 @@
|
|||||||
},
|
},
|
||||||
"hostname": {
|
"hostname": {
|
||||||
"default": {
|
"default": {
|
||||||
|
"aliases": {},
|
||||||
"detect_env_vars": [],
|
"detect_env_vars": [],
|
||||||
"disabled": false,
|
"disabled": false,
|
||||||
"format": "[$ssh_symbol$hostname]($style) in ",
|
"format": "[$ssh_symbol$hostname]($style) in ",
|
||||||
@ -908,6 +958,7 @@
|
|||||||
"default": {
|
"default": {
|
||||||
"context_aliases": {},
|
"context_aliases": {},
|
||||||
"contexts": [],
|
"contexts": [],
|
||||||
|
"detect_env_vars": [],
|
||||||
"detect_extensions": [],
|
"detect_extensions": [],
|
||||||
"detect_files": [],
|
"detect_files": [],
|
||||||
"detect_folders": [],
|
"detect_folders": [],
|
||||||
@ -999,6 +1050,38 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"mojo": {
|
||||||
|
"default": {
|
||||||
|
"detect_extensions": [
|
||||||
|
"mojo",
|
||||||
|
"🔥"
|
||||||
|
],
|
||||||
|
"detect_files": [],
|
||||||
|
"detect_folders": [],
|
||||||
|
"disabled": false,
|
||||||
|
"format": "with [$symbol($version )]($style)",
|
||||||
|
"style": "bold 208",
|
||||||
|
"symbol": "🔥 "
|
||||||
|
},
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/MojoConfig"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"nats": {
|
||||||
|
"default": {
|
||||||
|
"disabled": true,
|
||||||
|
"format": "[$symbol($name )]($style)",
|
||||||
|
"style": "bold purple",
|
||||||
|
"symbol": "✉️ "
|
||||||
|
},
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/NatsConfig"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"nim": {
|
"nim": {
|
||||||
"default": {
|
"default": {
|
||||||
"detect_extensions": [
|
"detect_extensions": [
|
||||||
@ -1104,6 +1187,25 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"odin": {
|
||||||
|
"default": {
|
||||||
|
"detect_extensions": [
|
||||||
|
"odin"
|
||||||
|
],
|
||||||
|
"detect_files": [],
|
||||||
|
"detect_folders": [],
|
||||||
|
"disabled": false,
|
||||||
|
"format": "via [$symbol($version )]($style)",
|
||||||
|
"show_commit": false,
|
||||||
|
"style": "bold bright-blue",
|
||||||
|
"symbol": "Ø "
|
||||||
|
},
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/OdinConfig"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"opa": {
|
"opa": {
|
||||||
"default": {
|
"default": {
|
||||||
"detect_extensions": [
|
"detect_extensions": [
|
||||||
@ -1142,12 +1244,15 @@
|
|||||||
"format": "[$symbol]($style)",
|
"format": "[$symbol]($style)",
|
||||||
"style": "bold white",
|
"style": "bold white",
|
||||||
"symbols": {
|
"symbols": {
|
||||||
|
"AIX": "➿ ",
|
||||||
|
"AlmaLinux": "💠 ",
|
||||||
"Alpaquita": "🔔 ",
|
"Alpaquita": "🔔 ",
|
||||||
"Alpine": "🏔️ ",
|
"Alpine": "🏔️ ",
|
||||||
"Amazon": "🙂 ",
|
"Amazon": "🙂 ",
|
||||||
"Android": "🤖 ",
|
"Android": "🤖 ",
|
||||||
"Arch": "🎗️ ",
|
"Arch": "🎗️ ",
|
||||||
"Artix": "🎗️ ",
|
"Artix": "🎗️ ",
|
||||||
|
"CachyOS": "🎗️ ",
|
||||||
"CentOS": "💠 ",
|
"CentOS": "💠 ",
|
||||||
"Debian": "🌀 ",
|
"Debian": "🌀 ",
|
||||||
"DragonFly": "🐉 ",
|
"DragonFly": "🐉 ",
|
||||||
@ -1159,6 +1264,7 @@
|
|||||||
"Gentoo": "🗜️ ",
|
"Gentoo": "🗜️ ",
|
||||||
"HardenedBSD": "🛡️ ",
|
"HardenedBSD": "🛡️ ",
|
||||||
"Illumos": "🐦 ",
|
"Illumos": "🐦 ",
|
||||||
|
"Kali": "🐉 ",
|
||||||
"Linux": "🐧 ",
|
"Linux": "🐧 ",
|
||||||
"Mabox": "📦 ",
|
"Mabox": "📦 ",
|
||||||
"Macos": "🍎 ",
|
"Macos": "🍎 ",
|
||||||
@ -1168,6 +1274,7 @@
|
|||||||
"Mint": "🌿 ",
|
"Mint": "🌿 ",
|
||||||
"NetBSD": "🚩 ",
|
"NetBSD": "🚩 ",
|
||||||
"NixOS": "❄️ ",
|
"NixOS": "❄️ ",
|
||||||
|
"Nobara": "🎩 ",
|
||||||
"OpenBSD": "🐡 ",
|
"OpenBSD": "🐡 ",
|
||||||
"OpenCloudOS": "☁️ ",
|
"OpenCloudOS": "☁️ ",
|
||||||
"OracleLinux": "🦴 ",
|
"OracleLinux": "🦴 ",
|
||||||
@ -1176,10 +1283,14 @@
|
|||||||
"RedHatEnterprise": "🎩 ",
|
"RedHatEnterprise": "🎩 ",
|
||||||
"Redhat": "🎩 ",
|
"Redhat": "🎩 ",
|
||||||
"Redox": "🧪 ",
|
"Redox": "🧪 ",
|
||||||
|
"RockyLinux": "💠 ",
|
||||||
"SUSE": "🦎 ",
|
"SUSE": "🦎 ",
|
||||||
"Solus": "⛵ ",
|
"Solus": "⛵ ",
|
||||||
"Ubuntu": "🎯 ",
|
"Ubuntu": "🎯 ",
|
||||||
|
"Ultramarine": "🔷 ",
|
||||||
"Unknown": "❓ ",
|
"Unknown": "❓ ",
|
||||||
|
"Uos": "🐲 ",
|
||||||
|
"Void": " ",
|
||||||
"Windows": "🪟 ",
|
"Windows": "🪟 ",
|
||||||
"openEuler": "🦉 ",
|
"openEuler": "🦉 ",
|
||||||
"openSUSE": "🦎 "
|
"openSUSE": "🦎 "
|
||||||
@ -1293,7 +1404,9 @@
|
|||||||
"purs"
|
"purs"
|
||||||
],
|
],
|
||||||
"detect_files": [
|
"detect_files": [
|
||||||
"spago.dhall"
|
"spago.dhall",
|
||||||
|
"spago.yaml",
|
||||||
|
"spago.lock"
|
||||||
],
|
],
|
||||||
"detect_folders": [],
|
"detect_folders": [],
|
||||||
"disabled": false,
|
"disabled": false,
|
||||||
@ -1310,8 +1423,12 @@
|
|||||||
},
|
},
|
||||||
"python": {
|
"python": {
|
||||||
"default": {
|
"default": {
|
||||||
|
"detect_env_vars": [
|
||||||
|
"VIRTUAL_ENV"
|
||||||
|
],
|
||||||
"detect_extensions": [
|
"detect_extensions": [
|
||||||
"py"
|
"py",
|
||||||
|
"ipynb"
|
||||||
],
|
],
|
||||||
"detect_files": [
|
"detect_files": [
|
||||||
"requirements.txt",
|
"requirements.txt",
|
||||||
@ -1320,7 +1437,8 @@
|
|||||||
"Pipfile",
|
"Pipfile",
|
||||||
"tox.ini",
|
"tox.ini",
|
||||||
"setup.py",
|
"setup.py",
|
||||||
"__init__.py"
|
"__init__.py",
|
||||||
|
"pixi.toml"
|
||||||
],
|
],
|
||||||
"detect_folders": [],
|
"detect_folders": [],
|
||||||
"disabled": false,
|
"disabled": false,
|
||||||
@ -1342,6 +1460,27 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"quarto": {
|
||||||
|
"default": {
|
||||||
|
"detect_extensions": [
|
||||||
|
"qmd"
|
||||||
|
],
|
||||||
|
"detect_files": [
|
||||||
|
"_quarto.yml"
|
||||||
|
],
|
||||||
|
"detect_folders": [],
|
||||||
|
"disabled": false,
|
||||||
|
"format": "via [$symbol($version )]($style)",
|
||||||
|
"style": "bold #75AADB",
|
||||||
|
"symbol": "⨁ ",
|
||||||
|
"version_format": "v${raw}"
|
||||||
|
},
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/QuartoConfig"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"raku": {
|
"raku": {
|
||||||
"default": {
|
"default": {
|
||||||
"detect_extensions": [
|
"detect_extensions": [
|
||||||
@ -1397,7 +1536,7 @@
|
|||||||
"Rsx"
|
"Rsx"
|
||||||
],
|
],
|
||||||
"detect_files": [
|
"detect_files": [
|
||||||
".Rprofile"
|
"DESCRIPTION"
|
||||||
],
|
],
|
||||||
"detect_folders": [
|
"detect_folders": [
|
||||||
".Rproj.user"
|
".Rproj.user"
|
||||||
@ -1583,7 +1722,7 @@
|
|||||||
"not_executable_symbol": "🚫",
|
"not_executable_symbol": "🚫",
|
||||||
"not_found_symbol": "🔍",
|
"not_found_symbol": "🔍",
|
||||||
"pipestatus": false,
|
"pipestatus": false,
|
||||||
"pipestatus_format": "\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)",
|
"pipestatus_format": "\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) ",
|
||||||
"pipestatus_separator": "|",
|
"pipestatus_separator": "|",
|
||||||
"recognize_signal_code": true,
|
"recognize_signal_code": true,
|
||||||
"sigint_symbol": "🧱",
|
"sigint_symbol": "🧱",
|
||||||
@ -1671,8 +1810,31 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"typst": {
|
||||||
|
"default": {
|
||||||
|
"detect_extensions": [
|
||||||
|
"typ"
|
||||||
|
],
|
||||||
|
"detect_files": [
|
||||||
|
"template.typ"
|
||||||
|
],
|
||||||
|
"detect_folders": [],
|
||||||
|
"disabled": false,
|
||||||
|
"format": "via [$symbol($version )]($style)",
|
||||||
|
"style": "bold #0093A7",
|
||||||
|
"symbol": "t ",
|
||||||
|
"version_format": "v${raw}"
|
||||||
|
},
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/TypstConfig"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"username": {
|
"username": {
|
||||||
"default": {
|
"default": {
|
||||||
|
"aliases": {},
|
||||||
|
"detect_env_vars": [],
|
||||||
"disabled": false,
|
"disabled": false,
|
||||||
"format": "[$user]($style) in ",
|
"format": "[$user]($style) in ",
|
||||||
"show_always": false,
|
"show_always": false,
|
||||||
@ -1826,7 +1988,7 @@
|
|||||||
"definitions": {
|
"definitions": {
|
||||||
"AwsConfig": {
|
"AwsConfig": {
|
||||||
"title": "AWS",
|
"title": "AWS",
|
||||||
"description": "The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.\n\nThe module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.\n\nWhen using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` or `AWS_CREDENTIAL_EXPIRATION` var.\n\nWhen using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.\n\nWhen using [`AWSume`](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.",
|
"description": "The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required.\n\nThe module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.\n\nWhen using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` or `AWS_CREDENTIAL_EXPIRATION` var.\n\nWhen using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var.\n\nWhen using [`AWSume`](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.\n\nWhen using [aws-sso-cli](https://github.com/synfinatic/aws-sso-cli) the profile is read from the `AWS_SSO_PROFILE` env var.",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"format": {
|
"format": {
|
||||||
@ -2047,7 +2209,7 @@
|
|||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"symbol": {
|
"symbol": {
|
||||||
"default": "🍞 ",
|
"default": "🥟 ",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"style": {
|
"style": {
|
||||||
@ -2067,6 +2229,7 @@
|
|||||||
},
|
},
|
||||||
"detect_files": {
|
"detect_files": {
|
||||||
"default": [
|
"default": [
|
||||||
|
"bun.lock",
|
||||||
"bun.lockb",
|
"bun.lockb",
|
||||||
"bunfig.toml"
|
"bunfig.toml"
|
||||||
],
|
],
|
||||||
@ -2585,6 +2748,7 @@
|
|||||||
"default": [
|
"default": [
|
||||||
"deno.json",
|
"deno.json",
|
||||||
"deno.jsonc",
|
"deno.jsonc",
|
||||||
|
"deno.lock",
|
||||||
"mod.ts",
|
"mod.ts",
|
||||||
"deps.ts",
|
"deps.ts",
|
||||||
"mod.js",
|
"mod.js",
|
||||||
@ -2686,6 +2850,80 @@
|
|||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
},
|
},
|
||||||
|
"DirenvConfig": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"format": {
|
||||||
|
"default": "[$symbol$loaded/$allowed]($style) ",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"symbol": {
|
||||||
|
"default": "direnv ",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"style": {
|
||||||
|
"default": "bold bright-yellow",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"disabled": {
|
||||||
|
"default": true,
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"detect_extensions": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_env_vars": {
|
||||||
|
"default": [
|
||||||
|
"DIRENV_FILE"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_files": {
|
||||||
|
"default": [
|
||||||
|
".envrc"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_folders": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"allowed_msg": {
|
||||||
|
"default": "allowed",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"not_allowed_msg": {
|
||||||
|
"default": "not allowed",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"denied_msg": {
|
||||||
|
"default": "denied",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"loaded_msg": {
|
||||||
|
"default": "loaded",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"unloaded_msg": {
|
||||||
|
"default": "not loaded",
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
"DockerContextConfig": {
|
"DockerContextConfig": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -3397,6 +3635,57 @@
|
|||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
},
|
},
|
||||||
|
"GleamConfig": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"format": {
|
||||||
|
"default": "via [$symbol($version )]($style)",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"version_format": {
|
||||||
|
"default": "v${raw}",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"symbol": {
|
||||||
|
"default": "⭐ ",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"style": {
|
||||||
|
"default": "bold #FFAFF3",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"disabled": {
|
||||||
|
"default": false,
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"detect_extensions": {
|
||||||
|
"default": [
|
||||||
|
"gleam"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_files": {
|
||||||
|
"default": [
|
||||||
|
"gleam.toml"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_folders": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
"GoConfig": {
|
"GoConfig": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -3763,6 +4052,13 @@
|
|||||||
"disabled": {
|
"disabled": {
|
||||||
"default": false,
|
"default": false,
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"aliases": {
|
||||||
|
"default": {},
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@ -4027,6 +4323,13 @@
|
|||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"detect_env_vars": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
"contexts": {
|
"contexts": {
|
||||||
"default": [],
|
"default": [],
|
||||||
"type": "array",
|
"type": "array",
|
||||||
@ -4230,6 +4533,74 @@
|
|||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
},
|
},
|
||||||
|
"MojoConfig": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"format": {
|
||||||
|
"default": "with [$symbol($version )]($style)",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"symbol": {
|
||||||
|
"default": "🔥 ",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"style": {
|
||||||
|
"default": "bold 208",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"disabled": {
|
||||||
|
"default": false,
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"detect_extensions": {
|
||||||
|
"default": [
|
||||||
|
"mojo",
|
||||||
|
"🔥"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_files": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_folders": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"NatsConfig": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"format": {
|
||||||
|
"default": "[$symbol($name )]($style)",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"symbol": {
|
||||||
|
"default": "✉️ ",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"style": {
|
||||||
|
"default": "bold purple",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"disabled": {
|
||||||
|
"default": true,
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
"NimConfig": {
|
"NimConfig": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -4455,6 +4826,55 @@
|
|||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
},
|
},
|
||||||
|
"OdinConfig": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"format": {
|
||||||
|
"default": "via [$symbol($version )]($style)",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"show_commit": {
|
||||||
|
"default": false,
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"symbol": {
|
||||||
|
"default": "Ø ",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"style": {
|
||||||
|
"default": "bold bright-blue",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"disabled": {
|
||||||
|
"default": false,
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"detect_extensions": {
|
||||||
|
"default": [
|
||||||
|
"odin"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_files": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_folders": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
"OpaConfig": {
|
"OpaConfig": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -4539,12 +4959,15 @@
|
|||||||
},
|
},
|
||||||
"symbols": {
|
"symbols": {
|
||||||
"default": {
|
"default": {
|
||||||
|
"AIX": "➿ ",
|
||||||
|
"AlmaLinux": "💠 ",
|
||||||
"Alpaquita": "🔔 ",
|
"Alpaquita": "🔔 ",
|
||||||
"Alpine": "🏔️ ",
|
"Alpine": "🏔️ ",
|
||||||
"Amazon": "🙂 ",
|
"Amazon": "🙂 ",
|
||||||
"Android": "🤖 ",
|
"Android": "🤖 ",
|
||||||
"Arch": "🎗️ ",
|
"Arch": "🎗️ ",
|
||||||
"Artix": "🎗️ ",
|
"Artix": "🎗️ ",
|
||||||
|
"CachyOS": "🎗️ ",
|
||||||
"CentOS": "💠 ",
|
"CentOS": "💠 ",
|
||||||
"Debian": "🌀 ",
|
"Debian": "🌀 ",
|
||||||
"DragonFly": "🐉 ",
|
"DragonFly": "🐉 ",
|
||||||
@ -4556,6 +4979,7 @@
|
|||||||
"Gentoo": "🗜️ ",
|
"Gentoo": "🗜️ ",
|
||||||
"HardenedBSD": "🛡️ ",
|
"HardenedBSD": "🛡️ ",
|
||||||
"Illumos": "🐦 ",
|
"Illumos": "🐦 ",
|
||||||
|
"Kali": "🐉 ",
|
||||||
"Linux": "🐧 ",
|
"Linux": "🐧 ",
|
||||||
"Mabox": "📦 ",
|
"Mabox": "📦 ",
|
||||||
"Macos": "🍎 ",
|
"Macos": "🍎 ",
|
||||||
@ -4565,6 +4989,7 @@
|
|||||||
"Mint": "🌿 ",
|
"Mint": "🌿 ",
|
||||||
"NetBSD": "🚩 ",
|
"NetBSD": "🚩 ",
|
||||||
"NixOS": "❄️ ",
|
"NixOS": "❄️ ",
|
||||||
|
"Nobara": "🎩 ",
|
||||||
"OpenBSD": "🐡 ",
|
"OpenBSD": "🐡 ",
|
||||||
"OpenCloudOS": "☁️ ",
|
"OpenCloudOS": "☁️ ",
|
||||||
"OracleLinux": "🦴 ",
|
"OracleLinux": "🦴 ",
|
||||||
@ -4573,10 +4998,14 @@
|
|||||||
"RedHatEnterprise": "🎩 ",
|
"RedHatEnterprise": "🎩 ",
|
||||||
"Redhat": "🎩 ",
|
"Redhat": "🎩 ",
|
||||||
"Redox": "🧪 ",
|
"Redox": "🧪 ",
|
||||||
|
"RockyLinux": "💠 ",
|
||||||
"SUSE": "🦎 ",
|
"SUSE": "🦎 ",
|
||||||
"Solus": "⛵ ",
|
"Solus": "⛵ ",
|
||||||
"Ubuntu": "🎯 ",
|
"Ubuntu": "🎯 ",
|
||||||
|
"Ultramarine": "🔷 ",
|
||||||
"Unknown": "❓ ",
|
"Unknown": "❓ ",
|
||||||
|
"Uos": "🐲 ",
|
||||||
|
"Void": " ",
|
||||||
"Windows": "🪟 ",
|
"Windows": "🪟 ",
|
||||||
"openEuler": "🦉 ",
|
"openEuler": "🦉 ",
|
||||||
"openSUSE": "🦎 "
|
"openSUSE": "🦎 "
|
||||||
@ -4829,7 +5258,9 @@
|
|||||||
},
|
},
|
||||||
"detect_files": {
|
"detect_files": {
|
||||||
"default": [
|
"default": [
|
||||||
"spago.dhall"
|
"spago.dhall",
|
||||||
|
"spago.yaml",
|
||||||
|
"spago.lock"
|
||||||
],
|
],
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@ -4891,7 +5322,8 @@
|
|||||||
},
|
},
|
||||||
"detect_extensions": {
|
"detect_extensions": {
|
||||||
"default": [
|
"default": [
|
||||||
"py"
|
"py",
|
||||||
|
"ipynb"
|
||||||
],
|
],
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@ -4906,7 +5338,8 @@
|
|||||||
"Pipfile",
|
"Pipfile",
|
||||||
"tox.ini",
|
"tox.ini",
|
||||||
"setup.py",
|
"setup.py",
|
||||||
"__init__.py"
|
"__init__.py",
|
||||||
|
"pixi.toml"
|
||||||
],
|
],
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@ -4919,6 +5352,15 @@
|
|||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"detect_env_vars": {
|
||||||
|
"default": [
|
||||||
|
"VIRTUAL_ENV"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@ -4936,6 +5378,57 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"QuartoConfig": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"format": {
|
||||||
|
"default": "via [$symbol($version )]($style)",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"version_format": {
|
||||||
|
"default": "v${raw}",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"symbol": {
|
||||||
|
"default": "⨁ ",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"style": {
|
||||||
|
"default": "bold #75AADB",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"disabled": {
|
||||||
|
"default": false,
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"detect_extensions": {
|
||||||
|
"default": [
|
||||||
|
"qmd"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_files": {
|
||||||
|
"default": [
|
||||||
|
"_quarto.yml"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_folders": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
"RakuConfig": {
|
"RakuConfig": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
@ -5079,7 +5572,7 @@
|
|||||||
},
|
},
|
||||||
"detect_files": {
|
"detect_files": {
|
||||||
"default": [
|
"default": [
|
||||||
".Rprofile"
|
"DESCRIPTION"
|
||||||
],
|
],
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
@ -5290,6 +5783,12 @@
|
|||||||
"default": "psh",
|
"default": "psh",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
|
"pwsh_indicator": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
"ion_indicator": {
|
"ion_indicator": {
|
||||||
"default": "ion",
|
"default": "ion",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
@ -5510,6 +6009,18 @@
|
|||||||
"default": "bold red",
|
"default": "bold red",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
|
"success_style": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"failure_style": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
"map_symbol": {
|
"map_symbol": {
|
||||||
"default": false,
|
"default": false,
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
@ -5527,7 +6038,7 @@
|
|||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"pipestatus_format": {
|
"pipestatus_format": {
|
||||||
"default": "\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)",
|
"default": "\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) ",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"pipestatus_segment_format": {
|
"pipestatus_segment_format": {
|
||||||
@ -5709,9 +6220,67 @@
|
|||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
},
|
},
|
||||||
|
"TypstConfig": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"format": {
|
||||||
|
"default": "via [$symbol($version )]($style)",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"version_format": {
|
||||||
|
"default": "v${raw}",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"symbol": {
|
||||||
|
"default": "t ",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"style": {
|
||||||
|
"default": "bold #0093A7",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"disabled": {
|
||||||
|
"default": false,
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"detect_extensions": {
|
||||||
|
"default": [
|
||||||
|
"typ"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_files": {
|
||||||
|
"default": [
|
||||||
|
"template.typ"
|
||||||
|
],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"detect_folders": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
"UsernameConfig": {
|
"UsernameConfig": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
"detect_env_vars": {
|
||||||
|
"default": [],
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
"format": {
|
"format": {
|
||||||
"default": "[$user]($style) in ",
|
"default": "[$user]($style) in ",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
@ -5731,6 +6300,13 @@
|
|||||||
"disabled": {
|
"disabled": {
|
||||||
"default": false,
|
"default": false,
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"aliases": {
|
||||||
|
"default": {},
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@ -5991,6 +6567,10 @@
|
|||||||
"ignore_timeout": {
|
"ignore_timeout": {
|
||||||
"default": false,
|
"default": false,
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"unsafe_no_escape": {
|
||||||
|
"default": false,
|
||||||
|
"type": "boolean"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
|
14
.github/renovate.json5
vendored
14
.github/renovate.json5
vendored
@ -16,6 +16,12 @@
|
|||||||
"semanticCommitType": "build",
|
"semanticCommitType": "build",
|
||||||
"rangeStrategy": "bump",
|
"rangeStrategy": "bump",
|
||||||
"rebaseWhen": "conflicted",
|
"rebaseWhen": "conflicted",
|
||||||
|
"lockFileMaintenance": {
|
||||||
|
"enabled": true,
|
||||||
|
"extends": ["schedule:weekly"],
|
||||||
|
"groupName": "lockfile maintenance",
|
||||||
|
"automerge": true
|
||||||
|
},
|
||||||
"packageRules": [
|
"packageRules": [
|
||||||
// group updates to related packages
|
// group updates to related packages
|
||||||
{
|
{
|
||||||
@ -52,14 +58,6 @@
|
|||||||
"groupName": "npm",
|
"groupName": "npm",
|
||||||
"matchDatasources": ["npm"],
|
"matchDatasources": ["npm"],
|
||||||
"extends": ["schedule:weekly"]
|
"extends": ["schedule:weekly"]
|
||||||
},
|
|
||||||
// Update (rust) lockfiles weekly
|
|
||||||
{
|
|
||||||
"matchDatasources": ["crate"],
|
|
||||||
"lockFileMaintenance": {
|
|
||||||
"enabled": true,
|
|
||||||
"extends": ["schedule:weekly"]
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
// custom regex update managers
|
// custom regex update managers
|
||||||
|
58
.github/workflows/format-workflow.yml
vendored
58
.github/workflows/format-workflow.yml
vendored
@ -12,7 +12,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
- name: Docs | Format
|
- name: Docs | Format
|
||||||
uses: dprint/check@v2.2
|
uses: dprint/check@v2.2
|
||||||
|
|
||||||
@ -22,21 +22,59 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
- name: Install | Taplo
|
- name: Install | Taplo
|
||||||
run: cargo install --debug --locked --version 0.8.1 taplo-cli
|
run: cargo install --debug --locked --version 0.9.0 taplo-cli
|
||||||
- name: Presets | Validate with schema
|
- name: Presets | Validate with schema
|
||||||
run: taplo lint --schema "file://${GITHUB_WORKSPACE}/.github/config-schema.json" docs/.vuepress/public/presets/toml/*.toml
|
run: taplo lint --schema "file://${GITHUB_WORKSPACE}/.github/config-schema.json" docs/public/presets/toml/*.toml
|
||||||
|
|
||||||
# If this is not a Crowdin PR, block changes to translated documentation
|
# If this is not a Crowdin PR, block changes to translated documentation
|
||||||
block-crowdin:
|
block-crowdin:
|
||||||
name: Block Translated Changes
|
name: Block Translated Changes
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
if: ${{ github.event_name == 'pull_request' }}
|
if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref != 'i18n_master' }}
|
||||||
steps:
|
steps:
|
||||||
- name: Prevent File Change
|
- name: Setup | Checkout
|
||||||
uses: xalvarez/prevent-file-change-action@v1.4.0
|
uses: actions/checkout@v4
|
||||||
if: ${{ github.event.pull_request.head.ref != 'i18n_master' }}
|
|
||||||
with:
|
with:
|
||||||
githubToken: ${{ secrets.GITHUB_TOKEN }}
|
fetch-depth: 0
|
||||||
pattern: docs/[a-z][a-z][a-z]?-[A-Z][A-Z]?/.*
|
- name: Prevent File Change
|
||||||
|
uses: actions/github-script@v7
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const { execSync } = require('child_process');
|
||||||
|
const pattern = /^docs\/[a-z][a-z][a-z]?-[A-Z][A-Z]?\/.*$/;
|
||||||
|
const base = context.payload.pull_request.base.sha;
|
||||||
|
const head = context.payload.pull_request.head.sha;
|
||||||
|
|
||||||
|
const result = execSync(`git diff --name-only ${base} ${head}`).toString().split('\n');
|
||||||
|
|
||||||
|
for (const file of result) {
|
||||||
|
if (pattern.test(file)) {
|
||||||
|
core.setFailed(`To avoid conflicts, changes to the translated documentation are only allowed via Crowdin at https://translate.starship.rs.`);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Vitepress build
|
||||||
|
vitepress:
|
||||||
|
name: Vitepress [Build]
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Setup | Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup | Node
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
cache: 'npm'
|
||||||
|
cache-dependency-path: docs/package-lock.json
|
||||||
|
|
||||||
|
- name: Setup | Install dependencies
|
||||||
|
run: npm install
|
||||||
|
working-directory: docs
|
||||||
|
|
||||||
|
- name: Build | Build docs site
|
||||||
|
run: npm run build
|
||||||
|
working-directory: docs
|
||||||
|
8
.github/workflows/publish-docs.yml
vendored
8
.github/workflows/publish-docs.yml
vendored
@ -7,12 +7,12 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup | Node
|
- name: Setup | Node
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v4
|
||||||
with:
|
with:
|
||||||
node-version: 16
|
node-version: 20
|
||||||
cache: 'npm'
|
cache: 'npm'
|
||||||
cache-dependency-path: docs/package-lock.json
|
cache-dependency-path: docs/package-lock.json
|
||||||
|
|
||||||
@ -27,7 +27,7 @@ jobs:
|
|||||||
- name: Publish
|
- name: Publish
|
||||||
uses: netlify/actions/cli@master
|
uses: netlify/actions/cli@master
|
||||||
with:
|
with:
|
||||||
args: deploy --prod --dir=docs/.vuepress/dist
|
args: deploy --prod --dir=docs/.vitepress/dist
|
||||||
env:
|
env:
|
||||||
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
|
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
|
||||||
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||||
|
95
.github/workflows/release.yml
vendored
95
.github/workflows/release.yml
vendored
@ -20,12 +20,11 @@ jobs:
|
|||||||
release_created: ${{ steps.release.outputs.release_created }}
|
release_created: ${{ steps.release.outputs.release_created }}
|
||||||
tag_name: ${{ steps.release.outputs.tag_name }}
|
tag_name: ${{ steps.release.outputs.tag_name }}
|
||||||
steps:
|
steps:
|
||||||
- uses: google-github-actions/release-please-action@v3
|
- uses: google-github-actions/release-please-action@v4
|
||||||
id: release
|
id: release
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
release-type: rust
|
release-type: rust
|
||||||
draft: true
|
|
||||||
|
|
||||||
# Build sources for every OS
|
# Build sources for every OS
|
||||||
github_build:
|
github_build:
|
||||||
@ -57,11 +56,11 @@ jobs:
|
|||||||
name: starship-arm-unknown-linux-musleabihf.tar.gz
|
name: starship-arm-unknown-linux-musleabihf.tar.gz
|
||||||
|
|
||||||
- target: x86_64-apple-darwin
|
- target: x86_64-apple-darwin
|
||||||
os: macOS-11
|
os: macos-latest
|
||||||
name: starship-x86_64-apple-darwin.tar.gz
|
name: starship-x86_64-apple-darwin.tar.gz
|
||||||
|
|
||||||
- target: aarch64-apple-darwin
|
- target: aarch64-apple-darwin
|
||||||
os: macOS-11
|
os: macos-latest
|
||||||
name: starship-aarch64-apple-darwin.tar.gz
|
name: starship-aarch64-apple-darwin.tar.gz
|
||||||
|
|
||||||
- target: x86_64-pc-windows-msvc
|
- target: x86_64-pc-windows-msvc
|
||||||
@ -89,7 +88,7 @@ jobs:
|
|||||||
RUSTFLAGS: ${{ matrix.rustflags || '' }}
|
RUSTFLAGS: ${{ matrix.rustflags || '' }}
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup | Rust
|
- name: Setup | Rust
|
||||||
uses: dtolnay/rust-toolchain@master
|
uses: dtolnay/rust-toolchain@master
|
||||||
@ -99,8 +98,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Setup | Install cargo-wix [Windows]
|
- name: Setup | Install cargo-wix [Windows]
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
# aarch64 is only supported in wix 4.0 development builds
|
if: matrix.os == 'windows-latest'
|
||||||
if: matrix.os == 'windows-latest' && matrix.target != 'aarch64-pc-windows-msvc'
|
|
||||||
run: cargo install --version 0.3.4 cargo-wix
|
run: cargo install --version 0.3.4 cargo-wix
|
||||||
env:
|
env:
|
||||||
# cargo-wix does not require static crt
|
# cargo-wix does not require static crt
|
||||||
@ -120,11 +118,35 @@ jobs:
|
|||||||
|
|
||||||
- name: Build | Installer [Windows]
|
- name: Build | Installer [Windows]
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
if: matrix.os == 'windows-latest' && matrix.target != 'aarch64-pc-windows-msvc'
|
if: matrix.os == 'windows-latest'
|
||||||
run: >
|
run: >
|
||||||
cargo wix -v --no-build --nocapture -I install/windows/main.wxs
|
cargo wix -v --no-build --nocapture -I install/windows/main.wxs
|
||||||
--target ${{ matrix.target }}
|
--target ${{ matrix.target }}
|
||||||
--output target/wix/starship-${{ matrix.target }}.msi
|
--output target/${{ matrix.target }}/release/starship-${{ matrix.target }}.msi
|
||||||
|
|
||||||
|
- name: Sign | Upload [Windows]
|
||||||
|
continue-on-error: true
|
||||||
|
if: matrix.os == 'windows-latest'
|
||||||
|
id: unsigned-artifacts
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: unsigned-${{ matrix.name }}
|
||||||
|
path: |
|
||||||
|
target/${{ matrix.target }}/release/starship.exe
|
||||||
|
target/${{ matrix.target }}/release/starship-${{ matrix.target }}.msi
|
||||||
|
|
||||||
|
- name: Sign | Sign [Windows]
|
||||||
|
continue-on-error: true
|
||||||
|
if: matrix.os == 'windows-latest'
|
||||||
|
uses: signpath/github-action-submit-signing-request@v1
|
||||||
|
with:
|
||||||
|
api-token: '${{ secrets.SIGNPATH_API_TOKEN }}'
|
||||||
|
organization-id: '${{ vars.SIGNPATH_ORGANIZATION_ID }}'
|
||||||
|
project-slug: 'starship'
|
||||||
|
github-artifact-id: '${{ steps.unsigned-artifacts.outputs.artifact-id }}'
|
||||||
|
signing-policy-slug: 'release-signing'
|
||||||
|
wait-for-completion: true
|
||||||
|
output-artifact-directory: 'target/${{ matrix.target }}/release'
|
||||||
|
|
||||||
- name: Post Build | Prepare artifacts [Windows]
|
- name: Post Build | Prepare artifacts [Windows]
|
||||||
if: matrix.os == 'windows-latest'
|
if: matrix.os == 'windows-latest'
|
||||||
@ -141,18 +163,18 @@ jobs:
|
|||||||
cd -
|
cd -
|
||||||
|
|
||||||
- name: Release | Upload artifacts
|
- name: Release | Upload artifacts
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: ${{ matrix.name }}
|
name: ${{ matrix.name }}
|
||||||
path: ${{ matrix.name }}
|
path: ${{ matrix.name }}
|
||||||
|
|
||||||
- name: Release | Upload installer artifacts [Windows]
|
- name: Release | Upload installer artifacts [Windows]
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
if: matrix.os == 'windows-latest' && matrix.target != 'aarch64-pc-windows-msvc'
|
if: matrix.os == 'windows-latest'
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: starship-${{ matrix.target }}.msi
|
name: starship-${{ matrix.target }}.msi
|
||||||
path: target/wix/starship-${{ matrix.target }}.msi
|
path: target/${{ matrix.target }}/release/starship-${{ matrix.target }}.msi
|
||||||
|
|
||||||
# Notarize starship binaries for MacOS and build notarized pkg installers
|
# Notarize starship binaries for MacOS and build notarized pkg installers
|
||||||
notarize_and_pkgbuild:
|
notarize_and_pkgbuild:
|
||||||
@ -179,7 +201,7 @@ jobs:
|
|||||||
STARSHIP_VERSION: ${{ needs.release_please.outputs.tag_name }}
|
STARSHIP_VERSION: ${{ needs.release_please.outputs.tag_name }}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
# Required to include the recently merged Crowdin PR
|
# Required to include the recently merged Crowdin PR
|
||||||
ref: master
|
ref: master
|
||||||
@ -215,6 +237,11 @@ jobs:
|
|||||||
# Add Apple Developer ID credentials to keychain
|
# Add Apple Developer ID credentials to keychain
|
||||||
xcrun notarytool store-credentials "$KEYCHAIN_ENTRY" --team-id "$APPLEID_TEAMID" --apple-id "$APPLEID_USERNAME" --password "$APPLEID_PASSWORD" --keychain "$KEYCHAIN_PATH"
|
xcrun notarytool store-credentials "$KEYCHAIN_ENTRY" --team-id "$APPLEID_TEAMID" --apple-id "$APPLEID_USERNAME" --password "$APPLEID_PASSWORD" --keychain "$KEYCHAIN_PATH"
|
||||||
|
|
||||||
|
- name: Setup | Node
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 20
|
||||||
|
|
||||||
- name: Notarize | Build docs
|
- name: Notarize | Build docs
|
||||||
run: |
|
run: |
|
||||||
cd docs
|
cd docs
|
||||||
@ -222,7 +249,7 @@ jobs:
|
|||||||
npm run build
|
npm run build
|
||||||
|
|
||||||
- name: Notarize | Download artifacts
|
- name: Notarize | Download artifacts
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: ${{ matrix.name }}
|
name: ${{ matrix.name }}
|
||||||
path: artifacts
|
path: artifacts
|
||||||
@ -234,7 +261,7 @@ jobs:
|
|||||||
run: bash install/macos_packages/build_and_notarize.sh starship docs ${{ matrix.arch }} ${{ matrix.pkgname }}
|
run: bash install/macos_packages/build_and_notarize.sh starship docs ${{ matrix.arch }} ${{ matrix.pkgname }}
|
||||||
|
|
||||||
- name: Notarize | Upload Notarized Flat Installer
|
- name: Notarize | Upload Notarized Flat Installer
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: ${{ matrix.pkgname }}
|
name: ${{ matrix.pkgname }}
|
||||||
path: ${{ matrix.pkgname }}
|
path: ${{ matrix.pkgname }}
|
||||||
@ -243,10 +270,11 @@ jobs:
|
|||||||
run: tar czvf ${{ matrix.name }} starship
|
run: tar czvf ${{ matrix.name }} starship
|
||||||
|
|
||||||
- name: Notarize | Upload Notarized Binary
|
- name: Notarize | Upload Notarized Binary
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: ${{ matrix.name }}
|
name: ${{ matrix.name }}
|
||||||
path: ${{ matrix.name }}
|
path: ${{ matrix.name }}
|
||||||
|
overwrite: true
|
||||||
|
|
||||||
- name: Cleanup Secrets
|
- name: Cleanup Secrets
|
||||||
if: ${{ always() }}
|
if: ${{ always() }}
|
||||||
@ -261,7 +289,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Artifacts
|
- name: Setup | Artifacts
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v4
|
||||||
|
|
||||||
- name: Setup | Checksums
|
- name: Setup | Checksums
|
||||||
run: for file in starship-*/starship-*; do openssl dgst -sha256 -r "$file" | awk '{print $1}' > "${file}.sha256"; done
|
run: for file in starship-*/starship-*; do openssl dgst -sha256 -r "$file" | awk '{print $1}' > "${file}.sha256"; done
|
||||||
@ -272,7 +300,7 @@ jobs:
|
|||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
- name: Build | Add Artifacts to Release
|
- name: Build | Add Artifacts to Release
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v2
|
||||||
with:
|
with:
|
||||||
files: starship-*/starship-*
|
files: starship-*/starship-*
|
||||||
tag_name: ${{ needs.release_please.outputs.tag_name }}
|
tag_name: ${{ needs.release_please.outputs.tag_name }}
|
||||||
@ -285,7 +313,7 @@ jobs:
|
|||||||
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup | Rust
|
- name: Setup | Rust
|
||||||
uses: dtolnay/rust-toolchain@stable
|
uses: dtolnay/rust-toolchain@stable
|
||||||
@ -299,7 +327,7 @@ jobs:
|
|||||||
needs: [release_please, upload_artifacts]
|
needs: [release_please, upload_artifacts]
|
||||||
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
||||||
steps:
|
steps:
|
||||||
- uses: mislav/bump-homebrew-formula-action@v3.1
|
- uses: mislav/bump-homebrew-formula-action@v3.2
|
||||||
with:
|
with:
|
||||||
formula-name: starship
|
formula-name: starship
|
||||||
tag-name: ${{ needs.release_please.outputs.tag_name }}
|
tag-name: ${{ needs.release_please.outputs.tag_name }}
|
||||||
@ -315,13 +343,22 @@ jobs:
|
|||||||
needs: [release_please, github_build, upload_artifacts]
|
needs: [release_please, github_build, upload_artifacts]
|
||||||
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
||||||
env:
|
env:
|
||||||
URL_64: https://github.com/starship/starship/releases/download/${{ needs.release_please.outputs.tag_name }}/starship-x86_64-pc-windows-msvc.msi
|
URL_64: https://github.com/starship/starship/releases/download/${{ needs.release_please.outputs.tag_name }}/starship-x86_64-pc-windows-msvc
|
||||||
URL_32: https://github.com/starship/starship/releases/download/${{ needs.release_please.outputs.tag_name }}/starship-i686-pc-windows-msvc.msi
|
URL_32: https://github.com/starship/starship/releases/download/${{ needs.release_please.outputs.tag_name }}/starship-i686-pc-windows-msvc
|
||||||
|
URL_ARM: https://github.com/starship/starship/releases/download/${{ needs.release_please.outputs.tag_name }}/starship-aarch64-pc-windows-msvc
|
||||||
steps:
|
steps:
|
||||||
|
# Publishing will fail if the repo is too far behind the upstream
|
||||||
|
- run: gh repo sync matchai/winget-pkgs
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GH_PAT }}
|
||||||
- run: |
|
- run: |
|
||||||
$version = '${{ needs.release_please.outputs.tag_name }}'.replace('v', '')
|
$version = '${{ needs.release_please.outputs.tag_name }}'.replace('v', '')
|
||||||
iwr https://aka.ms/wingetcreate/latest -OutFile wingetcreate.exe
|
iwr https://aka.ms/wingetcreate/latest -OutFile wingetcreate.exe
|
||||||
./wingetcreate.exe update Starship.Starship -s -v $version -u $env:URL_64 $env:URL_32 -t ${{ secrets.GH_PAT }}
|
./wingetcreate.exe update Starship.Starship -s -v $version `
|
||||||
|
-u ${{ env.URL_64 }}.msi ${{ env.URL_64 }}.zip `
|
||||||
|
${{ env.URL_32 }}.msi ${{ env.URL_32 }}.zip `
|
||||||
|
${{ env.URL_ARM }}.msi ${{ env.URL_ARM }}.zip `
|
||||||
|
-t ${{ secrets.GH_PAT }}
|
||||||
|
|
||||||
choco_update:
|
choco_update:
|
||||||
name: Update Chocolatey Package
|
name: Update Chocolatey Package
|
||||||
@ -330,9 +367,9 @@ jobs:
|
|||||||
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
if: ${{ needs.release_please.outputs.release_created == 'true' }}
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
- name: Setup | Artifacts
|
- name: Setup | Artifacts
|
||||||
uses: actions/download-artifact@v3
|
uses: actions/download-artifact@v4
|
||||||
- run: pwsh ./install/windows/choco/update.ps1
|
- run: pwsh ./install/windows/choco/update.ps1
|
||||||
env:
|
env:
|
||||||
STARSHIP_VERSION: ${{ needs.release_please.outputs.tag_name }}
|
STARSHIP_VERSION: ${{ needs.release_please.outputs.tag_name }}
|
||||||
@ -346,11 +383,11 @@ jobs:
|
|||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
- name: Merge | Merge Crowdin PR
|
- name: Merge | Merge Crowdin PR
|
||||||
run: gh pr merge i18n_master --squash --repo=starship/starship
|
run: gh pr merge i18n_master --squash --repo=starship/starship
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GH_PAT }}
|
||||||
|
|
||||||
publish_docs:
|
publish_docs:
|
||||||
name: Trigger docs deployment
|
name: Trigger docs deployment
|
||||||
@ -358,7 +395,7 @@ jobs:
|
|||||||
needs: merge_crowdin_pr
|
needs: merge_crowdin_pr
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
- name: Trigger workflow dispatch
|
- name: Trigger workflow dispatch
|
||||||
run: gh workflow run publish-docs.yml
|
run: gh workflow run publish-docs.yml
|
||||||
env:
|
env:
|
||||||
|
4
.github/workflows/security-audit.yml
vendored
4
.github/workflows/security-audit.yml
vendored
@ -22,8 +22,8 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
- name: Test | Security Audit
|
- name: Test | Security Audit
|
||||||
uses: EmbarkStudios/cargo-deny-action@v1.5.5
|
uses: EmbarkStudios/cargo-deny-action@v2.0.4
|
||||||
with:
|
with:
|
||||||
command: check ${{ matrix.checks }}
|
command: check ${{ matrix.checks }}
|
||||||
|
4
.github/workflows/spell-check.yml
vendored
4
.github/workflows/spell-check.yml
vendored
@ -6,5 +6,5 @@ jobs:
|
|||||||
name: Spell Check with Typos
|
name: Spell Check with Typos
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
- uses: actions/checkout@v4
|
||||||
- uses: crate-ci/typos@v1.16.22
|
- uses: crate-ci/typos@v1.29.4
|
||||||
|
48
.github/workflows/workflow.yml
vendored
48
.github/workflows/workflow.yml
vendored
@ -24,7 +24,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup | Rust
|
- name: Setup | Rust
|
||||||
uses: dtolnay/rust-toolchain@stable
|
uses: dtolnay/rust-toolchain@stable
|
||||||
@ -43,7 +43,7 @@ jobs:
|
|||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup | Rust
|
- name: Setup | Rust
|
||||||
uses: dtolnay/rust-toolchain@stable
|
uses: dtolnay/rust-toolchain@stable
|
||||||
@ -54,7 +54,7 @@ jobs:
|
|||||||
uses: Swatinem/rust-cache@v2
|
uses: Swatinem/rust-cache@v2
|
||||||
|
|
||||||
- name: Build | Lint
|
- name: Build | Lint
|
||||||
uses: giraffate/clippy-action@871cc4173f2594435c7ea6b0bce499cf6c2164a1
|
uses: giraffate/clippy-action@94e9bd8deab2618756ec5380f12eb35bcb0a88ca
|
||||||
|
|
||||||
# Ensure that the project could be successfully compiled
|
# Ensure that the project could be successfully compiled
|
||||||
cargo_check:
|
cargo_check:
|
||||||
@ -62,7 +62,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup | Rust
|
- name: Setup | Rust
|
||||||
uses: dtolnay/rust-toolchain@stable
|
uses: dtolnay/rust-toolchain@stable
|
||||||
@ -80,7 +80,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup | Rust
|
- name: Setup | Rust
|
||||||
uses: dtolnay/rust-toolchain@stable
|
uses: dtolnay/rust-toolchain@stable
|
||||||
@ -98,7 +98,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup | Rust
|
- name: Setup | Rust
|
||||||
uses: dtolnay/rust-toolchain@stable
|
uses: dtolnay/rust-toolchain@stable
|
||||||
@ -120,7 +120,7 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup | Rust
|
- name: Setup | Rust
|
||||||
uses: dtolnay/rust-toolchain@stable
|
uses: dtolnay/rust-toolchain@stable
|
||||||
@ -132,7 +132,7 @@ jobs:
|
|||||||
run: cargo run --locked --features config-schema -- config-schema > .github/config-schema.json
|
run: cargo run --locked --features config-schema -- config-schema > .github/config-schema.json
|
||||||
|
|
||||||
- name: Check | Detect Changes
|
- name: Check | Detect Changes
|
||||||
uses: reviewdog/action-suggester@v1.8.0
|
uses: reviewdog/action-suggester@v1.19.0
|
||||||
with:
|
with:
|
||||||
tool_name: starship config-schema
|
tool_name: starship config-schema
|
||||||
filter_mode: nofilter
|
filter_mode: nofilter
|
||||||
@ -156,7 +156,7 @@ jobs:
|
|||||||
RUSTFLAGS: ${{ matrix.rustflags || '' }}
|
RUSTFLAGS: ${{ matrix.rustflags || '' }}
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
# Install all the required dependencies for testing
|
# Install all the required dependencies for testing
|
||||||
- name: Setup | Rust
|
- name: Setup | Rust
|
||||||
@ -201,7 +201,9 @@ jobs:
|
|||||||
- name: Build | Installer [Windows]
|
- name: Build | Installer [Windows]
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
if: matrix.os == 'windows-latest' && matrix.rust == 'stable'
|
if: matrix.os == 'windows-latest' && matrix.rust == 'stable'
|
||||||
run: cargo wix --dbg-build -v --nocapture -I install/windows/main.wxs
|
run: >
|
||||||
|
cargo wix --dbg-build -v --nocapture -I install/windows/main.wxs
|
||||||
|
--output target/debug/starship-x86_64-pc-windows-msvc.msi
|
||||||
|
|
||||||
- name: Build | Chocolatey Package [Windows]
|
- name: Build | Chocolatey Package [Windows]
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
@ -219,8 +221,32 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
STARSHIP_VERSION: v1.2.3
|
STARSHIP_VERSION: v1.2.3
|
||||||
|
|
||||||
|
- name: Sign | Upload Executable [Windows]
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
continue-on-error: true
|
||||||
|
id: unsigned-artifacts
|
||||||
|
if: matrix.os == 'windows-latest' && matrix.rust == 'stable' && github.event_name == 'push' && github.repository == 'starship/starship'
|
||||||
|
with:
|
||||||
|
name: unsigned-artifacts-dbg
|
||||||
|
path: |
|
||||||
|
target/debug/starship.exe
|
||||||
|
target/debug/starship-x86_64-pc-windows-msvc.msi
|
||||||
|
|
||||||
|
- name: Sign | Sign [Windows]
|
||||||
|
uses: signpath/github-action-submit-signing-request@v1
|
||||||
|
continue-on-error: true
|
||||||
|
if: matrix.os == 'windows-latest' && matrix.rust == 'stable' && github.event_name == 'push' && github.repository == 'starship/starship'
|
||||||
|
with:
|
||||||
|
api-token: '${{ secrets.SIGNPATH_API_TOKEN }}'
|
||||||
|
organization-id: '${{ vars.SIGNPATH_ORGANIZATION_ID }}'
|
||||||
|
project-slug: 'starship'
|
||||||
|
github-artifact-id: '${{ steps.unsigned-artifacts.outputs.artifact-id }}'
|
||||||
|
signing-policy-slug: 'test-signing'
|
||||||
|
wait-for-completion: true
|
||||||
|
output-artifact-directory: target/debug
|
||||||
|
|
||||||
- name: Upload coverage to Codecov
|
- name: Upload coverage to Codecov
|
||||||
uses: codecov/codecov-action@v3
|
uses: codecov/codecov-action@v5
|
||||||
if: github.repository == 'starship/starship'
|
if: github.repository == 'starship/starship'
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
token: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
5
.gitignore
vendored
5
.gitignore
vendored
@ -27,7 +27,8 @@ Cargo.lock
|
|||||||
|
|
||||||
# Compiled files for documentation
|
# Compiled files for documentation
|
||||||
docs/node_modules
|
docs/node_modules
|
||||||
docs/.vuepress/dist/
|
docs/.vitepress/dist/
|
||||||
|
docs/.vitepress/cache/
|
||||||
|
|
||||||
# Ignore pkg files within the install directory
|
# Ignore pkg files within the install directory
|
||||||
install/**/*.pkg
|
install/**/*.pkg
|
||||||
|
221
CHANGELOG.md
221
CHANGELOG.md
@ -1,5 +1,226 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [1.22.1](https://github.com/starship/starship/compare/v1.22.0...v1.22.1) (2025-01-11)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **windows:** downgrade libz-ng-sys ([#6489](https://github.com/starship/starship/issues/6489)) ([6f7c67b](https://github.com/starship/starship/commit/6f7c67b4858b755c19754a2ec1063502545a16b6))
|
||||||
|
|
||||||
|
## [1.22.0](https://github.com/starship/starship/compare/v1.21.1...v1.22.0) (2025-01-11)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **battery:** Use best match instead of first match for `battery.display` threshold ([#6442](https://github.com/starship/starship/issues/6442)) ([2690a32](https://github.com/starship/starship/commit/2690a329cf9a6b4a160d024674193007fb292e1a))
|
||||||
|
* **bun:** Detect bun using new text-format lockfile ([#6441](https://github.com/starship/starship/issues/6441)) ([2df521c](https://github.com/starship/starship/commit/2df521c69b0b1400edee7b7b332b5e2a900c7775))
|
||||||
|
* **direnv:** allow direnv to detect environment variables ([#6196](https://github.com/starship/starship/issues/6196)) ([4593716](https://github.com/starship/starship/commit/45937166c8b3cb53f09b29c65d0f547aa7f2f022))
|
||||||
|
* **status:** add `{success,failure}_style` options ([#6269](https://github.com/starship/starship/issues/6269)) ([e21775c](https://github.com/starship/starship/commit/e21775c694a81cf092eafa3c9a7b169ae9c8ebf2))
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **fish:** restore support for fish <v3.4.0 ([#6337](https://github.com/starship/starship/issues/6337)) ([85d3fb2](https://github.com/starship/starship/commit/85d3fb2e2ab96e639fe6b67ba1afbb94b6c5b83e))
|
||||||
|
* handle variable bash $SHLVL behavior with explicit option ([#4912](https://github.com/starship/starship/issues/4912)) ([7ead2b5](https://github.com/starship/starship/commit/7ead2b55eb58a878dc3ea8d87204f84862bd8148))
|
||||||
|
* **hostname:** use DNS instead of NetBIOS name on Windows ([#6343](https://github.com/starship/starship/issues/6343)) ([43f097e](https://github.com/starship/starship/commit/43f097eae838c1fba52659113826669802081918))
|
||||||
|
* **init/pwsh:** preserve ViModeChangeHandler ([#6225](https://github.com/starship/starship/issues/6225)) ([9b6d394](https://github.com/starship/starship/commit/9b6d394e01d50db4395cfe402531bfd96c540462))
|
||||||
|
* **init:** do not use cygpath for elvish ([#6376](https://github.com/starship/starship/issues/6376)) ([576aa14](https://github.com/starship/starship/commit/576aa14d15f57abf7d1c28e3486f2682e45c2f62))
|
||||||
|
* **status:** add trailing space to `pipestatus_format` ([#6404](https://github.com/starship/starship/issues/6404)) ([8a38b8f](https://github.com/starship/starship/commit/8a38b8f6f19fa6f17098e32f22183beac0498764))
|
||||||
|
* **username:** avoid using `whoami` on android ([#6342](https://github.com/starship/starship/issues/6342)) ([af5d139](https://github.com/starship/starship/commit/af5d139060bbb60690196dc53e05424ac3c0fb5d)), closes [#6340](https://github.com/starship/starship/issues/6340)
|
||||||
|
|
||||||
|
## [1.21.1](https://github.com/starship/starship/compare/v1.21.0...v1.21.1) (2024-10-18)
|
||||||
|
|
||||||
|
|
||||||
|
### Reverts
|
||||||
|
|
||||||
|
* "perf(fish): Skip unnecessary indirection in starship init fish" ([#6326](https://github.com/starship/starship/issues/6326)) ([00d927b](https://github.com/starship/starship/commit/00d927bb20e618b587635876d2e10047f98eff88))
|
||||||
|
|
||||||
|
## [1.21.0](https://github.com/starship/starship/compare/v1.20.1...v1.21.0) (2024-10-17)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **deno:** add `deno.lock` file to default `detect_files` list ([#6310](https://github.com/starship/starship/issues/6310)) ([22c6c52](https://github.com/starship/starship/commit/22c6c5201d8fa682ad43501cf46427263a530c71))
|
||||||
|
* **hostname:** add option to replace hostnames with aliases ([#6097](https://github.com/starship/starship/issues/6097)) ([68a8fc9](https://github.com/starship/starship/commit/68a8fc9563a52c4119241375d181ff68bb3d3da3))
|
||||||
|
* **mojo:** add module for Mojo language ([#6108](https://github.com/starship/starship/issues/6108)) ([171746a](https://github.com/starship/starship/commit/171746a58408cbc0d48dedc52e21327bd35fccd4))
|
||||||
|
* **package:** support alternative gradle module version syntax ([#6079](https://github.com/starship/starship/issues/6079)) ([a62012e](https://github.com/starship/starship/commit/a62012e3280238b4c794bbe484b296af3b8fb53a))
|
||||||
|
* **python:** Add detect env vars option ([#4486](https://github.com/starship/starship/issues/4486)) ([8a2d944](https://github.com/starship/starship/commit/8a2d944bc80a0a8358c30e639e8af51c1d45d973))
|
||||||
|
* **python:** detect pixi and ipynb files ([#6228](https://github.com/starship/starship/issues/6228)) ([36134d8](https://github.com/starship/starship/commit/36134d896bda3c739ffd6555be62499716b0a9b0))
|
||||||
|
* **release:** codesign windows release binaries ([#6273](https://github.com/starship/starship/issues/6273)) ([fcc697b](https://github.com/starship/starship/commit/fcc697b9b31aef44aefaf9a6660d51d44f707149))
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **bash:** fix variable leak in Bash integration ([#6143](https://github.com/starship/starship/issues/6143)) ([e1189ed](https://github.com/starship/starship/commit/e1189ed7567de580d8f51c8baf870056a6060789))
|
||||||
|
* **cmd_duration:** Make render_time format more consistent ([#5825](https://github.com/starship/starship/issues/5825)) ([4abea6b](https://github.com/starship/starship/commit/4abea6b601c53adfa5719a7aac11069dc054cdf8))
|
||||||
|
* **docker_context:** Ignore Docker Desktop "desktop-linux" context. ([#6314](https://github.com/starship/starship/issues/6314)) ([14babde](https://github.com/starship/starship/commit/14babde435f6307a8a28f9d323f0d66a319e9eab))
|
||||||
|
* **docs:** correct username options ([#6084](https://github.com/starship/starship/issues/6084)) ([d96fbc5](https://github.com/starship/starship/commit/d96fbc5bcb9c039f875c4a55cff31edda57d5e6e))
|
||||||
|
* **fish:** add missing arguments for fish transient prompt functions ([#6181](https://github.com/starship/starship/issues/6181)) ([d6814be](https://github.com/starship/starship/commit/d6814be0ba35dd52f6f0d0e1a3f14d5f106efd63)), closes [#6180](https://github.com/starship/starship/issues/6180)
|
||||||
|
* **fish:** improve fish transient prompt ([#6107](https://github.com/starship/starship/issues/6107)) ([274dff3](https://github.com/starship/starship/commit/274dff37dbb375821a90d6976a11cf57d9386e4f))
|
||||||
|
* **fish:** use correct input function in transient execute ([#6265](https://github.com/starship/starship/issues/6265)) ([244c2c6](https://github.com/starship/starship/commit/244c2c629e1f358bf849923531d5cf0d69c2db2d))
|
||||||
|
* Fixed "Click to download TOML" links ([#6234](https://github.com/starship/starship/issues/6234)) ([0200d75](https://github.com/starship/starship/commit/0200d75b3781977d5335e637858f4e0996ee0384))
|
||||||
|
* **git_status:** read proper name for core.fsmonitor flag ([#6173](https://github.com/starship/starship/issues/6173)) ([33b3b8e](https://github.com/starship/starship/commit/33b3b8e3986f6180a8f7b461a5a07fea702ec628))
|
||||||
|
* **package:** support alternative gradle module version syntax ([#6080](https://github.com/starship/starship/issues/6080)) ([a62012e](https://github.com/starship/starship/commit/a62012e3280238b4c794bbe484b296af3b8fb53a))
|
||||||
|
* **python:** improve parsing of `pyvenv.cfg` files ([#6145](https://github.com/starship/starship/issues/6145)) ([7b65ad5](https://github.com/starship/starship/commit/7b65ad51635463003941ec0ecea1d4d315b2df53))
|
||||||
|
* use `whoami` for user/hostname queries again ([#6311](https://github.com/starship/starship/issues/6311)) ([77f0883](https://github.com/starship/starship/commit/77f08832d5228dff6c0e01ba4d4ad206c9d2362f))
|
||||||
|
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* **fish:** Skip unnecessary indirection in starship init fish ([#6253](https://github.com/starship/starship/issues/6253)) ([798f640](https://github.com/starship/starship/commit/798f64033f5348793003ddd74fa0ce1c744c300b))
|
||||||
|
* Skip unnecessary indirection in starship init fish ([798f640](https://github.com/starship/starship/commit/798f64033f5348793003ddd74fa0ce1c744c300b))
|
||||||
|
|
||||||
|
## [1.20.1](https://github.com/starship/starship/compare/v1.20.0...v1.20.1) (2024-07-26)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **ci:** move to macos-latest image ([#6132](https://github.com/starship/starship/issues/6132)) ([c7a8ea7](https://github.com/starship/starship/commit/c7a8ea757033512b5723a39be71bdb91fdcfbdb1))
|
||||||
|
|
||||||
|
## [1.20.0](https://github.com/starship/starship/compare/v1.19.0...v1.20.0) (2024-07-26)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **color:** add prev_fg and prev_bg as color specifiers based on the previous foreground/background colors respectively ([#6017](https://github.com/starship/starship/issues/6017)) ([9a3e87f](https://github.com/starship/starship/commit/9a3e87f2cbaa8ca4b8dea41f4f56ff297e94bb1a))
|
||||||
|
* **color:** add prevfg,prevbg as color specifiers based on the previous foreground/background colors respectively ([9a3e87f](https://github.com/starship/starship/commit/9a3e87f2cbaa8ca4b8dea41f4f56ff297e94bb1a))
|
||||||
|
* **gcloud:** Disabled gcloud module when active config hasn't been set ([#6039](https://github.com/starship/starship/issues/6039)) ([4d36d46](https://github.com/starship/starship/commit/4d36d463b91a245a62c357de308cad3cdec48edf))
|
||||||
|
* **purescript:** add support for spago-next configuration files ([#6036](https://github.com/starship/starship/issues/6036)) ([e028186](https://github.com/starship/starship/commit/e0281868c9d7801fc25f64f86ab8312d2a5a1794))
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **direnv:** replace nonexistent "orange" color with "bright-yellow" ([#5969](https://github.com/starship/starship/issues/5969)) ([478d5cc](https://github.com/starship/starship/commit/478d5cccb6f7f4622dd681756cf004ba92c98607))
|
||||||
|
* **dotnet:** Remove duplicate v in dotnet version ([#6060](https://github.com/starship/starship/issues/6060)) ([52a89a5](https://github.com/starship/starship/commit/52a89a515ed44d861ea556a0bb70d6901660a9b5))
|
||||||
|
* improve non-msvc windows support by bumping stable dependencies ([#5989](https://github.com/starship/starship/issues/5989)) ([50a6b84](https://github.com/starship/starship/commit/50a6b846045899c88d95b063a6b939a6dcb72a5c))
|
||||||
|
* **k8s:** don't trigger if scan config is set but env vars are not ([#5979](https://github.com/starship/starship/issues/5979)) ([8c75822](https://github.com/starship/starship/commit/8c75822d4380e020ebd289a4ef06cd4d31ee5196))
|
||||||
|
* **preset:** fix typo in Open Policy Agent module format string ([#6118](https://github.com/starship/starship/issues/6118)) ([eba9748](https://github.com/starship/starship/commit/eba9748eb1bd9e1802d2a770eb0907cdb73292d6))
|
||||||
|
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* **k8s:** Improve performance of kubeconfig module ([#6032](https://github.com/starship/starship/issues/6032)) ([fae92b2](https://github.com/starship/starship/commit/fae92b29646f73bf1eb843fde80885c58480e85b))
|
||||||
|
|
||||||
|
## [1.19.0](https://github.com/starship/starship/compare/v1.18.2...v1.19.0) (2024-05-15)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **container:** show name if available ([#5195](https://github.com/starship/starship/issues/5195)) ([3e3f18e](https://github.com/starship/starship/commit/3e3f18ef277c9bb3db9f60c964f280c7d981102c))
|
||||||
|
* **gleam:** Add Gleam module ([#5886](https://github.com/starship/starship/issues/5886)) ([34a8f7e](https://github.com/starship/starship/commit/34a8f7e62845fd66df3f6f9003cb850f2b0d9bc5))
|
||||||
|
* **k8s:** Add detect env vars option ([#4488](https://github.com/starship/starship/issues/4488)) ([e3b5dff](https://github.com/starship/starship/commit/e3b5dff3524608328de6ee3cbb390f8c640b0ce0))
|
||||||
|
* **nats:** Add NATS Context ([#5900](https://github.com/starship/starship/issues/5900)) ([5facd85](https://github.com/starship/starship/commit/5facd85da56d28e74878286923f148bc468f71c3))
|
||||||
|
* **odin:** Add Odin Lang module ([#5873](https://github.com/starship/starship/issues/5873)) ([335c514](https://github.com/starship/starship/commit/335c514e9ee5fa5bc8a8294b4804ddf198504b97))
|
||||||
|
* **username:** add aliases option ([#5855](https://github.com/starship/starship/issues/5855)) ([9c1eadd](https://github.com/starship/starship/commit/9c1eaddae154daed9e1d00faac414586f7920013))
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **bash:** fix handling of the preserved DEBUG trap (used in Bash <= 4.3) ([#5908](https://github.com/starship/starship/issues/5908)) ([fe1a8df](https://github.com/starship/starship/commit/fe1a8df6fa5121cc83b288cf054a8ed16631d335))
|
||||||
|
* **bash:** use `eval` instead of a procsub for the POSIX mode ([#5020](https://github.com/starship/starship/issues/5020)) ([0f859e8](https://github.com/starship/starship/commit/0f859e8b61c8ada354f4ea4147fb8752dca02c51))
|
||||||
|
* **bash:** use eval instead of a procsub for the POSIX mode ([0f859e8](https://github.com/starship/starship/commit/0f859e8b61c8ada354f4ea4147fb8752dca02c51))
|
||||||
|
* **bun:** change default icon ([#5880](https://github.com/starship/starship/issues/5880)) ([be4e97c](https://github.com/starship/starship/commit/be4e97c2d9169cbf0bc30e271dd4ba07530dc46f))
|
||||||
|
* **scala:** use scala-cli first to avoid timeout ([2221a88](https://github.com/starship/starship/commit/2221a88f5ada124c657a265b878e37be47998766))
|
||||||
|
* **xonsh:** remove `| cat` workaround from xonsh init ([#5113](https://github.com/starship/starship/issues/5113)) ([de5b7f0](https://github.com/starship/starship/commit/de5b7f041a8c88ecf912b3be3b32d70f76518348))
|
||||||
|
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* **scala:** use scala-cli first to avoid timeout ([#5952](https://github.com/starship/starship/issues/5952)) ([2221a88](https://github.com/starship/starship/commit/2221a88f5ada124c657a265b878e37be47998766))
|
||||||
|
|
||||||
|
## [1.18.2](https://github.com/starship/starship/compare/v1.18.1...v1.18.2) (2024-03-29)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* replace unmaintained crates `yaml-rust`, `dirs-next` ([#5887](https://github.com/starship/starship/issues/5887)) ([796a411](https://github.com/starship/starship/commit/796a411602c9ca4e5103c54247440f4efe892918))
|
||||||
|
|
||||||
|
|
||||||
|
### Reverts
|
||||||
|
|
||||||
|
* "build(deps): update rust crate gix to 0.61.1" ([#5878](https://github.com/starship/starship/issues/5878)) ([eb80dba](https://github.com/starship/starship/commit/eb80dbab99e38b5018aa3fb70b06ae9e4d793b24))
|
||||||
|
|
||||||
|
## [1.18.1](https://github.com/starship/starship/compare/v1.18.0...v1.18.1) (2024-03-24)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **deps:** update rust crate os_info to 3.8.2 ([#5870](https://github.com/starship/starship/issues/5870)) ([d421f63](https://github.com/starship/starship/commit/d421f63785f901caf222941cbfae7cb8c0feec74))
|
||||||
|
* replace all remaining paths referring to vuepress ([#5859](https://github.com/starship/starship/issues/5859)) ([d5861f9](https://github.com/starship/starship/commit/d5861f9f974147d307c319865890cbb3e50dbe5a))
|
||||||
|
|
||||||
|
## [1.18.0](https://github.com/starship/starship/compare/v1.17.1...v1.18.0) (2024-03-21)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* $gemset variable for Ruby module ([#5429](https://github.com/starship/starship/issues/5429)) ([938ea3c](https://github.com/starship/starship/commit/938ea3c40145af68d8e28b2ef0275531f1123202))
|
||||||
|
* **bash:** Support right prompt and transience ([#4902](https://github.com/starship/starship/issues/4902)) ([5ead13d](https://github.com/starship/starship/commit/5ead13d6aa6303c85c562f1b940048cc539667cd))
|
||||||
|
* **bash:** use PS0 for preexec hook ([#5735](https://github.com/starship/starship/issues/5735)) ([ae711c0](https://github.com/starship/starship/commit/ae711c0f332f4f24c843e59d6d5783e398e21b38))
|
||||||
|
* **direnv:** use JSON status with direnv >= 2.33.0 ([#5692](https://github.com/starship/starship/issues/5692)) ([482c7b7](https://github.com/starship/starship/commit/482c7b719fc304fcad5f3572c4551f8ff4179522))
|
||||||
|
* **docs:** move to vitepress ([#5785](https://github.com/starship/starship/issues/5785)) ([7485c90](https://github.com/starship/starship/commit/7485c90c9f7259c026a84dd0335f56860005315d))
|
||||||
|
* **install:** Add version option to install script ([f66bfd9](https://github.com/starship/starship/commit/f66bfd9435f215867681a699428bd882d8c63ce7))
|
||||||
|
* **install:** Add version option to install script ([#5728](https://github.com/starship/starship/issues/5728)) ([f66bfd9](https://github.com/starship/starship/commit/f66bfd9435f215867681a699428bd882d8c63ce7))
|
||||||
|
* **os:** add new os symbols ([#5849](https://github.com/starship/starship/issues/5849)) ([df65b21](https://github.com/starship/starship/commit/df65b2155f92c03d07cabbcee6c92104a878c963))
|
||||||
|
* **quarto:** Add Quarto module ([#5820](https://github.com/starship/starship/issues/5820)) ([0e49f04](https://github.com/starship/starship/commit/0e49f04a6b249090cf3703c5dac041a51e6bf530))
|
||||||
|
* **release:** add winget arm64 push & repo sync ([#5033](https://github.com/starship/starship/issues/5033)) ([aef1a3f](https://github.com/starship/starship/commit/aef1a3f275e7ec9095c4718ecf6a268abfe7794a))
|
||||||
|
* **username:** add detect_env_vars as option ([#5833](https://github.com/starship/starship/issues/5833)) ([b8a812b](https://github.com/starship/starship/commit/b8a812b93207da992ff8ae9f8b955bfa1252072b))
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **bash:** Handle Unbound Variables Errors in Bash ([#4972](https://github.com/starship/starship/issues/4972)) ([7093d5c](https://github.com/starship/starship/commit/7093d5cd84967edba93c9ed412b07519664f6356))
|
||||||
|
* **bash:** improve integration with bash-preexec ([#5734](https://github.com/starship/starship/issues/5734)) ([2aa711c](https://github.com/starship/starship/commit/2aa711ccc7096437e21149b18d1384534bfbcc57))
|
||||||
|
* **character:** also handle vi edit mode in pwsh ([#5775](https://github.com/starship/starship/issues/5775)) ([0891ec2](https://github.com/starship/starship/commit/0891ec27a40421cd742a853885731aed63f412aa))
|
||||||
|
* **direnv:** update to work with direnv v2.33 ([#5657](https://github.com/starship/starship/issues/5657)) ([cec111a](https://github.com/starship/starship/commit/cec111affdaf0a52f72c398f8307cf7e19c7dd8d))
|
||||||
|
* **git_branch:** fall back to "HEAD" when there is no current branch ([#5768](https://github.com/starship/starship/issues/5768)) ([6a96e84](https://github.com/starship/starship/commit/6a96e84a15e3ea598356e4fcad23ac4b2690dd1e))
|
||||||
|
* **nu:** continuation prompt not being displayed correctly ([#5851](https://github.com/starship/starship/issues/5851)) ([d308e91](https://github.com/starship/starship/commit/d308e918ee014f4ca9976683e79e819afd8160f7))
|
||||||
|
* **status:** fix pipestatus width calculation ([#5036](https://github.com/starship/starship/issues/5036)) ([ab84043](https://github.com/starship/starship/commit/ab840439e326a80c53466c7b767d29be0112b9d2)), closes [#3162](https://github.com/starship/starship/issues/3162)
|
||||||
|
* **zsh:** improve starship binary path escaping ([#5574](https://github.com/starship/starship/issues/5574)) ([2bb57cf](https://github.com/starship/starship/commit/2bb57cf0cd6d53194d26f4be96dff5fa14942622))
|
||||||
|
|
||||||
|
## [1.17.1](https://github.com/starship/starship/compare/v1.17.0...v1.17.1) (2024-01-02)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* v1.17.0 post-release fix-ups ([#5660](https://github.com/starship/starship/issues/5660)) ([89dc192](https://github.com/starship/starship/commit/89dc19214bb671fe50a8f1be79a4594e7998ddea))
|
||||||
|
|
||||||
|
|
||||||
|
### Reverts
|
||||||
|
|
||||||
|
* refactor(modules): use whoami crate to get username ([#5669](https://github.com/starship/starship/issues/5669)) ([a83e107](https://github.com/starship/starship/commit/a83e10776ba37bd1ab439e5e4d0125a06e947728))
|
||||||
|
|
||||||
|
## [1.17.0](https://github.com/starship/starship/compare/v1.16.0...v1.17.0) (2023-12-28)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* add additional exit status code meanings from libc ([#5412](https://github.com/starship/starship/issues/5412)) ([81c7d0c](https://github.com/starship/starship/commit/81c7d0cc5805dc10018f0589a6671e1b727a0e9c))
|
||||||
|
* add typst module ([7b21705](https://github.com/starship/starship/commit/7b217056bdb8dcb5b328b51fa3b68fe837f9fb3c))
|
||||||
|
* **aws:** Adding the AWS SSO CLI env variable to profile list ([#5640](https://github.com/starship/starship/issues/5640)) ([6d96df3](https://github.com/starship/starship/commit/6d96df3c6828161bb9dc922fe45ef35a1ce33771))
|
||||||
|
* **direnv:** add new direnv module ([#5157](https://github.com/starship/starship/issues/5157)) ([e47bfba](https://github.com/starship/starship/commit/e47bfbabb9b7d6af12a29db9413a6ec03fba174b))
|
||||||
|
* **fossil_metrics:** add fossil_metrics module ([#4874](https://github.com/starship/starship/issues/4874)) ([e867cda](https://github.com/starship/starship/commit/e867cda1eb90ba452768bd2e0738afc2fd0db613))
|
||||||
|
* **hostname:** add detect_env_vars as option ([#5196](https://github.com/starship/starship/issues/5196)) ([43b2d42](https://github.com/starship/starship/commit/43b2d42cd526e34c5f0290e7409fbd6d3a54e908))
|
||||||
|
* **kubernetes:** Add styling based on current context ([#4550](https://github.com/starship/starship/issues/4550)) ([6b444e0](https://github.com/starship/starship/commit/6b444e05c688f9b871d0fe4624cd5559eba1f95c))
|
||||||
|
* R lang packages version, remove .Rprofile from rlang detection ([#5588](https://github.com/starship/starship/issues/5588)) ([5267c46](https://github.com/starship/starship/commit/5267c464eb5e4b23e44cdb7c56919991f4f67ae3))
|
||||||
|
* **scanner:** add option not to follow symlinks ([#5325](https://github.com/starship/starship/issues/5325)) ([7b851fc](https://github.com/starship/starship/commit/7b851fc30e109213e911eec38460315872f1ae59))
|
||||||
|
* **shell:** allow distinguishing between pwsh and powershell ([#5478](https://github.com/starship/starship/issues/5478)) ([d7a34b4](https://github.com/starship/starship/commit/d7a34b45f88ced63bd79a582c14a6b2f8ebd9544))
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **bash:** unbound variable error with STARSHIP_PREEXEC_READY ([#5438](https://github.com/starship/starship/issues/5438)) ([8168c21](https://github.com/starship/starship/commit/8168c21293de8118af1e95778b1eee8f26cd6d6a))
|
||||||
|
* **docker_context:** ignore unix domain socket path from Docker Context ([#5616](https://github.com/starship/starship/issues/5616)) ([a910e09](https://github.com/starship/starship/commit/a910e094f77ba6d67349a561e5e9780becfe823a)), closes [#5548](https://github.com/starship/starship/issues/5548)
|
||||||
|
* **git_status:** Avoid printing error on missing stash ref ([#5434](https://github.com/starship/starship/issues/5434)) ([00d3dc8](https://github.com/starship/starship/commit/00d3dc86a21d11aede96f81ffbe49babe487984e))
|
||||||
|
* **git:** prevent `core.fsmonitor` from executing external commands ([#3981](https://github.com/starship/starship/issues/3981)) ([03278e4](https://github.com/starship/starship/commit/03278e4de4f540cbd0e346e9df878c7e6798d757))
|
||||||
|
* **install:** do not use curl installed through snap ([#5442](https://github.com/starship/starship/issues/5442)) ([0e73817](https://github.com/starship/starship/commit/0e738175c57d5789350b996b69c5713aac03835e))
|
||||||
|
* **pastel-powerline:** remove `$path` from docker-context module format string ([#5534](https://github.com/starship/starship/issues/5534)) ([6abc83d](https://github.com/starship/starship/commit/6abc83decdf176842985b4daa5b09771c6b93415))
|
||||||
|
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* **git_status:** avoid running in bare repos ([#5581](https://github.com/starship/starship/issues/5581)) ([ac4a839](https://github.com/starship/starship/commit/ac4a83910357d69950ca304a3fb41d1d39bc3592))
|
||||||
|
* Skip unnecessary indirection in starship init zsh ([#5322](https://github.com/starship/starship/issues/5322)) ([5ca8daa](https://github.com/starship/starship/commit/5ca8daacd4ce936f97170f814a780b34bfaa486e))
|
||||||
|
|
||||||
## [1.16.0](https://github.com/starship/starship/compare/v1.15.0...v1.16.0) (2023-07-30)
|
## [1.16.0](https://github.com/starship/starship/compare/v1.15.0...v1.16.0) (2023-07-30)
|
||||||
|
|
||||||
|
|
||||||
|
@ -251,7 +251,7 @@ Changes to documentation can be viewed in a rendered state from the GitHub PR pa
|
|||||||
(go to the CI section at the bottom of the page and look for "deploy preview", then
|
(go to the CI section at the bottom of the page and look for "deploy preview", then
|
||||||
click on "details"). If you want to view changes locally as well, follow these steps.
|
click on "details"). If you want to view changes locally as well, follow these steps.
|
||||||
|
|
||||||
After cloning the project, you can do the following to run the VuePress website on your local machine:
|
After cloning the project, you can do the following to run the VitePress website on your local machine:
|
||||||
|
|
||||||
1. `cd` into the `/docs` directory.
|
1. `cd` into the `/docs` directory.
|
||||||
2. Install the project dependencies:
|
2. Install the project dependencies:
|
||||||
@ -266,7 +266,7 @@ After cloning the project, you can do the following to run the VuePress website
|
|||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
Once setup is complete, you can refer to VuePress documentation on the actual implementation here: <https://vuepress.vuejs.org/guide/>.
|
Once setup is complete, you can refer to VitePress documentation on the actual implementation here: <https://vitepress.dev/guide/getting-started>.
|
||||||
|
|
||||||
## Git/GitHub workflow
|
## Git/GitHub workflow
|
||||||
|
|
||||||
@ -292,7 +292,7 @@ everyone remember what they are. Don't worry: most of them are quite simple!
|
|||||||
appropriate--this is a bare minimum).
|
appropriate--this is a bare minimum).
|
||||||
- [ ] Add the variable to the appropriate location in the "Default Prompt
|
- [ ] Add the variable to the appropriate location in the "Default Prompt
|
||||||
Format" section of the documentation
|
Format" section of the documentation
|
||||||
- [ ] Add an appropriate choice of options to each preset in `docs/.vuepress/public/presets/toml`
|
- [ ] Add an appropriate choice of options to each preset in `docs/public/presets/toml`
|
||||||
- [ ] Update the config file schema by running `cargo run --features config-schema -- config-schema > .github/config-schema.json`
|
- [ ] Update the config file schema by running `cargo run --features config-schema -- config-schema > .github/config-schema.json`
|
||||||
- [ ] Create configs structs/traits in `src/configs/<module>.rs` and add the
|
- [ ] Create configs structs/traits in `src/configs/<module>.rs` and add the
|
||||||
following:
|
following:
|
||||||
|
2795
Cargo.lock
generated
2795
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
100
Cargo.toml
100
Cargo.toml
@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "starship"
|
name = "starship"
|
||||||
version = "1.16.0"
|
version = "1.22.1"
|
||||||
authors = ["Starship Contributors"]
|
authors = ["Starship Contributors"]
|
||||||
build = "build.rs"
|
build = "build.rs"
|
||||||
categories = ["command-line-utilities"]
|
categories = ["command-line-utilities"]
|
||||||
@ -15,7 +15,7 @@ include = [
|
|||||||
"build.rs",
|
"build.rs",
|
||||||
"LICENSE",
|
"LICENSE",
|
||||||
"/README.md",
|
"/README.md",
|
||||||
"docs/.vuepress/public/presets/toml/",
|
"docs/public/presets/toml/",
|
||||||
".github/config-schema.json",
|
".github/config-schema.json",
|
||||||
]
|
]
|
||||||
keywords = ["prompt", "shell", "bash", "fish", "zsh"]
|
keywords = ["prompt", "shell", "bash", "fish", "zsh"]
|
||||||
@ -23,7 +23,7 @@ license = "ISC"
|
|||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
repository = "https://github.com/starship/starship"
|
repository = "https://github.com/starship/starship"
|
||||||
# Note: MSRV is only intended as a hint, and only the latest version is officially supported in starship.
|
# Note: MSRV is only intended as a hint, and only the latest version is officially supported in starship.
|
||||||
rust-version = "1.65"
|
rust-version = "1.80"
|
||||||
description = """
|
description = """
|
||||||
The minimal, blazing-fast, and infinitely customizable prompt for any shell! ☄🌌️
|
The minimal, blazing-fast, and infinitely customizable prompt for any shell! ☄🌌️
|
||||||
"""
|
"""
|
||||||
@ -42,61 +42,61 @@ gix-max-perf = ["gix-features/zlib-ng", "gix/fast-sha1"]
|
|||||||
gix-faster = ["gix-features/zlib-stock", "gix/fast-sha1"]
|
gix-faster = ["gix-features/zlib-stock", "gix/fast-sha1"]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
chrono = { version = "0.4.30", default-features = false, features = ["clock", "std", "wasmbind"] }
|
chrono = { version = "0.4.39", default-features = false, features = ["clock", "std", "wasmbind"] }
|
||||||
clap = { version = "4.4.7", features = ["derive", "cargo", "unicode"] }
|
clap = { version = "4.5.26", features = ["derive", "cargo", "unicode"] }
|
||||||
clap_complete = "4.4.4"
|
clap_complete = "4.5.42"
|
||||||
dirs-next = "2.0.0"
|
dirs = "5.0.1"
|
||||||
dunce = "1.0.4"
|
dunce = "1.0.5"
|
||||||
gethostname = "0.4.3"
|
|
||||||
# default feature restriction addresses https://github.com/starship/starship/issues/4251
|
# default feature restriction addresses https://github.com/starship/starship/issues/4251
|
||||||
gix = { version = "0.55.2", default-features = false, features = ["max-performance-safe", "revision"] }
|
gix = { version = "0.69.1", default-features = false, features = ["max-performance-safe", "revision"] }
|
||||||
gix-features = { version = "0.36.0", optional = true }
|
gix-features = { version = "0.39.1", optional = true }
|
||||||
indexmap = { version = "2.0.2", features = ["serde"] }
|
indexmap = { version = "2.7.0", features = ["serde"] }
|
||||||
log = { version = "0.4.20", features = ["std"] }
|
log = { version = "0.4.24", features = ["std"] }
|
||||||
# notify-rust is optional (on by default) because the crate doesn't currently build for darwin with nix
|
# 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
|
# see: https://github.com/NixOS/nixpkgs/issues/160876
|
||||||
notify-rust = { version = "4.9.0", optional = true }
|
notify-rust = { version = "4.11.3", optional = true }
|
||||||
nu-ansi-term = "0.49.0"
|
nu-ansi-term = "0.50.1"
|
||||||
once_cell = "1.18.0"
|
open = "5.3.2"
|
||||||
open = "5.0.0"
|
|
||||||
# update os module config and tests when upgrading os_info
|
# update os module config and tests when upgrading os_info
|
||||||
os_info = "3.7.0"
|
os_info = "3.9.2"
|
||||||
path-slash = "0.2.1"
|
path-slash = "0.2.1"
|
||||||
pest = "2.7.5"
|
pest = "2.7.15"
|
||||||
pest_derive = "2.7.5"
|
pest_derive = "2.7.15"
|
||||||
quick-xml = "0.31.0"
|
process_control = "5.0.0"
|
||||||
|
quick-xml = "0.37.2"
|
||||||
rand = "0.8.5"
|
rand = "0.8.5"
|
||||||
rayon = "1.8.0"
|
rayon = "1.10.0"
|
||||||
regex = { version = "1.10.2", default-features = false, features = ["perf", "std", "unicode-perl"] }
|
regex = { version = "1.11.1", default-features = false, features = ["perf", "std", "unicode-perl"] }
|
||||||
rust-ini = "0.19.0"
|
rust-ini = "0.21.1"
|
||||||
semver = "1.0.20"
|
semver = "1.0.24"
|
||||||
serde = { version = "1.0.189", features = ["derive"] }
|
serde = { version = "1.0.217", features = ["derive"] }
|
||||||
serde_json = "1.0.107"
|
serde_json = "1.0.135"
|
||||||
sha1 = "0.10.6"
|
sha1 = "0.10.6"
|
||||||
shadow-rs = { version = "0.24.1", default-features = false }
|
shadow-rs = { version = "0.37.0", default-features = false }
|
||||||
# battery is optional (on by default) because the crate doesn't currently build for Termux
|
# battery is optional (on by default) because the crate doesn't currently build for Termux
|
||||||
# see: https://github.com/svartalf/rust-battery/issues/33
|
# see: https://github.com/svartalf/rust-battery/issues/33
|
||||||
starship-battery = { version = "0.8.2", optional = true }
|
starship-battery = { version = "0.10.0", optional = true }
|
||||||
strsim = "0.10.0"
|
strsim = "0.11.1"
|
||||||
systemstat = "=0.2.3"
|
systemstat = "=0.2.4"
|
||||||
terminal_size = "0.3.0"
|
terminal_size = "0.4.1"
|
||||||
toml = { version = "0.8.4", features = ["preserve_order"] }
|
toml = { version = "0.8.19", features = ["preserve_order"] }
|
||||||
toml_edit = "0.20.4"
|
toml_edit = "0.22.22"
|
||||||
unicode-segmentation = "1.10.1"
|
unicode-segmentation = "1.12.0"
|
||||||
unicode-width = "0.1.11"
|
unicode-width = "0.2.0"
|
||||||
urlencoding = "2.1.3"
|
urlencoding = "2.1.3"
|
||||||
versions = "5.0.1"
|
versions = "6.3.2"
|
||||||
which = "5.0.0"
|
which = "7.0.1"
|
||||||
yaml-rust = "0.4.5"
|
whoami = { version = "1.5.2", default-features = false }
|
||||||
|
yaml-rust2 = "0.9.0"
|
||||||
|
|
||||||
process_control = { version = "4.0.3", features = ["crossbeam-channel"] }
|
guess_host_triple = "0.1.4"
|
||||||
|
home = "0.5.11"
|
||||||
guess_host_triple = "0.1.3"
|
# Temporary workaround for https://github.com/rust-lang/libz-sys/issues/225
|
||||||
home = "0.5.5"
|
libz-ng-sys = { version = "<1.1.20", optional = true }
|
||||||
shell-words = "1.1.0"
|
shell-words = "1.1.0"
|
||||||
|
|
||||||
[dependencies.schemars]
|
[dependencies.schemars]
|
||||||
version = "0.8.15"
|
version = "0.8.21"
|
||||||
optional = true
|
optional = true
|
||||||
features = ["preserve_order", "indexmap2"]
|
features = ["preserve_order", "indexmap2"]
|
||||||
|
|
||||||
@ -104,7 +104,7 @@ features = ["preserve_order", "indexmap2"]
|
|||||||
deelevate = "0.2.0"
|
deelevate = "0.2.0"
|
||||||
|
|
||||||
[target.'cfg(windows)'.dependencies.windows]
|
[target.'cfg(windows)'.dependencies.windows]
|
||||||
version = "0.48.0"
|
version = "0.59.0"
|
||||||
features = [
|
features = [
|
||||||
"Win32_Foundation",
|
"Win32_Foundation",
|
||||||
"Win32_UI_Shell",
|
"Win32_UI_Shell",
|
||||||
@ -114,18 +114,18 @@ features = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
[target.'cfg(not(windows))'.dependencies]
|
[target.'cfg(not(windows))'.dependencies]
|
||||||
nix = { version = "0.27.1", default-features = false, features = ["feature", "fs", "user"] }
|
nix = { version = "0.29.0", default-features = false, features = ["feature", "fs", "user"] }
|
||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
shadow-rs = { version = "0.24.1", default-features = false }
|
shadow-rs = { version = "0.37.0", default-features = false }
|
||||||
dunce = "1.0.4"
|
dunce = "1.0.5"
|
||||||
|
|
||||||
[target.'cfg(windows)'.build-dependencies]
|
[target.'cfg(windows)'.build-dependencies]
|
||||||
winres = "0.1.12"
|
winres = "0.1.12"
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
mockall = "0.11"
|
mockall = "0.13.1"
|
||||||
tempfile = "3.8.0"
|
tempfile = "3.15.0"
|
||||||
|
|
||||||
[profile.release]
|
[profile.release]
|
||||||
codegen-units = 1
|
codegen-units = 1
|
||||||
|
34
README.md
34
README.md
@ -32,6 +32,11 @@
|
|||||||
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||||||
alt="Follow @StarshipPrompt on Twitter"
|
alt="Follow @StarshipPrompt on Twitter"
|
||||||
/></a>
|
/></a>
|
||||||
|
<a href="https://stand-with-ukraine.pp.ua"
|
||||||
|
><img
|
||||||
|
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
|
||||||
|
alt="Stand With Ukraine"
|
||||||
|
/></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
@ -227,6 +232,7 @@ Alternatively, install Starship using any of the following package managers:
|
|||||||
| Gentoo | [Gentoo Packages] | `emerge app-shells/starship` |
|
| Gentoo | [Gentoo Packages] | `emerge app-shells/starship` |
|
||||||
| Manjaro | | `pacman -S starship` |
|
| Manjaro | | `pacman -S starship` |
|
||||||
| NixOS | [nixpkgs] | `nix-env -iA nixpkgs.starship` |
|
| NixOS | [nixpkgs] | `nix-env -iA nixpkgs.starship` |
|
||||||
|
| openSUSE | [OSS] | `zypper in starship` |
|
||||||
| Void Linux | [Void Linux Packages] | `xbps-install -S starship` |
|
| Void Linux | [Void Linux Packages] | `xbps-install -S starship` |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
@ -333,20 +339,14 @@ eval $(starship init ion)
|
|||||||
<details>
|
<details>
|
||||||
<summary>Nushell</summary>
|
<summary>Nushell</summary>
|
||||||
|
|
||||||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
mkdir ~/.cache/starship
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
starship init nu | save -f ~/.cache/starship/init.nu
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
```
|
```
|
||||||
|
|
||||||
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
|
Note: Only Nushell v0.96+ is supported
|
||||||
|
|
||||||
```sh
|
|
||||||
use ~/.cache/starship/init.nu
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: Only Nushell v0.78+ is supported
|
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
@ -427,9 +427,16 @@ Please check out these previous works that helped inspire the creation of starsh
|
|||||||
|
|
||||||
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
|
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
|
||||||
|
|
||||||
**Supporter Tier**
|
## 🔒 Code Signing Policy
|
||||||
|
|
||||||
- [Appwrite](https://appwrite.io/)
|
Free code signing provided by [SignPath.io], certificate by [SignPath Foundation].
|
||||||
|
|
||||||
|
Code Signing Roles:
|
||||||
|
|
||||||
|
- Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts)
|
||||||
|
- Approvers and Authors: [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.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<br>
|
<br>
|
||||||
@ -453,8 +460,11 @@ This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE)
|
|||||||
[homebrew]: https://formulae.brew.sh/formula/starship
|
[homebrew]: https://formulae.brew.sh/formula/starship
|
||||||
[macports]: https://ports.macports.org/port/starship
|
[macports]: https://ports.macports.org/port/starship
|
||||||
[nixpkgs]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix
|
[nixpkgs]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix
|
||||||
|
[OSS]: https://software.opensuse.org/package/starship
|
||||||
[pkgsrc]: https://pkgsrc.se/shells/starship
|
[pkgsrc]: https://pkgsrc.se/shells/starship
|
||||||
[scoop]: https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json
|
[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
|
[termux]: https://github.com/termux/termux-packages/tree/master/packages/starship
|
||||||
[void linux packages]: https://github.com/void-linux/void-packages/tree/master/srcpkgs/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
|
[winget]: https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship
|
||||||
|
8
build.rs
8
build.rs
@ -5,7 +5,9 @@ use std::io::Write;
|
|||||||
use shadow_rs::SdResult;
|
use shadow_rs::SdResult;
|
||||||
|
|
||||||
fn main() -> SdResult<()> {
|
fn main() -> SdResult<()> {
|
||||||
shadow_rs::new_hook(gen_presets_hook)?;
|
shadow_rs::ShadowBuilder::builder()
|
||||||
|
.hook(gen_presets_hook)
|
||||||
|
.build()?;
|
||||||
|
|
||||||
#[cfg(windows)]
|
#[cfg(windows)]
|
||||||
{
|
{
|
||||||
@ -19,8 +21,8 @@ fn main() -> SdResult<()> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn gen_presets_hook(mut file: &File) -> SdResult<()> {
|
fn gen_presets_hook(mut file: &File) -> SdResult<()> {
|
||||||
println!("cargo:rerun-if-changed=docs/.vuepress/public/presets/toml");
|
println!("cargo:rerun-if-changed=docs/public/presets/toml");
|
||||||
let paths = fs::read_dir("docs/.vuepress/public/presets/toml")?;
|
let paths = fs::read_dir("docs/public/presets/toml")?;
|
||||||
let mut sortedpaths = paths.collect::<io::Result<Vec<_>>>()?;
|
let mut sortedpaths = paths.collect::<io::Result<Vec<_>>>()?;
|
||||||
sortedpaths.sort_by_key(std::fs::DirEntry::path);
|
sortedpaths.sort_by_key(std::fs::DirEntry::path);
|
||||||
|
|
||||||
|
14
deny.toml
14
deny.toml
@ -1,20 +1,15 @@
|
|||||||
[advisories]
|
[advisories]
|
||||||
vulnerability = "deny"
|
version = 2
|
||||||
unmaintained = "warn"
|
|
||||||
yanked = "warn"
|
|
||||||
notice = "warn"
|
|
||||||
|
|
||||||
# A list of advisory IDs to ignore. Note that ignored advisories will still
|
# A list of advisory IDs to ignore. Note that ignored advisories will still
|
||||||
# output a note when they are encountered.
|
# output a note when they are encountered.
|
||||||
ignore = [
|
ignore = [
|
||||||
|
# { id = "RUSTSEC-0000-0000", reason = "" },
|
||||||
|
|
||||||
# "RUSTSEC-0000-0000",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[licenses]
|
[licenses]
|
||||||
# The lint level for crates which do not have a detectable license
|
version = 2
|
||||||
unlicensed = "deny"
|
|
||||||
# List of explicitly allowed licenses
|
# List of explicitly allowed licenses
|
||||||
allow = [
|
allow = [
|
||||||
"Apache-2.0 WITH LLVM-exception",
|
"Apache-2.0 WITH LLVM-exception",
|
||||||
@ -27,6 +22,7 @@ allow = [
|
|||||||
"MIT",
|
"MIT",
|
||||||
"MPL-2.0",
|
"MPL-2.0",
|
||||||
"Unicode-DFS-2016",
|
"Unicode-DFS-2016",
|
||||||
|
"Unicode-3.0",
|
||||||
"Unlicense",
|
"Unlicense",
|
||||||
"WTFPL",
|
"WTFPL",
|
||||||
"Zlib",
|
"Zlib",
|
||||||
|
@ -1,98 +1,346 @@
|
|||||||
import { defineConfig, SidebarConfigArray } from "vuepress/config";
|
import { defineConfig } from "vitepress";
|
||||||
|
|
||||||
const sidebar = (lang, override = {}): SidebarConfigArray =>
|
const sidebar = (lang: string | undefined, override = {}) =>
|
||||||
[
|
[
|
||||||
"", // "Home", which should always have a override
|
{ page: "guide", text: "Guide" }, // README, which should always have a override
|
||||||
"guide", // README, which should always have a override
|
|
||||||
// Overrides for any page below is an inconsistency between the sidebar title and page title
|
// Overrides for any page below is an inconsistency between the sidebar title and page title
|
||||||
"installing",
|
{ page: "installing", text: "Installation" },
|
||||||
"config",
|
{ page: "config", text: "Configuration" },
|
||||||
"advanced-config",
|
{ page: "advanced-config", text: "Advanced Configuration" },
|
||||||
"faq",
|
{ page: "faq", text: "FAQ" },
|
||||||
"presets",
|
{ page: "presets", text: "Presets" },
|
||||||
].map(page => {
|
].map(item => {
|
||||||
let path = "/";
|
let path = "/";
|
||||||
|
|
||||||
if (lang) {
|
if (lang) {
|
||||||
path += `${lang}/`;
|
path += `${lang}/`;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (page) {
|
if (item.page) {
|
||||||
path += `${page}/`;
|
path += `${item.page}/`;
|
||||||
}
|
}
|
||||||
|
|
||||||
// If no override is set for current page, let VuePress fallback to page title
|
// If no override is set for current page, let VitePress fallback to page title
|
||||||
return page in override ? [path, override[page]] : path;
|
return { link: path, text: override?.[item.page] ?? item.text };
|
||||||
});
|
});
|
||||||
|
|
||||||
module.exports = defineConfig({
|
const editLinkPattern = 'https://github.com/starship/starship/edit/master/docs/:path';
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
locales: {
|
locales: {
|
||||||
"/": {
|
root: {
|
||||||
|
label: "English",
|
||||||
lang: "en-US",
|
lang: "en-US",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "The minimal, blazing-fast, and infinitely customizable prompt for any shell!",
|
description: "The minimal, blazing-fast, and infinitely customizable prompt for any shell!",
|
||||||
|
|
||||||
|
themeConfig: {
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "Configuration", link: "/config/"}],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("", {
|
||||||
|
guide: "Guide",
|
||||||
|
}),
|
||||||
|
// Enable edit links
|
||||||
|
editLink: {
|
||||||
|
text: "Edit this page on GitHub",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"/de-DE/": {
|
"de-DE": {
|
||||||
|
label: "Deutsch",
|
||||||
lang: "de-DE",
|
lang: "de-DE",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!",
|
description: "Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!",
|
||||||
|
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "Sprachen",
|
||||||
|
returnToTopLabel: "Zurück zum Seitenanfang",
|
||||||
|
sidebarMenuLabel: "Menü",
|
||||||
|
|
||||||
|
nav: [{ text: "Konfiguration", link: "/de-DE/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("de-DE", {
|
||||||
|
guide: "Anleitung",
|
||||||
|
installing: "Erweiterte Installation",
|
||||||
|
faq: "Häufig gestellte Fragen",
|
||||||
|
presets: "Konfigurations-Beispiele",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "Bearbeite diese Seite auf GitHub",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"/es-ES/": {
|
"es-ES": {
|
||||||
|
label: "Español",
|
||||||
lang: "es-ES",
|
lang: "es-ES",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description:
|
description:
|
||||||
"¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!",
|
"¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "Idiomas",
|
||||||
|
returnToTopLabel: "Volver arriba",
|
||||||
|
sidebarMenuLabel: "Menú",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "Configuración", link: "/es-ES/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("es-ES", {
|
||||||
|
guide: "Guía",
|
||||||
|
installing: "Instalación avanzada",
|
||||||
|
faq: "Preguntas frecuentes",
|
||||||
|
presets: "Ajustes predeterminados",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "Edita esta página en GitHub",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/fr-FR/": {
|
"fr-FR": {
|
||||||
|
label: "Français",
|
||||||
lang: "fr-FR",
|
lang: "fr-FR",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "L'invite minimaliste, ultra-rapide et personnalisable à l'infini pour n'importe quel shell !",
|
description: "L'invite minimaliste, ultra-rapide et personnalisable à l'infini pour n'importe quel shell !",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "Langues",
|
||||||
|
returnToTopLabel: "Retour en haut",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "Configuration", link: "/fr-FR/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("fr-FR", {
|
||||||
|
guide: "Guide",
|
||||||
|
installing: "Installation avancée",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "Éditez cette page sur GitHub",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/id-ID/": {
|
"id-ID": {
|
||||||
|
label: "Bahasa Indonesia",
|
||||||
lang: "id-ID",
|
lang: "id-ID",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "Prompt yang minimal, super cepat, dan dapat disesuaikan tanpa batas untuk shell apa pun!",
|
description: "Prompt yang minimal, super cepat, dan dapat disesuaikan tanpa batas untuk shell apa pun!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "Languages",
|
||||||
|
returnToTopLabel: "Kembali ke atas",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "Konfigurasi", link: "/id-ID/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("id-ID", {
|
||||||
|
guide: "Petunjuk",
|
||||||
|
installing: "Advanced Installation",
|
||||||
|
faq: "Pertanyaan Umum",
|
||||||
|
presets: "Prasetel",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "Sunting halaman ini di Github",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/it-IT/": {
|
"it-IT": {
|
||||||
|
label: "Italiano",
|
||||||
lang: "it-IT",
|
lang: "it-IT",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "Il prompt minimalista, super veloce e infinitamente personalizzabile per qualsiasi shell!",
|
description: "Il prompt minimalista, super veloce e infinitamente personalizzabile per qualsiasi shell!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "Languages",
|
||||||
|
returnToTopLabel: "Torna all'inizio",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "Configuration", link: "/it-IT/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("it-IT", {
|
||||||
|
guide: "Guide",
|
||||||
|
installing: "Installazione Avanzata",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "Modifica questa pagina in Github",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/ja-JP/": {
|
"ja-JP": {
|
||||||
|
label: "日本語",
|
||||||
lang: "ja-JP",
|
lang: "ja-JP",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです!",
|
description: "シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "言語",
|
||||||
|
returnToTopLabel: "ページの先頭へ",
|
||||||
|
sidebarMenuLabel: "メニュー",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "設定", link: "/ja-JP/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("ja-JP", {
|
||||||
|
guide: "ガイド",
|
||||||
|
installing: "高度なインストール",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "GitHub で編集する",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/pt-BR/": {
|
"pt-BR": {
|
||||||
|
label: "Português do Brasil",
|
||||||
lang: "pt-BR",
|
lang: "pt-BR",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description:
|
description:
|
||||||
"O prompt minimalista, extremamente rápido e infinitamente personalizável para qualquer shell!",
|
"O prompt minimalista, extremamente rápido e infinitamente personalizável para qualquer shell!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "Languages",
|
||||||
|
returnToTopLabel: "Voltar ao topo",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "Configuração", link: "/pt-BR/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("pt-BR", {
|
||||||
|
guide: "Guia",
|
||||||
|
installing: "Instalação avançada",
|
||||||
|
faq: "Perguntas frequentes",
|
||||||
|
presets: "Predefinições",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "Edite esta página no Github",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/ru-RU/": {
|
"ru-RU": {
|
||||||
|
label: "Русский",
|
||||||
lang: "ru-RU",
|
lang: "ru-RU",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "Минималистичная, быстрая и бесконечно настраиваемая командная строка для любой оболочки!",
|
description: "Минималистичная, быстрая и бесконечно настраиваемая командная строка для любой оболочки!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "Языки",
|
||||||
|
returnToTopLabel: "Наверх",
|
||||||
|
sidebarMenuLabel: "Меню",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "Настройка", link: "/ru-RU/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("ru-RU", {
|
||||||
|
guide: "Руководство",
|
||||||
|
installing: "Advanced Installation",
|
||||||
|
config: "Настройка",
|
||||||
|
"advanced-config": "Расширенная Настройка",
|
||||||
|
faq: "Часто Задаваемые Вопросы",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "Редактировать эту страницу на GitHub",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/uk-UA/": {
|
"uk-UA": {
|
||||||
|
label: "Українська",
|
||||||
lang: "uk-UA",
|
lang: "uk-UA",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "Простий, супер швидкий та безмежно адаптивний командний рядок для будь-якої оболонки!",
|
description: "Простий, супер швидкий та безмежно адаптивний командний рядок для будь-якої оболонки!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "Мови",
|
||||||
|
returnToTopLabel: "Догори",
|
||||||
|
sidebarMenuLabel: "Меню",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "Налаштування", link: "/uk-UA/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("uk-UA", {
|
||||||
|
guide: "Керівництво",
|
||||||
|
installing: "Розширене встановлення",
|
||||||
|
config: "Налаштування",
|
||||||
|
"advanced-config": "Розширені налаштування",
|
||||||
|
faq: "Часті питання",
|
||||||
|
presets: "Шаблони",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "Редагувати цю сторінку на GitHub",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/vi-VN/": {
|
"vi-VN": {
|
||||||
|
label: "Tiếng Việt",
|
||||||
lang: "vi-VN",
|
lang: "vi-VN",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "Nhỏ gọn, cực nhanh, và khả năng tuỳ chỉnh vô hạn prompt cho bất kì shell nào!",
|
description: "Nhỏ gọn, cực nhanh, và khả năng tuỳ chỉnh vô hạn prompt cho bất kì shell nào!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "Ngôn ngữ",
|
||||||
|
returnToTopLabel: "Quay lại đầu trang",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "Cấu hình", link: "/vi-VN/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("vi-VN", {
|
||||||
|
guide: "Hướng dẫn",
|
||||||
|
installing: "Cài đặt nâng cao",
|
||||||
|
faq: "Các hỏi thường gặp",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "Chỉnh sửa trang này trên GitHub",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/zh-CN/": {
|
"zh-CN": {
|
||||||
|
label: "简体中文",
|
||||||
lang: "zh-CN",
|
lang: "zh-CN",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "轻量级、反应迅速,可定制的高颜值终端!",
|
description: "轻量级、反应迅速,可定制的高颜值终端!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "语言",
|
||||||
|
returnToTopLabel: "返回顶部",
|
||||||
|
sidebarMenuLabel: "目录",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "配置", link: "/zh-CN/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("zh-CN", {
|
||||||
|
guide: "指南",
|
||||||
|
installing: "高级安装",
|
||||||
|
config: "配置",
|
||||||
|
"advanced-config": "高级配置",
|
||||||
|
faq: "常见问题",
|
||||||
|
presets: "社区配置分享",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "在 GitHub 上修改此页",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
"/zh-TW/": {
|
"zh-TW": {
|
||||||
|
label: "繁體中文",
|
||||||
lang: "zh-TW",
|
lang: "zh-TW",
|
||||||
title: "Starship",
|
title: "Starship",
|
||||||
description: "適合任何 shell 的最小、極速、無限客製化的提示字元!",
|
description: "適合任何 shell 的最小、極速、無限客製化的提示字元!",
|
||||||
|
themeConfig: {
|
||||||
|
// text for the language dropdown
|
||||||
|
langMenuLabel: "語言",
|
||||||
|
returnToTopLabel: "返回頂部",
|
||||||
|
sidebarMenuLabel: "目錄",
|
||||||
|
// Custom navbar values
|
||||||
|
nav: [{ text: "設定", link: "/zh-TW/config/" }],
|
||||||
|
// Custom sidebar values
|
||||||
|
sidebar: sidebar("zh-TW", {
|
||||||
|
guide: "指引",
|
||||||
|
installing: "進階安裝",
|
||||||
|
}),
|
||||||
|
editLink: {
|
||||||
|
text: "在 GitHub 上修改此頁面",
|
||||||
|
pattern: editLinkPattern,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
// prettier-ignore
|
// prettier-ignore
|
||||||
@ -120,7 +368,7 @@ module.exports = defineConfig({
|
|||||||
[
|
[
|
||||||
"script",
|
"script",
|
||||||
{
|
{
|
||||||
async: true,
|
async: '',
|
||||||
src: "https://www.googletagmanager.com/gtag/js?id=G-N3M0VJ9NL6",
|
src: "https://www.googletagmanager.com/gtag/js?id=G-N3M0VJ9NL6",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
@ -130,245 +378,41 @@ module.exports = defineConfig({
|
|||||||
"window.dataLayer = window.dataLayer || [];\nfunction gtag(){dataLayer.push(arguments);}\ngtag('js', new Date());\ngtag('config', 'G-N3M0VJ9NL6');",
|
"window.dataLayer = window.dataLayer || [];\nfunction gtag(){dataLayer.push(arguments);}\ngtag('js', new Date());\ngtag('config', 'G-N3M0VJ9NL6');",
|
||||||
],
|
],
|
||||||
],
|
],
|
||||||
evergreen: true,
|
sitemap: {
|
||||||
theme: "default-prefers-color-scheme",
|
hostname: 'https://starship.rs'
|
||||||
|
},
|
||||||
|
vite: {
|
||||||
|
resolve: {
|
||||||
|
preserveSymlinks: true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
cleanUrls: true,
|
||||||
|
markdown: {
|
||||||
|
theme: "github-dark"
|
||||||
|
},
|
||||||
|
ignoreDeadLinks: [
|
||||||
|
/\/toml\/.*/,
|
||||||
|
],
|
||||||
|
// VitePress doesn't support README.md as index files
|
||||||
|
// Rewrite README.md to index.md at different levels
|
||||||
|
rewrites: {
|
||||||
|
"README.md": "index.md",
|
||||||
|
":c0/README.md": ":c0/index.md",
|
||||||
|
":c0/:c1/README.md": ":c0/:c1/index.md",
|
||||||
|
":c0/:c1/:c2/README.md": ":c0/:c1/:c2/index.md",
|
||||||
|
":c0/:c1/:c2/:c3/README.md": ":c0/:c1/:c2/:c3/index.md",
|
||||||
|
},
|
||||||
themeConfig: {
|
themeConfig: {
|
||||||
logo: "/icon.png",
|
logo: "/icon.png",
|
||||||
// the GitHub repo path
|
socialLinks: [
|
||||||
repo: "starship/starship",
|
{ icon: 'github', link: 'https://github.com/starship/starship' },
|
||||||
// the label linking to the repo
|
],
|
||||||
repoLabel: "GitHub",
|
|
||||||
// if your docs are not at the root of the repo:
|
|
||||||
docsDir: "docs",
|
|
||||||
// defaults to false, set to true to enable
|
|
||||||
editLinks: true,
|
|
||||||
// enables Algolia DocSearch
|
// enables Algolia DocSearch
|
||||||
algolia: {
|
algolia: {
|
||||||
apiKey: "44118471f56286dcda7db941a043370d",
|
apiKey: "44118471f56286dcda7db941a043370d",
|
||||||
indexName: "starship",
|
indexName: "starship",
|
||||||
appId: "M3XUO3SQOR",
|
appId: "M3XUO3SQOR",
|
||||||
},
|
},
|
||||||
locales: {
|
}
|
||||||
"/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Languages",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "English",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Edit this page on GitHub",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Configuration", link: "/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("", {
|
|
||||||
guide: "Guide",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/de-DE/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Sprachen",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "Deutsch",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Bearbeite diese Seite auf GitHub",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Konfiguration", link: "/de-DE/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("de-DE", {
|
|
||||||
guide: "Anleitung",
|
|
||||||
installing: "Erweiterte Installation",
|
|
||||||
faq: "Häufig gestellte Fragen",
|
|
||||||
presets: "Konfigurations-Beispiele",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/es-ES/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Idiomas",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "Español",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Edita esta página en GitHub",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Configuración", link: "/es-ES/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("es-ES", {
|
|
||||||
guide: "Guía",
|
|
||||||
installing: "Instalación avanzada",
|
|
||||||
faq: "Preguntas frecuentes",
|
|
||||||
presets: "Ajustes predeterminados",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/fr-FR/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Langues",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "Français",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Éditez cette page sur GitHub",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Configuration", link: "/fr-FR/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("fr-FR", {
|
|
||||||
guide: "Guide",
|
|
||||||
installing: "Installation avancée",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/id-ID/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Languages",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "Bahasa Indonesia",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Sunting halaman ini di Github",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Konfigurasi", link: "/id-ID/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("id-ID", {
|
|
||||||
guide: "Petunjuk",
|
|
||||||
installing: "Advanced Installation",
|
|
||||||
faq: "Pertanyaan Umum",
|
|
||||||
presets: "Prasetel",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/it-IT/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Languages",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "Italiano",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Modifica questa pagina in Github",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Configuration", link: "/it-IT/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("it-IT", {
|
|
||||||
guide: "Guide",
|
|
||||||
installing: "Installazione Avanzata",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/ja-JP/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "言語",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "日本語",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "GitHub で編集する",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "設定", link: "/ja-JP/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("ja-JP", {
|
|
||||||
guide: "ガイド",
|
|
||||||
installing: "高度なインストール",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/pt-BR/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Languages",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "Português do Brasil",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Edite esta página no Github",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Configuração", link: "/pt-BR/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("pt-BR", {
|
|
||||||
guide: "Guia",
|
|
||||||
installing: "Instalação avançada",
|
|
||||||
faq: "Perguntas frequentes",
|
|
||||||
presets: "Predefinições",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/ru-RU/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Языки",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "Русский",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Редактировать эту страницу на GitHub",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Настройка", link: "/ru-RU/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("ru-RU", {
|
|
||||||
guide: "Руководство",
|
|
||||||
installing: "Advanced Installation",
|
|
||||||
config: "Настройка",
|
|
||||||
"advanced-config": "Расширенная Настройка",
|
|
||||||
faq: "Часто Задаваемые Вопросы",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/uk-UA/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Мови",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "Українська",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Редагувати цю сторінку на GitHub",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Налаштування", link: "/uk-UA/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("uk-UA", {
|
|
||||||
guide: "Керівництво",
|
|
||||||
installing: "Розширене встановлення",
|
|
||||||
config: "Налаштування",
|
|
||||||
"advanced-config": "Розширені налаштування",
|
|
||||||
faq: "Часті питання",
|
|
||||||
presets: "Шаблони",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/vi-VN/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "Ngôn ngữ",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "Tiếng Việt",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "Chỉnh sửa trang này trên GitHub",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "Cấu hình", link: "/vi-VN/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("vi-VN", {
|
|
||||||
guide: "Hướng dẫn",
|
|
||||||
installing: "Cài đặt nâng cao",
|
|
||||||
faq: "Các hỏi thường gặp",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/zh-TW/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "語言",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "繁體中文",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "在 GitHub 上修改此頁面",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "設定", link: "/zh-TW/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("zh-TW", {
|
|
||||||
guide: "指引",
|
|
||||||
installing: "進階安裝",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
"/zh-CN/": {
|
|
||||||
// text for the language dropdown
|
|
||||||
selectText: "语言",
|
|
||||||
// label for this locale in the language dropdown
|
|
||||||
label: "简体中文",
|
|
||||||
// Custom text for edit link. Defaults to "Edit this page"
|
|
||||||
editLinkText: "在 GitHub 上修改此页",
|
|
||||||
// Custom navbar values
|
|
||||||
nav: [{ text: "配置", link: "/zh-CN/config/" }],
|
|
||||||
// Custom sidebar values
|
|
||||||
sidebar: sidebar("zh-CN", {
|
|
||||||
guide: "指南",
|
|
||||||
installing: "高级安装",
|
|
||||||
presets: "社区配置分享",
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
plugins: [
|
|
||||||
[
|
|
||||||
"vuepress-plugin-sitemap",
|
|
||||||
{
|
|
||||||
hostname: "https://starship.rs",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
["vuepress-plugin-code-copy", true],
|
|
||||||
],
|
|
||||||
});
|
});
|
112
docs/.vitepress/theme/index.css
Normal file
112
docs/.vitepress/theme/index.css
Normal file
@ -0,0 +1,112 @@
|
|||||||
|
.VPHero .container {
|
||||||
|
flex-direction: column;
|
||||||
|
text-align: center !important;
|
||||||
|
gap: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.VPHero .image {
|
||||||
|
order: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.VPHero .image-container {
|
||||||
|
transform: none;
|
||||||
|
height: auto;
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 640px) {
|
||||||
|
.VPHero .image-container {
|
||||||
|
max-width: 320px;
|
||||||
|
width: auto;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.VPHero .image img {
|
||||||
|
width: 100%;
|
||||||
|
max-height: 130px;
|
||||||
|
max-width: none;
|
||||||
|
position: static;
|
||||||
|
transform: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.VPHero .image img.uwu {
|
||||||
|
max-height: 290px;
|
||||||
|
max-width: 80vw;
|
||||||
|
}
|
||||||
|
|
||||||
|
.VPHero .container .actions {
|
||||||
|
justify-content: center !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.VPHero .main {
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.demo-video {
|
||||||
|
max-width: 700px;
|
||||||
|
width: 100%;
|
||||||
|
margin: 50px auto;
|
||||||
|
border-radius: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.action-button {
|
||||||
|
background-color: #dd0b78 !important;
|
||||||
|
border-bottom: #c6096b !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
p[align="center"] img {
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
|
||||||
|
p[align="center"] img[height="20"] {
|
||||||
|
height: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Nerd Font';
|
||||||
|
src: url("/nerd-font.woff2") format("woff2");
|
||||||
|
font-weight: 400;
|
||||||
|
font-style: normal;
|
||||||
|
unicode-range: U+e000-f8ff, U+f0000-fffff, U+100000-10ffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
overflow-wrap: break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
.vp-doc [class*='language-']>button.copy {
|
||||||
|
top: unset;
|
||||||
|
bottom: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
:root {
|
||||||
|
--vp-font-family-mono: 'Nerd Font', source-code-pro, SFMono-Regular, 'SF Mono', Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace;
|
||||||
|
--vp-c-brand-1: #9b0854;
|
||||||
|
--vp-c-brand-2: #f31186;
|
||||||
|
--vp-c-brand-3: #dd0b78;
|
||||||
|
--vp-c-brand-soft: rgba(221, 11, 120, 0.14);
|
||||||
|
/* The following colors were extracted from the dark variant of the default VitePress theme
|
||||||
|
* Styled variables from: https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css#L319-L362
|
||||||
|
*/
|
||||||
|
--vp-code-block-bg: #282c34;
|
||||||
|
--vp-code-color: #282c34;
|
||||||
|
--vp-code-block-divider-color: #000;
|
||||||
|
--vp-code-lang-color: rgba(235, 235, 245, 0.38);
|
||||||
|
--vp-code-line-highlight-color: rgba(101, 117, 133, 0.16);
|
||||||
|
--vp-code-line-number-color: rgba(235, 235, 245, 0.38);
|
||||||
|
--vp-code-copy-code-border-color: #2e2e32;
|
||||||
|
--vp-code-copy-code-bg: #202127;
|
||||||
|
--vp-code-copy-code-hover-border-color: #2e2e32;
|
||||||
|
--vp-code-copy-code-hover-bg: #1b1b1f;
|
||||||
|
--vp-code-copy-code-active-text: rgba(235, 235, 245, 0.6);
|
||||||
|
}
|
||||||
|
|
||||||
|
.dark {
|
||||||
|
--vp-c-brand-1: #ff70cd;
|
||||||
|
--vp-c-brand-2: #ff14ad;
|
||||||
|
--vp-c-brand-3: #ff33b8;
|
||||||
|
--vp-c-brand-soft: rgba(255, 51, 184, 0.14);
|
||||||
|
--vp-code-color: #fff;
|
||||||
|
}
|
4
docs/.vitepress/theme/index.js
Normal file
4
docs/.vitepress/theme/index.js
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
import DefaultTheme from "vitepress/theme";
|
||||||
|
import "./index.css";
|
||||||
|
|
||||||
|
export default DefaultTheme;
|
@ -1 +0,0 @@
|
|||||||
../../../.github/config-schema.json
|
|
@ -1 +0,0 @@
|
|||||||
../../../media/icon.png
|
|
@ -1 +0,0 @@
|
|||||||
../../../install/install.sh
|
|
@ -1 +0,0 @@
|
|||||||
../../../media/logo.png
|
|
@ -1 +0,0 @@
|
|||||||
../../../media/logo.svg
|
|
Binary file not shown.
Binary file not shown.
Before Width: | Height: | Size: 190 KiB |
@ -1,284 +0,0 @@
|
|||||||
format = """
|
|
||||||
$cmd_duration\
|
|
||||||
$hostname\
|
|
||||||
$localip\
|
|
||||||
$shlvl\
|
|
||||||
$shell\
|
|
||||||
$env_var\
|
|
||||||
$username\
|
|
||||||
$sudo\
|
|
||||||
$character\
|
|
||||||
"""
|
|
||||||
|
|
||||||
right_format = """
|
|
||||||
$singularity\
|
|
||||||
$kubernetes\
|
|
||||||
$directory\
|
|
||||||
$vcsh\
|
|
||||||
$fossil_branch\
|
|
||||||
$git_branch\
|
|
||||||
$git_commit\
|
|
||||||
$git_state\
|
|
||||||
$git_metrics\
|
|
||||||
$git_status\
|
|
||||||
$hg_branch\
|
|
||||||
$pijul_channel\
|
|
||||||
$docker_context\
|
|
||||||
$package\
|
|
||||||
$c\
|
|
||||||
$cmake\
|
|
||||||
$cobol\
|
|
||||||
$daml\
|
|
||||||
$dart\
|
|
||||||
$deno\
|
|
||||||
$dotnet\
|
|
||||||
$elixir\
|
|
||||||
$elm\
|
|
||||||
$erlang\
|
|
||||||
$fennel\
|
|
||||||
$golang\
|
|
||||||
$guix_shell\
|
|
||||||
$haskell\
|
|
||||||
$haxe\
|
|
||||||
$helm\
|
|
||||||
$java\
|
|
||||||
$julia\
|
|
||||||
$kotlin\
|
|
||||||
$gradle\
|
|
||||||
$lua\
|
|
||||||
$nim\
|
|
||||||
$nodejs\
|
|
||||||
$ocaml\
|
|
||||||
$opa\
|
|
||||||
$perl\
|
|
||||||
$php\
|
|
||||||
$pulumi\
|
|
||||||
$purescript\
|
|
||||||
$python\
|
|
||||||
$raku\
|
|
||||||
$rlang\
|
|
||||||
$red\
|
|
||||||
$ruby\
|
|
||||||
$rust\
|
|
||||||
$scala\
|
|
||||||
$solidity\
|
|
||||||
$swift\
|
|
||||||
$terraform\
|
|
||||||
$vlang\
|
|
||||||
$vagrant\
|
|
||||||
$zig\
|
|
||||||
$buf\
|
|
||||||
$nix_shell\
|
|
||||||
$conda\
|
|
||||||
$meson\
|
|
||||||
$spack\
|
|
||||||
$memory_usage\
|
|
||||||
$aws\
|
|
||||||
$gcloud\
|
|
||||||
$openstack\
|
|
||||||
$azure\
|
|
||||||
$crystal\
|
|
||||||
$custom\
|
|
||||||
$jobs\
|
|
||||||
$status\
|
|
||||||
$os\
|
|
||||||
$container\
|
|
||||||
$battery\
|
|
||||||
$time\
|
|
||||||
"""
|
|
||||||
|
|
||||||
add_newline = true
|
|
||||||
|
|
||||||
[character]
|
|
||||||
format = "$symbol "
|
|
||||||
success_symbol = "[◉](bold italic bright-yellow)"
|
|
||||||
error_symbol = "[⊘](italic purple)"
|
|
||||||
|
|
||||||
[env_var.VIMSHELL] # vim subshell
|
|
||||||
format = "[$env_value]($style)"
|
|
||||||
style = 'green italic'
|
|
||||||
|
|
||||||
[sudo]
|
|
||||||
format = "[$symbol]($style)"
|
|
||||||
style = "italic bright-purple"
|
|
||||||
symbol = "◇┈"
|
|
||||||
disabled = false
|
|
||||||
|
|
||||||
[username]
|
|
||||||
style_user = "yellow bold"
|
|
||||||
style_root = "purple bold italic"
|
|
||||||
format = "[$user]($style) ▻ "
|
|
||||||
disabled = false
|
|
||||||
|
|
||||||
[directory]
|
|
||||||
home_symbol = "⌂"
|
|
||||||
truncation_length = 2
|
|
||||||
truncation_symbol = "▦ "
|
|
||||||
read_only = " ■"
|
|
||||||
style = "italic blue"
|
|
||||||
format = ' [$path]($style)[$read_only]($read_only_style)'
|
|
||||||
|
|
||||||
[cmd_duration]
|
|
||||||
min_time = 500
|
|
||||||
format = "[$duration ](italic bright-yellow)"
|
|
||||||
|
|
||||||
[jobs]
|
|
||||||
format = "[ $symbol$number]($style)"
|
|
||||||
style = "white"
|
|
||||||
symbol = "[▶ ](blue italic)"
|
|
||||||
|
|
||||||
[localip]
|
|
||||||
ssh_only = true
|
|
||||||
format = " ◯[$localipv4](bold magenta)"
|
|
||||||
disabled = false
|
|
||||||
|
|
||||||
[time]
|
|
||||||
disabled = false
|
|
||||||
format = "[ $time]($style)"
|
|
||||||
time_format = "%R"
|
|
||||||
utc_time_offset = "local"
|
|
||||||
style = "dimmed white"
|
|
||||||
|
|
||||||
[battery]
|
|
||||||
format = "[ $percentage $symbol]($style)"
|
|
||||||
full_symbol = "[█](italic green)"
|
|
||||||
charging_symbol = "[↑](italic green)"
|
|
||||||
discharging_symbol = "[↓](italic)"
|
|
||||||
unknown_symbol = "[░](italic)"
|
|
||||||
empty_symbol = "[▃](italic red)"
|
|
||||||
|
|
||||||
[[battery.display]]
|
|
||||||
threshold = 40
|
|
||||||
style = "dimmed yellow"
|
|
||||||
|
|
||||||
[[battery.display]]
|
|
||||||
threshold = 70
|
|
||||||
style = "dimmed white"
|
|
||||||
|
|
||||||
[git_branch]
|
|
||||||
format = "[ $symbol $branch(:$remote_branch)]($style)"
|
|
||||||
symbol = "[◬](bold bright-blue)"
|
|
||||||
style = "bold italic bright-blue"
|
|
||||||
|
|
||||||
[git_status]
|
|
||||||
style = "italic bright-blue"
|
|
||||||
format = """([⎪$ahead_behind$staged$modified$untracked$renamed$deleted$conflicted$stashed⎥]($style))"""
|
|
||||||
conflicted = "[◪◦](italic bright-magenta)"
|
|
||||||
ahead = "[▲│[${count}](bold white)│](italic green)"
|
|
||||||
behind = "[▽│[${count}](bold white)│](italic red)"
|
|
||||||
diverged = "[◇ ▲┤[${ahead_count}](regular white)│▽┤[${behind_count}](regular white)│](italic bright-magenta)"
|
|
||||||
untracked = "[◌◦](italic bright-yellow)"
|
|
||||||
stashed = "[◦◫◦](italic white)"
|
|
||||||
modified = "[●◦](italic yellow)"
|
|
||||||
staged = "[■┤[$count](bold white)│](italic bright-cyan)"
|
|
||||||
renamed = "[◎◦](italic bright-blue)"
|
|
||||||
deleted = "[✕](italic red)"
|
|
||||||
|
|
||||||
[deno]
|
|
||||||
format = " deno [∫ $version](blue italic)"
|
|
||||||
version_format = "${major}.${minor}"
|
|
||||||
|
|
||||||
[lua]
|
|
||||||
format = " lua [${symbol}${version}]($style)"
|
|
||||||
symbol = "⨀ "
|
|
||||||
style = "italic bright-yellow"
|
|
||||||
|
|
||||||
[nodejs]
|
|
||||||
format = " node [◫ ($version)](italic bright-green)"
|
|
||||||
detect_files = ["package-lock.json", "yarn.lock"]
|
|
||||||
version_format = "${major}.${minor}"
|
|
||||||
|
|
||||||
[python]
|
|
||||||
format = " py [${symbol}${version}]($style)"
|
|
||||||
symbol = "[⌉](italic bright-blue)⌊ "
|
|
||||||
version_format = "${major}.${minor}"
|
|
||||||
style = "italic bright-yellow"
|
|
||||||
|
|
||||||
[ruby]
|
|
||||||
format = " rb [${symbol}${version}]($style)"
|
|
||||||
symbol = "◆ "
|
|
||||||
version_format = "${major}.${minor}"
|
|
||||||
style = "italic red"
|
|
||||||
|
|
||||||
[rust]
|
|
||||||
format = " rs [$symbol$version]($style)"
|
|
||||||
symbol = "⊃ "
|
|
||||||
version_format = "${major}.${minor}"
|
|
||||||
style = "italic red"
|
|
||||||
|
|
||||||
[package]
|
|
||||||
format = " pkg [$symbol$version]($style)"
|
|
||||||
version_format = "${major}.${minor}"
|
|
||||||
symbol = "◫ "
|
|
||||||
style = "bright-yellow italic"
|
|
||||||
|
|
||||||
[swift]
|
|
||||||
format = " sw [${symbol}${version}]($style)"
|
|
||||||
symbol = "◁ "
|
|
||||||
style = "italic bright-red"
|
|
||||||
version_format = "${major}.${minor}"
|
|
||||||
|
|
||||||
[aws]
|
|
||||||
format = " aws [$symbol $profile $region]($style)"
|
|
||||||
style = "italic blue"
|
|
||||||
symbol = "▲ "
|
|
||||||
|
|
||||||
[buf]
|
|
||||||
symbol = "■ "
|
|
||||||
format = " buf [$symbol $version $buf_version]($style)"
|
|
||||||
|
|
||||||
[c]
|
|
||||||
symbol = "∁ "
|
|
||||||
format = " c [$symbol($version(-$name))]($style)"
|
|
||||||
|
|
||||||
[conda]
|
|
||||||
symbol = "◯ "
|
|
||||||
format = " conda [$symbol$environment]($style)"
|
|
||||||
|
|
||||||
[dart]
|
|
||||||
symbol = "◁◅ "
|
|
||||||
format = " dart [$symbol($version )]($style)"
|
|
||||||
|
|
||||||
[docker_context]
|
|
||||||
symbol = "◧ "
|
|
||||||
format = " docker [$symbol$context]($style)"
|
|
||||||
|
|
||||||
[elixir]
|
|
||||||
symbol = "△ "
|
|
||||||
format = " exs [$symbol $version OTP $otp_version ]($style)"
|
|
||||||
|
|
||||||
[elm]
|
|
||||||
symbol = "◩ "
|
|
||||||
format = " elm [$symbol($version )]($style)"
|
|
||||||
|
|
||||||
[golang]
|
|
||||||
symbol = "∩ "
|
|
||||||
format = " go [$symbol($version )]($style)"
|
|
||||||
|
|
||||||
[haskell]
|
|
||||||
symbol = "❯λ "
|
|
||||||
format = " hs [$symbol($version )]($style)"
|
|
||||||
|
|
||||||
[java]
|
|
||||||
symbol = "∪ "
|
|
||||||
format = " java [${symbol}(${version} )]($style)"
|
|
||||||
|
|
||||||
[julia]
|
|
||||||
symbol = "◎ "
|
|
||||||
format = " jl [$symbol($version )]($style)"
|
|
||||||
|
|
||||||
[memory_usage]
|
|
||||||
symbol = "▪▫▪ "
|
|
||||||
format = " mem [${ram}( ${swap})]($style)"
|
|
||||||
|
|
||||||
[nim]
|
|
||||||
symbol = "▴▲▴ "
|
|
||||||
format = " nim [$symbol($version )]($style)"
|
|
||||||
|
|
||||||
[nix_shell]
|
|
||||||
symbol = "⊛ "
|
|
||||||
format = " nix [$symbol$state $name]($style)"
|
|
||||||
|
|
||||||
[spack]
|
|
||||||
symbol = "◇ "
|
|
||||||
format = " spack [$symbol$environment]($style)"
|
|
@ -1,38 +0,0 @@
|
|||||||
.home .hero img
|
|
||||||
max-width: 500px !important
|
|
||||||
min-width: 300px
|
|
||||||
width: 100%
|
|
||||||
|
|
||||||
.center
|
|
||||||
margin 0 auto;
|
|
||||||
width: 80%
|
|
||||||
.demo-video
|
|
||||||
width: 100%
|
|
||||||
margin: 50px 0
|
|
||||||
border-radius: 6px
|
|
||||||
|
|
||||||
.hero
|
|
||||||
margin: 150px 25px 70px
|
|
||||||
|
|
||||||
.action-button
|
|
||||||
background-color: #dd0b78 !important
|
|
||||||
border-bottom: #c6096b !important
|
|
||||||
|
|
||||||
@font-face
|
|
||||||
font-family: 'Nerd Font';
|
|
||||||
src: url("/nerd-font.woff2") format("woff2");
|
|
||||||
font-weight: 400;
|
|
||||||
font-style: normal
|
|
||||||
|
|
||||||
code
|
|
||||||
font-family: 'Nerd Font', source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace;
|
|
||||||
overflow-wrap: break-word
|
|
||||||
|
|
||||||
@media (prefers-color-scheme: light)
|
|
||||||
:root
|
|
||||||
--languageTextColor: rgba(255,255,255,0.4)
|
|
||||||
|
|
||||||
.code-copy
|
|
||||||
position: absolute
|
|
||||||
right: 0
|
|
||||||
bottom: 1px
|
|
@ -1,6 +0,0 @@
|
|||||||
$accentColor = #DD0B78
|
|
||||||
$accentDarkColor = #ff33b8
|
|
||||||
$textColor = #2c3e50
|
|
||||||
$borderColor = #eaecef
|
|
||||||
$codeBgLightColor = #282c34
|
|
||||||
$preTextLightColor = #fff
|
|
@ -1,10 +1,13 @@
|
|||||||
---
|
---
|
||||||
home: true
|
layout: home
|
||||||
heroImage: /logo.svg
|
hero:
|
||||||
heroText: null
|
image: /logo.svg
|
||||||
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell!
|
text: null
|
||||||
actionText: Get Started →
|
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell!
|
||||||
actionLink: ./guide/
|
actions:
|
||||||
|
- theme: brand
|
||||||
|
text: Get Started →
|
||||||
|
link: ./guide/
|
||||||
features:
|
features:
|
||||||
- title: Compatibility First
|
- title: Compatibility First
|
||||||
details: Works on the most common shells on the most common operating systems. Use it everywhere!
|
details: Works on the most common shells on the most common operating systems. Use it everywhere!
|
||||||
@ -19,12 +22,24 @@ 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.
|
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.
|
||||||
---
|
---
|
||||||
|
|
||||||
<div class="center">
|
<script setup>
|
||||||
<video class="demo-video" muted autoplay loop playsinline>
|
import { onMounted } from 'vue'
|
||||||
<source src="/demo.webm" type="video/webm">
|
|
||||||
<source src="/demo.mp4" type="video/mp4">
|
onMounted(() => {
|
||||||
</video>
|
const urlParams = new URLSearchParams(window.location.search)
|
||||||
</div>
|
if (urlParams.has('uwu') || urlParams.has('kawaii')) {
|
||||||
|
const img = document.querySelector('.VPHero .VPImage.image-src')
|
||||||
|
img.classList.add('uwu')
|
||||||
|
img.src = '/logo-uwu.png'
|
||||||
|
img.alt = 'Kawaii Starship Logo by @sawaratsuki1004'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<video class="demo-video" muted autoplay loop playsinline>
|
||||||
|
<source src="/demo.webm" type="video/webm">
|
||||||
|
<source src="/demo.mp4" type="video/mp4">
|
||||||
|
</video>
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
@ -51,6 +66,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
|||||||
```sh
|
```sh
|
||||||
brew install starship
|
brew install starship
|
||||||
```
|
```
|
||||||
|
|
||||||
With [Winget](https://github.com/microsoft/winget-cli):
|
With [Winget](https://github.com/microsoft/winget-cli):
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
@ -138,20 +154,15 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
|||||||
::: warning
|
::: warning
|
||||||
|
|
||||||
This will change in the future.
|
This will change in the future.
|
||||||
Only Nushell v0.78+ is supported.
|
Only Nushell v0.96+ is supported.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||||
```sh
|
|
||||||
mkdir ~/.cache/starship
|
|
||||||
starship init nu | save -f ~/.cache/starship/init.nu
|
|
||||||
```
|
|
||||||
|
|
||||||
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
use ~/.cache/starship/init.nu
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Xonsh
|
#### Xonsh
|
||||||
|
@ -106,6 +106,41 @@ starship init fish | source
|
|||||||
enable_transience
|
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 \<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
|
||||||
|
|
||||||
|
```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
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bleopt prompt_rps1_final='$(starship module time)'
|
||||||
|
```
|
||||||
|
|
||||||
## Custom pre-prompt and pre-execution Commands in Cmd
|
## Custom pre-prompt and pre-execution Commands in Cmd
|
||||||
|
|
||||||
Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands
|
Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands
|
||||||
@ -259,9 +294,11 @@ in `format` is also supported in `right_format`. The `$all` variable will only c
|
|||||||
not explicitly used in either `format` or `right_format`.
|
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
|
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).
|
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.
|
`right_format` is currently supported for the following 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.
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
@ -300,7 +337,7 @@ Note: Continuation prompts are only available in the following shells:
|
|||||||
```toml
|
```toml
|
||||||
# ~/.config/starship.toml
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
# A continuation prompt that displays two filled in arrows
|
# A continuation prompt that displays two filled-in arrows
|
||||||
continuation_prompt = '▶▶ '
|
continuation_prompt = '▶▶ '
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -321,7 +358,9 @@ Style strings are a list of words, separated by whitespace. The words are not ca
|
|||||||
- `<color>`
|
- `<color>`
|
||||||
- `none`
|
- `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. `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.
|
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.
|
||||||
|
|
||||||
@ -338,6 +377,6 @@ If multiple colors are specified for foreground/background, the last one in the
|
|||||||
|
|
||||||
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
|
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
|
||||||
|
|
||||||
- Many terminals disable support for `blink` by default
|
- Many terminals disable support for `blink` by default.
|
||||||
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
|
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
|
||||||
- `strikethrough` is not supported by the default macOS Terminal.app
|
- `strikethrough` is not supported by the default macOS Terminal.app.
|
||||||
|
@ -1,10 +1,14 @@
|
|||||||
---
|
---
|
||||||
home: true
|
layout: home
|
||||||
heroImage: /logo.svg
|
hero:
|
||||||
heroText:
|
image: /logo.svg
|
||||||
tagline: التخصيص البسيط و السريع و الغير محدود لي ال"shell"!
|
text:
|
||||||
actionText: البدء مع Starship ←
|
tagline: التخصيص البسيط و السريع و الغير محدود لي ال"shell"!
|
||||||
actionLink: ./guide/
|
actions:
|
||||||
|
-
|
||||||
|
theme: brand
|
||||||
|
text: البدء مع Starship ←
|
||||||
|
link: ./guide/
|
||||||
features:
|
features:
|
||||||
-
|
-
|
||||||
title: التوافق أولاً
|
title: التوافق أولاً
|
||||||
@ -21,12 +25,24 @@ 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.
|
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.
|
||||||
---
|
---
|
||||||
|
|
||||||
<div class="center">
|
<script setup>
|
||||||
<video class="demo-video" muted autoplay loop playsinline>
|
import { onMounted } from 'vue'
|
||||||
<source src="/demo.webm" type="video/webm">
|
|
||||||
<source src="/demo.mp4" type="video/mp4">
|
onMounted(() => {
|
||||||
</video>
|
const urlParams = new URLSearchParams(window.location.search)
|
||||||
</div>
|
if (urlParams.has('uwu') || urlParams.has('kawaii')) {
|
||||||
|
const img = document.querySelector('.VPHero .VPImage.image-src')
|
||||||
|
img.classList.add('uwu')
|
||||||
|
img.src = '/logo-uwu.png'
|
||||||
|
img.alt = 'Kawaii Starship Logo by @sawaratsuki1004'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<video class="demo-video" muted autoplay loop playsinline>
|
||||||
|
<source src="/demo.webm" type="video/webm">
|
||||||
|
<source src="/demo.mp4" type="video/mp4">
|
||||||
|
</video>
|
||||||
|
|
||||||
### المتطلبات الأساسية
|
### المتطلبات الأساسية
|
||||||
|
|
||||||
@ -55,6 +71,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
|||||||
```sh
|
```sh
|
||||||
brew install starship
|
brew install starship
|
||||||
```
|
```
|
||||||
|
|
||||||
With [Winget](https://github.com/microsoft/winget-cli):
|
With [Winget](https://github.com/microsoft/winget-cli):
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
@ -149,20 +166,15 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
|
|||||||
|
|
||||||
::: warning
|
::: warning
|
||||||
|
|
||||||
This will change in the future. Only Nushell v0.78+ is supported.
|
This will change in the future. Only Nushell v0.96+ is supported.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||||
```sh
|
|
||||||
mkdir ~/.cache/starship
|
|
||||||
starship init nu | save -f ~/.cache/starship/init.nu
|
|
||||||
```
|
|
||||||
|
|
||||||
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
use ~/.cache/starship/init.nu
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@ -80,6 +80,26 @@ starship init fish | source
|
|||||||
enable_transience
|
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 \<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
|
||||||
|
|
||||||
|
```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
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bleopt prompt_rps1_final='$(starship module time)'
|
||||||
|
```
|
||||||
|
|
||||||
## Custom pre-prompt and pre-execution Commands in Cmd
|
## 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:
|
||||||
@ -203,9 +223,11 @@ Invoke-Expression (&starship init powershell)
|
|||||||
|
|
||||||
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.
|
`right_format` is currently supported for the following 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.
|
||||||
|
|
||||||
### مثال
|
### مثال
|
||||||
|
|
||||||
@ -244,7 +266,7 @@ Note: Continuation prompts are only available in the following shells:
|
|||||||
```toml
|
```toml
|
||||||
# ~/.config/starship.toml
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
# A continuation prompt that displays two filled in arrows
|
# A continuation prompt that displays two filled-in arrows
|
||||||
continuation_prompt = '▶▶ '
|
continuation_prompt = '▶▶ '
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -265,7 +287,7 @@ Style strings are a list of words, separated by whitespace. The words are not ca
|
|||||||
- `<color>`
|
- `<color>`
|
||||||
- `none`
|
- `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. `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.
|
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.
|
||||||
|
|
||||||
@ -279,6 +301,6 @@ If multiple colors are specified for foreground/background, the last one in the
|
|||||||
|
|
||||||
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
|
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
|
||||||
|
|
||||||
- Many terminals disable support for `blink` by default
|
- Many terminals disable support for `blink` by default.
|
||||||
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
|
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
|
||||||
- `strikethrough` is not supported by the default macOS Terminal.app
|
- `strikethrough` is not supported by the default macOS Terminal.app.
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -58,7 +58,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
|||||||
|
|
||||||
## Why do I see `Executing command "..." timed out.` warnings?
|
## 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?
|
## I see symbols I don't understand or expect, what do they mean?
|
||||||
|
|
||||||
@ -72,7 +72,7 @@ You can enable the debug logs by using the `STARSHIP_LOG` env var. These logs ca
|
|||||||
env STARSHIP_LOG=trace starship module rust
|
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 to blame.
|
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.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
env STARSHIP_LOG=trace starship timings
|
env STARSHIP_LOG=trace starship timings
|
||||||
@ -120,3 +120,11 @@ If Starship was installed using the install script, the following command will d
|
|||||||
# Locate and delete the starship binary
|
# Locate and delete the starship binary
|
||||||
sh -c 'rm "$(command -v 'starship')"'
|
sh -c 'rm "$(command -v 'starship')"'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## How do I install Starship without `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`.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
When using a package manager, see the documentation for your package manager about installing with or without `sudo`.
|
||||||
|
@ -20,7 +20,7 @@
|
|||||||
<a href="https://repology.org/project/starship/versions"
|
<a href="https://repology.org/project/starship/versions"
|
||||||
><img
|
><img
|
||||||
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
|
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
|
||||||
alt="Packaging status" /></a
|
alt="واقع التغليف" /></a
|
||||||
><br />
|
><br />
|
||||||
<a href="https://discord.gg/starship"
|
<a href="https://discord.gg/starship"
|
||||||
><img
|
><img
|
||||||
@ -32,6 +32,11 @@
|
|||||||
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||||||
alt="تابع @StarshipPrompt على تويتر"
|
alt="تابع @StarshipPrompt على تويتر"
|
||||||
/></a>
|
/></a>
|
||||||
|
<a href="https://stand-with-ukraine.pp.ua"
|
||||||
|
><img
|
||||||
|
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
|
||||||
|
alt="Stand With Ukraine"
|
||||||
|
/></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
@ -87,7 +92,7 @@
|
|||||||
><img
|
><img
|
||||||
height="20"
|
height="20"
|
||||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
|
||||||
alt="Italiano"
|
alt="الإيطالية"
|
||||||
/></a>
|
/></a>
|
||||||
|
|
||||||
<a
|
<a
|
||||||
@ -147,8 +152,6 @@
|
|||||||
/></a>
|
/></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
|
|
||||||
|
|
||||||
<h1></h1>
|
<h1></h1>
|
||||||
|
|
||||||
<img
|
<img
|
||||||
@ -168,7 +171,7 @@
|
|||||||
- **Easy:** سريع التثبيت – استخدمها في دقائق معدودة.
|
- **Easy:** سريع التثبيت – استخدمها في دقائق معدودة.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://starship.rs/config/"><strong>استكشف مستندات Starship ▶</strong></a>
|
<a href="https://starship.rs/config/"><strong>تصفّح مستندات Starship ▶</strong></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<a name="🚀-installation"></a>
|
<a name="🚀-installation"></a>
|
||||||
@ -229,6 +232,7 @@ curl -sS https://starship.rs/install.sh | sh
|
|||||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||||
| Manjaro | | `pacman -S starship` |
|
| Manjaro | | `pacman -S starship` |
|
||||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||||
|
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
@ -299,7 +303,7 @@ load(io.popen('starship init cmd'):read("*a"))()
|
|||||||
<details>
|
<details>
|
||||||
<summary>Elvish</summary>
|
<summary>Elvish</summary>
|
||||||
|
|
||||||
أضف ما يلي إلى نهاية `~/.elvish/rc.elv`:
|
أضف ما يلي إلى نهاية الملف `~/.elvish/rc.elv`:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
eval (starship init elvish)
|
eval (starship init elvish)
|
||||||
@ -334,20 +338,14 @@ eval $(starship init ion)
|
|||||||
<details>
|
<details>
|
||||||
<summary>Nushell</summary>
|
<summary>Nushell</summary>
|
||||||
|
|
||||||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
mkdir ~/.cache/starship
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
starship init nu | save -f ~/.cache/starship/init.nu
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
```
|
```
|
||||||
|
|
||||||
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
|
Note: Only Nushell v0.96+ is supported
|
||||||
|
|
||||||
```sh
|
|
||||||
use ~/.cache/starship/init.nu
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: Only Nushell v0.78+ is supported
|
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
@ -427,9 +425,16 @@ If you're looking to further customize Starship:
|
|||||||
|
|
||||||
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
|
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
|
||||||
|
|
||||||
**Supporter Tier**
|
## 🔒 Code Signing Policy
|
||||||
|
|
||||||
- [Appwrite](https://appwrite.io/)
|
Free code signing provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org).
|
||||||
|
|
||||||
|
Code Signing Roles:
|
||||||
|
|
||||||
|
- Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts)
|
||||||
|
- Approvers and Authors: [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.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<br>
|
<br>
|
||||||
|
@ -1,19 +1,19 @@
|
|||||||
# التثبيت المتقدم
|
# Advanced Installation
|
||||||
|
|
||||||
To install starship, you need to do two things:
|
لثتبيت starship تحتاج للقيام بشيئين هما:
|
||||||
|
|
||||||
1. Get the **starship** binary onto your computer
|
1. ثبت ملفات **starship** على جهازك
|
||||||
1. Tell your shell to use the starship binary as its prompt by modifying its init scripts
|
1. تنبيه موجه الأوامر بإن يقوم بجعل سطر الأوامر ل starship وذلك بتعديل كود الإبتداء
|
||||||
|
|
||||||
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
|
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. لكن، من أجل الاستخدام المتقدم، هناك حاجة لتوجيهات أخرى.
|
||||||
|
|
||||||
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
|
هناك العديد من الحالات التي لا تلبي المعلومات في ملف README.md احتياجها ولذلك هذه بعض إرشادات التثبيت الإضافية مقدمة من مجتمع starship. إذا كانت لديك ملاحظة وقمت بحلها ولم تجد هذا الحل لها ضمن الحلول التالية، الرجاء أضفها هنا!
|
||||||
|
|
||||||
## [Chocolatey](https://chocolatey.org)
|
## [Chocolatey](https://chocolatey.org)
|
||||||
|
|
||||||
### المتطلبات الأساسية
|
### المتطلبات الأساسية
|
||||||
|
|
||||||
Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
|
إذهب إلى [ صفحة تثبيت Chocolatey ](https://chocolatey.org/install) و اتبع الإرشادات لتثبيت البرنامج.
|
||||||
|
|
||||||
### التثبيت
|
### التثبيت
|
||||||
|
|
||||||
@ -39,25 +39,25 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term
|
|||||||
|
|
||||||
### التثبيت
|
### التثبيت
|
||||||
|
|
||||||
On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage:
|
يمكن تثبيت starship في Funtoo linux باستخدام [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
emerge app-shells/starship
|
emerge app-shells/starship
|
||||||
```
|
```
|
||||||
|
|
||||||
## [Nix](https://nixos.wiki/wiki/Nix)
|
## [Nix](https://wiki.nixos.org/wiki/Nix)
|
||||||
|
|
||||||
### Getting the Binary
|
### احصل على ملفات الباينري
|
||||||
|
|
||||||
#### Imperatively
|
#### بشكل مباشر
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
nix-env -iA nixos.starship
|
nix-env -iA nixos.starship
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
#### بشكل تصريحي، من أجل مستخدم واحد، عبر [home-manager](https://github.com/nix-community/home-manager)
|
||||||
|
|
||||||
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
مكن كود`programs.starship` في ملف`home.nix` و أضف إلى الإعدادات الإعدادات التالية
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
{
|
{
|
||||||
@ -78,15 +78,15 @@ Enable the `programs.starship` module in your `home.nix` file, and add your sett
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
then run
|
ثم بعد ذلك شغل
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
home-manager switch
|
home-manager switch
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Declarative, system-wide, with NixOS
|
#### بشكل تصريحي، لعدة مستخدمين
|
||||||
|
|
||||||
Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run
|
أضف `pkgs.starship` إلى `environment.systemPackages` في `configuration.nix`, بعد ذلك شغل
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
sudo nixos-rebuild switch
|
sudo nixos-rebuild switch
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
# Migrating to v0.45.0
|
# الإنتقال إلى النسخة v0.45.0
|
||||||
|
|
||||||
Starship v0.45.0 is a release containing breaking changes, in preparation for the big v1.0.0. We have made some major changes around how configuration is done on the prompt, to allow for a greater degree of customization.
|
النسخة 0.45.0 سوف تستمر في تقديم تحديثات جذرية حتى الوصول للنسخة المستقرة 1.0.0. لقد قمنا بتغييرات رئيسية لكيفية إعداد سطر الأوامر، وذلك يسمح بطيف أكبر من قابلية التخصيص.
|
||||||
|
|
||||||
This guide is intended to walk you through the breaking changes.
|
هذا الدليل هو جولة خلال التغييرات الرئيسية التي قمنا بها.
|
||||||
|
|
||||||
## `prompt_order` has been replaced by a root-level `format`
|
## `prompt_order`تم استبداله بتنسيق 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.
|
Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship.
|
||||||
|
|
||||||
|
@ -63,3 +63,15 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
|
|||||||
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
||||||
|
|
||||||
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
|
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
|
||||||
|
|
||||||
|
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
|
||||||
|
|
||||||
|
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||||
|
|
||||||
|
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./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.
|
||||||
|
|
||||||
|
[![Screenshot of Jetpack preset](/presets/img/jetpack.png "Click to view Jetpack preset")](./jetpack)
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#bracketed-segments)
|
[Return to Presets](./#bracketed-segments)
|
||||||
|
|
||||||
# Bracketed Segments Preset
|
# Bracketed Segments Preset
|
||||||
|
|
||||||
@ -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
|
starship preset bracketed-segments -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/bracketed-segments.toml)
|
[Click to download TOML](/presets/toml/bracketed-segments.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml
|
<<< @/public/presets/toml/bracketed-segments.toml
|
||||||
|
21
docs/ar-SA/presets/gruvbox-rainbow.md
Normal file
21
docs/ar-SA/presets/gruvbox-rainbow.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
[Return to Presets](./#gruvbox-rainbow)
|
||||||
|
|
||||||
|
# Gruvbox Rainbow Preset
|
||||||
|
|
||||||
|
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||||
|
|
||||||
|
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
|
||||||
|
|
||||||
|
### المتطلبات الأساسية
|
||||||
|
|
||||||
|
- تثبيت [Nerd Font](https://www.nerdfonts.com/) وتمكينه في موجه الأوامر الخاصة بك
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset gruvbox-rainbow -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/gruvbox-rainbow.toml
|
24
docs/ar-SA/presets/jetpack.md
Normal file
24
docs/ar-SA/presets/jetpack.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
[Return to Presets](./#jetpack)
|
||||||
|
|
||||||
|
# Jetpack Preset
|
||||||
|
|
||||||
|
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||||
|
|
||||||
|
> Jetpack uses the terminal's color theme.
|
||||||
|
|
||||||
|
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
|
||||||
|
|
||||||
|
### Prerequisite
|
||||||
|
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset jetpack -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/jetpack.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/jetpack.toml
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#nerd-font-symbols)
|
[Return to Presets](./#nerd-font-symbols)
|
||||||
|
|
||||||
# Nerd Font Symbols Preset
|
# Nerd Font Symbols Preset
|
||||||
|
|
||||||
@ -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
|
starship preset nerd-font-symbols -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/nerd-font-symbols.toml)
|
[Click to download TOML](/presets/toml/nerd-font-symbols.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml
|
<<< @/public/presets/toml/nerd-font-symbols.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#no-empty-icons)
|
[Return to Presets](./#no-empty-icons)
|
||||||
|
|
||||||
# No Empty Icons Preset
|
# No Empty Icons Preset
|
||||||
|
|
||||||
@ -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
|
starship preset no-empty-icons -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/no-empty-icons.toml)
|
[Click to download TOML](/presets/toml/no-empty-icons.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
|
<<< @/public/presets/toml/no-empty-icons.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#no-nerd-fonts)
|
[Return to Presets](./#no-nerd-fonts)
|
||||||
|
|
||||||
# No Nerd Fonts Preset
|
# No Nerd Fonts Preset
|
||||||
|
|
||||||
@ -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
|
starship preset no-nerd-font -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/no-nerd-font.toml)
|
[Click to download TOML](/presets/toml/no-nerd-font.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
|
<<< @/public/presets/toml/no-nerd-font.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#no-runtime-versions)
|
[Return to Presets](./#no-runtime-versions)
|
||||||
|
|
||||||
# No Runtime Versions Preset
|
# No Runtime Versions Preset
|
||||||
|
|
||||||
@ -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
|
starship preset no-runtime-versions -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/no-runtime-versions.toml)
|
[Click to download TOML](/presets/toml/no-runtime-versions.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml
|
<<< @/public/presets/toml/no-runtime-versions.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#pastel-powerline)
|
[Return to Presets](./#pastel-powerline)
|
||||||
|
|
||||||
# Pastel Powerline Preset
|
# Pastel Powerline Preset
|
||||||
|
|
||||||
@ -16,6 +16,6 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
|
|||||||
starship preset pastel-powerline -o ~/.config/starship.toml
|
starship preset pastel-powerline -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/pastel-powerline.toml)
|
[Click to download TOML](/presets/toml/pastel-powerline.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml
|
<<< @/public/presets/toml/pastel-powerline.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#plain-text-symbols)
|
[Return to Presets](./#plain-text-symbols)
|
||||||
|
|
||||||
## Plain Text Symbols Preset
|
## Plain Text Symbols Preset
|
||||||
|
|
||||||
@ -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
|
starship preset plain-text-symbols -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/plain-text-symbols.toml)
|
[Click to download TOML](/presets/toml/plain-text-symbols.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml
|
<<< @/public/presets/toml/plain-text-symbols.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#pure)
|
[Return to Presets](./#pure)
|
||||||
|
|
||||||
# Pure Preset
|
# Pure Preset
|
||||||
|
|
||||||
@ -12,6 +12,6 @@ This preset emulates the look and behavior of [Pure](https://github.com/sindreso
|
|||||||
starship preset pure-preset -o ~/.config/starship.toml
|
starship preset pure-preset -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/pure-preset.toml)
|
[Click to download TOML](/presets/toml/pure-preset.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/pure-preset.toml
|
<<< @/public/presets/toml/pure-preset.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#pastel-powerline)
|
[Return to Presets](./#pastel-powerline)
|
||||||
|
|
||||||
# Tokyo Night Preset
|
# Tokyo Night Preset
|
||||||
|
|
||||||
@ -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
|
starship preset tokyo-night -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/tokyo-night.toml)
|
[Click to download TOML](/presets/toml/tokyo-night.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/tokyo-night.toml
|
<<< @/public/presets/toml/tokyo-night.toml
|
||||||
|
200
docs/bn-BD/README.md
Normal file
200
docs/bn-BD/README.md
Normal file
@ -0,0 +1,200 @@
|
|||||||
|
---
|
||||||
|
layout: home
|
||||||
|
hero:
|
||||||
|
image: /logo.svg
|
||||||
|
text:
|
||||||
|
tagline: আপনার টার্মিনাল এর জন্য একটি সহজ, প্রচণ্ড দ্রুত এবং অশেষভাবে কাস্টমাইজ করার মতো সুবিধাসম্পন্ন একটি প্রম্প্ট!
|
||||||
|
actions:
|
||||||
|
-
|
||||||
|
theme: brand
|
||||||
|
text: Get Started →
|
||||||
|
link: ./guide/
|
||||||
|
features:
|
||||||
|
-
|
||||||
|
title: Compatibility First
|
||||||
|
details: Works on the most common shells on the most common operating systems. Use it everywhere!
|
||||||
|
-
|
||||||
|
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
|
||||||
|
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
|
||||||
|
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.
|
||||||
|
---
|
||||||
|
|
||||||
|
<script setup>
|
||||||
|
import { onMounted } from 'vue'
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
const urlParams = new URLSearchParams(window.location.search)
|
||||||
|
if (urlParams.has('uwu') || urlParams.has('kawaii')) {
|
||||||
|
const img = document.querySelector('.VPHero .VPImage.image-src')
|
||||||
|
img.classList.add('uwu')
|
||||||
|
img.src = '/logo-uwu.png'
|
||||||
|
img.alt = 'Kawaii Starship Logo by @sawaratsuki1004'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<video class="demo-video" muted autoplay loop playsinline>
|
||||||
|
<source src="/demo.webm" type="video/webm">
|
||||||
|
<source src="/demo.mp4" type="video/mp4">
|
||||||
|
</video>
|
||||||
|
|
||||||
|
### পূর্বশর্ত
|
||||||
|
|
||||||
|
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal.
|
||||||
|
|
||||||
|
### Quick Install
|
||||||
|
|
||||||
|
1. Install the **starship** binary:
|
||||||
|
|
||||||
|
|
||||||
|
#### Install Latest Version
|
||||||
|
|
||||||
|
With Shell:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl -sS https://starship.rs/install.sh | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
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/):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
brew install starship
|
||||||
|
```
|
||||||
|
|
||||||
|
With [Winget](https://github.com/microsoft/winget-cli):
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
winget install starship
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Add the init script to your shell's config file:
|
||||||
|
|
||||||
|
|
||||||
|
#### Bash
|
||||||
|
|
||||||
|
`~/.bashrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# ~/.bashrc
|
||||||
|
|
||||||
|
eval "$(starship init bash)"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Fish
|
||||||
|
|
||||||
|
`~/.config/fish/config.fish` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# ~/.config/fish/config.fish
|
||||||
|
|
||||||
|
starship init fish | source
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Zsh
|
||||||
|
|
||||||
|
`~/.zshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# ~/.zshrc
|
||||||
|
|
||||||
|
eval "$(starship init zsh)"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### 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.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
Invoke-Expression (&starship init powershell)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Ion
|
||||||
|
|
||||||
|
`~/.config/ion/initrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# ~/.config/ion/initrc
|
||||||
|
|
||||||
|
eval $(starship init ion)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Elvish
|
||||||
|
|
||||||
|
::: warning
|
||||||
|
|
||||||
|
Only elvish v0.18 or higher is supported.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
`~/.elvish/rc.elv` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# ~/.elvish/rc.elv
|
||||||
|
|
||||||
|
eval (starship init elvish)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Tcsh
|
||||||
|
|
||||||
|
`~/.tcshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# ~/.tcshrc
|
||||||
|
|
||||||
|
eval `starship init tcsh`
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Nushell
|
||||||
|
|
||||||
|
::: 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):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Xonsh
|
||||||
|
|
||||||
|
`~/.xonshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# ~/.xonshrc
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
```lua
|
||||||
|
-- starship.lua
|
||||||
|
|
||||||
|
load(io.popen('starship init cmd'):read("*a"))()
|
||||||
|
```
|
306
docs/bn-BD/advanced-config/README.md
Normal file
306
docs/bn-BD/advanced-config/README.md
Normal file
@ -0,0 +1,306 @@
|
|||||||
|
# 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.
|
||||||
|
|
||||||
|
::: 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`.
|
||||||
|
|
||||||
|
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 {
|
||||||
|
&starship module character
|
||||||
|
}
|
||||||
|
|
||||||
|
Invoke-Expression (&starship init powershell)
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
- `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:
|
||||||
|
|
||||||
|
- 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)
|
||||||
|
return io.popen("starship module character"
|
||||||
|
.." --keymap="..rl.getvariable('keymap')
|
||||||
|
):read("*a")
|
||||||
|
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
|
||||||
|
|
||||||
|
```lua
|
||||||
|
function starship_transient_rprompt_func(prompt)
|
||||||
|
return io.popen("starship module time"):read("*a")
|
||||||
|
end
|
||||||
|
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`.
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
```fish
|
||||||
|
function starship_transient_prompt_func
|
||||||
|
starship module character
|
||||||
|
end
|
||||||
|
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
|
||||||
|
|
||||||
|
```fish
|
||||||
|
function starship_transient_rprompt_func
|
||||||
|
starship module time
|
||||||
|
end
|
||||||
|
starship init fish | source
|
||||||
|
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 \<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
|
||||||
|
|
||||||
|
```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
|
||||||
|
|
||||||
|
```bash
|
||||||
|
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:
|
||||||
|
|
||||||
|
- 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)
|
||||||
|
print("🚀")
|
||||||
|
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
|
||||||
|
|
||||||
|
```lua
|
||||||
|
function starship_precmd_user_func(line)
|
||||||
|
print("Executing: "..line)
|
||||||
|
end
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
- 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(){
|
||||||
|
echo "🚀"
|
||||||
|
}
|
||||||
|
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.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
function blastoff(){
|
||||||
|
echo "🚀"
|
||||||
|
}
|
||||||
|
trap blastoff DEBUG # Trap DEBUG *before* running starship
|
||||||
|
set -o functrace
|
||||||
|
eval $(starship init bash)
|
||||||
|
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:
|
||||||
|
|
||||||
|
Create a function named `Invoke-Starship-PreCommand`
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
function Invoke-Starship-PreCommand {
|
||||||
|
$host.ui.Write("🚀")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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`.
|
||||||
|
|
||||||
|
First, define a window title change function (identical in bash and zsh):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
function set_win_title(){
|
||||||
|
echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
You can use variables to customize this title (`$USER`, `$HOSTNAME`, and `$PWD` are popular choices).
|
||||||
|
|
||||||
|
In `bash`, set this function to be the precmd starship function:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
starship_precmd_user_func="set_win_title"
|
||||||
|
```
|
||||||
|
|
||||||
|
In `zsh`, add this to the `precmd_functions` array:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
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.
|
||||||
|
|
||||||
|
For example, if you want to display your current directory in your terminal tab title, add the following snippet to your `~/.bashrc` or `~/.zshrc`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
function set_win_title(){
|
||||||
|
echo -ne "\033]0; $(basename "$PWD") \007"
|
||||||
|
}
|
||||||
|
starship_precmd_user_func="set_win_title"
|
||||||
|
```
|
||||||
|
|
||||||
|
For Cmd, you can change the window title using the `starship_preprompt_user_func` function.
|
||||||
|
|
||||||
|
```lua
|
||||||
|
function starship_preprompt_user_func(prompt)
|
||||||
|
console.settitle(os.getenv('USERNAME').."@"..os.getenv('COMPUTERNAME')..": "..os.getcwd())
|
||||||
|
end
|
||||||
|
|
||||||
|
load(io.popen('starship init cmd'):read("*a"))()
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also set a similar output with PowerShell by creating a function named `Invoke-Starship-PreCommand`.
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
# edit $PROFILE
|
||||||
|
function Invoke-Starship-PreCommand {
|
||||||
|
$host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
|
||||||
|
}
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
# A minimal left prompt
|
||||||
|
format = """$character"""
|
||||||
|
|
||||||
|
# move the rest of the prompt to the right
|
||||||
|
right_format = """$all"""
|
||||||
|
```
|
||||||
|
|
||||||
|
Produces a prompt like the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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).
|
||||||
|
|
||||||
|
Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`.
|
||||||
|
|
||||||
|
Note: `continuation_prompt` should be set to a literal string without any variables.
|
||||||
|
|
||||||
|
Note: Continuation prompts are only available in the following shells:
|
||||||
|
|
||||||
|
- `bash`
|
||||||
|
- `zsh`
|
||||||
|
- `PowerShell`
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
# A continuation prompt that displays two filled-in arrows
|
||||||
|
continuation_prompt = '▶▶ '
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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`
|
||||||
|
|
||||||
|
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).
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
|
||||||
|
|
||||||
|
- Many terminals disable support for `blink` by default.
|
||||||
|
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
|
||||||
|
- `strikethrough` is not supported by the default macOS Terminal.app.
|
4691
docs/bn-BD/config/README.md
Normal file
4691
docs/bn-BD/config/README.md
Normal file
File diff suppressed because it is too large
Load Diff
130
docs/bn-BD/faq/README.md
Normal file
130
docs/bn-BD/faq/README.md
Normal file
@ -0,0 +1,130 @@
|
|||||||
|
# Frequently Asked Questions
|
||||||
|
|
||||||
|
## What is the configuration used in the demo GIF?
|
||||||
|
|
||||||
|
- **Terminal Emulator**: [iTerm2](https://iterm2.com/)
|
||||||
|
- **Theme**: Minimal
|
||||||
|
- **Color Scheme**: [Snazzy](https://github.com/sindresorhus/iterm2-snazzy)
|
||||||
|
- **Font**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)
|
||||||
|
- **Shell**: [Fish Shell](https://fishshell.com/)
|
||||||
|
- **Configuration**: [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?
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
## Do top level `format` and `<module>.disabled` do the same thing?
|
||||||
|
|
||||||
|
Yes, they can both be used to disable modules in the prompt. If all you plan to do is disable modules, `<module>.disabled` is the preferred way to do so for these reasons:
|
||||||
|
|
||||||
|
- Disabling modules is more explicit than omitting them from the top level `format`
|
||||||
|
- Newly created modules will be added to the prompt as Starship is updated
|
||||||
|
|
||||||
|
## The docs say Starship is cross-shell. Why isn't my preferred shell supported?
|
||||||
|
|
||||||
|
The way Starship is built, it should be possible to add support for virtually any shell. The starship binary is stateless and shell agnostic, so as long as your shell supports prompt customization and shell expansion, Starship can be used.
|
||||||
|
|
||||||
|
Here's a small example getting Starship working with bash:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Get the status code from the last command executed
|
||||||
|
STATUS=$?
|
||||||
|
|
||||||
|
# Get the number of jobs running.
|
||||||
|
NUM_JOBS=$(jobs -p | wc -l)
|
||||||
|
|
||||||
|
# Set the prompt to the output of `starship prompt`
|
||||||
|
PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
|
||||||
|
```
|
||||||
|
|
||||||
|
The [Bash implementation](https://github.com/starship/starship/blob/master/src/init/starship.bash) built into Starship is slightly more complex to allow for advanced features like the [Command Duration module](https://starship.rs/config/#command-duration) and to ensure that Starship is compatible with pre-installed Bash configurations.
|
||||||
|
|
||||||
|
For a list of all flags accepted by `starship prompt`, use the following command:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship prompt --help
|
||||||
|
```
|
||||||
|
|
||||||
|
The prompt will use as much context as is provided, but no flags are "required".
|
||||||
|
|
||||||
|
## How do I run Starship on Linux distributions with older versions of glibc?
|
||||||
|
|
||||||
|
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`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
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.
|
||||||
|
|
||||||
|
## I see symbols I don't understand or expect, what do they mean?
|
||||||
|
|
||||||
|
If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules.
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
env STARSHIP_LOG=trace starship module rust
|
||||||
|
```
|
||||||
|
|
||||||
|
If starship is being slow you can try using the `timings` command to see if there is a particular module or command that is to blame.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
env STARSHIP_LOG=trace starship timings
|
||||||
|
```
|
||||||
|
|
||||||
|
This will output the trace log and a breakdown of all modules that either took more than 1ms to execute or produced some output.
|
||||||
|
|
||||||
|
Finally if you find a bug you can use the `bug-report` command to create a GitHub issue.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship bug-report
|
||||||
|
```
|
||||||
|
|
||||||
|
## Why don't I see a glyph symbol in my prompt?
|
||||||
|
|
||||||
|
The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that:
|
||||||
|
|
||||||
|
- 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:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
echo -e "\xf0\x9f\x90\x8d"
|
||||||
|
echo -e "\xee\x82\xa0"
|
||||||
|
```
|
||||||
|
|
||||||
|
The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
If Starship was installed using a package manager, please refer to their docs for uninstallation instructions.
|
||||||
|
|
||||||
|
If Starship was installed using the install script, the following command will delete the binary:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Locate and delete the starship binary
|
||||||
|
sh -c 'rm "$(command -v 'starship')"'
|
||||||
|
```
|
||||||
|
|
||||||
|
## How do I install Starship without `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`.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
When using a package manager, see the documentation for your package manager about installing with or without `sudo`.
|
446
docs/bn-BD/guide/README.md
Normal file
446
docs/bn-BD/guide/README.md
Normal file
@ -0,0 +1,446 @@
|
|||||||
|
<p align="center">
|
||||||
|
<img
|
||||||
|
width="400"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
|
||||||
|
alt="Starship – Cross-shell prompt"
|
||||||
|
/>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<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"
|
||||||
|
/></a>
|
||||||
|
<a href="https://crates.io/crates/starship"
|
||||||
|
><img
|
||||||
|
src="https://img.shields.io/crates/v/starship?style=flat-square"
|
||||||
|
alt="Crates.io version"
|
||||||
|
/></a>
|
||||||
|
<a href="https://repology.org/project/starship/versions"
|
||||||
|
><img
|
||||||
|
src="https://img.shields.io/repology/repositories/starship?label=in%20repositories&style=flat-square"
|
||||||
|
alt="Packaging status" /></a
|
||||||
|
><br />
|
||||||
|
<a href="https://discord.gg/starship"
|
||||||
|
><img
|
||||||
|
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
|
||||||
|
alt="Chat on Discord"
|
||||||
|
/></a>
|
||||||
|
<a href="https://twitter.com/StarshipPrompt"
|
||||||
|
><img
|
||||||
|
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||||||
|
alt="Follow @StarshipPrompt on Twitter"
|
||||||
|
/></a>
|
||||||
|
<a href="https://stand-with-ukraine.pp.ua"
|
||||||
|
><img
|
||||||
|
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
|
||||||
|
alt="Stand With Ukraine"
|
||||||
|
/></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<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"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
|
||||||
|
alt="English"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/de-DE/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png"
|
||||||
|
alt="Deutsch"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/es-ES/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
|
||||||
|
alt="Español"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/fr-FR/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
|
||||||
|
alt="Français"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/id-ID/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png"
|
||||||
|
alt="Bahasa Indonesia"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/it-IT/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
|
||||||
|
alt="Italiano"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/ja-JP/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png"
|
||||||
|
alt="日本語"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/pt-BR/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/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"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
|
||||||
|
alt="Русский"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/uk-UA/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ua.png"
|
||||||
|
alt="Українська"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/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"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png"
|
||||||
|
alt="简体中文"
|
||||||
|
/></a>
|
||||||
|
|
||||||
|
<a
|
||||||
|
href="https://github.com/starship/starship/blob/master/docs/zh-TW/guide/README.md"
|
||||||
|
><img
|
||||||
|
height="20"
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png"
|
||||||
|
alt="繁體中文"
|
||||||
|
/></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h1></h1>
|
||||||
|
|
||||||
|
<img
|
||||||
|
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
|
||||||
|
alt="Starship with iTerm2 and the Snazzy theme"
|
||||||
|
width="50%"
|
||||||
|
align="right"
|
||||||
|
/>
|
||||||
|
|
||||||
|
**আপনার টার্মিনাল এর জন্য একটি সহজ, প্রচণ্ড দ্রুত এবং অশেষভাবে কাস্টমাইজ করার মতো সুবিধাসম্পন্ন একটি প্রম্প্ট!**
|
||||||
|
|
||||||
|
- **দ্রুত:** দ্রুত - সত্যি সত্যিই _অনেক_ দ্রুত! 🚀
|
||||||
|
- **কাস্টমাইজ করার সুবিধা:** প্রম্পটের প্রতিটি দিক কনফিগ করুন মন মত ।
|
||||||
|
- **ব্যতিক্রমহীন:** যেকোনো অপারেটিং সিস্টেম ও শেলে কাজ করে ।
|
||||||
|
- **চালাক:** এক নজরে দরকারি সকল তথ্য দেখা যায় ।
|
||||||
|
- **ফিচার সমৃদ্ধ:** আপনার প্রিয় সকল টুল ব্যবহার করতে পারবেন ।
|
||||||
|
- **সহজ:** অনায়াসে ইন্সটল করুন – মিনিটের মধ্যে ব্যবহার শুরু করে দিন ।
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://starship.rs/config/"><strong>Starship এর ডকুমেন্টেশন ঘুরে দেখুন ▶</strong></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<a name="🚀-installation"></a>
|
||||||
|
|
||||||
|
## 🚀 ইন্সটল
|
||||||
|
|
||||||
|
### পূর্বশর্ত
|
||||||
|
|
||||||
|
- আপনার থেকে টার্মিনালে একটি [Nerd Font](https://www.nerdfonts.com/) ব্যবহার করতে হবে (উদাহরণস্বরূপ আপনি [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) টি ব্যবহার করতে পারেন) ।
|
||||||
|
|
||||||
|
### ধাপ ১. Starship ইন্সটল করুন
|
||||||
|
|
||||||
|
ইনস্টলেশন নির্দেশিকা দেখতে নিচের তালিকা থেকে আপনার অপারেটিং সিস্টেম বাছাই করুন:
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>অ্যান্ড্রয়েড</summary>
|
||||||
|
|
||||||
|
নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে Starship ইন্সটল করুন:
|
||||||
|
|
||||||
|
| রিপোজিটরি | নির্দেশাবলী |
|
||||||
|
| --------------------------------------------------------------------------------- | ---------------------- |
|
||||||
|
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>বিএসডি</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` |
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>লিনাক্স </summary>
|
||||||
|
|
||||||
|
আপনার সিস্টেম এর জন্য লেটেস্ট সংস্করণটি ইন্সটল করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
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` |
|
||||||
|
| 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` |
|
||||||
|
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>ম্যাক ওএস </summary>
|
||||||
|
|
||||||
|
আপনার সিস্টেম এর জন্য লেটেস্ট সংস্করণটি ইন্সটল করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
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` |
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>উইন্ডোজ</summary>
|
||||||
|
|
||||||
|
আপনার সিস্টেম এর জন্য লেটেস্ট সংস্করণটি [রিলিজ সেকশনে](https://github.com/starship/starship/releases/latest) থাকা MSI-ইন্সটলার ব্যবহার করে ইন্সটল করুন ।
|
||||||
|
|
||||||
|
নিম্নলিখিত প্যাকেজ ম্যানেজার গুলোর মধ্যে থেকে যেকোনো একটি ব্যবহার করে 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` |
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### ধাপ ২. Starship ব্যবহার করার জন্য আপনার শেল প্রস্তুত করুন
|
||||||
|
|
||||||
|
Starship চালু করতে আপনার শেল কে ঠিক মতো কনফিগার করুন । নিম্নলিখিত তালিকা থেকে আপনার শেল বাছাই করুন:
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Bash</summary>
|
||||||
|
|
||||||
|
`~/.bashrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
eval "$(starship init bash)"
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Cmd</summary>
|
||||||
|
|
||||||
|
আপনাকে Cmd এর সাথে [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) ব্যবহার করতে হবে । `%LocalAppData%\clink\starship.lua` ফাইল টি তৈরি করে তার মধ্যে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```lua
|
||||||
|
load(io.popen('starship init cmd'):read("*a"))()
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Elvish</summary>
|
||||||
|
|
||||||
|
`~/.elvish/rc.elv` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
eval (starship init elvish)
|
||||||
|
```
|
||||||
|
|
||||||
|
বিঃদ্রঃ শুধুমাত্র Elvish v0.18+ কাজ করবে ।
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Fish</summary>
|
||||||
|
|
||||||
|
`~/.config/fish/config.fish` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```fish
|
||||||
|
starship init fish | source
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Ion</summary>
|
||||||
|
|
||||||
|
`~/.config/ion/initrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
eval $(starship init ion)
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Nushell</summary>
|
||||||
|
|
||||||
|
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: Only Nushell v0.96+ is supported
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>PowerShell</summary>
|
||||||
|
|
||||||
|
আপনার PowerShell কনফিগের (PowerShell এ `$PROFILE` কমান্ডটি রান করে ফাইলটি খুঁজে বের করুন) শেষে নিম্নলিখিত লাইনটি যোগ করুন:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
Invoke-Expression (&starship init powershell)
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Tcsh</summary>
|
||||||
|
|
||||||
|
`~/.tcshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
eval `starship init tcsh`
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Xonsh</summary>
|
||||||
|
|
||||||
|
`~/.xonshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```python
|
||||||
|
execx($(starship init xonsh))
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Zsh</summary>
|
||||||
|
|
||||||
|
`~/.zshrc` এর শেষে নিম্নলিখিত লাইন টি যোগ করুন:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
eval "$(starship init zsh)"
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### ধাপ ৩. Starship কনফিগার করুন
|
||||||
|
|
||||||
|
নতুন একটি শেল চালু করুন, এরপর আপনি আপনার সুন্দর নতুন শেল প্রম্প্ট দেখতে পাবেন । পূর্ব নির্ধারিত কনফিগ যদি ভালো লেগে থাকে, তাহলে উপভোগ করুন!
|
||||||
|
|
||||||
|
আপনি যদি Starship কে নিজের মতো করে কাস্টমাইজ করতে চান:
|
||||||
|
|
||||||
|
- **[কনফিগারেশন](https://starship.rs/config/)** – আপনার নিজের ইচ্ছা মতো নিজের প্রম্প্টকে পরিবর্তন করতে শিখুন
|
||||||
|
|
||||||
|
- **[অন্যদের তৈরি কনফিগ](https://starship.rs/presets/)** – অন্যদের তৈরি করা সুন্দর কনফিগ দেখে অনুপ্রাণিত হন
|
||||||
|
|
||||||
|
## 🤝 নিজে অবদান রাখুন
|
||||||
|
|
||||||
|
আমরা সবসময় **সকল দক্ষতা স্তরের** অবদানকারীদের খুঁজছি! আপনি যদি সহজ ভাবে এই প্রোজেক্টে অবদান রাখতে চান তাইলে ["good first issue"](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) গুলির সমাধান করার চেষ্টা করতে পারেন ।
|
||||||
|
|
||||||
|
আপনি যদি ইংরেজি ছাড়া অন্য কোন ভাষায় সাবলীল হন, তাহলে আপনি আমাদের ডকুমেন্টেশন অনুবাদে এবং আপ-টু-ডেট রাখতে সহায়তা করতে পারেন, আমরা খুবই কৃতজ্ঞ হব । যদি এক্ষেত্রে সাহায্য করতে চান, তাহলে [Starship Crowdin](https://translate.starship.rs/) পেইজ এ গিয়ে আপনার অনুবাদ গুলি যোগ করতে পারবেন ।
|
||||||
|
|
||||||
|
আপনি যদি Starship এ অবদান রাখতে আগ্রহী হন, অনুগ্রহ করে আমাদের অবদান রাখার [নির্দেশিকা ও নিয়মকানুন](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) দেখে নিবেন । এছাড়াও, নির্দ্বিধায় আমাদের [Discord](https://discord.gg/8Jzqu3T) সার্ভারে এসে হাই বলে যান । 👋
|
||||||
|
|
||||||
|
## 💭 অনুপ্রেরণা
|
||||||
|
|
||||||
|
অনুগ্রহ করে Starship এর পূর্ববর্তী এইসব প্রোজেক্ট থেকে ঘুরে আসুন, যারা Starship তৈরিতে অনেক অনুপ্রেরণা দিয়েছে । 🙏
|
||||||
|
|
||||||
|
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts.
|
||||||
|
|
||||||
|
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** – Cross-shell robbyrussell theme written in JavaScript.
|
||||||
|
|
||||||
|
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
|
||||||
|
|
||||||
|
## ❤️ স্পনসর
|
||||||
|
|
||||||
|
[একজন স্পনসর হয়ে](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).
|
||||||
|
|
||||||
|
Code Signing Roles:
|
||||||
|
|
||||||
|
- Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts)
|
||||||
|
- Approvers and Authors: [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.
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<br>
|
||||||
|
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/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) লাইসেন্সের অধিনে রয়েছে ।
|
93
docs/bn-BD/installing/README.md
Normal file
93
docs/bn-BD/installing/README.md
Normal file
@ -0,0 +1,93 @@
|
|||||||
|
# Advanced Installation
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
## [Chocolatey](https://chocolatey.org)
|
||||||
|
|
||||||
|
### পূর্বশর্ত
|
||||||
|
|
||||||
|
Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey.
|
||||||
|
|
||||||
|
### ইন্সটল
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
## [Funtoo Linux](https://www.funtoo.org/Welcome)
|
||||||
|
|
||||||
|
### ইন্সটল
|
||||||
|
|
||||||
|
On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
emerge app-shells/starship
|
||||||
|
```
|
||||||
|
|
||||||
|
## [Nix](https://wiki.nixos.org/wiki/Nix)
|
||||||
|
|
||||||
|
### Getting the Binary
|
||||||
|
|
||||||
|
#### Imperatively
|
||||||
|
|
||||||
|
```sh
|
||||||
|
nix-env -iA nixos.starship
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Declarative, single user, via [home-manager](https://github.com/nix-community/home-manager)
|
||||||
|
|
||||||
|
Enable the `programs.starship` module in your `home.nix` file, and add your settings
|
||||||
|
|
||||||
|
```nix
|
||||||
|
{
|
||||||
|
programs.starship = {
|
||||||
|
enable = true;
|
||||||
|
# Configuration written to ~/.config/starship.toml
|
||||||
|
settings = {
|
||||||
|
# add_newline = false;
|
||||||
|
|
||||||
|
# character = {
|
||||||
|
# success_symbol = "[➜](bold green)";
|
||||||
|
# error_symbol = "[➜](bold red)";
|
||||||
|
# };
|
||||||
|
|
||||||
|
# package.disabled = true;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
then run
|
||||||
|
|
||||||
|
```sh
|
||||||
|
home-manager switch
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Declarative, system-wide, with NixOS
|
||||||
|
|
||||||
|
Add `pkgs.starship` to `environment.systemPackages` in your `configuration.nix`, then run
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo nixos-rebuild switch
|
||||||
|
```
|
267
docs/bn-BD/migrating-to-0.45.0/README.md
Normal file
267
docs/bn-BD/migrating-to-0.45.0/README.md
Normal file
@ -0,0 +1,267 @@
|
|||||||
|
# Migrating to 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.
|
||||||
|
|
||||||
|
This guide is intended to walk you through the breaking changes.
|
||||||
|
|
||||||
|
## `prompt_order` has been replaced by a root-level `format`
|
||||||
|
|
||||||
|
Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship.
|
||||||
|
|
||||||
|
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**
|
||||||
|
|
||||||
|
```toml
|
||||||
|
prompt_order = [
|
||||||
|
"username",
|
||||||
|
"hostname",
|
||||||
|
"directory",
|
||||||
|
"git_branch",
|
||||||
|
"git_commit",
|
||||||
|
"git_state",
|
||||||
|
"git_status",
|
||||||
|
"cmd_duration",
|
||||||
|
"custom",
|
||||||
|
"line_break",
|
||||||
|
"jobs",
|
||||||
|
"battery",
|
||||||
|
"time",
|
||||||
|
"character",
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example v0.45.0 configuration**
|
||||||
|
|
||||||
|
```toml
|
||||||
|
format = """\
|
||||||
|
$username\
|
||||||
|
$hostname\
|
||||||
|
$directory\
|
||||||
|
$git_branch\
|
||||||
|
$git_commit\
|
||||||
|
$git_state\
|
||||||
|
$git_status\
|
||||||
|
$cmd_duration\
|
||||||
|
$custom\
|
||||||
|
$line_break\
|
||||||
|
$jobs\
|
||||||
|
$battery\
|
||||||
|
$time\
|
||||||
|
$character\
|
||||||
|
"""
|
||||||
|
```
|
||||||
|
|
||||||
|
## Module `prefix` and `suffix` have been replaced by `format`
|
||||||
|
|
||||||
|
Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered.
|
||||||
|
|
||||||
|
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**
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[cmd_duration]
|
||||||
|
prefix = "took "
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example v0.45.0 configuration**
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[cmd_duration]
|
||||||
|
# $duration – The command duration (e.g. "15s")
|
||||||
|
# $style – The default style of the module (e.g. "bold yellow")
|
||||||
|
format = "took [$duration]($style) "
|
||||||
|
```
|
||||||
|
|
||||||
|
### Affected Modules
|
||||||
|
|
||||||
|
#### Character
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ----------------------- | ---------------- |
|
||||||
|
| `symbol` | `success_symbol` |
|
||||||
|
| `use_symbol_for_status` | `error_symbol` |
|
||||||
|
| `style_success` | `success_symbol` |
|
||||||
|
| `style_failure` | `error_symbol` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[character]
|
||||||
|
-- symbol = "❯"
|
||||||
|
-- error_symbol = "✖"
|
||||||
|
-- use_symbol_for_status = true
|
||||||
|
-- vicmd_symbol = "❮"
|
||||||
|
++ success_symbol = "[❯](bold green)"
|
||||||
|
++ error_symbol = "[❯](bold red)"
|
||||||
|
++ vicmd_symbol = "[❮](bold green)"
|
||||||
|
```
|
||||||
|
|
||||||
|
Previously, the `use_symbol_for_status` property was used to configure the prompt to show the `error_symbol` when the last command resulted in a non-zero status code.
|
||||||
|
|
||||||
|
With the release of v0.45.0, we now always use `error_symbol` after non-zero status codes, unifying `use_symbol_for_status` and `error_symbol` properties.
|
||||||
|
|
||||||
|
To configure the prompt to use the older `use_symbol_for_status = true` configuration, add the following to your config file:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[character]
|
||||||
|
error_symbol = "[✖](bold red)"
|
||||||
|
```
|
||||||
|
|
||||||
|
_Note:_ The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples.
|
||||||
|
|
||||||
|
#### Command Duration
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ---------------- | ----------- |
|
||||||
|
| `prefix` | `format` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[cmd_duration]
|
||||||
|
-- prefix = "took "
|
||||||
|
++ format = "took [$duration]($style) "
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Directory
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ---------------- | ----------- |
|
||||||
|
| `prefix` | `format` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[directory]
|
||||||
|
-- prefix = "in "
|
||||||
|
++ format = "[$path]($style)[$read_only]($read_only_style) "
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Environment Variable
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ---------------- | ----------- |
|
||||||
|
| `prefix` | `format` |
|
||||||
|
| `suffix` | `format` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[env_var]
|
||||||
|
-- prefix = ""
|
||||||
|
-- suffix = ""
|
||||||
|
++ format = "with [$env_value]($style) "
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Git Commit
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ---------------- | ----------- |
|
||||||
|
| `prefix` | `format` |
|
||||||
|
| `suffix` | `format` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[git_commit]
|
||||||
|
-- prefix = "("
|
||||||
|
-- suffix = ")"
|
||||||
|
++ format = '[\($hash\)]($style) '
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Git Status
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ----------------- | ----------- |
|
||||||
|
| `prefix` | `format` |
|
||||||
|
| `suffix` | `format` |
|
||||||
|
| `show_sync_count` | `format` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[git_status]
|
||||||
|
-- prefix = "["
|
||||||
|
-- suffix = "]"
|
||||||
|
-- show_sync_count = false
|
||||||
|
++ format = '([\[$all_status$ahead_behind\]]($style) )'
|
||||||
|
```
|
||||||
|
|
||||||
|
Previously, the `show_sync_count` property was used to configure the prompt to show the number of commits the branch was ahead or behind the remote branch.
|
||||||
|
|
||||||
|
With the release of v0.45.0, this has been replaced with three separate properties, `ahead`, `behind`, and `diverged`.
|
||||||
|
|
||||||
|
To configure the prompt to use the older `show_sync_count = true` configuration, set the following to your config file:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[git_status]
|
||||||
|
ahead = "⇡${count}"
|
||||||
|
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
|
||||||
|
behind = "⇣${count}"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Hostname
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ---------------- | ----------- |
|
||||||
|
| `prefix` | `format` |
|
||||||
|
| `suffix` | `format` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[hostname]
|
||||||
|
-- prefix = ""
|
||||||
|
-- suffix = ""
|
||||||
|
++ format = "[$hostname]($style) in "
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Singularity
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ---------------- | ----------- |
|
||||||
|
| `label` | `format` |
|
||||||
|
| `prefix` | `format` |
|
||||||
|
| `suffix` | `format` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[singularity]
|
||||||
|
-- prefix = ""
|
||||||
|
-- suffix = ""
|
||||||
|
++ format = '[$symbol\[$env\]]($style) '
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Time
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ---------------- | ------------- |
|
||||||
|
| `format` | `time_format` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[time]
|
||||||
|
-- format = "🕙[ %T ]"
|
||||||
|
++ time_format = "%T"
|
||||||
|
++ format = "at 🕙[$time]($style) "
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Custom Commands
|
||||||
|
|
||||||
|
| Removed Property | Replacement |
|
||||||
|
| ---------------- | ----------- |
|
||||||
|
| `prefix` | `format` |
|
||||||
|
| `suffix` | `format` |
|
||||||
|
|
||||||
|
**Changes to the Default Configuration**
|
||||||
|
|
||||||
|
```diff
|
||||||
|
[custom.example]
|
||||||
|
-- prefix = ""
|
||||||
|
-- suffix = ""
|
||||||
|
++ format = "[$symbol$output]($style) "
|
||||||
|
```
|
77
docs/bn-BD/presets/README.md
Normal file
77
docs/bn-BD/presets/README.md
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
# 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! 😊
|
||||||
|
|
||||||
|
To get details on how to use a preset, simply click on the image.
|
||||||
|
|
||||||
|
## [Nerd Font Symbols](./nerd-font.md)
|
||||||
|
|
||||||
|
This preset changes the symbols for each module to use Nerd Font symbols.
|
||||||
|
|
||||||
|
[![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font)
|
||||||
|
|
||||||
|
## [No 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.
|
||||||
|
|
||||||
|
::: 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)
|
||||||
|
|
||||||
|
## [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.).
|
||||||
|
|
||||||
|
[![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments)
|
||||||
|
|
||||||
|
## [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.
|
||||||
|
|
||||||
|
[![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./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!
|
||||||
|
|
||||||
|
[![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes)
|
||||||
|
|
||||||
|
## [No Empty Icons](./no-empty-icons.md)
|
||||||
|
|
||||||
|
This preset does not show icons if the toolset is not found.
|
||||||
|
|
||||||
|
[![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png "Click to view No Runtime Versions preset")](./no-empty-icons.md)
|
||||||
|
|
||||||
|
## [Pure Prompt](./pure-preset.md)
|
||||||
|
|
||||||
|
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
|
||||||
|
|
||||||
|
[![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./pure-preset)
|
||||||
|
|
||||||
|
## [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.
|
||||||
|
|
||||||
|
[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline)
|
||||||
|
|
||||||
|
## [Tokyo Night](./tokyo-night.md)
|
||||||
|
|
||||||
|
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
||||||
|
|
||||||
|
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
|
||||||
|
|
||||||
|
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
|
||||||
|
|
||||||
|
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||||
|
|
||||||
|
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./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.
|
||||||
|
|
||||||
|
[![Screenshot of Jetpack preset](/presets/img/jetpack.png "Click to view Jetpack preset")](./jetpack)
|
17
docs/bn-BD/presets/bracketed-segments.md
Normal file
17
docs/bn-BD/presets/bracketed-segments.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
[Return to Presets](./#bracketed-segments)
|
||||||
|
|
||||||
|
# Bracketed Segments Preset
|
||||||
|
|
||||||
|
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.).
|
||||||
|
|
||||||
|
![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png)
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset bracketed-segments -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/bracketed-segments.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/bracketed-segments.toml
|
21
docs/bn-BD/presets/gruvbox-rainbow.md
Normal file
21
docs/bn-BD/presets/gruvbox-rainbow.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
[Return to Presets](./#gruvbox-rainbow)
|
||||||
|
|
||||||
|
# Gruvbox Rainbow Preset
|
||||||
|
|
||||||
|
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||||
|
|
||||||
|
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
|
||||||
|
|
||||||
|
### পূর্বশর্ত
|
||||||
|
|
||||||
|
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset gruvbox-rainbow -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/gruvbox-rainbow.toml
|
24
docs/bn-BD/presets/jetpack.md
Normal file
24
docs/bn-BD/presets/jetpack.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
[Return to Presets](./#jetpack)
|
||||||
|
|
||||||
|
# Jetpack Preset
|
||||||
|
|
||||||
|
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||||
|
|
||||||
|
> Jetpack uses the terminal's color theme.
|
||||||
|
|
||||||
|
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
|
||||||
|
|
||||||
|
### Prerequisite
|
||||||
|
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset jetpack -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/jetpack.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/jetpack.toml
|
21
docs/bn-BD/presets/nerd-font.md
Normal file
21
docs/bn-BD/presets/nerd-font.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
[Return to Presets](./#nerd-font-symbols)
|
||||||
|
|
||||||
|
# Nerd Font Symbols Preset
|
||||||
|
|
||||||
|
This preset changes the symbols for each module to use Nerd Font symbols.
|
||||||
|
|
||||||
|
![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png)
|
||||||
|
|
||||||
|
### পূর্বশর্ত
|
||||||
|
|
||||||
|
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font)
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset nerd-font-symbols -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/nerd-font-symbols.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/nerd-font-symbols.toml
|
17
docs/bn-BD/presets/no-empty-icons.md
Normal file
17
docs/bn-BD/presets/no-empty-icons.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
[Return to Presets](./#no-empty-icons)
|
||||||
|
|
||||||
|
# No Empty Icons Preset
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
![Screenshot of No Empty Icons preset](/presets/img/no-empty-icons.png)
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset no-empty-icons -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/no-empty-icons.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/no-empty-icons.toml
|
19
docs/bn-BD/presets/no-nerd-font.md
Normal file
19
docs/bn-BD/presets/no-nerd-font.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
[Return to Presets](./#no-nerd-fonts)
|
||||||
|
|
||||||
|
# No Nerd Fonts Preset
|
||||||
|
|
||||||
|
This preset restricts the use of symbols to those from emoji and powerline sets.
|
||||||
|
|
||||||
|
This means that even without a Nerd Font installed, you should be able to view all module symbols.
|
||||||
|
|
||||||
|
This preset will become the default preset in a future release of starship.
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset no-nerd-font -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/no-nerd-font.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/no-nerd-font.toml
|
17
docs/bn-BD/presets/no-runtimes.md
Normal file
17
docs/bn-BD/presets/no-runtimes.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
[Return to Presets](./#no-runtime-versions)
|
||||||
|
|
||||||
|
# No Runtime Versions Preset
|
||||||
|
|
||||||
|
This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you!
|
||||||
|
|
||||||
|
![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png)
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset no-runtime-versions -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/no-runtime-versions.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/no-runtime-versions.toml
|
21
docs/bn-BD/presets/pastel-powerline.md
Normal file
21
docs/bn-BD/presets/pastel-powerline.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
[Return to Presets](./#pastel-powerline)
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png)
|
||||||
|
|
||||||
|
### পূর্বশর্ত
|
||||||
|
|
||||||
|
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font)
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset pastel-powerline -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/pastel-powerline.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/pastel-powerline.toml
|
17
docs/bn-BD/presets/plain-text.md
Normal file
17
docs/bn-BD/presets/plain-text.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
[Return to Presets](./#plain-text-symbols)
|
||||||
|
|
||||||
|
## Plain Text Symbols Preset
|
||||||
|
|
||||||
|
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
|
||||||
|
|
||||||
|
![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png)
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset plain-text-symbols -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/plain-text-symbols.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/plain-text-symbols.toml
|
17
docs/bn-BD/presets/pure-preset.md
Normal file
17
docs/bn-BD/presets/pure-preset.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
[Return to Presets](./#pure)
|
||||||
|
|
||||||
|
# Pure Preset
|
||||||
|
|
||||||
|
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
|
||||||
|
|
||||||
|
![Screenshot of Pure preset](/presets/img/pure-preset.png)
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset pure-preset -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/pure-preset.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/pure-preset.toml
|
21
docs/bn-BD/presets/tokyo-night.md
Normal file
21
docs/bn-BD/presets/tokyo-night.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
[Return to Presets](./#pastel-powerline)
|
||||||
|
|
||||||
|
# Tokyo Night Preset
|
||||||
|
|
||||||
|
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
||||||
|
|
||||||
|
![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png)
|
||||||
|
|
||||||
|
### পূর্বশর্ত
|
||||||
|
|
||||||
|
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset tokyo-night -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/tokyo-night.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/tokyo-night.toml
|
@ -1,10 +1,14 @@
|
|||||||
---
|
---
|
||||||
home: true
|
layout: home
|
||||||
heroImage: /logo.svg
|
hero:
|
||||||
heroText:
|
image: /logo.svg
|
||||||
tagline: promptـێکی سوکەڵە، خێرا، و بێسنور دڵخوازکراو بۆ هەر شێڵێک!
|
text:
|
||||||
actionText: دەستپێبکە ←
|
tagline: promptـێکی سوکەڵە، خێرا، و بێسنور دڵخوازکراو بۆ هەر شێڵێک!
|
||||||
actionLink: ./guide/
|
actions:
|
||||||
|
-
|
||||||
|
theme: brand
|
||||||
|
text: دەستپێبکە ←
|
||||||
|
link: ./guide/
|
||||||
features:
|
features:
|
||||||
-
|
-
|
||||||
title: سەرەتا گونجان
|
title: سەرەتا گونجان
|
||||||
@ -21,12 +25,24 @@ 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.'
|
||||||
---
|
---
|
||||||
|
|
||||||
<div class="center">
|
<script setup>
|
||||||
<video class="demo-video" muted autoplay loop playsinline>
|
import { onMounted } from 'vue'
|
||||||
<source src="/demo.webm" type="video/webm">
|
|
||||||
<source src="/demo.mp4" type="video/mp4">
|
onMounted(() => {
|
||||||
</video>
|
const urlParams = new URLSearchParams(window.location.search)
|
||||||
</div>
|
if (urlParams.has('uwu') || urlParams.has('kawaii')) {
|
||||||
|
const img = document.querySelector('.VPHero .VPImage.image-src')
|
||||||
|
img.classList.add('uwu')
|
||||||
|
img.src = '/logo-uwu.png'
|
||||||
|
img.alt = 'Kawaii Starship Logo by @sawaratsuki1004'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<video class="demo-video" muted autoplay loop playsinline>
|
||||||
|
<source src="/demo.webm" type="video/webm">
|
||||||
|
<source src="/demo.mp4" type="video/mp4">
|
||||||
|
</video>
|
||||||
|
|
||||||
### پێشمەرجەکان
|
### پێشمەرجەکان
|
||||||
|
|
||||||
@ -55,6 +71,7 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب
|
|||||||
```sh
|
```sh
|
||||||
brew install starship
|
brew install starship
|
||||||
```
|
```
|
||||||
|
|
||||||
With [Winget](https://github.com/microsoft/winget-cli):
|
With [Winget](https://github.com/microsoft/winget-cli):
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
@ -149,20 +166,15 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب
|
|||||||
|
|
||||||
::: warning
|
::: warning
|
||||||
|
|
||||||
This will change in the future. Only Nushell v0.78+ is supported.
|
This will change in the future. Only Nushell v0.96+ is supported.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||||
```sh
|
|
||||||
mkdir ~/.cache/starship
|
|
||||||
starship init nu | save -f ~/.cache/starship/init.nu
|
|
||||||
```
|
|
||||||
|
|
||||||
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
use ~/.cache/starship/init.nu
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@ -80,6 +80,26 @@ starship init fish | source
|
|||||||
enable_transience
|
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 \<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
|
||||||
|
|
||||||
|
```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
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bleopt prompt_rps1_final='$(starship module time)'
|
||||||
|
```
|
||||||
|
|
||||||
## Custom pre-prompt and pre-execution Commands in Cmd
|
## 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:
|
||||||
@ -203,9 +223,11 @@ Invoke-Expression (&starship init powershell)
|
|||||||
|
|
||||||
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.
|
`right_format` is currently supported for the following 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.
|
||||||
|
|
||||||
### نموونە
|
### نموونە
|
||||||
|
|
||||||
@ -244,7 +266,7 @@ Note: Continuation prompts are only available in the following shells:
|
|||||||
```toml
|
```toml
|
||||||
# ~/.config/starship.toml
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
# A continuation prompt that displays two filled in arrows
|
# A continuation prompt that displays two filled-in arrows
|
||||||
continuation_prompt = '▶▶ '
|
continuation_prompt = '▶▶ '
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -265,7 +287,7 @@ Style strings are a list of words, separated by whitespace. The words are not ca
|
|||||||
- `<color>`
|
- `<color>`
|
||||||
- `هیچ`
|
- `هیچ`
|
||||||
|
|
||||||
کە `<color>` دیاریکەری ڕەنگێکە (لە ژێرەوە باسکراوە). `fg:<color>` و `<color>` لە ئێستادا هەمان شت ئەکەن، بەڵام ئەمە ڕەنگە لە داهاتووا بگۆڕێت. `inverted` ڕەنگی پاشبنەما و پێشبنەما ئەگۆڕێتەوە. ڕیزبەندی ووشەکان لە زنجیرەکەدا گرنگ نییە.
|
کە `<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` ڕەنگی پاشبنەما و پێشبنەما ئەگۆڕێتەوە. ڕیزبەندی ووشەکان لە زنجیرەکەدا گرنگ نییە.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
@ -279,6 +301,6 @@ If multiple colors are specified for foreground/background, the last one in the
|
|||||||
|
|
||||||
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
|
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
|
||||||
|
|
||||||
- Many terminals disable support for `blink` by default
|
- Many terminals disable support for `blink` by default.
|
||||||
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
|
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
|
||||||
- `strikethrough` is not supported by the default macOS Terminal.app
|
- `strikethrough` is not supported by the default macOS Terminal.app.
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -58,7 +58,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
|||||||
|
|
||||||
## Why do I see `Executing command "..." timed out.` warnings?
|
## 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?
|
## I see symbols I don't understand or expect, what do they mean?
|
||||||
|
|
||||||
@ -72,7 +72,7 @@ You can enable the debug logs by using the `STARSHIP_LOG` env var. These logs ca
|
|||||||
env STARSHIP_LOG=trace starship module rust
|
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 to blame.
|
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.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
env STARSHIP_LOG=trace starship timings
|
env STARSHIP_LOG=trace starship timings
|
||||||
@ -120,3 +120,11 @@ If Starship was installed using the install script, the following command will d
|
|||||||
# Locate and delete the starship binary
|
# Locate and delete the starship binary
|
||||||
sh -c 'rm "$(command -v 'starship')"'
|
sh -c 'rm "$(command -v 'starship')"'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## How do I install Starship without `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`.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
When using a package manager, see the documentation for your package manager about installing with or without `sudo`.
|
||||||
|
@ -32,6 +32,11 @@
|
|||||||
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||||||
alt="شوێن @StarshipPrompt بکەوە لەسەر تویتەر"
|
alt="شوێن @StarshipPrompt بکەوە لەسەر تویتەر"
|
||||||
/></a>
|
/></a>
|
||||||
|
<a href="https://stand-with-ukraine.pp.ua"
|
||||||
|
><img
|
||||||
|
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
|
||||||
|
alt="Stand With Ukraine"
|
||||||
|
/></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
@ -143,8 +148,6 @@
|
|||||||
/></a>
|
/></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
|
|
||||||
|
|
||||||
<h1></h1>
|
<h1></h1>
|
||||||
|
|
||||||
<img
|
<img
|
||||||
@ -225,6 +228,7 @@ Alternatively, install Starship using any of the following package managers:
|
|||||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||||
| Manjaro | | `pacman -S starship` |
|
| Manjaro | | `pacman -S starship` |
|
||||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||||
|
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
@ -330,20 +334,14 @@ eval $(starship init ion)
|
|||||||
<details>
|
<details>
|
||||||
<summary>Nushell</summary>
|
<summary>Nushell</summary>
|
||||||
|
|
||||||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
mkdir ~/.cache/starship
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
starship init nu | save -f ~/.cache/starship/init.nu
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
```
|
```
|
||||||
|
|
||||||
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
|
Note: Only Nushell v0.96+ is supported
|
||||||
|
|
||||||
```sh
|
|
||||||
use ~/.cache/starship/init.nu
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: Only Nushell v0.78+ is supported
|
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
@ -423,9 +421,16 @@ If you're looking to further customize Starship:
|
|||||||
|
|
||||||
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
|
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
|
||||||
|
|
||||||
**Supporter Tier**
|
## 🔒 Code Signing Policy
|
||||||
|
|
||||||
- [Appwrite](https://appwrite.io/)
|
Free code signing provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org).
|
||||||
|
|
||||||
|
Code Signing Roles:
|
||||||
|
|
||||||
|
- Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts)
|
||||||
|
- Approvers and Authors: [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.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<br>
|
<br>
|
||||||
|
@ -5,7 +5,7 @@ To install starship, you need to do two things:
|
|||||||
1. Get the **starship** binary onto your computer
|
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
|
1. 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!
|
||||||
|
|
||||||
@ -45,7 +45,7 @@ On Funtoo Linux, starship can be installed from [core-kit](https://github.com/fu
|
|||||||
emerge app-shells/starship
|
emerge app-shells/starship
|
||||||
```
|
```
|
||||||
|
|
||||||
## [Nix](https://nixos.wiki/wiki/Nix)
|
## [Nix](https://wiki.nixos.org/wiki/Nix)
|
||||||
|
|
||||||
### Getting the Binary
|
### Getting the Binary
|
||||||
|
|
||||||
|
@ -63,3 +63,15 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
|
|||||||
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
||||||
|
|
||||||
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
|
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
|
||||||
|
|
||||||
|
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
|
||||||
|
|
||||||
|
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||||
|
|
||||||
|
[![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./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.
|
||||||
|
|
||||||
|
[![Screenshot of Jetpack preset](/presets/img/jetpack.png "Click to view Jetpack preset")](./jetpack)
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#bracketed-segments)
|
[Return to Presets](./#bracketed-segments)
|
||||||
|
|
||||||
# Bracketed Segments Preset
|
# Bracketed Segments Preset
|
||||||
|
|
||||||
@ -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
|
starship preset bracketed-segments -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/bracketed-segments.toml)
|
[Click to download TOML](/presets/toml/bracketed-segments.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml
|
<<< @/public/presets/toml/bracketed-segments.toml
|
||||||
|
21
docs/ckb-IR/presets/gruvbox-rainbow.md
Normal file
21
docs/ckb-IR/presets/gruvbox-rainbow.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
[Return to Presets](./#gruvbox-rainbow)
|
||||||
|
|
||||||
|
# Gruvbox Rainbow Preset
|
||||||
|
|
||||||
|
This preset is heavily inspired by [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||||
|
|
||||||
|
![Screenshot of Gruvbox Rainbow preset](/presets/img/gruvbox-rainbow.png)
|
||||||
|
|
||||||
|
### پێشمەرجەکان
|
||||||
|
|
||||||
|
- [فۆنتێکی Nerd](https://www.nerdfonts.com/) دامەزراوە و چالاککراوە لە تێرمیناڵەکەتا
|
||||||
|
|
||||||
|
### ڕێکخستن
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset gruvbox-rainbow -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/gruvbox-rainbow.toml
|
24
docs/ckb-IR/presets/jetpack.md
Normal file
24
docs/ckb-IR/presets/jetpack.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
[Return to Presets](./#jetpack)
|
||||||
|
|
||||||
|
# Jetpack Preset
|
||||||
|
|
||||||
|
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||||
|
|
||||||
|
> Jetpack uses the terminal's color theme.
|
||||||
|
|
||||||
|
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
|
||||||
|
|
||||||
|
### Prerequisite
|
||||||
|
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
### ڕێکخستن
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset jetpack -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/jetpack.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/jetpack.toml
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#nerd-font-symbols)
|
[Return to Presets](./#nerd-font-symbols)
|
||||||
|
|
||||||
# Nerd Font Symbols Preset
|
# Nerd Font Symbols Preset
|
||||||
|
|
||||||
@ -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
|
starship preset nerd-font-symbols -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/nerd-font-symbols.toml)
|
[Click to download TOML](/presets/toml/nerd-font-symbols.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml
|
<<< @/public/presets/toml/nerd-font-symbols.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#no-empty-icons)
|
[Return to Presets](./#no-empty-icons)
|
||||||
|
|
||||||
# No Empty Icons Preset
|
# No Empty Icons Preset
|
||||||
|
|
||||||
@ -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
|
starship preset no-empty-icons -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/no-empty-icons.toml)
|
[Click to download TOML](/presets/toml/no-empty-icons.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
|
<<< @/public/presets/toml/no-empty-icons.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#no-nerd-fonts)
|
[Return to Presets](./#no-nerd-fonts)
|
||||||
|
|
||||||
# No Nerd Fonts Preset
|
# No Nerd Fonts Preset
|
||||||
|
|
||||||
@ -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
|
starship preset no-nerd-font -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/no-nerd-font.toml)
|
[Click to download TOML](/presets/toml/no-nerd-font.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
|
<<< @/public/presets/toml/no-nerd-font.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#no-runtime-versions)
|
[Return to Presets](./#no-runtime-versions)
|
||||||
|
|
||||||
# No Runtime Versions Preset
|
# No Runtime Versions Preset
|
||||||
|
|
||||||
@ -12,6 +12,6 @@
|
|||||||
starship preset no-runtime-versions -o ~/.config/starship.toml
|
starship preset no-runtime-versions -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/no-runtime-versions.toml)
|
[Click to download TOML](/presets/toml/no-runtime-versions.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml
|
<<< @/public/presets/toml/no-runtime-versions.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#pastel-powerline)
|
[Return to Presets](./#pastel-powerline)
|
||||||
|
|
||||||
# Pastel Powerline Preset
|
# Pastel Powerline Preset
|
||||||
|
|
||||||
@ -16,6 +16,6 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
|
|||||||
starship preset pastel-powerline -o ~/.config/starship.toml
|
starship preset pastel-powerline -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/pastel-powerline.toml)
|
[Click to download TOML](/presets/toml/pastel-powerline.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml
|
<<< @/public/presets/toml/pastel-powerline.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#plain-text-symbols)
|
[Return to Presets](./#plain-text-symbols)
|
||||||
|
|
||||||
## Plain Text Symbols Preset
|
## Plain Text Symbols Preset
|
||||||
|
|
||||||
@ -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
|
starship preset plain-text-symbols -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/plain-text-symbols.toml)
|
[Click to download TOML](/presets/toml/plain-text-symbols.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml
|
<<< @/public/presets/toml/plain-text-symbols.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#pure)
|
[Return to Presets](./#pure)
|
||||||
|
|
||||||
# Pure Preset
|
# Pure Preset
|
||||||
|
|
||||||
@ -12,6 +12,6 @@
|
|||||||
starship preset pure-preset -o ~/.config/starship.toml
|
starship preset pure-preset -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/pure-preset.toml)
|
[Click to download TOML](/presets/toml/pure-preset.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/pure-preset.toml
|
<<< @/public/presets/toml/pure-preset.toml
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Return to Presets](./README.md#pastel-powerline)
|
[Return to Presets](./#pastel-powerline)
|
||||||
|
|
||||||
# Tokyo Night Preset
|
# Tokyo Night Preset
|
||||||
|
|
||||||
@ -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
|
starship preset tokyo-night -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Click to download TOML](/presets/toml/tokyo-night.toml)
|
[Click to download TOML](/presets/toml/tokyo-night.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/tokyo-night.toml
|
<<< @/public/presets/toml/tokyo-night.toml
|
||||||
|
@ -164,7 +164,7 @@ For example:
|
|||||||
|
|
||||||
#### Style Strings
|
#### Style Strings
|
||||||
|
|
||||||
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
|
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](../advanced-config/).
|
||||||
|
|
||||||
- `'fg:green bg:blue'` sets green text on a blue background
|
- `'fg:green bg:blue'` sets green text on a blue background
|
||||||
- `'bg:blue fg:bright-green'` sets bright green text on a blue background
|
- `'bg:blue fg:bright-green'` sets bright green text on a blue background
|
||||||
@ -210,16 +210,16 @@ This is the list of prompt-wide configuration options.
|
|||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
|
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
|
||||||
| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
|
| `right_format` | `''` | See [Enable Right Prompt](../advanced-config/#enable-right-prompt) |
|
||||||
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
|
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
|
||||||
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
|
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
|
||||||
| `add_newline` | `true` | Inserts blank line between shell prompts. |
|
| `add_newline` | `true` | Inserts blank line between shell prompts. |
|
||||||
| `palette` | `''` | Sets which color palette from `palettes` to use. |
|
| `palette` | `''` | Sets which color palette from `palettes` to use. |
|
||||||
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
|
| `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
|
||||||
| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
|
| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
|
||||||
|
|
||||||
::: tip
|
::: tip
|
||||||
|
|
||||||
@ -295,6 +295,7 @@ $elixir\
|
|||||||
$elm\
|
$elm\
|
||||||
$erlang\
|
$erlang\
|
||||||
$fennel\
|
$fennel\
|
||||||
|
$gleam\
|
||||||
$golang\
|
$golang\
|
||||||
$guix_shell\
|
$guix_shell\
|
||||||
$haskell\
|
$haskell\
|
||||||
@ -314,6 +315,7 @@ $php\
|
|||||||
$pulumi\
|
$pulumi\
|
||||||
$purescript\
|
$purescript\
|
||||||
$python\
|
$python\
|
||||||
|
$quarto\
|
||||||
$raku\
|
$raku\
|
||||||
$rlang\
|
$rlang\
|
||||||
$red\
|
$red\
|
||||||
@ -323,6 +325,7 @@ $scala\
|
|||||||
$solidity\
|
$solidity\
|
||||||
$swift\
|
$swift\
|
||||||
$terraform\
|
$terraform\
|
||||||
|
$typst\
|
||||||
$vlang\
|
$vlang\
|
||||||
$vagrant\
|
$vagrant\
|
||||||
$zig\
|
$zig\
|
||||||
@ -336,6 +339,8 @@ $aws\
|
|||||||
$gcloud\
|
$gcloud\
|
||||||
$openstack\
|
$openstack\
|
||||||
$azure\
|
$azure\
|
||||||
|
$nats\
|
||||||
|
$direnv\
|
||||||
$env_var\
|
$env_var\
|
||||||
$crystal\
|
$crystal\
|
||||||
$custom\
|
$custom\
|
||||||
@ -382,6 +387,9 @@ date is read from the `AWSUME_EXPIRATION` env var.
|
|||||||
When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials`
|
When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials`
|
||||||
falls back to the `x_security_token_expires` key.
|
falls back to the `x_security_token_expires` key.
|
||||||
|
|
||||||
|
When using [aws-sso-cli](https://github.com/synfinatic/aws-sso-cli) the profile
|
||||||
|
is read from the `AWS_SSO_PROFILE` env var.
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
@ -564,17 +572,14 @@ style = 'bold red'
|
|||||||
[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
|
[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
|
||||||
threshold = 30
|
threshold = 30
|
||||||
style = 'bold yellow'
|
style = 'bold yellow'
|
||||||
discharging_symbol = '💦'
|
discharging_symbol = '💦 '
|
||||||
|
|
||||||
# when capacity is over 30%, the battery indicator will not be displayed
|
# when capacity is over 30%, the battery indicator will not be displayed
|
||||||
```
|
```
|
||||||
|
|
||||||
## Buf
|
## Buf
|
||||||
|
|
||||||
The `buf` module shows the currently installed version of [Buf](https://buf.build). By default, the module is shown if all of the following conditions are met:
|
The `buf` module shows the currently installed version of [Buf](https://buf.build). By default, the module is shown if the current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file.
|
||||||
|
|
||||||
- The [`buf`](https://github.com/bufbuild/buf) CLI is installed.
|
|
||||||
- The current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file.
|
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
@ -613,21 +618,22 @@ symbol = '🦬 '
|
|||||||
The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime.
|
The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime.
|
||||||
By default the module will be shown if any of the following conditions are met:
|
By default the module will be shown if any of the following conditions are met:
|
||||||
|
|
||||||
|
- The current directory contains a `bun.lock` file
|
||||||
- The current directory contains a `bun.lockb` file
|
- The current directory contains a `bun.lockb` file
|
||||||
- The current directory contains a `bunfig.toml` file
|
- The current directory contains a `bunfig.toml` file
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
| ------------------- | ------------------------------------------ | ------------------------------------------------------------------------- |
|
||||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||||
| `symbol` | `'🍞 '` | A format string representing the symbol of Bun. |
|
| `symbol` | `'🥟 '` | A format string representing the symbol of Bun. |
|
||||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||||
| `detect_files` | `['bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
|
| `detect_files` | `['bun.lock', 'bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |
|
||||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||||
| `style` | `'bold red'` | The style for the module. |
|
| `style` | `'bold red'` | The style for the module. |
|
||||||
| `disabled` | `false` | Disables the `bun` module. |
|
| `disabled` | `false` | Disables the `bun` module. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
@ -639,7 +645,9 @@ By default the module will be shown if any of the following conditions are met:
|
|||||||
|
|
||||||
*: This variable can only be used as a part of a style string
|
*: This variable can only be used as a part of a style string
|
||||||
|
|
||||||
### Example
|
### Examples
|
||||||
|
|
||||||
|
#### Customize the format
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# ~/.config/starship.toml
|
# ~/.config/starship.toml
|
||||||
@ -648,6 +656,15 @@ By default the module will be shown if any of the following conditions are met:
|
|||||||
format = 'via [🍔 $version](bold green) '
|
format = 'via [🍔 $version](bold green) '
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Replace Node.js
|
||||||
|
|
||||||
|
You can override the `detect_files` property of [the nodejs module](#nodejs) in your config so as to only show the bun runtime:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[nodejs]
|
||||||
|
detect_files = ['package.json', '.node-version', '!bunfig.toml', '!bun.lockb']
|
||||||
|
```
|
||||||
|
|
||||||
## C
|
## C
|
||||||
|
|
||||||
The `c` module shows some information about your C compiler. By default
|
The `c` module shows some information about your C compiler. By default
|
||||||
@ -887,6 +904,7 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e
|
|||||||
::: tip
|
::: tip
|
||||||
|
|
||||||
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
|
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
|
||||||
|
If you use [pixi](https://pixi.sh), you can disable pixi's prompt modifier by running `pixi config set change-ps1 false`.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
@ -1080,20 +1098,20 @@ format = 'via [🔰 $version](bold red) '
|
|||||||
The `deno` module shows you your currently installed version of [Deno](https://deno.land/).
|
The `deno` module shows you your currently installed version of [Deno](https://deno.land/).
|
||||||
By default the module will be shown if any of the following conditions are met:
|
By default the module will be shown if any of the following conditions are met:
|
||||||
|
|
||||||
- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
|
- The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
| ------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
|
||||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||||
| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |
|
| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |
|
||||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||||
| `detect_files` | `['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
|
| `detect_files` | `['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |
|
||||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||||
| `style` | `'green bold'` | The style for the module. |
|
| `style` | `'green bold'` | The style for the module. |
|
||||||
| `disabled` | `false` | Disables the `deno` module. |
|
| `disabled` | `false` | Disables the `deno` module. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
@ -1154,7 +1172,7 @@ it would have been `nixpkgs/pkgs`.
|
|||||||
| `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. |
|
| `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
|
`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network
|
||||||
prefixes or development directories (i.e. 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.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[directory.substitutions]
|
[directory.substitutions]
|
||||||
@ -1204,11 +1222,54 @@ truncation_length = 8
|
|||||||
truncation_symbol = '…/'
|
truncation_symbol = '…/'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Direnv
|
||||||
|
|
||||||
|
The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Option | Default | Description |
|
||||||
|
| ------------------- | -------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `format` | `'[$symbol$loaded/$allowed]($style) '` | The format for the module. |
|
||||||
|
| `symbol` | `'direnv '` | The symbol used before displaying the direnv context. |
|
||||||
|
| `style` | `'bold orange'` | The style for the module. |
|
||||||
|
| `disabled` | `true` | Disables the `direnv` module. |
|
||||||
|
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||||
|
| `detect_files` | `['.envrc']` | Which filenames should trigger this module. |
|
||||||
|
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||||
|
| `detect_env_vars` | `['DIRENV_FILE']` | Which environment variables should trigger this module. |
|
||||||
|
| `allowed_msg` | `'allowed'` | The message displayed when an rc file is allowed. |
|
||||||
|
| `not_allowed_msg` | `'not allowed'` | The message displayed when an rc file is not_allowed. |
|
||||||
|
| `denied_msg` | `'denied'` | The message displayed when an rc file is denied. |
|
||||||
|
| `loaded_msg` | `'loaded'` | The message displayed when an rc file is loaded. |
|
||||||
|
| `unloaded_msg` | `'not loaded'` | The message displayed when an rc file is not loaded. |
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
| Variable | Example | Description |
|
||||||
|
| -------- | ------------------- | --------------------------------------- |
|
||||||
|
| loaded | `loaded` | Whether the current rc file is loaded. |
|
||||||
|
| allowed | `denied` | Whether the current rc file is allowed. |
|
||||||
|
| rc_path | `/home/test/.envrc` | The current rc file path. |
|
||||||
|
| symbol | | Mirrors the value of option `symbol`. |
|
||||||
|
| style\* | `red bold` | Mirrors the value of option `style`. |
|
||||||
|
|
||||||
|
*: This variable can only be used as a part of a style string
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
[direnv]
|
||||||
|
disabled = false
|
||||||
|
```
|
||||||
|
|
||||||
## Docker Context
|
## Docker Context
|
||||||
|
|
||||||
The `docker_context` module shows the currently active
|
The `docker_context` module shows the currently active
|
||||||
[Docker context](https://docs.docker.com/engine/context/working-with-contexts/)
|
[Docker context](https://docs.docker.com/engine/context/working-with-contexts/)
|
||||||
if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or
|
if it's not set to `default` or `desktop-linux`, or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or
|
||||||
`DOCKER_CONTEXT` environment variables are set (as they are meant to override
|
`DOCKER_CONTEXT` environment variables are set (as they are meant to override
|
||||||
the context in use).
|
the context in use).
|
||||||
|
|
||||||
@ -1654,7 +1715,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
|
|||||||
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.
|
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.
|
||||||
|
|
||||||
When the module is enabled it will always be active, unless `detect_env_vars` has
|
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 be active when one of the
|
been set in which case the module will only be active when one of the
|
||||||
environment variables has been set.
|
environment variables has been set.
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
@ -1783,7 +1844,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
|
|||||||
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
|
||||||
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
|
||||||
| `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. |
|
| `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. |
|
||||||
| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown |
|
| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown |
|
||||||
| `disabled` | `false` | Disables the `git_commit` module. |
|
| `disabled` | `false` | Disables the `git_commit` module. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
@ -1921,7 +1982,7 @@ You can disable the module or use the `windows_starship` option to use a Windows
|
|||||||
| `staged` | `'+'` | The format of `staged` |
|
| `staged` | `'+'` | The format of `staged` |
|
||||||
| `renamed` | `'»'` | The format of `renamed` |
|
| `renamed` | `'»'` | The format of `renamed` |
|
||||||
| `deleted` | `'✘'` | The format of `deleted` |
|
| `deleted` | `'✘'` | The format of `deleted` |
|
||||||
| `typechanged` | `""` | The format of `typechange` |
|
| `typechanged` | `""` | The format of `typechanged` |
|
||||||
| `style` | `'bold red'` | The style for the module. |
|
| `style` | `'bold red'` | The style for the module. |
|
||||||
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
| `ignore_submodules` | `false` | Ignore changes to submodules. |
|
||||||
| `disabled` | `false` | Disables the `git_status` module. |
|
| `disabled` | `false` | Disables the `git_status` module. |
|
||||||
@ -1933,7 +1994,7 @@ The following variables can be used in `format`:
|
|||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
| -------------- | ------------------------------------------------------------------------------------------------------------- |
|
| -------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` |
|
| `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. |
|
| `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. |
|
| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |
|
||||||
| `untracked` | Displays `untracked` when there are untracked files in the working directory. |
|
| `untracked` | Displays `untracked` when there are untracked files in the working directory. |
|
||||||
@ -1942,7 +2003,7 @@ The following variables can be used in `format`:
|
|||||||
| `staged` | Displays `staged` when a new file has been added to the staging area. |
|
| `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. |
|
| `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. |
|
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
|
||||||
| `typechanged` | Displays `typechange` when a file's type has been changed in 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` |
|
| style\* | Mirrors the value of option `style` |
|
||||||
|
|
||||||
*: This variable can only be used as a part of a style string
|
*: This variable can only be used as a part of a style string
|
||||||
@ -1999,6 +2060,45 @@ Use Windows Starship executable on Windows paths in WSL
|
|||||||
windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe'
|
windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Gleam
|
||||||
|
|
||||||
|
The `gleam` module shows the currently installed version of [Gleam](https://gleam.run/).
|
||||||
|
By default the module will be shown if any of the following conditions are met:
|
||||||
|
|
||||||
|
- The current directory contains a `gleam.toml` file
|
||||||
|
- The current directory contains a file with the `.gleam` extension
|
||||||
|
|
||||||
|
### 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 Gleam. |
|
||||||
|
| `detect_extensions` | `['gleam']` | Which extensions should trigger this module. |
|
||||||
|
| `detect_files` | `['gleam.toml']` | Which filenames should trigger this module. |
|
||||||
|
| `style` | `'bold #FFAFF3'` | The style for the module. |
|
||||||
|
| `disabled` | `false` | Disables the `gleam` module. |
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
| Variable | Example | Description |
|
||||||
|
| -------- | -------- | ------------------------------------ |
|
||||||
|
| version | `v1.0.0` | The version of `gleam` |
|
||||||
|
| symbol | | Mirrors the value of option `symbol` |
|
||||||
|
| style\* | | Mirrors the value of option `style` |
|
||||||
|
|
||||||
|
*: This variable can only be used as a part of a style string
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
[gleam]
|
||||||
|
format = 'via [⭐ $version](bold red) '
|
||||||
|
```
|
||||||
|
|
||||||
## Go
|
## Go
|
||||||
|
|
||||||
The `golang` module shows the currently installed version of [Go](https://golang.org/).
|
The `golang` module shows the currently installed version of [Go](https://golang.org/).
|
||||||
@ -2177,7 +2277,7 @@ By default the module will be shown if any of the following conditions are met:
|
|||||||
| `detect_extensions` | `['hx', 'hxml']` | Which extensions should trigger this module. |
|
| `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_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 modules. |
|
||||||
| `symbol` | `'⌘ '` | A format string representing the symbol of Helm. |
|
| `symbol` | `'⌘ '` | A format string representing the symbol of Haxe. |
|
||||||
| `style` | `'bold fg:202'` | The style for the module. |
|
| `style` | `'bold fg:202'` | The style for the module. |
|
||||||
| `disabled` | `false` | Disables the `haxe` module. |
|
| `disabled` | `false` | Disables the `haxe` module. |
|
||||||
|
|
||||||
@ -2255,6 +2355,7 @@ The `hostname` module shows the system hostname.
|
|||||||
| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
|
| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |
|
||||||
| `style` | `'bold dimmed green'` | The style for the module. |
|
| `style` | `'bold dimmed green'` | The style for the module. |
|
||||||
| `disabled` | `false` | Disables the `hostname` module. |
|
| `disabled` | `false` | Disables the `hostname` module. |
|
||||||
|
| `aliases` | `{}` | Translate system hostnames to something else. If `trim_at` is specified, only the first part will be matched and replaced. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
@ -2291,6 +2392,14 @@ detect_env_vars = ['!TMUX', 'SSH_CONNECTION']
|
|||||||
disabled = false
|
disabled = false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Replace the hostname with a nickname
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
[hostname]
|
||||||
|
aliases = { "Max's MacBook Pro" = "home" }
|
||||||
|
```
|
||||||
|
|
||||||
## Java
|
## Java
|
||||||
|
|
||||||
The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/).
|
The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/).
|
||||||
@ -2502,8 +2611,9 @@ This module is disabled by default.
|
|||||||
To enable it, set `disabled` to `false` in your configuration file.
|
To enable it, set `disabled` to `false` in your configuration file.
|
||||||
|
|
||||||
When the module is enabled it will always be active, unless any of
|
When the module is enabled it will always be active, unless any of
|
||||||
`detect_extensions`, `detect_files` or `detect_folders` have been set in which
|
`detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have
|
||||||
case the module will only be active in directories that match those conditions.
|
been set in which case the module will only be active in directories that match
|
||||||
|
those conditions or one of the environmatal variable has been set.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
@ -2526,6 +2636,7 @@ and `user_alias` options instead.
|
|||||||
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
|
||||||
| `detect_files` | `[]` | Which filenames 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 modules. |
|
||||||
|
| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |
|
||||||
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
|
| `contexts` | `[]` | Customized styles and symbols for specific contexts. |
|
||||||
| `disabled` | `true` | Disables the `kubernetes` module. |
|
| `disabled` | `true` | Disables the `kubernetes` module. |
|
||||||
|
|
||||||
@ -2836,6 +2947,70 @@ truncation_length = 4
|
|||||||
truncation_symbol = ''
|
truncation_symbol = ''
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Mojo
|
||||||
|
|
||||||
|
The `mojo` module shows the current version of [Mojo programming language](https://www.modular.com/mojo) installed
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Option | Default | Description |
|
||||||
|
| ------------------- | ------------------------------------- | ------------------------------------------------------ |
|
||||||
|
| `format` | `'with [$symbol($version )]($style)'` | The format for the module. |
|
||||||
|
| `symbol` | `'🔥 '` | The symbol used before displaying the version of Mojo. |
|
||||||
|
| `style` | `'bold 208'` | The style for the module. |
|
||||||
|
| `disabled` | `false` | Disables the `mojo` module. |
|
||||||
|
| `detect_extensions` | `['mojo', '🔥']` | Which extensions should trigger this module. |
|
||||||
|
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||||
|
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
| Variable | Example | Description |
|
||||||
|
| -------- | -------- | ------------------------------------ |
|
||||||
|
| version | `24.4.0` | The version of `mojo` |
|
||||||
|
| symbol | | Mirrors the value of option `symbol` |
|
||||||
|
| style\* | | Mirrors the value of option `style` |
|
||||||
|
|
||||||
|
*: This variable can only be used as a part of a style string
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
[mojo]
|
||||||
|
format = 'via [mojo ($version )($hash )]($style)'
|
||||||
|
```
|
||||||
|
|
||||||
|
## NATS
|
||||||
|
|
||||||
|
The `nats` module shows the name of the current [NATS](https://nats.io) context.
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Option | Default | Description |
|
||||||
|
| ---------- | -------------------------- | ------------------------------------------------------------ |
|
||||||
|
| `symbol` | `'✉️ '` | The symbol used before the NATS context (defaults to empty). |
|
||||||
|
| `style` | `'bold purple'` | The style for the module. |
|
||||||
|
| `format` | `'[$symbol$name]($style)'` | The format for the module. |
|
||||||
|
| `disabled` | `false` | Disables the `nats` module. |
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
| Variable | Example | Description |
|
||||||
|
| -------- | ----------- | ------------------------------------ |
|
||||||
|
| name | `localhost` | The name of the NATS context |
|
||||||
|
| symbol | | Mirrors the value of option `symbol` |
|
||||||
|
| style\* | | Mirrors the value of option `style` |
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[nats]
|
||||||
|
format = '[$symbol]($style)'
|
||||||
|
style = 'bold purple'
|
||||||
|
```
|
||||||
|
|
||||||
## Nim
|
## Nim
|
||||||
|
|
||||||
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/).
|
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/).
|
||||||
@ -2935,17 +3110,17 @@ By default the module will be shown if any of the following conditions are met:
|
|||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
|
| ------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||||
| `symbol` | `' '` | A format string representing the symbol of Node.js. |
|
| `symbol` | `' '` | A format string representing the symbol of Node.js. |
|
||||||
| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Which extensions should trigger this module. |
|
| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Which extensions should trigger this module. |
|
||||||
| `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. |
|
| `detect_files` | `['package.json', '.node-version', '.nvmrc']` | Which filenames should trigger this module. |
|
||||||
| `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
|
| `detect_folders` | `['node_modules']` | Which folders should trigger this module. |
|
||||||
| `style` | `'bold green'` | The style for the module. |
|
| `style` | `'bold green'` | The style for the module. |
|
||||||
| `disabled` | `false` | Disables the `nodejs` module. |
|
| `disabled` | `false` | Disables the `nodejs` module. |
|
||||||
| `not_capable_style` | `'bold red'` | The style for the module when an engines property in package.json does not match the Node.js version. |
|
| `not_capable_style` | `'bold red'` | The style for the module when an engines property in package.json does not match the Node.js version. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
@ -3015,6 +3190,43 @@ By default the module will be shown if any of the following conditions are met:
|
|||||||
format = 'via [🐪 $version]($style) '
|
format = 'via [🐪 $version]($style) '
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Odin
|
||||||
|
|
||||||
|
The `odin` module shows the currently installed version of [Odin](https://odin-lang.org/). By default the module will be shown if the current directory contains a `.odin` file.
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Option | Default | Description |
|
||||||
|
| ------------------- | ------------------------------------ | ----------------------------------------------------- |
|
||||||
|
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||||
|
| `show_commit` | `false` | Shows the commit as part of the version. |
|
||||||
|
| `symbol` | `'Ø '` | The symbol used before displaying the version of Zig. |
|
||||||
|
| `style` | `'bold bright-blue'` | The style for the module. |
|
||||||
|
| `disabled` | `false` | Disables the `odin` module. |
|
||||||
|
| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |
|
||||||
|
| `detect_files` | `[]` | Which filenames should trigger this module. |
|
||||||
|
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
| Variable | Example | Description |
|
||||||
|
| -------- | ------------- | ------------------------------------ |
|
||||||
|
| version | `dev-2024-03` | The version of `odin` |
|
||||||
|
| symbol | | Mirrors the value of option `symbol` |
|
||||||
|
| style\* | | Mirrors the value of option `style` |
|
||||||
|
|
||||||
|
*: This variable can only be used as a part of a style string
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
|
[odin]
|
||||||
|
format = 'via [ ($version )]($style)'
|
||||||
|
show_commit = true
|
||||||
|
```
|
||||||
|
|
||||||
## Open Policy Agent
|
## Open Policy Agent
|
||||||
|
|
||||||
The `opa` module shows the currently installed version of the OPA tool.
|
The `opa` module shows the currently installed version of the OPA tool.
|
||||||
@ -3125,12 +3337,15 @@ If you would like an operating system to be added, feel free to open a [feature
|
|||||||
```toml
|
```toml
|
||||||
# This is the default symbols table.
|
# This is the default symbols table.
|
||||||
[os.symbols]
|
[os.symbols]
|
||||||
|
AIX = "➿ "
|
||||||
Alpaquita = "🔔 "
|
Alpaquita = "🔔 "
|
||||||
|
AlmaLinux = "💠 "
|
||||||
Alpine = "🏔️ "
|
Alpine = "🏔️ "
|
||||||
Amazon = "🙂 "
|
Amazon = "🙂 "
|
||||||
Android = "🤖 "
|
Android = "🤖 "
|
||||||
Arch = "🎗️ "
|
Arch = "🎗️ "
|
||||||
Artix = "🎗️ "
|
Artix = "🎗️ "
|
||||||
|
CachyOS = "🎗️ "
|
||||||
CentOS = "💠 "
|
CentOS = "💠 "
|
||||||
Debian = "🌀 "
|
Debian = "🌀 "
|
||||||
DragonFly = "🐉 "
|
DragonFly = "🐉 "
|
||||||
@ -3142,6 +3357,7 @@ Garuda = "🦅 "
|
|||||||
Gentoo = "🗜️ "
|
Gentoo = "🗜️ "
|
||||||
HardenedBSD = "🛡️ "
|
HardenedBSD = "🛡️ "
|
||||||
Illumos = "🐦 "
|
Illumos = "🐦 "
|
||||||
|
Kali = "🐉 "
|
||||||
Linux = "🐧 "
|
Linux = "🐧 "
|
||||||
Mabox = "📦 "
|
Mabox = "📦 "
|
||||||
Macos = "🍎 "
|
Macos = "🍎 "
|
||||||
@ -3151,6 +3367,7 @@ MidnightBSD = "🌘 "
|
|||||||
Mint = "🌿 "
|
Mint = "🌿 "
|
||||||
NetBSD = "🚩 "
|
NetBSD = "🚩 "
|
||||||
NixOS = "❄️ "
|
NixOS = "❄️ "
|
||||||
|
Nobara = "🎩 "
|
||||||
OpenBSD = "🐡 "
|
OpenBSD = "🐡 "
|
||||||
OpenCloudOS = "☁️ "
|
OpenCloudOS = "☁️ "
|
||||||
openEuler = "🦉 "
|
openEuler = "🦉 "
|
||||||
@ -3160,11 +3377,15 @@ Pop = "🍭 "
|
|||||||
Raspbian = "🍓 "
|
Raspbian = "🍓 "
|
||||||
Redhat = "🎩 "
|
Redhat = "🎩 "
|
||||||
RedHatEnterprise = "🎩 "
|
RedHatEnterprise = "🎩 "
|
||||||
|
RockyLinux = "💠 "
|
||||||
Redox = "🧪 "
|
Redox = "🧪 "
|
||||||
Solus = "⛵ "
|
Solus = "⛵ "
|
||||||
SUSE = "🦎 "
|
SUSE = "🦎 "
|
||||||
Ubuntu = "🎯 "
|
Ubuntu = "🎯 "
|
||||||
|
Ultramarine = "🔷 "
|
||||||
Unknown = "❓ "
|
Unknown = "❓ "
|
||||||
|
Uos = "🐲 "
|
||||||
|
Void = " "
|
||||||
Windows = "🪟 "
|
Windows = "🪟 "
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -3419,20 +3640,22 @@ The `purescript` module shows the currently installed version of [PureScript](ht
|
|||||||
By default the module will be shown if any of the following conditions are met:
|
By default the module will be shown if any of the following conditions are met:
|
||||||
|
|
||||||
- The current directory contains a `spago.dhall` file
|
- The current directory contains a `spago.dhall` file
|
||||||
|
- The current directory contains a `spago.yaml` file
|
||||||
|
- The current directory contains a `spago.lock` file
|
||||||
- The current directory contains a file with the `.purs` extension
|
- The current directory contains a file with the `.purs` extension
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
| ------------------- | --------------------------------------------- | ------------------------------------------------------------------------- |
|
||||||
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||||
| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. |
|
| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. |
|
||||||
| `detect_extensions` | `['purs']` | Which extensions should trigger this module. |
|
| `detect_extensions` | `['purs']` | Which extensions should trigger this module. |
|
||||||
| `detect_files` | `['spago.dhall']` | Which filenames should trigger this module. |
|
| `detect_files` | `['spago.dhall', 'spago.yaml', 'spago.lock']` | Which filenames should trigger this module. |
|
||||||
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||||
| `style` | `'bold white'` | The style for the module. |
|
| `style` | `'bold white'` | The style for the module. |
|
||||||
| `disabled` | `false` | Disables the `purescript` module. |
|
| `disabled` | `false` | Disables the `purescript` module. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
@ -3461,7 +3684,7 @@ current [Python virtual environment](https://docs.python.org/tutorial/venv.html)
|
|||||||
If `pyenv_version_name` is set to `true`, it will display the pyenv version
|
If `pyenv_version_name` is set to `true`, it will display the pyenv version
|
||||||
name. Otherwise, it will display the version number from `python --version`.
|
name. Otherwise, it will display the version number from `python --version`.
|
||||||
|
|
||||||
By default the module will be shown if any of the following conditions are met:
|
By default, the module will be shown if any of the following conditions are met:
|
||||||
|
|
||||||
- The current directory contains a `.python-version` file
|
- The current directory contains a `.python-version` file
|
||||||
- The current directory contains a `Pipfile` file
|
- The current directory contains a `Pipfile` file
|
||||||
@ -3470,24 +3693,26 @@ By default the module will be shown if any of the following conditions are met:
|
|||||||
- The current directory contains a `requirements.txt` file
|
- The current directory contains a `requirements.txt` file
|
||||||
- The current directory contains a `setup.py` file
|
- The current directory contains a `setup.py` file
|
||||||
- The current directory contains a `tox.ini` file
|
- The current directory contains a `tox.ini` file
|
||||||
|
- The current directory contains a `pixi.toml` file
|
||||||
- The current directory contains a file with the `.py` extension.
|
- The current directory contains a file with the `.py` extension.
|
||||||
|
- The current directory contains a file with the `.ipynb` extension.
|
||||||
- A virtual environment is currently activated
|
- A virtual environment is currently activated
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
|
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
|
||||||
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||||
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
|
| `symbol` | `'🐍 '` | A format string representing the symbol of Python |
|
||||||
| `style` | `'yellow bold'` | The style for the module. |
|
| `style` | `'yellow bold'` | The style for the module. |
|
||||||
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
|
||||||
| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |
|
| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |
|
||||||
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
|
| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. |
|
||||||
| `detect_extensions` | `['py']` | Which extensions should trigger this module |
|
| `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_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini', 'pixi.toml']` | Which filenames should trigger this module |
|
||||||
| `detect_folders` | `[]` | Which folders should trigger this module |
|
| `detect_folders` | `[]` | Which folders should trigger this module |
|
||||||
| `disabled` | `false` | Disables the `python` module. |
|
| `disabled` | `false` | Disables the `python` module. |
|
||||||
|
|
||||||
::: tip
|
::: tip
|
||||||
|
|
||||||
@ -3543,16 +3768,37 @@ python_binary = 'python3'
|
|||||||
detect_extensions = []
|
detect_extensions = []
|
||||||
```
|
```
|
||||||
|
|
||||||
```toml
|
## Quarto
|
||||||
# ~/.config/starship.toml
|
|
||||||
|
|
||||||
[python]
|
The `quarto` module shows the current installed version of Quarto used in a project.
|
||||||
# Display the version of python from inside a local venv.
|
|
||||||
#
|
By default, the module will be shown if any of the following conditions are met:
|
||||||
# Note this will only work when the venv is inside the project and it will only
|
|
||||||
# work in the directory that contains the venv dir but maybe this is ok?
|
- The current directory contains a `_quarto.yml` file
|
||||||
python_binary = ['./venv/bin/python', 'python', 'python3', 'python2']
|
- The current directory contains any `*.qmd` file
|
||||||
```
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Option | Default | Description |
|
||||||
|
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||||
|
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||||
|
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||||
|
| `symbol` | `'⨁ '` | A format string representing the symbol of Quarto |
|
||||||
|
| `style` | `'bold #75AADB'` | The style for the module. |
|
||||||
|
| `detect_extensions` | `['.qmd']` | Which extensions should trigger this module. |
|
||||||
|
| `detect_files` | `['_quarto.yml']` | Which filenames should trigger this module. |
|
||||||
|
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||||
|
| `disabled` | `false` | Disables the `quarto` module. |
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
| Variable | Example | Description |
|
||||||
|
| -------- | --------- | ------------------------------------ |
|
||||||
|
| version | `1.4.549` | The version of `quarto` |
|
||||||
|
| 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
|
||||||
|
|
||||||
## R
|
## R
|
||||||
|
|
||||||
@ -3703,11 +3949,12 @@ Starship gets the current Ruby version by running `ruby -v`.
|
|||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
| Variable | Example | Description |
|
| Variable | Example | Description |
|
||||||
| -------- | -------- | ------------------------------------ |
|
| -------- | -------- | ------------------------------------------- |
|
||||||
| version | `v2.5.1` | The version of `ruby` |
|
| version | `v2.5.1` | The version of `ruby` |
|
||||||
| symbol | | Mirrors the value of option `symbol` |
|
| symbol | | Mirrors the value of option `symbol` |
|
||||||
| style\* | | Mirrors the value of option `style` |
|
| style\* | | Mirrors the value of option `style` |
|
||||||
|
| gemset | `test` | Optional, gets the current RVM gemset name. |
|
||||||
|
|
||||||
*: This variable can only be used as a part of a style string
|
*: This variable can only be used as a part of a style string
|
||||||
|
|
||||||
@ -3816,22 +4063,23 @@ To enable it, set `disabled` to `false` in your configuration file.
|
|||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| ---------------------- | ------------------------- | ------------------------------------------------------------ |
|
| ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------ |
|
||||||
| `bash_indicator` | `'bsh'` | A format string used to represent bash. |
|
| `bash_indicator` | `'bsh'` | A format string used to represent bash. |
|
||||||
| `fish_indicator` | `'fsh'` | A format string used to represent fish. |
|
| `fish_indicator` | `'fsh'` | A format string used to represent fish. |
|
||||||
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
|
| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |
|
||||||
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. |
|
| `powershell_indicator` | `'psh'` | A format string used to represent powershell. |
|
||||||
| `ion_indicator` | `'ion'` | A format string used to represent ion. |
|
| `pwsh_indicator` | | A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. |
|
||||||
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
|
| `ion_indicator` | `'ion'` | A format string used to represent ion. |
|
||||||
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
|
| `elvish_indicator` | `'esh'` | A format string used to represent elvish. |
|
||||||
| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. |
|
| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |
|
||||||
| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. |
|
| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. |
|
||||||
| `nu_indicator` | `'nu'` | A format string used to represent nu. |
|
| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. |
|
||||||
| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. |
|
| `nu_indicator` | `'nu'` | A format string used to represent nu. |
|
||||||
| `format` | `'[$indicator]($style) '` | The format for the module. |
|
| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. |
|
||||||
| `style` | `'white bold'` | The style for the module. |
|
| `format` | `'[$indicator]($style) '` | The format for the module. |
|
||||||
| `disabled` | `true` | Disables the `shell` module. |
|
| `style` | `'white bold'` | The style for the module. |
|
||||||
|
| `disabled` | `true` | Disables the `shell` module. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
@ -3895,7 +4143,7 @@ threshold = 3
|
|||||||
|
|
||||||
Using `repeat` and `repeat_offset` along with `character` module, one can get
|
Using `repeat` and `repeat_offset` along with `character` module, one can get
|
||||||
prompt like `❯❯❯` where last character is colored appropriately for return
|
prompt like `❯❯❯` where last character is colored appropriately for return
|
||||||
status code and preceeding characters are provided by `shlvl`.
|
status code and preceding characters are provided by `shlvl`.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# ~/.config/starship.toml
|
# ~/.config/starship.toml
|
||||||
@ -4029,38 +4277,40 @@ To enable it, set `disabled` to `false` in your configuration file.
|
|||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| --------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
| --------------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------- |
|
||||||
| `format` | `'[$symbol$status]($style) '` | The format of the module |
|
| `format` | `'[$symbol$status]($style) '` | The format of the module |
|
||||||
| `symbol` | `'❌'` | The symbol displayed on program error |
|
| `symbol` | `'❌'` | The symbol displayed on program error |
|
||||||
| `success_symbol` | `''` | The symbol displayed on program success |
|
| `success_symbol` | `''` | The symbol displayed on program success |
|
||||||
| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |
|
| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |
|
||||||
| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found |
|
| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found |
|
||||||
| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) |
|
| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) |
|
||||||
| `signal_symbol` | `'⚡'` | The symbol displayed on any signal |
|
| `signal_symbol` | `'⚡'` | The symbol displayed on any signal |
|
||||||
| `style` | `'bold red'` | The style for the module. |
|
| `style` | `'bold red'` | The style for the module. |
|
||||||
| `recognize_signal_code` | `true` | Enable signal mapping from exit code |
|
| `success_style` | | The style used on program success (defaults to `style` if unset). |
|
||||||
| `map_symbol` | `false` | Enable symbols mapping from exit code |
|
| `failure_style` | | The style used on program failure (defaults to `style` if unset). |
|
||||||
| `pipestatus` | `false` | Enable pipestatus reporting |
|
| `recognize_signal_code` | `true` | Enable signal mapping from exit code |
|
||||||
| `pipestatus_separator` | <code>|</code> | The symbol used to separate pipestatus segments (supports formatting) |
|
| `map_symbol` | `false` | Enable symbols mapping from exit code |
|
||||||
| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | The format of the module when the command is a pipeline |
|
| `pipestatus` | `false` | Enable pipestatus reporting |
|
||||||
| `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments |
|
| `pipestatus_separator` | <code>|</code> | The symbol used to separate pipestatus segments (supports formatting) |
|
||||||
| `disabled` | `true` | Disables the `status` module. |
|
| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style) '` | The format of the module when the command is a pipeline |
|
||||||
|
| `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments |
|
||||||
|
| `disabled` | `true` | Disables the `status` module. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
| Variable | Example | Description |
|
| Variable | Example | Description |
|
||||||
| -------------- | ------- | ------------------------------------------------------------------------------------------ |
|
| -------------- | ------- | -------------------------------------------------------------------------------------------- |
|
||||||
| status | `127` | The exit code of the last command |
|
| status | `127` | The exit code of the last command |
|
||||||
| hex_status | `0x7F` | The exit code of the last command in hex |
|
| hex_status | `0x7F` | The exit code of the last command in hex |
|
||||||
| int | `127` | The exit code of the last command |
|
| int | `127` | The exit code of the last command |
|
||||||
| common_meaning | `ERROR` | Meaning of the code if not a signal |
|
| common_meaning | `ERROR` | Meaning of the code if not a signal |
|
||||||
| signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
|
| signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
|
||||||
| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
|
| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
|
||||||
| maybe_int | `7` | Contains the exit code number when no meaning has been found |
|
| maybe_int | `7` | Contains the exit code number when no meaning has been found |
|
||||||
| pipestatus | | Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format |
|
| pipestatus | | Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format |
|
||||||
| symbol | | Mirrors the value of option `symbol` |
|
| symbol | | Mirrors the value of option `symbol` |
|
||||||
| style\* | | Mirrors the value of option `style` |
|
| style\* | | Mirrors the value of option `success_style` on program success and `failure_style` otherwise |
|
||||||
|
|
||||||
*: This variable can only be used as a part of a style string
|
*: This variable can only be used as a part of a style string
|
||||||
|
|
||||||
@ -4278,6 +4528,39 @@ utc_time_offset = '-5'
|
|||||||
time_range = '10:00:00-14:00:00'
|
time_range = '10:00:00-14:00:00'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Typst
|
||||||
|
|
||||||
|
The `typst` module shows the current installed version of Typst used in a project.
|
||||||
|
|
||||||
|
By default, the module will be shown if any of the following conditions are met:
|
||||||
|
|
||||||
|
- The current directory contains a `template.typ` file
|
||||||
|
- The current directory contains any `*.typ` file
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Option | Default | Description |
|
||||||
|
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
|
||||||
|
| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |
|
||||||
|
| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
|
||||||
|
| `symbol` | `'t '` | A format string representing the symbol of Typst |
|
||||||
|
| `style` | `'bold #0093A7'` | The style for the module. |
|
||||||
|
| `detect_extensions` | `['.typ']` | Which extensions should trigger this module. |
|
||||||
|
| `detect_files` | `['template.typ']` | Which filenames should trigger this module. |
|
||||||
|
| `detect_folders` | `[]` | Which folders should trigger this module. |
|
||||||
|
| `disabled` | `false` | Disables the `typst` module. |
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
| Variable | Example | Description |
|
||||||
|
| ------------- | --------- | ----------------------------------------------- |
|
||||||
|
| version | `v0.9.0` | The version of `typst`, alias for typst_version |
|
||||||
|
| typst_version | `default` | The current Typst version |
|
||||||
|
| 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
|
||||||
|
|
||||||
## Username
|
## Username
|
||||||
|
|
||||||
The `username` module shows active user's username.
|
The `username` module shows active user's username.
|
||||||
@ -4287,6 +4570,7 @@ The module will be shown if any of the following conditions are met:
|
|||||||
- The current user isn't the same as the one that is logged in
|
- The current user isn't the same as the one that is logged in
|
||||||
- The user is currently connected as an SSH session
|
- The user is currently connected as an SSH session
|
||||||
- The variable `show_always` is set to true
|
- The variable `show_always` is set to true
|
||||||
|
- The array `detect_env_vars` contains at least the name of one environment variable, that is set
|
||||||
|
|
||||||
::: tip
|
::: tip
|
||||||
|
|
||||||
@ -4298,13 +4582,15 @@ these variables, one workaround is to set one of them with a dummy value.
|
|||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| ------------- | ----------------------- | ------------------------------------------- |
|
| ----------------- | ----------------------- | --------------------------------------------------------- |
|
||||||
| `style_root` | `'bold red'` | The style used when the user is root/admin. |
|
| `style_root` | `'bold red'` | The style used when the user is root/admin. |
|
||||||
| `style_user` | `'bold yellow'` | The style used for non-root users. |
|
| `style_user` | `'bold yellow'` | The style used for non-root users. |
|
||||||
| `format` | `'[$user]($style) in '` | The format for the module. |
|
| `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. |
|
||||||
| `show_always` | `false` | Always shows the `username` module. |
|
| `format` | `'[$user]($style) in '` | The format for the module. |
|
||||||
| `disabled` | `false` | Disables the `username` module. |
|
| `show_always` | `false` | Always shows the `username` module. |
|
||||||
|
| `disabled` | `false` | Disables the `username` module. |
|
||||||
|
| `aliases` | `{}` | Translate system usernames to something else. |
|
||||||
|
|
||||||
### Variables
|
### Variables
|
||||||
|
|
||||||
@ -4315,6 +4601,8 @@ these variables, one workaround is to set one of them with a dummy value.
|
|||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
|
#### Always show the username
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# ~/.config/starship.toml
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
@ -4324,6 +4612,7 @@ style_root = 'black bold'
|
|||||||
format = 'user: [$user]($style) '
|
format = 'user: [$user]($style) '
|
||||||
disabled = false
|
disabled = false
|
||||||
show_always = true
|
show_always = true
|
||||||
|
aliases = { "corpuser034g" = "matchai" }
|
||||||
```
|
```
|
||||||
|
|
||||||
## Vagrant
|
## Vagrant
|
||||||
@ -4507,11 +4796,12 @@ If you have an interesting example not covered there, feel free to share it ther
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
::: warning Command output is printed unescaped to the prompt
|
::: warning If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.
|
||||||
|
|
||||||
Whatever output the command generates is printed unmodified in the prompt. This means if the output
|
Whatever output the command generates is printed unmodified in the prompt. This means if the output
|
||||||
contains special sequences that are interpreted by your shell they will be expanded when displayed.
|
contains shell-specific interpretable sequences, they could be interpreted on display.
|
||||||
These special sequences are shell specific, e.g. you can write a command module that writes bash sequences,
|
Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell.
|
||||||
|
Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences,
|
||||||
e.g. `\h`, but this module will not work in a fish or zsh shell.
|
e.g. `\h`, but this module will not work in a fish or zsh shell.
|
||||||
|
|
||||||
Format strings can also contain shell specific prompt sequences, e.g.
|
Format strings can also contain shell specific prompt sequences, e.g.
|
||||||
@ -4525,10 +4815,11 @@ Format strings can also contain shell specific prompt sequences, e.g.
|
|||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. |
|
| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. |
|
||||||
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
|
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the `shell` returns a `0` status code from executing it. |
|
||||||
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
|
| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |
|
||||||
| `shell` | | [See below](#custom-command-shell) |
|
| `shell` | | [See below](#custom-command-shell) |
|
||||||
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
|
| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |
|
||||||
|
| `unsafe_no_escape` | `false` | When set, command output is not escaped of characters that could be interpreted by the shell. |
|
||||||
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
|
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
|
||||||
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
|
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
|
||||||
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
|
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
|
||||||
@ -4544,7 +4835,7 @@ Format strings can also contain shell specific prompt sequences, e.g.
|
|||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
| -------- | -------------------------------------- |
|
| -------- | -------------------------------------- |
|
||||||
| output | The output of shell command in `shell` |
|
| output | The output of `command` run in `shell` |
|
||||||
| symbol | Mirrors the value of option `symbol` |
|
| symbol | Mirrors the value of option `symbol` |
|
||||||
| style\* | Mirrors the value of option `style` |
|
| style\* | Mirrors the value of option `style` |
|
||||||
|
|
||||||
@ -4559,7 +4850,7 @@ Format strings can also contain shell specific prompt sequences, e.g.
|
|||||||
|
|
||||||
If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows.
|
If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows.
|
||||||
|
|
||||||
The `command` will be passed in on stdin.
|
The `command` (and `when`, if applicable) will be passed in on stdin.
|
||||||
|
|
||||||
If `shell` is not given or only contains one element and Starship detects PowerShell will be used,
|
If `shell` is not given or only contains one element and Starship detects PowerShell will be used,
|
||||||
the following arguments will automatically be added: `-NoProfile -Command -`.
|
the following arguments will automatically be added: `-NoProfile -Command -`.
|
||||||
|
@ -1,10 +1,14 @@
|
|||||||
---
|
---
|
||||||
home: true
|
layout: home
|
||||||
heroImage: /logo.svg
|
hero:
|
||||||
heroText:
|
image: /logo.svg
|
||||||
tagline: Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!
|
text:
|
||||||
actionText: Loslegen →
|
tagline: Der minimalistische, super schnelle und unendlich anpassbare Prompt für jede Shell!
|
||||||
actionLink: ./de-DE/guide/
|
actions:
|
||||||
|
-
|
||||||
|
theme: brand
|
||||||
|
text: Loslegen →
|
||||||
|
link: ./de-DE/guide/
|
||||||
features:
|
features:
|
||||||
-
|
-
|
||||||
title: Kompatibel
|
title: Kompatibel
|
||||||
@ -21,12 +25,24 @@ 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.
|
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.
|
||||||
---
|
---
|
||||||
|
|
||||||
<div class="center">
|
<script setup>
|
||||||
<video class="demo-video" muted autoplay loop playsinline>
|
import { onMounted } from 'vue'
|
||||||
<source src="/demo.webm" type="video/webm">
|
|
||||||
<source src="/demo.mp4" type="video/mp4">
|
onMounted(() => {
|
||||||
</video>
|
const urlParams = new URLSearchParams(window.location.search)
|
||||||
</div>
|
if (urlParams.has('uwu') || urlParams.has('kawaii')) {
|
||||||
|
const img = document.querySelector('.VPHero .VPImage.image-src')
|
||||||
|
img.classList.add('uwu')
|
||||||
|
img.src = '/logo-uwu.png'
|
||||||
|
img.alt = 'Kawaii Starship Logo by @sawaratsuki1004'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<video class="demo-video" muted autoplay loop playsinline>
|
||||||
|
<source src="/demo.webm" type="video/webm">
|
||||||
|
<source src="/demo.mp4" type="video/mp4">
|
||||||
|
</video>
|
||||||
|
|
||||||
### Voraussetzungen
|
### Voraussetzungen
|
||||||
|
|
||||||
@ -45,7 +61,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
|
|||||||
curl -sS https://starship.rs/install.sh | sh
|
curl -sS https://starship.rs/install.sh | sh
|
||||||
```
|
```
|
||||||
|
|
||||||
Um Starship selbst zu aktualisieren, führe das Skript oben erneut aus. Die vorhandene Version wird ersetzt, ohne das deine Konfiguration von Starship verloren geht.
|
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
|
#### Installation mithilfe eines Paket-Managers
|
||||||
@ -55,6 +71,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
|
|||||||
```sh
|
```sh
|
||||||
brew install starship
|
brew install starship
|
||||||
```
|
```
|
||||||
|
|
||||||
Mit [Winget](https://github.com/microsoft/winget-cli):
|
Mit [Winget](https://github.com/microsoft/winget-cli):
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
@ -66,7 +83,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
|
|||||||
|
|
||||||
#### Bash
|
#### Bash
|
||||||
|
|
||||||
Trage folgendes am Ende der `~/.bashrc` ein:
|
Füge dies ans Ende von `~/.bashrc`:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# ~/.bashrc
|
# ~/.bashrc
|
||||||
@ -99,7 +116,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
|
|||||||
|
|
||||||
#### Powershell
|
#### Powershell
|
||||||
|
|
||||||
Trage das folgende am Ende von `Microsoft.PowerShell_profile.ps1` ein. Du kannst den Speicherort dieser Datei überprüfen, indem du die `$PROFILE` Variable in PowerShell abfragst. Der Pfat lautet normalerweise `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` unter Windows und `~/.config/powershell/Microsoft.PowerShell_profile.ps1` auf -Nix.
|
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.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
Invoke-Expression (&starship init powershell)
|
Invoke-Expression (&starship init powershell)
|
||||||
@ -149,20 +166,15 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
|
|||||||
|
|
||||||
::: warning
|
::: warning
|
||||||
|
|
||||||
Das wird sich in Zukunft ändern. Nur Nushell v0.78+ wird unterstützt.
|
Das wird sich in Zukunft ändern. Only Nushell v0.96+ is supported.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||||
```sh
|
|
||||||
mkdir ~/.cache/starship
|
|
||||||
starship init nu | save -f ~/.cache/starship/init.nu
|
|
||||||
```
|
|
||||||
|
|
||||||
Und füge folgendes am Ende deiner Nushell-Konfiguration hinzu (du findest diese, indem du folgenden Befehl in Nushell ausführst `$nu.config-path`):
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
use ~/.cache/starship/init.nu
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Erweiterte Konfiguration
|
# Erweiterte Konfiguration
|
||||||
|
|
||||||
Auch wenn Starship eine vielseitige Shell ist, reichen manche Konfigurationen in der `starship.toml` nicht aus, um erweiterte Einstellungen vorzunehmen. Diese Seite beschreibt einige fortgeschrittene Konfigurationen für Starship.
|
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
|
::: warning
|
||||||
|
|
||||||
@ -10,7 +10,7 @@ Die hier beschriebenen Konfigurationen werden sich mit kommenden Updates von Sta
|
|||||||
|
|
||||||
## TransientPrompt in PowerShell
|
## 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`.
|
Es ist möglich, die zuvor geprintete Prompt mit einem benutzerdefinierten String zu ersetzen. Das ist in Fällen nützlich, in denen nicht immer die ganze Information der Prompt gebraucht wird. Führe `Enable-TransientPrompt` in deiner Shell-Session aus, um dieses Verhalten zu aktivieren. Füge das Statement in dein `$PROFILE` ein, um diese Funktion dauerhaft zu aktivieren. 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
|
||||||
|
|
||||||
@ -26,7 +26,7 @@ Enable-TransientPrompt
|
|||||||
|
|
||||||
## TransientPrompt and TransientRightPrompt in Cmd
|
## 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. Das ist in Fällen nützlich, in denen nicht immer die ganze Information der Prompt gebraucht wird. To enable this, run `clink set prompt.transient <value>` where \<value\> can be one of:
|
||||||
|
|
||||||
- `always`: always replace the previous prompt
|
- `always`: always replace the previous prompt
|
||||||
- `same_dir`: replace the previous prompt only if the working directory is same
|
- `same_dir`: replace the previous prompt only if the working directory is same
|
||||||
@ -56,7 +56,7 @@ load(io.popen('starship init cmd'):read("*a"))()
|
|||||||
|
|
||||||
## TransientPrompt and TransientRightPrompt in Fish
|
## 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`.
|
Es ist möglich, die zuvor geprintete Prompt mit einem benutzerdefinierten String zu ersetzen. Das ist in Fällen nützlich, in denen nicht immer die ganze Information der Prompt gebraucht wird. 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.
|
Note that in case of Fish, the transient prompt is only printed if the commandline is non-empty, and syntactically correct.
|
||||||
|
|
||||||
@ -80,6 +80,26 @@ starship init fish | source
|
|||||||
enable_transience
|
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 \<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
|
||||||
|
|
||||||
|
```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
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bleopt prompt_rps1_final='$(starship module time)'
|
||||||
|
```
|
||||||
|
|
||||||
## Custom pre-prompt and pre-execution Commands in Cmd
|
## 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:
|
||||||
@ -129,7 +149,7 @@ eval $(starship init bash)
|
|||||||
set +o functrace
|
set +o functrace
|
||||||
```
|
```
|
||||||
|
|
||||||
## Custom pre-prompt and pre-execution Commands in PowerShell
|
## 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:
|
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:
|
||||||
|
|
||||||
@ -203,9 +223,11 @@ Invoke-Expression (&starship init powershell)
|
|||||||
|
|
||||||
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.
|
`right_format` is currently supported for the following 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.
|
||||||
|
|
||||||
### Beispiel
|
### Beispiel
|
||||||
|
|
||||||
@ -244,7 +266,7 @@ Hinweis: Fortsetzungs-Prompts sind nur für folgende Shells verfügbar:
|
|||||||
```toml
|
```toml
|
||||||
# ~/.config/starship.toml
|
# ~/.config/starship.toml
|
||||||
|
|
||||||
# Ein Fortsetzungs-Prompt der 2 ausgefüllte Pfeile darstellt
|
# A continuation prompt that displays two filled-in arrows
|
||||||
continuation_prompt = '▶▶ '
|
continuation_prompt = '▶▶ '
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -265,7 +287,7 @@ Stil-Zeichenketten sind eine Liste von Wörtern, getrennt durch Leerzeichen. Die
|
|||||||
- `<color>`
|
- `<color>`
|
||||||
- `keins`
|
- `keins`
|
||||||
|
|
||||||
wobei `<color>` eine Farbspezifikation ist (siehe unten). `fg:<color>` und `<color>` tun derzeit dasselbe, das kann sich in Zukunft aber ändern. `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.
|
`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.
|
||||||
|
|
||||||
@ -279,6 +301,6 @@ Wenn mehrere Farben für Vordergrund oder Hintergrund angegeben werden, hat die
|
|||||||
|
|
||||||
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
|
Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist:
|
||||||
|
|
||||||
- Many terminals disable support for `blink` by default
|
- Many terminals disable support for `blink` by default.
|
||||||
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
|
- `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564).
|
||||||
- `strikethrough` is not supported by the default macOS Terminal.app
|
- `strikethrough` is not supported by the default macOS Terminal.app.
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -58,7 +58,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
|||||||
|
|
||||||
## Why do I see `Executing command "..." timed out.` warnings?
|
## 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?
|
## I see symbols I don't understand or expect, what do they mean?
|
||||||
|
|
||||||
@ -72,7 +72,7 @@ You can enable the debug logs by using the `STARSHIP_LOG` env var. These logs ca
|
|||||||
env STARSHIP_LOG=trace starship module rust
|
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 to blame.
|
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.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
env STARSHIP_LOG=trace starship timings
|
env STARSHIP_LOG=trace starship timings
|
||||||
@ -120,3 +120,11 @@ Wenn Starship mit Hilfe des Installationsscripts installiert wurde, entfernt der
|
|||||||
# Locate and delete the starship binary
|
# Locate and delete the starship binary
|
||||||
sh -c 'rm "$(command -v 'starship')"'
|
sh -c 'rm "$(command -v 'starship')"'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## How do I install Starship without `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`.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
When using a package manager, see the documentation for your package manager about installing with or without `sudo`.
|
||||||
|
@ -32,6 +32,11 @@
|
|||||||
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
|
||||||
alt="Folge @StarshipPrompt auf Twitter"
|
alt="Folge @StarshipPrompt auf Twitter"
|
||||||
/></a>
|
/></a>
|
||||||
|
<a href="https://stand-with-ukraine.pp.ua"
|
||||||
|
><img
|
||||||
|
src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraineFlat.svg"
|
||||||
|
alt="Wir stehen zur Ukraine"
|
||||||
|
/></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
@ -103,7 +108,7 @@
|
|||||||
><img
|
><img
|
||||||
height="20"
|
height="20"
|
||||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png"
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png"
|
||||||
alt="Portugiesisch (Brasilien)"
|
alt="Português do Brasil"
|
||||||
/></a>
|
/></a>
|
||||||
|
|
||||||
<a
|
<a
|
||||||
@ -127,7 +132,7 @@
|
|||||||
><img
|
><img
|
||||||
height="20"
|
height="20"
|
||||||
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
|
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
|
||||||
alt="Vietnamesisch"
|
alt="Tiếng Việt"
|
||||||
/></a>
|
/></a>
|
||||||
|
|
||||||
<a
|
<a
|
||||||
@ -147,8 +152,6 @@
|
|||||||
/></a>
|
/></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)
|
|
||||||
|
|
||||||
<h1></h1>
|
<h1></h1>
|
||||||
|
|
||||||
<img
|
<img
|
||||||
@ -177,7 +180,7 @@
|
|||||||
|
|
||||||
### Voraussetzungen
|
### Voraussetzungen
|
||||||
|
|
||||||
- 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)).
|
- Eine [Nerd Font](https://www.nerdfonts.com/), installiert und in deinem Terminal aktiviert (versuche es zum Beispiel mal mit der [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads)).
|
||||||
|
|
||||||
### Schritt 1. Installiere Starship
|
### Schritt 1. Installiere Starship
|
||||||
|
|
||||||
@ -229,6 +232,7 @@ Alternatively, install Starship using any of the following package managers:
|
|||||||
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
| Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` |
|
||||||
| Manjaro | | `pacman -S starship` |
|
| Manjaro | | `pacman -S starship` |
|
||||||
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/starship/default.nix) | `nix-env -iA nixpkgs.starship` |
|
||||||
|
| openSUSE | [OSS](https://software.opensuse.org/package/starship) | `zypper in starship` |
|
||||||
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
| Void Linux | [Void Linux Packages](https://github.com/void-linux/void-packages/tree/master/srcpkgs/starship) | `xbps-install -S starship` |
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
@ -270,14 +274,14 @@ Install Starship using any of the following package managers:
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### Schritt 2. Set up your shell to use Starship
|
### Schritt 2. Richte deine Shell für die Nutzung von Starship ein
|
||||||
|
|
||||||
Konfigurieren deine Shell um Starship zu initialisieren. Wähle dafür deine Shell aus der Liste aus:
|
Konfiguriere deine Shell, um Starship automatisch zu starten. Wähle dafür deine Shell aus der Liste aus:
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Bash</summary>
|
<summary>Bash</summary>
|
||||||
|
|
||||||
Trage folgendes am Ende der `~/.bashrc` ein:
|
Füge dies ans Ende von `~/.bashrc`:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
eval "$(starship init bash)"
|
eval "$(starship init bash)"
|
||||||
@ -288,7 +292,7 @@ eval "$(starship init bash)"
|
|||||||
<details>
|
<details>
|
||||||
<summary>⌘ Cmd</summary>
|
<summary>⌘ Cmd</summary>
|
||||||
|
|
||||||
Du musst [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) mit Cmd verwenden. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:
|
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
|
```lua
|
||||||
load(io.popen('starship init cmd'):read("*a"))()
|
load(io.popen('starship init cmd'):read("*a"))()
|
||||||
@ -334,27 +338,21 @@ eval $(starship init ion)
|
|||||||
<details>
|
<details>
|
||||||
<summary>Nushell</summary>
|
<summary>Nushell</summary>
|
||||||
|
|
||||||
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
|
Add the following to the end of your Nushell configuration (find it by running `$nu.config-path` in Nushell):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
mkdir ~/.cache/starship
|
mkdir ($nu.data-dir | path join "vendor/autoload")
|
||||||
starship init nu | save -f ~/.cache/starship/init.nu
|
starship init nu | save -f ($nu.data-dir | path join "vendor/autoload/starship.nu")
|
||||||
```
|
```
|
||||||
|
|
||||||
Und füge folgendes am Ende deiner Nushell-Konfiguration hinzu (du findest diese, indem du folgenden Befehl in Nushell ausführst `$nu.config-path`):
|
Note: Only Nushell v0.96+ is supported
|
||||||
|
|
||||||
```sh
|
|
||||||
use ~/.cache/starship/init.nu
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: Only Nushell v0.78+ is supported
|
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>PowerShell</summary>
|
<summary>PowerShell</summary>
|
||||||
|
|
||||||
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`):
|
Füge Folgendes am Ende deiner PowerShell-Konfiguration hinzu (finde sie, indem du folgenden Befehl ausführst `$PROFILE`):
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
Invoke-Expression (&starship init powershell)
|
Invoke-Expression (&starship init powershell)
|
||||||
@ -365,7 +363,7 @@ Invoke-Expression (&starship init powershell)
|
|||||||
<details>
|
<details>
|
||||||
<summary>Tcsh</summary>
|
<summary>Tcsh</summary>
|
||||||
|
|
||||||
Trage folgendes am Ende von `~/.bashrc` ein:
|
Füge Folgendes am Ende von `~/.tcshrc` ein:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
eval `starship init tcsh`
|
eval `starship init tcsh`
|
||||||
@ -417,19 +415,26 @@ Falls du an Starship mitwirken willst, wirf bitte einen Blick auf den [Leitfaden
|
|||||||
|
|
||||||
Schaut euch bitte auch die Projekte an, die die Entstehung von Starship inspiriert haben. 🙏
|
Schaut euch bitte auch die Projekte an, die die Entstehung von Starship inspiriert haben. 🙏
|
||||||
|
|
||||||
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts.
|
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Eine ZSH Prompt für Astronauten.
|
||||||
|
|
||||||
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** – Cross-shell robbyrussell theme written in JavaScript.
|
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** – Cross-Shell robbyrussell Thema geschrieben in JavaScript.
|
||||||
|
|
||||||
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons.
|
- **[reujab/silber](https://github.com/reujab/silver)** – Eine cross-shell anpassbare Powerline-Prompt mit Icons.
|
||||||
|
|
||||||
## ❤️ Sponsors
|
## ❤️ Sponsoren
|
||||||
|
|
||||||
Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website.
|
Unterstütze dieses Projekt, indem du [ein Sponsor wirst](https://github.com/sponsors/starship). Dein Name und Logo wird hier mit einem Link zu deiner Website erscheinen.
|
||||||
|
|
||||||
**Supporter Tier**
|
## 🔒 Code Signing Policy
|
||||||
|
|
||||||
- [Appwrite](https://appwrite.io/)
|
Free code signing provided by [SignPath.io](https://signpath.io), certificate by [SignPath Foundation](https://signpath.org).
|
||||||
|
|
||||||
|
Code Signing Roles:
|
||||||
|
|
||||||
|
- Reviewers: [Astronauts](https://github.com/orgs/starship/teams/astronauts)
|
||||||
|
- Approvers and Authors: [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.
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<br>
|
<br>
|
||||||
|
@ -5,7 +5,7 @@ Um Starship zu installieren, musst du zwei Dinge tun:
|
|||||||
1. Lade die **starship** Datei auf den Computer herunter
|
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. Weise deine Shell an die Starship Datei als Eingabeaufforderung zu nutzen, indem du eines der Initialisierungs-Skripte benutzt
|
||||||
|
|
||||||
Die Anleitung auf [der Hauptseite](/guide/#🚀-installation) wird für die meisten Benutzer ausreichend sein. Für einige speziellere Plattformen wird jedoch eine speziellere Anleitung benötigt.
|
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.
|
||||||
|
|
||||||
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 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!
|
||||||
|
|
||||||
@ -45,7 +45,7 @@ Unter Funtoo Linux kann starship von [core-kit](https://github.com/funtoo/core-k
|
|||||||
emerge app-shells/starship
|
emerge app-shells/starship
|
||||||
```
|
```
|
||||||
|
|
||||||
## [Nix](https://nixos.wiki/wiki/Nix)
|
## [Nix](https://wiki.nixos.org/wiki/Nix)
|
||||||
|
|
||||||
### Das Binary holen
|
### Das Binary holen
|
||||||
|
|
||||||
|
@ -63,3 +63,15 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m
|
|||||||
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme).
|
||||||
|
|
||||||
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
|
[![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png "Click to view Tokyo Night preset")](./tokyo-night)
|
||||||
|
|
||||||
|
## [Gruvbox Rainbow](./gruvbox-rainbow.md)
|
||||||
|
|
||||||
|
Diese Voreinstellung ist stark inspiriert von [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||||
|
|
||||||
|
[![Screenshot von Gruvbox Regenbogen](/presets/img/gruvbox-rainbow.png "Click to view Gruvbox Rainbow preset")](./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.
|
||||||
|
|
||||||
|
[![Screenshot of Jetpack preset](/presets/img/jetpack.png "Click to view Jetpack preset")](./jetpack)
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
[Zurück zu den Voreinstellungen](./README.md#bracketed-segments)
|
[Zurück zu den Voreinstellungen](./#bracketed-segments)
|
||||||
|
|
||||||
# Bracketed Segments Preset
|
# Bracketed Segments Preset
|
||||||
|
|
||||||
@ -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
|
starship preset bracketed-segments -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Zum Herunterladen der TOML Datei klicken](/presets/toml/bracketed-segments.toml)
|
[Click to download TOML](/presets/toml/bracketed-segments.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml
|
<<< @/public/presets/toml/bracketed-segments.toml
|
||||||
|
21
docs/de-DE/presets/gruvbox-rainbow.md
Normal file
21
docs/de-DE/presets/gruvbox-rainbow.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
[Zurück zu den Voreinstellungen](./#gruvbox-rainbow)
|
||||||
|
|
||||||
|
# Gruvbox Regenbogen
|
||||||
|
|
||||||
|
Diese Voreinstellung ist stark inspiriert von [Pastel Powerline](./pastel-powerline.md), and [Tokyo Night](./tokyo-night.md).
|
||||||
|
|
||||||
|
![Screenshot von Gruvbox Regenbogen](/presets/img/gruvbox-rainbow.png)
|
||||||
|
|
||||||
|
### Voraussetzungen
|
||||||
|
|
||||||
|
- Eine [Nerd Font](https://www.nerdfonts.com/) installiert und aktiviert in deinem Terminal
|
||||||
|
|
||||||
|
### Konfiguration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset gruvbox-rainbow -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/gruvbox-rainbow.toml
|
24
docs/de-DE/presets/jetpack.md
Normal file
24
docs/de-DE/presets/jetpack.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
[Zurück zu den Voreinstellungen](./#jetpack)
|
||||||
|
|
||||||
|
# Jetpack Preset
|
||||||
|
|
||||||
|
This is a pseudo minimalist preset inspired by the [geometry](https://github.com/geometry-zsh/geometry) and [spaceship](https://github.com/spaceship-prompt/spaceship-prompt) prompts.
|
||||||
|
|
||||||
|
> Jetpack uses the terminal's color theme.
|
||||||
|
|
||||||
|
![Screenshot of Jetpack preset](/presets/img/jetpack.png)
|
||||||
|
|
||||||
|
### Prerequisite
|
||||||
|
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
### Konfiguration
|
||||||
|
|
||||||
|
```sh
|
||||||
|
starship preset jetpack -o ~/.config/starship.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
[Click to download TOML](/presets/toml/jetpack.toml){download}
|
||||||
|
|
||||||
|
<<< @/public/presets/toml/jetpack.toml
|
@ -1,4 +1,4 @@
|
|||||||
[Zurück zu den Voreinstellungen](./README.md#nerd-font-symbols)
|
[Zurück zu den Voreinstellungen](./#nerd-font-symbols)
|
||||||
|
|
||||||
# Nerd Font Symbols Preset
|
# Nerd Font Symbols Preset
|
||||||
|
|
||||||
@ -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
|
starship preset nerd-font-symbols -o ~/.config/starship.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
[Zum Herunterladen der TOML Datei klicken](/presets/toml/nerd-font-symbols.toml)
|
[Click to download TOML](/presets/toml/nerd-font-symbols.toml){download}
|
||||||
|
|
||||||
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml
|
<<< @/public/presets/toml/nerd-font-symbols.toml
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user