{"id":13638255,"url":"https://github.com/anki-code/xontrib-prompt-starship","last_synced_at":"2025-04-09T06:12:06.087Z","repository":{"id":36986783,"uuid":"345190141","full_name":"anki-code/xontrib-prompt-starship","owner":"anki-code","description":"Starship cross-shell prompt in xonsh shell.","archived":false,"fork":false,"pushed_at":"2025-03-20T12:07:38.000Z","size":76,"stargazers_count":58,"open_issues_count":3,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-27T18:53:36.831Z","etag":null,"topics":["shell-prompt","starship","xonsh","xonsh-prompt","xontrib"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anki-code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://github.com/anki-code","https://www.buymeacoffee.com/xxh","https://github.com/xonsh/xonsh#the-xonsh-shell-community"]}},"created_at":"2021-03-06T20:37:07.000Z","updated_at":"2025-03-20T12:07:41.000Z","dependencies_parsed_at":"2024-10-27T11:09:05.673Z","dependency_job_id":"aca047ca-73d0-4b07-b9f2-e5ed5146c9ad","html_url":"https://github.com/anki-code/xontrib-prompt-starship","commit_stats":{"total_commits":62,"total_committers":5,"mean_commits":12.4,"dds":"0.11290322580645162","last_synced_commit":"853f11c3d03732a2a5ef70b03e0c43400d25c5ad"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anki-code%2Fxontrib-prompt-starship","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anki-code%2Fxontrib-prompt-starship/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anki-code%2Fxontrib-prompt-starship/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anki-code%2Fxontrib-prompt-starship/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anki-code","download_url":"https://codeload.github.com/anki-code/xontrib-prompt-starship/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987285,"owners_count":21028895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["shell-prompt","starship","xonsh","xonsh-prompt","xontrib"],"created_at":"2024-08-02T01:00:42.998Z","updated_at":"2025-04-09T06:12:06.074Z","avatar_url":"https://github.com/anki-code.png","language":"Python","funding_links":["https://github.com/anki-code","https://www.buymeacoffee.com/xxh","https://github.com/xonsh/xonsh#the-xonsh-shell-community"],"categories":["Prompts"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/starship/starship\"\u003eStarship\u003c/a\u003e cross-shell prompt in xonsh shell.\n\u003cbr\u003e\u003cbr\u003e\n\u003cimg src=\"https://repository-images.githubusercontent.com/345190141/5ab8de00-7ed9-11eb-8545-3582ec7e054a\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e  \nIf you like the idea click ⭐ on the repo and \u003ca href=\"https://twitter.com/intent/tweet?text=Nice%20prompt%20for%20the%20xonsh%20shell!\u0026url=https://github.com/anki-code/xontrib-xontrib-prompt-starship\" target=\"_blank\"\u003etweet\u003c/a\u003e.\n\u003c/p\u003e\n\nAdditional features:\n\n* You can split the prompt to left, right and bottom parts.\n\n## Installation\n\nTo install use pip:\n\n```bash\n# You already have Starship installed. Then:\nxpip install xontrib-prompt-starship\n# or: xpip install -U git+https://github.com/anki-code/xontrib-prompt-starship\n```\n\n## Usage\n\n```bash\nxontrib load prompt_starship\n```\n\n## Recommendation\n\nWe suggest to use `@` character to remember about [you're using xonsh syntax](https://github.com/anki-code/xonsh-cheatsheet/blob/main/README.md#three-most-frequent-things-that-newcomers-overlook) and to potentially [spread the word about xonsh](https://github.com/xonsh/xonsh#the-xonsh-shell-community) if you make a screenshot or show your terminal to friends or collegues:\n```ini\nmkdir -p ~/.config/ \u0026\u0026 echo @(\"\"\"\n[character]\nsuccess_symbol = \"[@](bold green)\"\nerror_symbol = \"[@](bold red)\"\n\"\"\".strip()) \u003e ~/.config/starship_xonsh.toml\n\n$STARSHIP_CONFIG = '~/.config/starship_xonsh.toml'\nxontrib load prompt_starship\n```\n\n## Configuration\n\nYou can set the different starship configs for left, right and bottom parts of prompt when your shell type is prompt-toolkit:\n\n```python\n$XONTRIB_PROMPT_STARSHIP_LEFT_CONFIG = \"~/.config/starship_xonsh_left.toml\"\n$XONTRIB_PROMPT_STARSHIP_RIGHT_CONFIG = \"~/.config/starship_xonsh_right.toml\"\n$XONTRIB_PROMPT_STARSHIP_BOTTOM_CONFIG = \"~/.config/starship_xonsh_bottom.toml\"\nxontrib load prompt_starship\n```\n\nIn case of [using starship as part of another prompt](https://github.com/anki-code/xontrib-prompt-bar#using-starship-cross-shell-prompt-to-rendering-right-sections) you can add starship prompt to `$PROMPT_FIELDS` without replacing the current prompt:\n```python\n$XONTRIB_PROMPT_STARSHIP_REPLACE_PROMPT = False\nxontrib load prompt_starship\nprint($PROMPT_FIELDS['starship_left']())\n```\n\n### Prompt bar with starship\n\n[See also](https://github.com/anki-code/xontrib-prompt-bar#using-starship-cross-shell-prompt-to-rendering-right-sections):\n\n\u003cimg src=\"https://raw.githubusercontent.com/anki-code/xontrib-prompt-bar/master/static/xontrib-prompt-bar-starship.png\" alt=\"Prompt bar with starship sections.\"\u003e\n\n\n## Known issues\n\n* [Prompt toolkit issue: the right prompt at the bottom.](https://github.com/prompt-toolkit/python-prompt-toolkit/issues/1241)\n* The using of bottom toolbar is not properly tested and adopted to cute appearance.\n\n## Credits\n* The xontrib-prompt-starship can be used as part of [xontrib-prompt-bar](https://github.com/anki-code/xontrib-prompt-bar).\n* This package is the part of [ergopack](https://github.com/anki-code/xontrib-ergopack) - the pack of ergonomic xontribs.\n* This package was created with [xontrib cookiecutter template](https://github.com/xonsh/xontrib-cookiecutter).\n* [Adding support for xonsh inside Starship](https://github.com/starship/starship/pull/2807)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanki-code%2Fxontrib-prompt-starship","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanki-code%2Fxontrib-prompt-starship","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanki-code%2Fxontrib-prompt-starship/lists"}