hotsheet 0.2.2 → 0.2.3

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/README.md CHANGED
@@ -107,6 +107,7 @@ The loop stays tight because the AI always knows what to work on next.
107
107
  - **Copy for commits** — `Cmd+C` copies selected ticket info (number + title) for use in commit messages
108
108
  - **File attachments** — attach files to any ticket
109
109
  - **Markdown sync** — `worklist.md` and `open-tickets.md` auto-generated on every change
110
+ - **Automatic backups** — tiered snapshots (every 5 min, hourly, daily) with preview-before-restore recovery
110
111
  - **Auto-cleanup** — configurable auto-deletion of old trash and verified items
111
112
  - **Fully local** — embedded PostgreSQL (PGLite), no network calls, no accounts, no telemetry
112
113
 
@@ -169,6 +170,46 @@ TICKET HS-15:
169
170
 
170
171
  ---
171
172
 
173
+ ## Backups & Data Safety
174
+
175
+ Hot Sheet automatically protects your data with tiered backups and instance locking.
176
+
177
+ ### Automatic backups
178
+
179
+ Backups run on three schedules, each keeping a rolling window of snapshots:
180
+
181
+ | Tier | Frequency | Retention |
182
+ |------|-----------|-----------|
183
+ | Recent | Every 5 minutes | Last hour (up to 12) |
184
+ | Hourly | Every hour | Last 12 hours (up to 12) |
185
+ | Daily | Every day | Last 7 days (up to 7) |
186
+
187
+ You can also trigger a manual backup at any time from the settings panel with the **Backup Now** button.
188
+
189
+ ### Recovering from a backup
190
+
191
+ Open the settings panel (gear icon) to see all available recovery points grouped by tier. Click any backup to enter **preview mode** — the app switches to a read-only view of the backup's data. You can navigate views, filter by category/priority, switch to column layout, and inspect individual tickets to verify it's the right recovery point.
192
+
193
+ If it looks correct, click **Restore This Backup** to replace the current database. A safety snapshot of your current data is automatically created before the restore, so you can always go back.
194
+
195
+ ### Configurable backup location
196
+
197
+ By default, backups are stored in `.hotsheet/backups/`. To store them elsewhere — for example, a folder synced by iCloud, Google Drive, or Dropbox — set the `backupDir` in `.hotsheet/settings.json`:
198
+
199
+ ```json
200
+ {
201
+ "backupDir": "/Users/you/Library/Mobile Documents/com~apple~CloudDocs/hotsheet-backups"
202
+ }
203
+ ```
204
+
205
+ This can also be changed from the settings panel UI.
206
+
207
+ ### Instance locking
208
+
209
+ Only one Hot Sheet instance can use a data directory at a time. If you accidentally start a second instance pointing at the same `.hotsheet/` folder, it will exit with a clear error instead of risking database corruption. The lock is automatically cleaned up when the app stops.
210
+
211
+ ---
212
+
172
213
  ## Install
173
214
 
174
215
  ### Desktop app (recommended)
@@ -226,17 +267,23 @@ hotsheet --browser
226
267
  | `--browser` | Open in browser instead of desktop window |
227
268
  | `--help` | Show help |
228
269
 
229
- ### Customizing the window title
270
+ ### Settings file
230
271
 
231
- When running multiple instances, you can customize the window title to tell them apart. Create `.hotsheet/settings.json` in your project:
272
+ Create `.hotsheet/settings.json` to configure per-project options:
232
273
 
233
274
  ```json
234
275
  {
235
- "appName": "HS - My Project"
276
+ "appName": "HS - My Project",
277
+ "backupDir": "/path/to/backup/location"
236
278
  }
237
279
  ```
238
280
 
239
- Without a settings file, the window title defaults to the project folder name.
281
+ | Key | Description |
282
+ |-----|-------------|
283
+ | `appName` | Custom window title (defaults to the project folder name) |
284
+ | `backupDir` | Backup storage path (defaults to `.hotsheet/backups/`) |
285
+
286
+ Both settings can also be changed from the settings panel UI.
240
287
 
241
288
  ### Keyboard shortcuts
242
289