{"id":17554056,"url":"https://github.com/olets/hometown-prompt","last_synced_at":"2026-03-14T04:39:18.301Z","repository":{"id":43307538,"uuid":"442314615","full_name":"olets/hometown-prompt","owner":"olets","description":"Feature rich, high performance Git-aware zsh theme. Nearly 500 unique cloners as of Oct '24","archived":false,"fork":false,"pushed_at":"2025-02-06T17:14:00.000Z","size":3689,"stargazers_count":10,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-07T21:09:35.992Z","etag":null,"topics":["command-line","git","git-status","gitstatus","prompt","shell","zsh","zsh-plugin","zsh-theme"],"latest_commit_sha":null,"homepage":"https://hometown-prompt.olets.dev/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/olets.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2021-12-28T01:19:26.000Z","updated_at":"2025-02-06T17:14:03.000Z","dependencies_parsed_at":"2024-06-19T02:52:36.431Z","dependency_job_id":"0ae712b8-40f8-41d0-80fb-fbbb2d7de468","html_url":"https://github.com/olets/hometown-prompt","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olets%2Fhometown-prompt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olets%2Fhometown-prompt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olets%2Fhometown-prompt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olets%2Fhometown-prompt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/olets","download_url":"https://codeload.github.com/olets/hometown-prompt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252252843,"owners_count":21718767,"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":["command-line","git","git-status","gitstatus","prompt","shell","zsh","zsh-plugin","zsh-theme"],"created_at":"2024-10-21T06:50:06.288Z","updated_at":"2026-03-14T04:39:18.273Z","avatar_url":"https://github.com/olets.png","language":"Shell","funding_links":[],"categories":["Themes"],"sub_categories":["ZSH on Windows"],"readme":"# Hometown Prompt\n\n![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/olets/hometown-prompt?include_prereleases\u0026label=pre-release) ![GitHub commits since latest release (by SemVer including pre-releases)](https://img.shields.io/github/commits-since/olets/hometown-prompt/latest?include_prereleases)\n\n\u003cimg src=\"./assets/hometown.png\" alt=\"\"\u003e\n\n**Hometown is a feature rich, high performance Git-aware zsh theme** with segments for the user, host, time, the current working directory and its parent, and —within a Git repo— detailed Git status. It is carefully designed to show a lot of information clearly.\n\n## Documentation\n\n\u0026nbsp;\n\n📖 See the guide, including a web simulation demonstrating how the prompt responds to context and configuration, at https://hometown-prompt.olets.dev/\n\n\u0026nbsp;\n\n## Screencast\n\nHere's a screencast showing it in action, as a gif. Note that when you \"accept\" the command line (that is, hit \u003ckbd\u003eEnter\u003c/kbd\u003e) the prompt trims down. You can view the same screencast as a video, with controls to pause, rewind, and fast forward, on the [Hometown docs site](https://hometown-prompt.olets.dev/).\n\n\u003cdetails\u003e\u003csummary\u003eToggle to show/hide the screencast\u003c/summary\u003e\n\n![Hometown Prompt screencast gif, default configuration](/assets/hometown-prompt-v4-demo.gif)\n\n\u003c/details\u003e\n\n\u003c!-- DUPE hometown-prompt@v4 README.md hometown-prompt-docs@v4 docs/parts/screencast.md, zsh-transient-prompt@v1 docs/parts/screencast.md --\u003e\n\n\u003cdetails\u003e\u003csummary\u003eToggle to show/hide an annotated transcript\u003c/summary\u003e\n\n```shell\nmkdir -p repo/child/grandchild/great-grandchild\ncd repo\n\n# cwd changes to current dir\n# previous prompt simplifies: cwd has only one segment\n\ngit init\n\n# cwd changes to underline Git repo root; Git branch and its appear\n\ncd child\n\n# cwd changes to current dir. segments start at repo root's parent\n\ncd grandchild\n\n# cwd changes as before\n# previous prompt simplifies: cwd starts at the repo root\n\ncd great-grandchild\n\n# cwd changes. shows at most repo root's parent, repo root, ellipsis, cwd parent, cwd\n\ngit init\n\n# cwd changes to underlined repo root, and parent\n\ntouch x y\n\n# Git status changes\n\ngit add -A\n\n# Git status changes, Git branch color changes\n\ngit commit -m first\n\n# Git status changes, Git branch color changes\n\ngit switch -c feature\n\n# Git branch changes, Git branch color changes\n\necho wip \u003e\u003e x\n\n# Git status changes, Git branch color changes\n\ngit stash\n\n# Git stash appears, Git status changes, Git branch color changes\n\necho a \u003e\u003e x\n\n# Git status changes\n\nrm y\n\n# Git status changes\n\ngit add .\n\n# Git status changes\n\ngit commit -m second\n\n# Git status changes, Git branch color changes\n\ngit stash drop\n\n# Git stash disappears\n\ngit switch main\n\n# Git branch changes\n\necho b \u003e\u003e x\n\n# Git status changes, Git branch color changes\n\ngit commit -am third\n\n# Git status changes, Git branch color changes\n\ngit rebase @ feature\n\n# Git HEAD changes, Git HEAD color changes, Git status changes, Git action appears, prompt character color changes\n\ngit checkout —ours x\n\n# Git status changes, Git action appears, prompt character color changes\n\ngit add x\n\n# Git HEAD changes, Git HEAD color changes, Git status changes, Git action appears\n\ngit rebase —continue —no-edit\n```\n\n\u003c/details\u003e\n\n## Appearance\n\nBy default it looks something like this. Time, current working directory, and Git ref info on the first line (using symbols, with inactive status data points hidden); Git file info on the second (using symbols, with disabled symbols for inactive status data points); and the prompt character on the third.\n\n![Hometown Prompt screenshot, default configuration](/assets/hometown-prompt-default.png)\n\nIt has numerous layout and content toggles.\n\nFor example you can mix and match line break options, hidden/disabled options, and word/symbol options in any way you like.\n\nWith very little configuration it can look, for example, like this. Time, current working directory, Git ref info (using symbols, with inactive status data points hidden); and Git file info (using symbols, with inactive status data points hidden) on the first line; and the prompt character on the second.\n\n![Hometown Prompt screenshot, default configuration](/assets/hometown-prompt-short.png)\n\nOr like this. Time and current working directory on the first line; Git ref info (using words, with disabled symbols for inactive branch data points) on the second line; Git file info (using words, with inactive status data points hidden) on the third line; and the prompt character on the fourth.\n\n![Hometown Prompt screenshot, default configuration](/assets/hometown-prompt-long.png)\n\nYou can also customize colors, text, symbols, and the slot which in these screenshots is the time. Here's just one of the infinite possibilities:\n\n![Hometown Prompt screenshot, custom configuration](/assets/hometown-prompt-custom.png)\n\n## Changelog\n\nSee the [CHANGELOG](CHANGELOG.md) file.\n\n## Contributing\n\n_Looking for the documentation site's source? See \u003chttps://github.com/olets/hometown-prompt-docs\u003e_\n\nThanks for your interest. Contributions are welcome!\n\n\u003e Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.\n\nCheck the [Issues](https://github.com/olets/hometown-prompt/issues) to see if your topic has been discussed before or if it is being worked on. You may also want to check the roadmap (see above).\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.\n\n### Sponsoring\n\nLove Hometown Prompt? I'm happy to be able to provide it for free. If you are moved to turn appreciation into action, I invite you to make a donation to one of the organizations listed below (to be listed as a financial contributor, send me a receipt via email or [Reddit DM](https://www.reddit.com/user/olets)). Thank you!\n\n- [O‘ahu Water Protectors](https://oahuwaterprotectors.org/) a coalition of organizers and concerned community members fighting for safe, clean water on Oʻahu. Currently focused on the Red Hill Bulk Fuel Storage Facility crisis (see Sierra Club of Hawaii's [explainer](https://sierraclubhawaii.org/redhill)).\n- [Hoʻoulu ʻĀina](https://hoouluaina.org/) is a 100-acre nature preserve nestled in the back of Kali hi valley on the island of Oʻahu which seeks to provide people of our ahupuaʻa and beyond the freedom to make connections and build meaningful relationships with the ʻāina, each other and ourselves.\n- [Ol Pejeta Conservancy](https://www.olpejetaconservancy.org/) are caretakers of the land, safeguarding endangered species and ensuring the openness and accessibility of conservation for all. They empower their people to think the same way and embrace new approaches to conservation, and provide natural wilderness experiences, backed up by scientifically credible conservation and genuine interactions with wildlife.\n- [Southern Utah Wilderness Alliance (SUWA)](https://suwa.org/) the only non-partisan, non-profit organization working full time to defend Utah’s redrock wilderness from oil and gas development, unnecessary road construction, rampant off-road vehicle use, and other threats to Utah’s wilderness-quality lands.\n\n## License\n\n\u003ca href=\"https://www.github.com/olets/hometown-prompt\"\u003eHometown Prompt\u003c/a\u003e by \u003ca href=\"https://www.github.com/olets\"\u003eHenry Bley-Vroman\u003c/a\u003e is licensed under a license which is the unmodified text of \u003ca href=\"https://creativecommons.org/licenses/by-nc-sa/4.0\"\u003eCC BY-NC-SA 4.0\u003c/a\u003e and the unmodified text of a \u003ca href=\"https://firstdonoharm.dev/build?modules=eco,extr,media,mil,sv,usta\"\u003eHippocratic License 3\u003c/a\u003e. It is not affiliated with Creative Commons or the Organization for Ethical Source.\n\nHuman-readable summary of (and not a substitute for) the [LICENSE](LICENSE) file:\n\nYou are free to\n\n- Share — copy and redistribute the material in any medium or format\n- Adapt — remix, transform, and build upon the material\n\nUnder the following terms\n\n- Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.\n- Non-commercial — You may not use the material for commercial purposes.\n- Ethics - You must abide by the ethical standards specified in the Hippocratic License 3 with Ecocide, Extractive Industries, US Tariff Act, Mass Surveillance, Military Activities, and Media modules.\n- Preserve terms — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.\n- No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.\n\n## Acknowledgments\n\n- The human-readable license summary is based on https://creativecommons.org/licenses/by-nc-sa/4.0. The ethics point was added.\n- Splash card font is [Nickainley](https://www.fontfabric.com/fonts/nickainley/) by Seniors Studio.\n- See also [Git Prompt Kit](https://github.com/olets/git-prompt-kit#acknowledgments)'s acknowledgments.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folets%2Fhometown-prompt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Folets%2Fhometown-prompt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folets%2Fhometown-prompt/lists"}