schub 0.1.0 → 0.1.2
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 +68 -0
- package/dist/index.js +1573 -597
- package/package.json +3 -1
- package/skills/create-proposal/SKILL.md +33 -0
- package/skills/create-tasks/SKILL.md +40 -0
- package/skills/implement-task/SKILL.md +84 -0
- package/skills/review-proposal/SKILL.md +37 -0
- package/skills/setup-project/SKILL.md +29 -0
- package/src/App.test.tsx +93 -0
- package/src/App.tsx +62 -10
- package/src/changes.ts +86 -28
- package/src/clipboard.ts +5 -0
- package/src/commands/adr.test.ts +69 -0
- package/src/commands/adr.ts +107 -0
- package/src/commands/changes.test.ts +171 -0
- package/src/commands/changes.ts +163 -0
- package/src/commands/cookbook.test.ts +71 -0
- package/src/commands/cookbook.ts +95 -0
- package/src/commands/eject.test.ts +74 -0
- package/src/commands/eject.ts +100 -0
- package/src/commands/init.test.ts +78 -0
- package/src/commands/init.ts +144 -0
- package/src/commands/project.test.ts +113 -0
- package/src/commands/project.ts +75 -0
- package/src/commands/review.test.ts +100 -0
- package/src/commands/review.ts +231 -0
- package/src/commands/tasks-create.test.ts +172 -0
- package/src/commands/tasks-list.test.ts +177 -0
- package/src/commands/tasks.ts +172 -0
- package/src/components/PlanView.test.tsx +113 -0
- package/src/components/PlanView.tsx +95 -26
- package/src/components/StatusView.test.tsx +380 -0
- package/src/components/StatusView.tsx +233 -83
- package/src/features/tasks/constants.ts +2 -0
- package/src/features/tasks/create.ts +15 -7
- package/src/features/tasks/filesystem.test.ts +78 -0
- package/src/features/tasks/filesystem.ts +61 -7
- package/src/ide.ts +7 -0
- package/src/index.test.ts +23 -0
- package/src/index.ts +60 -383
- package/src/init.test.ts +43 -0
- package/src/init.ts +27 -0
- package/src/project.ts +5 -32
- package/src/schub-root.ts +33 -0
- package/src/templates.ts +18 -0
- package/src/terminal.test.ts +46 -0
- package/templates/create-proposal/cookbook-template.md +37 -0
- package/templates/review-proposal/q&a-template.md +5 -1
- package/templates/templates-parity.test.ts +45 -0
- package/templates/setup-project/review-me-template.md +0 -18
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
SCHUB
|
|
3
|
+
</p>
|
|
4
|
+
<p align="center">Schub helps you plan and delegate coding tasks to coding agents without losing control.</p>
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="https://www.npmjs.com/package/schub"><img alt="npm" src="https://img.shields.io/npm/v/schub?style=flat-square" /></a>
|
|
7
|
+
<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>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
# Package managers
|
|
14
|
+
npm i -g schub@latest # or bun/pnpm/yarn
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
Run the CLI using `schub`.
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
schub [command]
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
If no command is provided, the interactive UI dashboard will launch.
|
|
26
|
+
|
|
27
|
+
### Commands
|
|
28
|
+
|
|
29
|
+
#### Project & Changes
|
|
30
|
+
|
|
31
|
+
- `schub init` - Initialize `.schub` and install Codex skills.
|
|
32
|
+
- `schub project create` - Initialize or update project-level documentation (Overview, Setup, Ways of Working).
|
|
33
|
+
- `schub changes create` - Create a new change proposal file.
|
|
34
|
+
- `schub eject` - Copy bundled skills and templates into `.schub` (use `--force` to overwrite).
|
|
35
|
+
|
|
36
|
+
#### Task Management
|
|
37
|
+
|
|
38
|
+
- `schub tasks create` - Generate task files based on a change proposal.
|
|
39
|
+
- `schub tasks list` - List all tasks in the current project context.
|
|
40
|
+
|
|
41
|
+
#### Reviews & Documentation
|
|
42
|
+
|
|
43
|
+
- `schub review create` - Generate a `REVIEW_ME.md` file for a specific change.
|
|
44
|
+
- `schub review complete` - Finalize a review, converting questions into a Q&A section.
|
|
45
|
+
- `schub adr create` - Create a new Architectural Decision Record (ADR).
|
|
46
|
+
- `schub cookbook create` - Create a new cookbook entry.
|
|
47
|
+
|
|
48
|
+
## LLM Skills
|
|
49
|
+
|
|
50
|
+
- `create-proposal` - Scaffold and update change proposals, including review requirements.
|
|
51
|
+
- `create-tasks` - Generate actionable task files under `.schub/tasks/` from a change id.
|
|
52
|
+
- `implement-task` - Implement a single task end-to-end and move it across task status folders.
|
|
53
|
+
- `review-proposal` - Run a proposal review session with open questions and Q&A updates.
|
|
54
|
+
- `setup-project` - Create or refresh `.schub/` project reference files.
|
|
55
|
+
- `skill-creator` - Guidance for creating or updating Codex skills.
|
|
56
|
+
- `skill-installer` - Install Codex skills from curated lists or repositories.
|
|
57
|
+
|
|
58
|
+
## Contributing
|
|
59
|
+
|
|
60
|
+
This CLI is built using [Ink](https://github.com/vadimdemedes/ink) for the interactive UI and [Bun](https://bun.sh) for execution.
|
|
61
|
+
|
|
62
|
+
### Scripts
|
|
63
|
+
|
|
64
|
+
- `bun run schub`: Run the CLI in development mode.
|
|
65
|
+
- `bun run build`: Build the CLI to `dist/`.
|
|
66
|
+
- `bun run lint`: Lint the codebase.
|
|
67
|
+
- `bun run format`: Format the codebase.
|
|
68
|
+
- `bun run test`: Run tests.
|