schub 0.1.7 → 0.1.9

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
@@ -22,7 +22,14 @@ Run the CLI using `schub`.
22
22
  schub [command]
23
23
  ```
24
24
 
25
- If no command is provided, the interactive UI dashboard will launch.
25
+ If no command is provided, the TUI dashboard will launch. Use `schub dashboard` to start the web dashboard (dev server from source, preview from built).
26
+
27
+ ### Environment
28
+
29
+ - `SCHUB_API_PORT` - Overrides the API port when `schub` auto-starts the API (maps to the API `PORT`).
30
+ - `SCHUB_DASHBOARD_PORT` - Overrides the dashboard port for `schub dashboard` (dev or preview).
31
+ - `SCHUB_DB_PATH` - Path to the local SQLite database used by schub services.
32
+ - `SCHUB_STORAGE_PATH` - Filesystem root used for file uploads and attachments.
26
33
 
27
34
  ### Commands
28
35
 
@@ -33,6 +40,11 @@ If no command is provided, the interactive UI dashboard will launch.
33
40
  - `schub changes create` - Create a new change proposal file.
34
41
  - `schub eject` - Copy bundled skills and templates into `.schub` (use `--force` to overwrite).
35
42
 
43
+ #### Dashboard
44
+
45
+ - `schub dashboard` - Start the web dashboard (dev opens `http://localhost:5173`, preview opens `http://localhost:4173`).
46
+ - `schub tui` - Launch the TUI dashboard.
47
+
36
48
  #### Task Management
37
49
 
38
50
  - `schub tasks create` - Generate task files based on a change proposal.
@@ -65,6 +77,11 @@ schub tasks update --id T0004 --id T0005 --status reviewed
65
77
  In Overview view, press `s` on a selected backlog or reviewed task to open the status modal.
66
78
  For backlog tasks choose `Reviewed` or `Archive`. For reviewed tasks choose `Backlog` or `Archive`, then press enter to confirm or esc to cancel.
67
79
 
80
+ #### Tickets
81
+
82
+ - `schub tickets create` - Create a ticket file under `.schub/tickets`.
83
+ - `schub tickets save` - Validate and save a ticket file.
84
+
68
85
  #### Reviews & Documentation
69
86
 
70
87
  - `schub review create` - Generate a `REVIEW_ME.md` file for a specific change.
@@ -75,7 +92,8 @@ For backlog tasks choose `Reviewed` or `Archive`. For reviewed tasks choose `Bac
75
92
  ## LLM Skills
76
93
 
77
94
  - `create-proposal` - Scaffold and update change proposals, including review requirements.
78
- - `create-tasks` - Generate actionable task files under `.schub/tasks/` from a change id.
95
+ - `create-ticket` - Create a ticket for any requested repo change.
96
+ - `create-tickets-for-proposal` - Generate actionable ticket files under `.schub/tasks/` from a change id.
79
97
  - `implement-task` - Implement a single task end-to-end and move it across task status folders.
80
98
  - `review-proposal` - Run a proposal review session with open questions and Q&A updates.
81
99
  - `setup-project` - Create or refresh `.schub/` project reference files.
@@ -87,6 +105,7 @@ This CLI is built using [Ink](https://github.com/vadimdemedes/ink) for the inter
87
105
  ### Scripts
88
106
 
89
107
  - `bun run schub`: Run the CLI in development mode.
108
+ - `bun run schub:built`: Run the built CLI from `dist/` (run `bun run build` first).
90
109
  - `bun run build`: Build the CLI to `dist/`.
91
110
  - `bun run lint`: Lint the codebase.
92
111
  - `bun run format`: Format the codebase.