{"id":16615191,"url":"https://github.com/nojhan/lp-gitcrux","last_synced_at":"2025-12-25T03:36:25.270Z","repository":{"id":204256842,"uuid":"670160369","full_name":"nojhan/lp-gitcrux","owner":"nojhan","description":"A theme for liquidprompt giving visual hints about what Git command to use, given the state of the current Git repository.","archived":false,"fork":false,"pushed_at":"2023-11-15T10:32:39.000Z","size":63,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-17T17:52:27.464Z","etag":null,"topics":["bash","liquidprompt","liquidprompt-theme","prompt-toolkit","prompt-tuning","shell","zsh"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nojhan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2023-07-24T12:28:39.000Z","updated_at":"2023-11-07T15:37:00.000Z","dependencies_parsed_at":"2023-11-15T11:44:12.973Z","dependency_job_id":null,"html_url":"https://github.com/nojhan/lp-gitcrux","commit_stats":null,"previous_names":["nojhan/lp-gitcrux"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nojhan%2Flp-gitcrux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nojhan%2Flp-gitcrux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nojhan%2Flp-gitcrux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nojhan%2Flp-gitcrux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nojhan","download_url":"https://codeload.github.com/nojhan/lp-gitcrux/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242956550,"owners_count":20212454,"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":["bash","liquidprompt","liquidprompt-theme","prompt-toolkit","prompt-tuning","shell","zsh"],"created_at":"2024-10-12T02:08:51.143Z","updated_at":"2025-12-25T03:36:25.265Z","avatar_url":"https://github.com/nojhan.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"GitCrux — A Liquid Prompt Theme\n===============================\n\nGitCrux is a theme for [Liquid Prompt](https://github.com/nojhan/liquidprompt),\nshowing visual hints inspired from [GitCrux](https://github.com/nojhan/gitcrux).\n\nThe objective of GitCrux is to help you finding which Git command to use,\ngiven the current state of your Git repository.\nHints are given in a visual way, helping the user to understand what commands\nwill change.\n\nIt targets users who are starting out with Git and struggle to remember\nthe classical Git workflow.\n\nExample:\n![](add-commit.png)\n\n\nDesign\n------\n\nThe first line of the prompt is the classical theme right from Liquid Prompt,\nonly without the VCS information.\n\nThe second line shows the five main states tracked by Git:\n\n- the remote repository (with the number of remote commits behind),\n- the local repository (showed by its name),\n- the staged changes (showing either a wall clock, or the number of altered lines),\n- the branch (and the number of commits ahead),\n- the stash.\n\nAll lines after show colored arrow, figuring what states the denoted command\nwill change. The color of the arrow figures the urgency to issue that command.\n\nFor instance, if there is only a few lines changed, the \"add\" arrow is shown\nin a light color, if there is several modified lines, the arrow will be colored\nmore strongly, and if there is too much editions, the arrow will be heavily\ncolored.\n\nThe prompt comes with the `gitcrux` command, that displays a diagram showing\nall the supported commands:\n\n![](gitcrux.png)\n\n\nSetup\n-----\n\nTo actually use the GitCrux theme, you need to add a few configuration commands\nto the script that loads Liquid Prompt. For example:\n\n```sh\n# Load Liquid Prompt.\nsource ~/liquidprompt/liquidprompt\n# Load the theme.\nsource ~/lp-gitcrux/gitcrux.theme \u0026\u0026 lp_theme gitcrux\n```\n\nBy default, GitCrux needs a [Nerd-font](https://www.nerdfonts.com/) to display\nthe arrows correctly.\nSee the [Nerd-fonts Fonts installation docs](https://www.nerdfonts.com/)\nfor help on installing this kind of fonts.\nIf you do not have a Nerd-font, you may configure\n`GITCRUX_ARROW_RIGHT` and `GITCRUX_ARROW_RIGHT` to draw different arrow styles\n(see below).\n\n\nConfiguration\n-------------\n\n### Liquid Prompt Configuration\n\nThe GitCrux theme honors all Liquid Prompt configuration options.\n\nHowever, the command hints only targets Git (so far), even if they are showed\nfor any supported VCS repository.\n\n\n### Theme configuration\n\n#### Arrows\n\n**GITCRUX_ARROW_RIGHT** *array* = ( \"\" \"\" )\n\nSymbols used to draw arrow heads and tails.\n\n**GITCRUX_ARROW_LEFT** *array* = ( \"\" \"\" )\n\nSymbols used to draw arrow heads and tails.\n\n**GITCRUX_MIN_COL_WIDTH** *integer* = 8\n\nMinimum width of each of the Git state columns.\n\n**GITCRUX_COL_DYNAMIC** *boolean* = 1\n\nAutomatically increase each columns width if at least one of the column text\nis larger than `GITCRUX_MIN_COL_WIDTH`.\n\n**GITCRUX_SHOW_EXPLANATION** *boolean* = 1\n\nShow a sentence explaining why the hint is shown.\n\n\n#### Colors\n\n**GITCRUX_COLOR_WEAK** *string* = \"0 195 0\"\n\nColor of arrows if the related sensor is below \"normal\".\n\n**GITCRUX_COLOR_NORMAL** *string* = \"0 39 1\"\n\nColor of arrows if the related sensor is above \"normal\" and below \"strong\".\n\n**GITCRUX_COLOR_STRONG** *string* = \"0 220 1\"\n\nColor of arrows if the related sensor is above \"strong\".\n\n**GITCRUX_COLOR_MSG** *string* = \"0 244 0\"\n\nColor of error messages.\n\n**GITCRUX_COLOR_EXPLANATION** *string* = \"28 -1 0\"\n\nColor of explanation messages.\n\n\n#### Thresholds.\n\n**GITCRUX_THRESH_BEHIND_NORMAL** *integer* = 2\n\nHow many commits behind remote needs a \"normal\" alert.\n\n**GITCRUX_THRESH_BEHIND_STRONG** *integer* = 5\n\nHow many commits behind remote needs a \"strong\" alert.\n\n\n**GITCRUX_THRESH_AHEAD_NORMAL** *integer* = 2\n\nHow many commits ahead of remote needs a \"normal\" alert.\n\n**GITCRUX_THRESH_AHEAD_STRONG** *integer* = 5\n\nHow many commits ahead remote needs a \"strong\" alert.\n\n\n**GITCRUX_THRESH_LINES_NORMAL** *integer* = 100\n\nHow many modified lines needs a \"normal\" alert.\n\n**GITCRUX_THRESH_LINES_STRONG** *integer* = 500\n\nHow many modified lines needs a \"strong\" alert.\n\n\n**GITCRUX_THRESH_ADD_NORMAL** *integer* = 100\n\nHow many added files needs a \"normal\" alert.\n\n**GITCRUX_THRESH_ADD_STRONG** *integer* = 500\n\nHow many added files needs a \"strong\" alert.\n\n\n**GITCRUX_THRESH_STASH_NORMAL** *integer* = 1\n\nHow many stashed commits needs a \"normal\" alert.\n\n**GITCRUX_THRESH_STASH_STRONG** *integer* = 5\n\nHow many stashed commits needs a \"strong\" alert.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnojhan%2Flp-gitcrux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnojhan%2Flp-gitcrux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnojhan%2Flp-gitcrux/lists"}