@bvdm/delano 0.2.8 → 0.2.10
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/.delano/viewer/public/app.jsx +2 -13
- package/.delano/viewer/public/delano-logo.svg +60 -0
- package/.delano/viewer/public/delano-mark.svg +53 -3
- package/.delano/viewer/public/favicon.png +0 -0
- package/.delano/viewer/public/index.html +3 -0
- package/.delano/viewer/public/styles.css +6 -4
- package/.delano/viewer/server.js +6 -0
- package/HANDBOOK.md +297 -74
- package/README.md +72 -9
- package/assets/install-manifest.json +3 -0
- package/assets/payload/.delano/viewer/public/app.jsx +2478 -0
- package/assets/payload/.delano/viewer/public/delano-logo.svg +60 -0
- package/assets/payload/.delano/viewer/public/favicon.png +0 -0
- package/assets/payload/.delano/viewer/public/index.html +3 -0
- package/assets/payload/.delano/viewer/public/styles.css +6 -4
- package/assets/payload/.delano/viewer/server.js +6 -0
- package/assets/payload/HANDBOOK.md +297 -74
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,46 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="docs/images/delano-logo.svg" alt="Delano" width="340">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
<strong>File-backed delivery contracts for coding agents and operators.</strong>
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="#one-command-bootstrap">Install</a>
|
|
11
|
+
·
|
|
12
|
+
<a href="#delano-cli">CLI</a>
|
|
13
|
+
·
|
|
14
|
+
<a href="#local-viewer">Viewer</a>
|
|
15
|
+
·
|
|
16
|
+
<a href="docs/delano-brandbook.html">Brand book</a>
|
|
17
|
+
·
|
|
18
|
+
<a href="HANDBOOK.md">Handbook</a>
|
|
19
|
+
</p>
|
|
20
|
+
|
|
21
|
+
Delano is an agent-agnostic delivery runtime. It keeps planning, execution, validation, and evidence on disk so maintainers, operators, and different coding agents can work from the same operating model without depending on one vendor workflow.
|
|
22
|
+
|
|
23
|
+
The product posture is a local dossier: warm paper, ledger ink, visible source paths, and quiet status signals. The interface and runtime both treat `.project/` as the source of truth.
|
|
24
|
+
|
|
25
|
+
## At a glance
|
|
26
|
+
|
|
27
|
+
| Surface | Role |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| `HANDBOOK.md` | Canonical operating model |
|
|
30
|
+
| `.project/` | File-backed delivery contracts: specs, plans, workstreams, tasks, decisions, updates, evidence |
|
|
31
|
+
| `.agents/` | Shared runtime: scripts, rules, hooks, skills, adapters |
|
|
32
|
+
| `.delano/` | Read-only local viewer for inspecting `.project` state |
|
|
33
|
+
| `docs/delano-brandbook.html` | Brand book for the Delano visual language |
|
|
34
|
+
|
|
35
|
+
## Quick start
|
|
2
36
|
|
|
3
|
-
|
|
37
|
+
```bash
|
|
38
|
+
npx -y @bvdm/delano@latest --yes
|
|
39
|
+
npx -y @bvdm/delano@latest viewer
|
|
40
|
+
npx -y @bvdm/delano@latest validate
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
The viewer opens a localhost-only read surface for `.project` contracts. Validation checks that the runtime, contracts, package payload, and local gates still line up.
|
|
4
44
|
|
|
5
45
|
## What Delano is
|
|
6
46
|
|
|
@@ -12,12 +52,24 @@ Delano is an agent-agnostic delivery runtime. It keeps planning, execution, and
|
|
|
12
52
|
|
|
13
53
|
The npm package is intentionally thin. It distributes the approved runtime payload, includes the read-only viewer UI, and wraps the existing shell-based PM scripts. It does not replace the handbook, the file contracts, or the underlying bash/Python execution layer.
|
|
14
54
|
|
|
55
|
+
## Design language
|
|
56
|
+
|
|
57
|
+
Delano's visual system is intentionally quiet and document-like. The brand mark identifies the source; it does not decorate the interface.
|
|
58
|
+
|
|
59
|
+
- **Creative north star:** The Local Dossier.
|
|
60
|
+
- **Palette:** warm document ground, paper surface, ledger ink, hairline dividers, restrained slate selection, and forest identity through the logo assets.
|
|
61
|
+
- **Typography:** Inter for product and documentation text, JetBrains Mono for provenance and exact paths. Red Hat Display belongs only inside the supplied wordmark artwork.
|
|
62
|
+
- **Shape:** small 4px to 6px radii, 1px hairlines, open ledger rows instead of stacked cards.
|
|
63
|
+
- **Motion:** brief, functional feedback only.
|
|
64
|
+
|
|
65
|
+
See [DESIGN.md](DESIGN.md) and the [Delano Brand Book](docs/delano-brandbook.html) for the full system.
|
|
66
|
+
|
|
15
67
|
## Delano CLI
|
|
16
68
|
|
|
17
69
|
- Package: `@bvdm/delano`
|
|
18
|
-
- Current package version: `0.2.
|
|
70
|
+
- Current package version: `0.2.10`
|
|
19
71
|
- Binary: `delano`
|
|
20
|
-
- Commands: `onboarding`, `install`, `viewer`, `init`, `validate`, `status`, `next`
|
|
72
|
+
- Commands: `onboarding`, `install`, `viewer`, `project`, `workstream`, `task`, `update`, `init`, `import-spec-kit`, `research`, `validate`, `status`, `next`
|
|
21
73
|
- Primary goal: bootstrap a repo safely, expose local delivery state clearly, and keep runtime gates verifiable
|
|
22
74
|
|
|
23
75
|
## Recent main changes
|
|
@@ -46,14 +98,14 @@ npx -y @bvdm/delano@latest install --yes
|
|
|
46
98
|
To install into a different directory:
|
|
47
99
|
|
|
48
100
|
```bash
|
|
49
|
-
npx -y @bvdm/delano@latest --target
|
|
101
|
+
npx -y @bvdm/delano@latest --target <repo> --yes
|
|
50
102
|
```
|
|
51
103
|
|
|
52
104
|
If you already have the package installed locally, the same flow is:
|
|
53
105
|
|
|
54
106
|
```bash
|
|
55
107
|
delano --yes
|
|
56
|
-
delano --target
|
|
108
|
+
delano --target <repo> --yes
|
|
57
109
|
```
|
|
58
110
|
|
|
59
111
|
## Global CLI install
|
|
@@ -67,7 +119,7 @@ npm install -g @bvdm/delano
|
|
|
67
119
|
Typical flow in a repository:
|
|
68
120
|
|
|
69
121
|
```bash
|
|
70
|
-
cd
|
|
122
|
+
cd <repo>
|
|
71
123
|
delano install --yes
|
|
72
124
|
delano viewer
|
|
73
125
|
delano validate
|
|
@@ -171,7 +223,13 @@ bash .agents/scripts/pm/next.sh --all
|
|
|
171
223
|
bash .agents/scripts/pm/research.sh <project-slug> <research-slug> --title "Research title" --question "Primary question" --json
|
|
172
224
|
```
|
|
173
225
|
|
|
174
|
-
|
|
226
|
+
## Local viewer
|
|
227
|
+
|
|
228
|
+
The viewer is packaged with `@bvdm/delano` and serves the selected repository's `.project` files read-only. It defaults to `http://127.0.0.1:3977`; set `DELANO_VIEWER_PORT` or `PORT` to use another port.
|
|
229
|
+
|
|
230
|
+
It indexes `.project/context`, `.project/templates`, and `.project/projects`, then derives artifact roles, statuses, project outlines, task/workstream relationships, snippets, and rendered markdown for local inspection.
|
|
231
|
+
|
|
232
|
+
The viewer follows the same design language as the brand book: source paths stay visible, status is shown with labels and dots, and dense project state is separated with hairlines rather than decorative cards.
|
|
175
233
|
|
|
176
234
|
## Required dependencies
|
|
177
235
|
|
|
@@ -212,7 +270,7 @@ Codex hook activation is intentionally manual:
|
|
|
212
270
|
2. Start Codex in the repository and approve the project trust prompt for the repo-local `.codex/` layer. Codex records trusted projects in `~/.codex/config.toml`, for example:
|
|
213
271
|
|
|
214
272
|
```toml
|
|
215
|
-
[projects."
|
|
273
|
+
[projects."<repo>"]
|
|
216
274
|
trust_level = "trusted"
|
|
217
275
|
```
|
|
218
276
|
|
|
@@ -320,7 +378,12 @@ If npm publish fails after the package checks pass, verify that the npm trusted
|
|
|
320
378
|
|
|
321
379
|
## Read next
|
|
322
380
|
|
|
381
|
+
- `docs/README.md` for the user documentation index
|
|
323
382
|
- `docs/user-guide.md` for the practical user flow
|
|
383
|
+
- `docs/cli-reference.md` for the CLI command reference
|
|
384
|
+
- `docs/viewer-guide.md` for the read-only viewer workflow
|
|
385
|
+
- `docs/agent-operator-guide.md` for instructing agents
|
|
386
|
+
- `docs/spec-kit-and-research.md` for Spec Kit-style import and research intake
|
|
324
387
|
- `HANDBOOK.md` for the full operating model
|
|
325
388
|
- `.agents/scripts/README.md` for the runtime script inventory
|
|
326
389
|
- `AGENTS.md` for adapter-neutral instructions
|
|
@@ -169,7 +169,10 @@
|
|
|
169
169
|
".delano/viewer/README.md",
|
|
170
170
|
".delano/viewer/server.js",
|
|
171
171
|
".delano/viewer/public/app.js",
|
|
172
|
+
".delano/viewer/public/app.jsx",
|
|
173
|
+
".delano/viewer/public/delano-logo.svg",
|
|
172
174
|
".delano/viewer/public/explorer.svg",
|
|
175
|
+
".delano/viewer/public/favicon.png",
|
|
173
176
|
".delano/viewer/public/index.html",
|
|
174
177
|
".delano/viewer/public/markdown.svg",
|
|
175
178
|
".delano/viewer/public/vscode.svg",
|