schub 0.1.9 → 0.1.10

package/README.md

@@ -1,7 +1,7 @@
 <p align="center">
   SCHUB
 </p>
-<p align="center">Schub helps you plan and delegate coding tasks to coding agents without losing control.</p>
+<p align="center">Schub helps you plan and delegate coding tickets to coding agents without losing control.</p>
 <p align="center">
  <a href="https://www.npmjs.com/package/schub"><img alt="npm" src="https://img.shields.io/npm/v/schub?style=flat-square" /></a>
   <a href="https://github.com/pufflyai/schub/actions/workflows/build.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/pufflyai/schub/build.yml?style=flat-square" /></a>
@@ -10,8 +10,8 @@
 ## Installation
 
 ```bash
-# Package managers
-npm i -g schub@latest        # or bun/pnpm/yarn
+# Package manager
+bun add -g schub@latest
 ```
 
 ## Usage
@@ -31,72 +31,89 @@ If no command is provided, the TUI dashboard will launch. Use `schub dashboard`
 - `SCHUB_DB_PATH` - Path to the local SQLite database used by schub services.
 - `SCHUB_STORAGE_PATH` - Filesystem root used for file uploads and attachments.
 
+Project-scoped DB commands use the project id from `.schub/config.json`.
+
 ### Commands
 
-#### Project & Changes
+#### Proposals
+
+- `schub proposals create` - Create a new proposal locally and in the database.
+- `schub proposals save` - Save all files in a proposal folder to DB/storage.
+- `schub proposals pull` - Pull a proposal from the database into `.schub`.
+- `schub proposals status` - Update a proposal status in frontmatter.
+- `schub proposals list` - List proposals (`--show-all` includes archived/rejected).
+- `schub proposals archive` - Archive a proposal (use `--skip-tickets` to keep tickets active).
+- `schub proposals delete` - Delete a proposal and clear linked tickets.
+
+##### Proposal IDs
 
-- `schub init` - Initialize `.schub` and install Codex skills.
-- `schub project create` - Initialize or update project-level documentation (Overview, Setup, Ways of Working).
-- `schub changes create` - Create a new change proposal file.
-- `schub eject` - Copy bundled skills and templates into `.schub` (use `--force` to overwrite).
+Proposal ids are stored as `P####_<slug>`. Any command that accepts `--proposal-id` also accepts the shorthand `P####` when it uniquely matches a proposal directory under `.schub/proposals` or `.schub/archive/proposals`.
+
+```bash
+schub proposals save --proposal-id P0003
+schub proposals pull --proposal-id P0003
+```
 
 #### Dashboard
 
 - `schub dashboard` - Start the web dashboard (dev opens `http://localhost:5173`, preview opens `http://localhost:4173`).
 - `schub tui` - Launch the TUI dashboard.
 
-#### Task Management
+#### Ticket Management
 
-- `schub tasks create` - Generate task files based on a change proposal.
-- `schub tasks list` - List all tasks in the current project context.
-- `schub tasks update` - Move backlog tasks to `reviewed` or `archived`.
-- `schub tasks implement` - Move a task to `wip` and launch Opencode (default `worktree` mode).
+- `schub tickets create` - Create a ticket from the ticket template.
+- `schub tickets list` - List all tickets in the current project context.
+- `schub tickets check` - Toggle a checklist item in a ticket.
+- `schub tickets update` - Move backlog tickets to `reviewed`, `rejected`, or `archived`.
+- `schub tickets implement` - Move a ticket to `wip` and launch Opencode.
+- `schub ticket save` - Validate and save a ticket to DB/storage.
 
-##### Task implementation
+##### Ticket implementation
 
 ```bash
-schub tasks implement --id T0007
-schub tasks implement --id T0007 --mode none
+schub tickets implement --id T0007
+schub tickets implement --id T0007 --mode worktree --project-id <project-id>
 ```
 
-- `--mode` defaults to `worktree`, creating `.schub/worktrees/<id>` on branch `task/<id>`.
+- `--mode` defaults to `none` (no worktree).
+- `--mode worktree` creates `.schub/worktrees/<id>` on branch `ticket/<id>` and requires `--project-id`.
 - `--mode none` runs from the current repo without a worktree.
 - `--worktree-root` overrides the default `.schub/worktrees` location.
 
-##### Task status updates
+##### Ticket checklist updates
 
 ```bash
-schub tasks update --id T0004 --id T0005 --status reviewed
+schub tickets check --id T0007 --item 2
 ```
 
-- `--id` (repeatable) selects backlog task IDs to move.
-- `--status` sets the target status: `reviewed` or `archived`.
+##### Ticket status updates
 
-##### Overview view shortcut
+```bash
+schub tickets update --id T0004 --id T0005 --status reviewed
+```
 
-In Overview view, press `s` on a selected backlog or reviewed task to open the status modal.
-For backlog tasks choose `Reviewed` or `Archive`. For reviewed tasks choose `Backlog` or `Archive`, then press enter to confirm or esc to cancel.
+- `--id` (repeatable) selects backlog ticket IDs to move.
+- `--status` sets the target status: `reviewed`, `rejected`, or `archived`.
 
-#### Tickets
+##### Overview view shortcut
 
-- `schub tickets create` - Create a ticket file under `.schub/tickets`.
-- `schub tickets save` - Validate and save a ticket file.
+In Overview view, press `s` on a selected backlog or reviewed ticket to open the status modal.
+For backlog tickets choose `Reviewed` or `Archive`. For reviewed tickets choose `Backlog` or `Archive`, then press enter to confirm or esc to cancel.
 
 #### Reviews & Documentation
 
-- `schub review create` - Generate a `REVIEW_ME.md` file for a specific change.
 - `schub review complete` - Finalize a review, converting questions into a Q&A section.
-- `schub adr create` - Create a new Architectural Decision Record (ADR).
-- `schub cookbook create` - Create a new cookbook entry.
+- `schub template create --name adr` - Create a new Architectural Decision Record file.
+- `schub template create --name cookbook` - Create a new cookbook file.
+- `schub template create --name review` - Create a `REVIEW_ME.md` file.
 
 ## LLM Skills
 
-- `create-proposal` - Scaffold and update change proposals, including review requirements.
+- `create-proposal` - Scaffold and update proposals, including review requirements.
 - `create-ticket` - Create a ticket for any requested repo change.
-- `create-tickets-for-proposal` - Generate actionable ticket files under `.schub/tasks/` from a change id.
-- `implement-task` - Implement a single task end-to-end and move it across task status folders.
+- `create-tickets-for-proposal` - Generate actionable ticket files under `.schub/tickets/` from a proposal id.
+- `implement-ticket` - Implement a single ticket end-to-end and move it across ticket status folders.
 - `review-proposal` - Run a proposal review session with open questions and Q&A updates.
-- `setup-project` - Create or refresh `.schub/` project reference files.
 
 ## Contributing