https://github.com/markshawn2020/zsh-git-relative-path
Zsh Git 相对路径插件 一个简单但实用的 Zsh 插件，它可以在你的命令提示符中显示相对于 Git 项目根目录的当前路径。这个插件是在 AI 的协助下在短短 10 分钟内完成的，展示了 AI 辅助开发的强大能力。
https://github.com/markshawn2020/zsh-git-relative-path
ai cursor git llm oh-my-zsh vscode windsurf zsh
Last synced: 24 days ago
JSON representation
Zsh Git 相对路径插件 一个简单但实用的 Zsh 插件，它可以在你的命令提示符中显示相对于 Git 项目根目录的当前路径。这个插件是在 AI 的协助下在短短 10 分钟内完成的，展示了 AI 辅助开发的强大能力。
- Host: GitHub
- URL: https://github.com/markshawn2020/zsh-git-relative-path
- Owner: MarkShawn2020
- License: mit
- Created: 2024-12-21T11:52:06.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-21T14:14:51.000Z (10 months ago)
- Last Synced: 2025-08-20T06:08:03.586Z (about 2 months ago)
- Topics: ai, cursor, git, llm, oh-my-zsh, vscode, windsurf, zsh
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@cs-magic-open/zsh-git-relative-path
- Size: 759 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zsh Git Relative Path Plugin
A ZSH plugin that shows your current path relative to the git project root in your prompt.
## Features
- Works with any oh-my-zsh theme
- Shows path relative to git project root when in a git repository
- Falls back to normal path display when not in a git repository
- Special support for popular themes (robbyrussell, agnoster, avit)
- Zero configuration needed!
## Prerequisites
- [Oh My Zsh](https://ohmyz.sh/)
- Node.js >= 14.0.0
- npm or pnpm
## Installation
### Using npm (Recommended)
```bash
npm install -g @cs-magic-open/zsh-git-relative-path
```
That's it! The plugin will be automatically configured and activated after installation.
### Alternative: Manual Installation
If you prefer to inspect the code first:
```bash
# 1. Clone the repository
git clone https://github.com/cs-magic-open/zsh-git-relative-path
cd zsh-git-relative-path
# 2. Install globally from local
npm install -g .
```
## Usage
Once installed, the plugin will automatically modify your prompt to show paths relative to the git project root. No additional configuration is needed!
Example:
```
# Before (in /Users/username/projects/my-project/src/components)
username ~/projects/my-project/src/components $
# After (same directory)
username src/components $
```
## Updating
To update to the latest version:
```bash
npm update -g @cs-magic-open/zsh-git-relative-path
```
## Uninstallation
```bash
npm uninstall -g @cs-magic-open/zsh-git-relative-path
```
## Development
To contribute or modify the plugin:
```bash
# Clone the repository
git clone https://github.com/cs-magic-open/zsh-git-relative-path
cd zsh-git-relative-path
# Install dependencies
npm install
# Make your changes...
# Bump version
npm version patch # or minor/major
```
## License
MIT
## Author
cs-magic-open