You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+46-2Lines changed: 46 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@
20
20
```
21
21
22
22
2.**Initialize Configuration:**
23
-
Create a config file at `~/.config/shortcuts/config.yaml`. See the [Configuration](#-configuration) section for details.
23
+
Create a config file at `~/.config/shortcuts-tui/config.yaml`. See the [Configuration](#-configuration) section for details.
24
24
25
25
3.**Launch:**
26
26
Simply run `shortcuts-tui`.
@@ -35,10 +35,54 @@
35
35
-**📖 Markdown Documentation:** Renders `.md` files with beautiful formatting for your guides and cheatsheets.
36
36
-**⌨️ Vim-First Navigation:** Full support for `j/k`, `d/u`, and `f/b` motions.
37
37
-**📂 Multi-Tab Interface:** Organize your workflows into logical tabs (e.g., "Dev", "Ops", "Guides").
38
+
-**🗂 Automatic Subdivisions:** Group items within tabs by placing files in subdirectories (e.g., `work/git.zsh` becomes `[Work > Git]`).
39
+
-**🤖 AI Automation:** Use the included [Prompts](prompts/generate_aliases.md) to generate aliases from your command history.
38
40
-**🎨 Catppuccin Theme:** Built-in support for the high-contrast Catppuccin Mocha palette.
39
41
40
42
---
41
43
44
+
## 🤖 AI Automation
45
+
46
+
You can automate the creation of your aliases using the system prompt found in `prompts/generate_aliases.md`. This is the fastest way to turn your command history into a searchable TUI interface.
47
+
48
+
### Using Gemini CLI (Recommended)
49
+
```bash
50
+
history -n -50 | gemini -p "$(cat prompts/generate_aliases.md)">>~/.dotfiles/scripts/local/generated.zsh
51
+
```
52
+
53
+
### Using Claude Code
54
+
```bash
55
+
history -n -50 | claude -p "$(cat prompts/generate_aliases.md)">>~/.dotfiles/scripts/local/generated.zsh
56
+
```
57
+
58
+
### Using OpenAI CLI
59
+
```bash
60
+
history -n -50 | openai api chat.completions.create -m gpt-4o -g user "$(cat prompts/generate_aliases.md)">>~/.dotfiles/scripts/local/generated.zsh
61
+
```
62
+
63
+
*Tip: After generating new aliases, press **`r`** inside Shortcuts TUI to reload and see them instantly!*
64
+
65
+
---
66
+
67
+
## 🗂 Subdivisions & Organization
68
+
69
+
Shortcuts TUI automatically organizes your items based on your directory structure. This is perfect for separating `local`, `work`, and `github` tools within the same tab.
70
+
71
+
### How it works:
72
+
1.**Directory Structure:**
73
+
```text
74
+
~/.dotfiles/scripts/
75
+
├── local/
76
+
│ └── dev.zsh # [Local > Dev]
77
+
└── work/
78
+
└── cloud.zsh # [Work > Cloud]
79
+
```
80
+
2.**Display:** Items will be prefixed with their subdivision in the list: `[Local > Dev] My Shortcut`.
81
+
3.**Ordering:** Items are automatically sorted by Subdivision, then Category (filename), then Title.
82
+
4.**Filtering:** Subdivisions are searchable! Type `work` to instantly see all your work-related shortcuts.
83
+
84
+
---
85
+
42
86
## 🛠 Installation
43
87
44
88
### Homebrew (Recommended)
@@ -60,7 +104,7 @@ mv shortcuts-tui /usr/local/bin/ # Or any directory in your $PATH
60
104
61
105
## ⚙️ Configuration
62
106
63
-
By default, **Shortcuts TUI** looks for `~/.config/shortcuts/config.yaml`.
107
+
By default, **Shortcuts TUI** looks for `~/.config/shortcuts-tui/config.yaml`.
64
108
65
109
<details>
66
110
<summary><b>Click to expand Configuration Details</b></summary>
Copy file name to clipboardExpand all lines: docs/github/shortcuts_tui_guide.md
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,13 +51,24 @@ alias gc="git commit -v" # Commit changes with verbose output
51
51
52
52
---
53
53
54
+
## 🗂 Automatic Subdivisions
55
+
You can group shortcuts within a single tab by using subdirectories. This is ideal for organizing your tools into `Local`, `Work`, or `GitHub` projects.
56
+
57
+
1. Create a subfolder in your scripts directory: `~/dotfiles/scripts/work/`.
58
+
2. Move your `.zsh` files there: `work/git.zsh`.
59
+
3. The TUI will display these items with a subdivision prefix: **`[Work > Git]`**.
60
+
61
+
*Tip: Subdivisions are indexed for search. Type `work` to instantly filter all work-related tools.*
0 commit comments