hotsheet 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +229 -0
- package/dist/cli.js +2060 -0
- package/dist/client/app.global.js +1 -0
- package/dist/client/styles.css +1 -0
- package/package.json +62 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Brian Westphal
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# Hot Sheet
|
|
4
|
+
|
|
5
|
+
### A fast, local ticket tracker that feeds your AI coding tools.
|
|
6
|
+
|
|
7
|
+
<br>
|
|
8
|
+
|
|
9
|
+
**Hot Sheet** is a lightweight project management tool that runs entirely on your machine. Create tickets with a bullet-list interface, drag them into priority order, and your AI tools automatically get a structured worklist they can act on.
|
|
10
|
+
|
|
11
|
+
No cloud. No logins. No JIRA. Just tickets and a tight feedback loop.
|
|
12
|
+
|
|
13
|
+
<br>
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g hotsheet
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
hotsheet
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
That's it. Opens in your browser. Data stays local.
|
|
24
|
+
|
|
25
|
+
</div>
|
|
26
|
+
|
|
27
|
+
<br>
|
|
28
|
+
|
|
29
|
+
<p align="center">
|
|
30
|
+
<img src="docs/demo-1.png" alt="Hot Sheet main UI showing tickets across categories, priorities, and statuses with the detail panel open" width="900">
|
|
31
|
+
</p>
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Why Hot Sheet?
|
|
36
|
+
|
|
37
|
+
AI coding tools are powerful, but they need direction. You know what needs to be built, fixed, or investigated — but communicating that to your AI tool means typing the same context over and over, or maintaining a text file that drifts out of sync.
|
|
38
|
+
|
|
39
|
+
Hot Sheet gives you a proper ticket interface — categories, priorities, statuses — with one key difference: it automatically exports a `worklist.md` file that AI tools like Claude Code can read directly. Your tickets become the AI's task list.
|
|
40
|
+
|
|
41
|
+
The workflow:
|
|
42
|
+
|
|
43
|
+
1. **You** create and prioritize tickets in Hot Sheet
|
|
44
|
+
2. **Hot Sheet** syncs an `Up Next` worklist to `.hotsheet/worklist.md`
|
|
45
|
+
3. **Your AI tool** reads the worklist and works through it
|
|
46
|
+
4. **You** mark tickets complete and add new ones
|
|
47
|
+
|
|
48
|
+
The loop stays tight because the AI always knows what to work on next.
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Features
|
|
53
|
+
|
|
54
|
+
**Bullet-list input** — type a title, hit Enter, ticket created. Set category and priority inline with keyboard shortcuts.
|
|
55
|
+
|
|
56
|
+
<p align="center">
|
|
57
|
+
<img src="docs/demo-2.png" alt="Quick ticket entry with the bullet-list input row" width="900">
|
|
58
|
+
</p>
|
|
59
|
+
|
|
60
|
+
**Six ticket categories** — Issue, Bug, Feature, Requirement Change, Task, Investigation — each with a distinct color. **Sidebar filtering** lets you drill down by view, category, or priority.
|
|
61
|
+
|
|
62
|
+
<p align="center">
|
|
63
|
+
<img src="docs/demo-3.png" alt="Sidebar filtering by Bug category" width="900">
|
|
64
|
+
</p>
|
|
65
|
+
|
|
66
|
+
**Batch operations** — select multiple tickets to bulk-update category, priority, status, or Up Next.
|
|
67
|
+
|
|
68
|
+
<p align="center">
|
|
69
|
+
<img src="docs/demo-5.png" alt="Multiple tickets selected with the batch toolbar visible" width="900">
|
|
70
|
+
</p>
|
|
71
|
+
|
|
72
|
+
**Detail panel** — side or bottom orientation, resizable, with fields for title, details, attachments, and timestamped notes. Auto-shows when you select a ticket.
|
|
73
|
+
|
|
74
|
+
<p align="center">
|
|
75
|
+
<img src="docs/demo-6.png" alt="Detail panel in bottom orientation showing ticket details and notes" width="900">
|
|
76
|
+
</p>
|
|
77
|
+
|
|
78
|
+
**Also includes:**
|
|
79
|
+
- **Five priority levels** — Highest to Lowest, sortable and filterable
|
|
80
|
+
- **Up Next flag** — star tickets to add them to the AI worklist
|
|
81
|
+
- **Search** — full-text search across ticket titles and details
|
|
82
|
+
- **Keyboard-driven** — `Enter` to create, `Cmd+I/B/F/R/K/G` for categories, `Alt+1-5` for priority, `Cmd+D` for Up Next
|
|
83
|
+
- **File attachments** — attach files to any ticket
|
|
84
|
+
- **Markdown sync** — `worklist.md` and `open-tickets.md` auto-generated on every change
|
|
85
|
+
- **Auto-cleanup** — configurable auto-deletion of old trash and verified items
|
|
86
|
+
- **Settings** — detail panel position, cleanup intervals, all persisted
|
|
87
|
+
- **Fully local** — embedded PostgreSQL (PGLite), no network calls, no accounts, no telemetry
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## AI Integration
|
|
92
|
+
|
|
93
|
+
The exported worklist is plain markdown. Any AI tool that can read files can use it.
|
|
94
|
+
|
|
95
|
+
Star tickets as "Up Next" and they appear in the worklist, sorted by priority. As the AI works, it updates ticket status and appends notes — visible right in the detail panel.
|
|
96
|
+
|
|
97
|
+
<p align="center">
|
|
98
|
+
<img src="docs/demo-4.png" alt="Up Next view showing prioritized tickets with AI progress notes in the detail panel" width="900">
|
|
99
|
+
</p>
|
|
100
|
+
|
|
101
|
+
### Claude Code
|
|
102
|
+
|
|
103
|
+
Point Claude Code at your worklist:
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
Read .hotsheet/worklist.md and work through the tickets in order.
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Or add it to your `CLAUDE.md`:
|
|
110
|
+
|
|
111
|
+
```markdown
|
|
112
|
+
Read .hotsheet/worklist.md for current work items.
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Other AI Tools
|
|
116
|
+
|
|
117
|
+
The worklist works with any AI tool that reads files — Cursor, Copilot, Aider, etc. Each ticket includes its number, type, priority, status, title, and details.
|
|
118
|
+
|
|
119
|
+
### What gets exported
|
|
120
|
+
|
|
121
|
+
`worklist.md` contains all tickets flagged as "Up Next," sorted by priority:
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
# Hot Sheet - Up Next
|
|
125
|
+
|
|
126
|
+
These are the current priority work items. Complete them in order of priority, where reasonable.
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
TICKET HS-12:
|
|
131
|
+
- Type: bug
|
|
132
|
+
- Priority: highest
|
|
133
|
+
- Status: not started
|
|
134
|
+
- Title: Fix login redirect loop
|
|
135
|
+
- Details: After session timeout, the redirect goes to /login?next=/login...
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
TICKET HS-15:
|
|
140
|
+
- Type: feature
|
|
141
|
+
- Priority: high
|
|
142
|
+
- Status: started
|
|
143
|
+
- Title: Add CSV export for reports
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Install
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
npm install -g hotsheet
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
Requires **Node.js 20+**.
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## Usage
|
|
159
|
+
|
|
160
|
+
```bash
|
|
161
|
+
# Start with defaults (port 4174, data in .hotsheet/)
|
|
162
|
+
hotsheet
|
|
163
|
+
|
|
164
|
+
# Custom port
|
|
165
|
+
hotsheet --port 8080
|
|
166
|
+
|
|
167
|
+
# Custom data directory
|
|
168
|
+
hotsheet --data-dir ~/projects/my-app/.hotsheet
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Options
|
|
172
|
+
|
|
173
|
+
| Flag | Description |
|
|
174
|
+
|------|-------------|
|
|
175
|
+
| `--port <number>` | Port to run on (default: 4174) |
|
|
176
|
+
| `--data-dir <path>` | Data directory (default: `.hotsheet/`) |
|
|
177
|
+
| `--help` | Show help |
|
|
178
|
+
|
|
179
|
+
### Keyboard shortcuts
|
|
180
|
+
|
|
181
|
+
| Shortcut | Action |
|
|
182
|
+
|----------|--------|
|
|
183
|
+
| `Enter` | Create new ticket |
|
|
184
|
+
| `Cmd+I` | Set category: Issue |
|
|
185
|
+
| `Cmd+B` | Set category: Bug |
|
|
186
|
+
| `Cmd+F` | Set category: Feature |
|
|
187
|
+
| `Cmd+R` | Set category: Req Change |
|
|
188
|
+
| `Cmd+K` | Set category: Task |
|
|
189
|
+
| `Cmd+G` | Set category: Investigation |
|
|
190
|
+
| `Alt+1-5` | Set priority (Highest to Lowest) |
|
|
191
|
+
| `Cmd+D` | Toggle Up Next |
|
|
192
|
+
| `Cmd+A` | Select all |
|
|
193
|
+
| `Escape` | Clear selection / close |
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## Architecture
|
|
198
|
+
|
|
199
|
+
| Layer | Technology |
|
|
200
|
+
|-------|-----------|
|
|
201
|
+
| CLI | TypeScript, Node.js |
|
|
202
|
+
| Server | Hono |
|
|
203
|
+
| Database | PGLite (embedded PostgreSQL) |
|
|
204
|
+
| UI | Custom server-side JSX (no React), vanilla client JS |
|
|
205
|
+
| Build | tsup (single-file bundle) |
|
|
206
|
+
| Storage | `.hotsheet/` in your project directory |
|
|
207
|
+
|
|
208
|
+
Data stays local. No network calls, no accounts, no telemetry.
|
|
209
|
+
|
|
210
|
+
---
|
|
211
|
+
|
|
212
|
+
## Development
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
git clone <repo-url>
|
|
216
|
+
cd hotsheet
|
|
217
|
+
npm install
|
|
218
|
+
|
|
219
|
+
npm run dev # Build client assets, then run via tsx
|
|
220
|
+
npm run build # Build to dist/cli.js
|
|
221
|
+
npm run clean # Remove dist and caches
|
|
222
|
+
npm link # Symlink for global 'hotsheet' command
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
## License
|
|
228
|
+
|
|
229
|
+
MIT
|