schub 0.1.20 → 0.1.22

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
@@ -51,19 +51,23 @@ If no command is provided, the TUI dashboard will launch. Use `schub dashboard`
51
51
 
52
52
  - `SCHUB_API_PORT` - Overrides the API port when `schub` auto-starts the API (maps to the API `PORT`).
53
53
  - `SCHUB_DASHBOARD_PORT` - Overrides the dashboard port for `schub dashboard` (dev or preview).
54
- - `SCHUB_DB_PATH` - Path to the local SQLite database used by schub services.
55
- - `SCHUB_STORAGE_PATH` - Filesystem root used for file uploads and attachments.
54
+ - `SCHUB_DB_PATH` - Path to the local SQLite database used by schub services (default: `~/.schub/schub.db`).
55
+ - `SCHUB_STORAGE_PATH` - Filesystem root used for file uploads and attachments (default: `~/.schub/storage`).
56
56
 
57
57
  Project-scoped DB commands use the project id from `.schub/config.json`.
58
58
 
59
59
  ### Commands
60
60
 
61
+ #### Init
62
+
63
+ - `schub init --project-id <project-id>` - Validate the project id in services and write `.schub/config.json` at the current git root (repo root or current git worktree root).
64
+
61
65
  #### Proposals
62
66
 
63
67
  - `schub proposals create` - Create a new proposal locally and in the database.
64
68
  - `schub proposals save` - Save all files in one proposal folder to DB/storage (`--proposal-id`) or save all local proposals (`--all`).
65
- - `schub proposals pull` - Pull a proposal from the database into `.schub`.
66
- - `schub proposals status` - Update a proposal status in frontmatter.
69
+ - `schub proposals pull` - Pull a proposal from the database into the local `.schub` folder (requires local `.schub/config.json`).
70
+ - `schub proposals update` - Update a proposal status in frontmatter.
67
71
  - `schub proposals list` - List proposals (`--show-all` includes archived/rejected).
68
72
  - `schub proposals archive` - Archive a proposal (use `--skip-tickets` to keep tickets active).
69
73
  - `schub proposals delete` - Delete a proposal and clear linked tickets.
@@ -83,7 +87,7 @@ schub proposals pull --proposal-id P0003
83
87
  - `schub docs init` - Scaffold `.schub/docs/docs.json` and starter markdown (`index.md`).
84
88
  - `schub docs init --overwrite` - Replace starter docs files when they already exist.
85
89
  - `schub docs save` - Save `.schub/docs/docs.json` and `**/*.md` to persisted project docs storage.
86
- - `schub docs pull` - Pull persisted project docs back into `.schub/docs`.
90
+ - `schub docs pull` - Pull persisted project docs back into local `.schub/docs` (requires local `.schub/config.json`).
87
91
 
88
92
  #### Dashboard
89
93
 
@@ -98,6 +102,7 @@ schub proposals pull --proposal-id P0003
98
102
  - `schub tickets update` - Move backlog tickets to any ticket status configured for the project in DB.
99
103
  - `schub tickets implement` - Move a ticket to `wip` and launch Opencode.
100
104
  - `schub tickets save` - Validate and save one ticket (`--id`) or all local tickets (`--all`) to DB/storage.
105
+ - `schub tickets pull` - Pull tickets from the database into the local `.schub/tickets` folder (requires local `.schub/config.json`).
101
106
 
102
107
  ##### Ticket implementation
103
108
 
@@ -107,9 +112,9 @@ schub tickets implement --id T0007 --mode worktree --project-id <project-id>
107
112
  ```
108
113
 
109
114
  - `--mode` defaults to `none` (no worktree).
110
- - `--mode worktree` creates `.schub/worktrees/<id>` on branch `ticket/<id>` and requires `--project-id`.
115
+ - `--mode worktree` creates `~/.schub/worktrees/<project-id>/<ticket-shorthand>/<attempt-shorthand>` and requires `--project-id`.
111
116
  - `--mode none` runs from the current repo without a worktree.
112
- - `--worktree-root` overrides the default `.schub/worktrees` location.
117
+ - `--worktree-root` overrides the default `~/.schub/worktrees` location.
113
118
 
114
119
  ##### Ticket checklist updates
115
120