shipbench 0.1.0
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/LICENSE +21 -0
- package/README.md +98 -0
- package/dist/index.js +7367 -0
- package/package.json +52 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 gmmurray
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# shipbench
|
|
2
|
+
|
|
3
|
+
**Git-native project management for solo developers.**
|
|
4
|
+
|
|
5
|
+
Your project plan lives inside your repository as plain Markdown, so Git, your
|
|
6
|
+
editor, this CLI, the local board, and your coding agents all work from one
|
|
7
|
+
source of truth. No account, no API key, no service.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install --global shipbench
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Or run it without installing:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx shipbench init
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Quickstart
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
cd your-repo
|
|
25
|
+
shipbench init # scaffold .shipbench/
|
|
26
|
+
shipbench task create "Build the API" # create your first task
|
|
27
|
+
shipbench task list # see the board
|
|
28
|
+
shipbench board # open the local Kanban board
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
`init` creates a `.shipbench/` directory holding `config.json`, `layout.json`,
|
|
32
|
+
a `README.md`, an `AGENTS.md` for coding agents, and a starter task. Commit it
|
|
33
|
+
like any other project file. Running `init` on an already-valid project leaves
|
|
34
|
+
it byte-for-byte unchanged.
|
|
35
|
+
|
|
36
|
+
## Commands
|
|
37
|
+
|
|
38
|
+
| Command | What it does |
|
|
39
|
+
| --- | --- |
|
|
40
|
+
| `shipbench init` | Create `.shipbench/` when absent. `--name <name>` sets the project name (defaults to the directory basename). |
|
|
41
|
+
| `shipbench task create <title>` | Create a task. `--status`, `--priority`, `--assignee`, `--tags=a,b,c`, `--depends-on=slug`, and `--json` to print the created task — the only way to learn a collision-suffixed slug programmatically. |
|
|
42
|
+
| `shipbench task list` | List live tasks in board order. Filters: `--status`, `--priority`, `--assignee`, `--tag`, `--available`, `--blocked`, `--archived`. `--json` for machine output. |
|
|
43
|
+
| `shipbench task get <slug>` | Retrieve one task as JSON. |
|
|
44
|
+
| `shipbench task move <slug>` | `--to=<status>` picks the column; `--top`, `--bottom`, `--before=<slug>`, `--after=<slug>`, `--position=<n>` pick the spot within it. |
|
|
45
|
+
| `shipbench task comment <slug> <text>` | Append a timestamped entry to the task's `## Task Updates` section. `edit` and `delete` subcommands take a zero-based index. |
|
|
46
|
+
| `shipbench task search <query>` | Case-insensitive search over titles, tags, and bodies. `--archived`, `--all`, `--limit`. |
|
|
47
|
+
| `shipbench task graph` | Dependency graph as JSON when piped or with `--json`; an ASCII summary in an interactive terminal. |
|
|
48
|
+
| `shipbench task archive <slug>` | Move a task to `tasks/archive/`, byte-identical and restorable. `--done [--keep=N]` bulk-archives completed tasks. |
|
|
49
|
+
| `shipbench task unarchive <slug>` | Restore an archived task exactly as it was. |
|
|
50
|
+
| `shipbench task delete <slug>` | Delete a task file and prune it from the layout. |
|
|
51
|
+
| `shipbench board` | Serve the Kanban board locally, with file watching for live updates. |
|
|
52
|
+
|
|
53
|
+
Global options: `-C <path>` runs any command against another directory,
|
|
54
|
+
`-v, --version`, `-h, --help`.
|
|
55
|
+
|
|
56
|
+
## Working with coding agents
|
|
57
|
+
|
|
58
|
+
`shipbench init` writes an `AGENTS.md` into `.shipbench/` describing the board's
|
|
59
|
+
conventions, so an agent that reads your repository can operate the board
|
|
60
|
+
without extra prompting. Two commands are built for that workflow:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
shipbench task list --available --json # unblocked, ranked candidates
|
|
64
|
+
shipbench task list --blocked # waiting on dependencies
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
`--available` returns tasks in the default column whose `depends_on` entries are
|
|
68
|
+
all complete or archived, ranked by priority then age. Dependencies are data,
|
|
69
|
+
not locks — they never gate a write or move a task between columns.
|
|
70
|
+
|
|
71
|
+
## The `.shipbench/` convention
|
|
72
|
+
|
|
73
|
+
Tasks are Markdown files with YAML frontmatter:
|
|
74
|
+
|
|
75
|
+
```markdown
|
|
76
|
+
---
|
|
77
|
+
title: Setup GitHub OAuth
|
|
78
|
+
status: todo
|
|
79
|
+
priority: medium
|
|
80
|
+
tags: [auth, backend]
|
|
81
|
+
created: 2026-06-16T10:00:00Z
|
|
82
|
+
updated: 2026-06-16T10:00:00Z
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
Freeform Markdown body.
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Columns, priorities, and the completion column are configured per project in
|
|
89
|
+
`.shipbench/config.json`. Any tool that can read a file can read the board.
|
|
90
|
+
|
|
91
|
+
## Documentation
|
|
92
|
+
|
|
93
|
+
- [shipbench.dev/docs](https://shipbench.dev/docs) — quickstart, CLI reference, and recipes
|
|
94
|
+
- [Repository](https://github.com/gmmurray/shipbench)
|
|
95
|
+
|
|
96
|
+
## License
|
|
97
|
+
|
|
98
|
+
MIT
|