@telepath-computer/television 0.1.27 → 0.1.29

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
@@ -1,6 +1,15 @@
1
1
  # Television
2
2
 
3
- Television is a virtual display for agents. You can run it as a local desktop app or as a standalone server, then create, update, and remove persistent artifacts in workspaces.
3
+ Television is a virtual display for agents. You can run it as a local desktop app or as a standalone server, then create, update, and remove persistent artifacts in screens.
4
+
5
+ See [docs/architecture.md](docs/architecture.md) for the system overview and [docs/api.md](docs/api.md) for the network API.
6
+
7
+ ## Environment
8
+
9
+ - **Runtime.** Electron 35+ (Chromium renderer, Node.js main process) for desktop, or Node.js 18+ (22 recommended) for the standalone server.
10
+ - **Package manager.** npm screens under `packages/*` (`cli`, `desktop`, `layout`, `layout-demo`, `server`, `shared`, `web`).
11
+ - **Build.** Vite builds the renderer to `dist/browser/` (with `base: "./"` so Electron can load it over `file://`). esbuild bundles the Electron main process to `dist/electron.cjs` and the `tv` CLI to `dist/cli.cjs`.
12
+ - **Tests.** Vitest for unit/integration and server tests, Playwright for browser e2e.
4
13
 
5
14
  ## Getting Started
6
15
 
@@ -35,10 +44,13 @@ npm run build
35
44
  npm link
36
45
  tv serve
37
46
  tv status
38
- tv list-workspaces
39
- tv create-artifact --title "hello" --content "world"
47
+ tv list-screens
40
48
  ```
41
49
 
50
+ After pulling changes, rerun `npm run build && npm link` to refresh the installed `tv` binary — it bundles skill content and CLI logic at build time, so the installed binary can drift from the source tree between releases.
51
+
52
+ Artifacts are created and edited by agents using the `tv create-internal-artifact`, `tv edit-internal-artifact`, and `tv commit-pending-artifact` lifecycle. Run `tv help` for the full agent workflow; see [docs/cli.md](docs/cli.md) for the CLI reference.
53
+
42
54
  ### System service
43
55
 
44
56
  ```bash
@@ -52,13 +64,12 @@ tv stop
52
64
  Use these commands depending on how much coverage you want:
53
65
 
54
66
  ```bash
55
- npm run test:setup # one-time Playwright browser install
56
- npm test # Vitest unit/integration tests
57
- npm run test:e2e-browser # Playwright browser e2e tests (Chromium)
58
- npm run test:e2e-node # server e2e tests
59
- npm run test:electron # built Electron smoke test
60
- npm run test:all # all tests
61
- npm run verify # lint + type-check + all tests
67
+ npm run test:setup # one-time Playwright browser install
68
+ npm test # Vitest unit/integration tests (root + all screens)
69
+ npm run test:e2e # all e2e: node (vitest) + browser (Playwright) + screen e2e
70
+ npm run test:agent # ACP bridge agent e2e (requires openclaw on PATH)
71
+ npm run test:all # everything: test + test:e2e + agent
72
+ npm run verify # lint + type-check + test:all
62
73
  ```
63
74
 
64
75
  CI currently runs `npm run lint`, `npm run type-check`, and `npm test`. The other suites are available for local verification.