beads-enhanced-ui 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 ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2025 Maximilian Antoni
2
+
3
+ Permission is hereby granted, free of charge, to any person
4
+ obtaining a copy of this software and associated documentation
5
+ files (the "Software"), to deal in the Software without
6
+ restriction, including without limitation the rights to use,
7
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the
9
+ Software is furnished to do so, subject to the following
10
+ conditions:
11
+
12
+ The above copyright notice and this permission notice shall be
13
+ included in all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
+ OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,95 @@
1
+ <h1 align="center">
2
+ Beads UI
3
+ </h1>
4
+ <p align="center">
5
+ <b>Local UI for the <code>bd</code> CLI – <a href="https://github.com/steveyegge/beads">Beads</a></b><br>
6
+ Collaborate on issues with your coding agent.
7
+ </p>
8
+ <div align="center">
9
+ <a href="https://www.npmjs.com/package/beads-ui"><img src="https://img.shields.io/npm/v/beads-ui.svg" alt="npm Version"></a>
10
+ <a href="https://semver.org"><img src="https://img.shields.io/:semver-%E2%9C%93-blue.svg" alt="SemVer"></a>
11
+ <a href="https://github.com/mantoni/beads-ui/actions/worflows/ci.yml"><img src="https://github.com/mantoni/eslint_d.js/actions/workflows/ci.yml/badge.svg" alt="Build Status"></a>
12
+ <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/npm/l/eslint_d.svg" alt="MIT License"></a>
13
+ <br>
14
+ <br>
15
+ </div>
16
+
17
+ ## Features
18
+
19
+ - ✨ **Zero setup** – just run `bdui start`
20
+ - πŸ“Ί **Live updates** – Monitors the beads database for changes
21
+ - πŸ”Ž **Issues view** – Filter and search issues, edit inline
22
+ - ⛰️ **Epics view** – Show progress per epic, expand rows, edit inline
23
+ - πŸ‚ **Board view** – Blocked / Ready / In progress / Closed columns
24
+ - ⌨️ **Keyboard navigation** – Navigate and edit without touching the mouse
25
+ - πŸ”€ **Multi-workspace** – Switch between projects via dropdown, auto-registers
26
+ workspaces
27
+
28
+ ## Setup
29
+
30
+ ```sh
31
+ npm i beads-ui -g
32
+ # In your project directory:
33
+ bdui start --open
34
+ ```
35
+
36
+ See `bdui --help` for options.
37
+
38
+ ## Screenshots
39
+
40
+ **Issues**
41
+
42
+ ![Issues view](https://github.com/mantoni/beads-ui/raw/main/media/bdui-issues.png)
43
+
44
+ **Epics**
45
+
46
+ ![Epics view](https://github.com/mantoni/beads-ui/raw/main/media/bdui-epics.png)
47
+
48
+ **Board**
49
+
50
+ ![Board view](https://github.com/mantoni/beads-ui/raw/main/media/bdui-board.png)
51
+
52
+ ## Environment variables
53
+
54
+ - `BD_BIN`: path to the `bd` binary.
55
+ - `BDUI_RUNTIME_DIR`: override runtime directory for PID/logs. Defaults to
56
+ `$XDG_RUNTIME_DIR/beads-ui` or the system temp dir.
57
+ - `HOST`: overrides the bind address (default `127.0.0.1`).
58
+ - `PORT`: overrides the listen port (default `3000`).
59
+
60
+ These can also be set via CLI options: `bdui start --host 0.0.0.0 --port 8080`
61
+
62
+ ## Platform notes
63
+
64
+ - macOS/Linux are fully supported. On Windows, the CLI uses `cmd /c start` to
65
+ open URLs and relies on Node’s `process.kill` semantics for stopping the
66
+ daemon.
67
+
68
+ ## Developer Workflow
69
+
70
+ - πŸ”¨ Clone the repo and run `npm install`.
71
+ - πŸš€ Start the dev server with `npm start`.
72
+ - πŸ”— Alternatively, use `npm link` to link the package globally and run
73
+ `bdui start` from any project.
74
+
75
+ ## Coverage Commands
76
+
77
+ - `npm run all` runs lint, typecheck, the full Vitest suite, and the stable
78
+ frontend coverage gate via `npm run test:coverage:app`.
79
+ - `npm run test:coverage:app` measures browser-side `jsdom` coverage for
80
+ `app/**/*.js`.
81
+ - `npm run test:coverage` runs full-suite coverage across all Vitest projects,
82
+ so it reflects repo-wide test health rather than only the frontend gate.
83
+
84
+ ## Debug Logging
85
+
86
+ - The codebase uses the `debug` package with namespaces like `beads-ui:*`.
87
+ - Enable logs in the browser by running in DevTools:
88
+ - `localStorage.debug = 'beads-ui:*'` then reload the page
89
+ - Enable logs for Node/CLI (server, build scripts) by setting `DEBUG`:
90
+ - `DEBUG=beads-ui:* bdui start`
91
+ - `DEBUG=beads-ui:* node scripts/build-frontend.js`
92
+
93
+ ## License
94
+
95
+ MIT
package/app/index.html ADDED
@@ -0,0 +1,49 @@
1
+ <!doctype html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
6
+ <title>Beads</title>
7
+ <link rel="stylesheet" href="./styles.css" />
8
+ </head>
9
+ <body>
10
+ <header class="app-header">
11
+ <div class="header-left">
12
+ <h1 class="app-title">Beads</h1>
13
+ <div id="workspace-picker" class="header-workspace"></div>
14
+ <nav id="top-nav" class="header-nav" aria-label="Primary"></nav>
15
+ </div>
16
+ <div class="header-actions">
17
+ <div
18
+ id="header-loading"
19
+ class="header-loading"
20
+ role="status"
21
+ aria-live="polite"
22
+ aria-label="Loading"
23
+ hidden
24
+ >
25
+ <span class="header-loading__spinner" aria-hidden="true"></span>
26
+ <span class="visually-hidden">Loading</span>
27
+ </div>
28
+ <label class="theme-toggle" title="Toggle dark mode">
29
+ <span>Dark</span>
30
+ <input
31
+ id="theme-switch"
32
+ type="checkbox"
33
+ aria-label="Toggle dark mode"
34
+ />
35
+ </label>
36
+ <button
37
+ id="new-issue-btn"
38
+ type="button"
39
+ aria-haspopup="dialog"
40
+ title="Create a new issue (Ctrl/Cmd+N)"
41
+ >
42
+ New issue
43
+ </button>
44
+ </div>
45
+ </header>
46
+ <main id="app" class="app-shell" aria-live="polite"></main>
47
+ <script type="module" src="/main.bundle.js"></script>
48
+ </body>
49
+ </html>