|
1 | 1 | # proj‑jumper |
2 | 2 |
|
3 | | -**proj‑jumper** is a lightweight Z shell plugin that lets you jump straight into any project folder under a single development root--perfect when that root lives on a removable drive. |
4 | | - |
5 | | -```text |
6 | | -proj listy # → /Volumes/dog_house/development/projects/listy |
7 | | -proj # fuzzy‑pick a project (needs fzf) |
8 | | -``` |
9 | | - |
10 | | --------------------------------------------------------------------------------- |
11 | | - |
12 | | -## Features |
13 | | - |
14 | | -- **Smart root check** – warns if the volume isn't mounted instead of failing. |
15 | | -- **One‑word "proj |
16 | | - |
17 | | - <name>"</name>** |
18 | | - |
19 | | - – faster than typing long paths. |
20 | | -- **Interactive picker** – choose from a fuzzy list when you just run `proj`. |
21 | | -- **Tab completion** – `proj sa<Tab>` → `proj savage`. |
22 | | -- **Configurable root** – `export PROJ_DEV_ROOT=/another/path`. |
23 | | - |
24 | | --------------------------------------------------------------------------------- |
25 | | - |
26 | | -## Installation |
27 | | - |
28 | | -### Homebrew (recommended for macOS) |
29 | | - |
30 | | -```sh |
31 | | -brew tap kikolator/proj |
32 | | -brew install proj-jumper |
33 | | - |
34 | | -# one‑time link & activate |
35 | | -ln -s "$(brew --prefix)/opt/proj-jumper/share/proj-jumper" \ |
36 | | - "${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/plugins/proj-jumper" |
37 | | - |
38 | | -# add the plugin name to the list in ~/.zshrc, then: |
39 | | -source ~/.zshrc |
40 | | -``` |
41 | | - |
42 | | -### Oh My Zsh (manual) |
43 | | - |
44 | | -```sh |
45 | | -git clone https://github.com/Kikolator/proj-jumper \ |
46 | | - "${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/plugins/proj-jumper" |
47 | | -# edit ~/.zshrc |
48 | | -plugins=(... proj-jumper) |
49 | | -source ~/.zshrc |
50 | | -``` |
51 | | - |
52 | | --------------------------------------------------------------------------------- |
53 | | - |
54 | | -## Usage |
55 | | - |
56 | | -Action | Command | Result |
57 | | ----------------------- | -------------- | ---------------------- |
58 | | -Jump to a project | `proj savage` | `cd` into _savage_ |
59 | | -Pick interactively | `proj` | fuzzy list via **fzf** |
60 | | -List projects (no fzf) | `proj` | prints directory names |
61 | | -Tab‑complete | `proj li<Tab>` | expands to _listy_ |
62 | | - |
63 | | -### Environment variables |
64 | | - |
65 | | -Variable | Purpose |
66 | | ---------------- | ---------------------------------------------------------------------- |
67 | | -`PROJ_DEV_ROOT` | Override the default root (`/Volumes/dog_house/development/projects`). |
68 | | -`DEV_ROOT` | Same as above--kept for compatibility. |
69 | | - |
70 | | --------------------------------------------------------------------------------- |
71 | | - |
72 | | -## Requirements |
73 | | - |
74 | | -- Zsh 5.0+ |
75 | | -- Optional: [`fzf`](https://github.com/junegunn/fzf) for the interactive picker. |
76 | | - |
77 | | --------------------------------------------------------------------------------- |
78 | | - |
79 | | -## License |
80 | | - |
81 | | -[MIT](LICENSE) © 2025 Kikolator |
82 | | - |
83 | | -# proj‑jumper |
84 | | - |
85 | 3 | **proj‑jumper** is a lightweight Z‑shell plugin that lets you jump straight into any project folder under a single development root -- perfect when that root lives on a removable drive. |
86 | 4 |
|
87 | 5 | ```text |
|
0 commit comments