{"id":31238944,"url":"https://github.com/nn1ks/mshp","last_synced_at":"2026-04-05T08:32:57.583Z","repository":{"id":54753904,"uuid":"273893114","full_name":"nn1ks/mshp","owner":"nn1ks","description":"A minimal and fast shell prompt","archived":false,"fork":false,"pushed_at":"2021-02-01T00:53:59.000Z","size":145,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-03T16:16:25.024Z","etag":null,"topics":["bash","minimal","prompt","shell","shell-prompt","terminal","zsh"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nn1ks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-21T11:44:54.000Z","updated_at":"2023-10-06T12:44:05.000Z","dependencies_parsed_at":"2022-08-14T01:50:28.993Z","dependency_job_id":null,"html_url":"https://github.com/nn1ks/mshp","commit_stats":null,"previous_names":["yuqio/mshp"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/nn1ks/mshp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nn1ks%2Fmshp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nn1ks%2Fmshp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nn1ks%2Fmshp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nn1ks%2Fmshp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nn1ks","download_url":"https://codeload.github.com/nn1ks/mshp/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nn1ks%2Fmshp/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31430009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T08:13:15.228Z","status":"ssl_error","status_checked_at":"2026-04-05T08:13:11.839Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","minimal","prompt","shell","shell-prompt","terminal","zsh"],"created_at":"2025-09-22T19:18:27.873Z","updated_at":"2026-04-05T08:32:57.507Z","avatar_url":"https://github.com/nn1ks.png","language":"Rust","funding_links":[],"categories":["Packages"],"sub_categories":["Prompts"],"readme":"# mshp\n\n[![Build](https://img.shields.io/github/workflow/status/yuqio/mshp/CI?labelColor=4c566a\u0026color=a3be8c\u0026logo=github)](https://github.com/yuqio/mshp/actions)\n[![Crate](https://img.shields.io/crates/v/mshp?labelColor=4c566a\u0026color=81a1c1\u0026logo=rust)](https://crates.io/crates/mshp)\n[![License](https://img.shields.io/crates/l/mshp?labelColor=4c566a\u0026color=b48ead)](https://github.com/yuqio/mshp#license)\n\n**A minimal and fast shell prompt written in Rust.**\n\n![screenshot](screenshot.png)\n\n## Installation\n\n### Building from source\n\n1. Install and setup [Rust](https://www.rust-lang.org)\n2. Run `cargo install mshp`\n\n### Pre-compiled binary\n\n1. Download a binary from the [releases page](https://github.com/yuqio/mshp/releases)\n2. Move the binary to your `PATH`\n\n## Usage\n\n### Bash, Dash, Ksh, etc.\n\nOn most POSIX compatible shells you can add the following line to your init file (e.g. `.bashrc`):\n\n```sh\nPS1=\"$(mshp)\"\n```\n\n### Zsh\n\nAdd the following to your `.zshrc` file:\n\n```zsh\nprecmd() {\n    PS1=\"$(mshp)\"\n}\n```\n\n### Ion\n\nAdd the following to your `.config/ion/initrc` file:\n\n```ion\nfn PROMPT\n    echo -n \"$(mshp)\"\nend\n```\n\n## Configuration\n\n`mshp` can be configured via environment variables.\n\n### Variable types\n\n- **`Color`**: Takes one of the following as value:\n\n    - `default` _(case insensitive)_ (sets the color to the default foreground color defined by the terminal)\n    - A written out ANSII color (`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`) _(case insensitive)_\n    - A ANSII number (e.g. `1` for red)\n    - A hex color beginning with `#` (e.g. `#00F` or `#0000FF` for blue)\n\n- **`Boolean`**: Takes either `0`/`false` (deactivate setting) or `1`/`true` (activate setting) as value\n\n- **`String`**: Takes any value\n\n### Available environment variables\n\n- **`MSHP_PATH_COLOR`**\n\n    Sets the foreground color of the current working directory.\n\n    Type: `Color`, Default: `blue`\n\n- **`MSHP_GIT_BRANCH_ICON`**\n\n    Sets the icon that is displayed next to the git branch.\n\n    Type: `String`, Default: ``\n\n- **`MSHP_GIT_BRANCH_COLOR`**\n\n    Sets the foreground color used to display the git branch and the icon.\n\n    Type: `Color`, Default: `cyan`\n\n- **`MSHP_GIT_BRANCH_DISABLE`**\n\n    Disables the git branch and icon.\n\n    Type: `Boolean`, Default: `false`\n\n- **`MSHP_GIT_STATUS_STAGED_ICON`**\n\n    Sets the icon that is used to indicate uncommited and staged changes in the git repo.\n\n    Type: `String`, Default: `+`\n\n- **`MSHP_GIT_STATUS_UNSTAGED_ICON`**\n\n    Sets the icon that is used to indicate uncommited and unstaged changes in the git repo.\n\n    Type: `String`, Default: `!`\n\n- **`MSHP_GIT_STATUS_UNTRACKED_ICON`**\n\n    Sets the icon that is used to indicate untracked files in the git repo.\n\n    Type: `String`, Default: `!`\n\n- **`MSHP_GIT_STATUS_AHEAD_ICON`**\n\n    Sets the icon that is used to indicate that your local branch is ahead of the upstream branch.\n\n    Type: `String`, Default: `↥`\n\n- **`MSHP_GIT_STATUS_BEHIND_ICON`**\n\n    Sets the icon that is used to indicate that your local branch is behind the upstream branch.\n\n    Type: `String`, Default: `↧`\n\n- **`MSHP_GIT_STATUS_COLOR`**\n\n    Sets the color for the above mentioned icons.\n\n    Type: `Color`, Default: `cyan`\n\n- **`MSHP_GIT_STATUS_DISABLE`**\n\n    Disables the above mentioned icons.\n\n    Type: `Boolean`, Default: `false`\n\n- **`MSHP_CHAR_USER_ICON`**\n\n    Sets the icon that is displayed at the end of the prompt to indicate that the current user is\n    not the root user.\n\n    Type: `String`, Default: `$`\n\n- **`MSHP_CHAR_USER_COLOR`**\n\n    Sets the color for the user character.\n\n    Type: `Color`, Default: `green`\n\n- **`MSHP_CHAR_USER_FAILED_ICON`**\n\n    Sets the icon that is displayed at the end of the prompt to indicate that the current user is\n    not the root user when the previous command failed.\n\n    Type: `String`, Default: `$`\n\n- **`MSHP_CHAR_USER_FAILED_COLOR`**\n\n    Sets the color for the user character when the previous command failed.\n\n    Type: `Color`, Default: `red`\n\n- **`MSHP_CHAR_ROOT_ICON`**\n\n    Sets the icon that is displayed at the end of the prompt to indicate that the current user is\n    the root user.\n\n    Type: `String`, Default: `#`\n\n- **`MSHP_CHAR_ROOT_COLOR`**\n\n    Sets the color for the root character.\n\n    Type: `Color`, Default: `green`\n\n- **`MSHP_CHAR_ROOT_FAILED_ICON`**\n\n    Sets the icon that is displayed at the end of the prompt to indicate that the current user is\n    the root user when the previous command failed.\n\n    Type: `String`, Default: `#`\n\n- **`MSHP_CHAR_ROOT_FAILED_COLOR`**\n\n    Sets the color for the root character when the previous command failed.\n\n    Type: `Color`, Default: `red`\n\n## License\n\nLicensed under either of [Apache License, Version 2.0] or [MIT License] at your\noption.\n\n[Apache License, Version 2.0]: https://github.com/yuqio/parg/blob/master/LICENSE-APACHE\n[MIT License]: https://github.com/yuqio/parg/blob/master/LICENSE-MIT\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in this crate by you, as defined in the Apache-2.0 license, shall\nbe dual licensed as above, without any additional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnn1ks%2Fmshp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnn1ks%2Fmshp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnn1ks%2Fmshp/lists"}