@telepath-computer/television 0.1.1

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 ADDED
@@ -0,0 +1,88 @@
1
+ # Television
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.
4
+
5
+ ![Screenshot](docs/assets/screenshot.png)
6
+
7
+ ## Getting Started
8
+
9
+ Requirements:
10
+ - Node.js 18+ (Node 22 recommended)
11
+ - npm
12
+
13
+ ### Install & run (desktop app)
14
+
15
+ ```bash
16
+ npm install
17
+ npm run start
18
+ ```
19
+
20
+ `npm run start` builds and launches Electron, and also starts the server at `http://localhost:32848`.
21
+
22
+ ### Install & run (standalone server + browser)
23
+
24
+ Build the standalone artifacts, link the CLI locally, and start the standalone
25
+ server:
26
+
27
+ ```bash
28
+ npm install
29
+ npm run build
30
+ npm link
31
+ tv serve
32
+ ```
33
+
34
+ Then open the printed server URL in a browser. When the built renderer bundle is
35
+ present, `tv serve` serves the browser UI from `dist/browser/`.
36
+
37
+ ### Install & run (standalone server + CLI)
38
+
39
+ Build the CLI, link it locally, and start the standalone server:
40
+
41
+ ```bash
42
+ npm install
43
+ npm run build
44
+ npm link
45
+ tv serve
46
+ ```
47
+
48
+ In another terminal, use the CLI against the running server:
49
+
50
+ ```bash
51
+ tv status
52
+ tv list-workspaces
53
+ tv create-artifact --title "hello" --content "world"
54
+ ```
55
+
56
+ ### Run as a system service
57
+
58
+ Once the CLI is built and linked, you can install Television as a background
59
+ service so it starts automatically:
60
+
61
+ ```bash
62
+ tv serve --persist
63
+ tv status
64
+ tv stop
65
+ ```
66
+
67
+ ### Development
68
+
69
+ For development with hot reload, use the dev server:
70
+
71
+ ```bash
72
+ npm run dev
73
+ ```
74
+
75
+ This starts a Vite dev server for the shared renderer in `src/browser/` with HMR, so changes to renderer code and CSS will update live without restarting. Changes to Electron main process code in `src/electron/`, the server, or CLI require restarting.
76
+
77
+ ### Verification
78
+
79
+ Use these commands depending on how much coverage you want:
80
+
81
+ ```bash
82
+ npm run test:setup # one-time Playwright browser install
83
+ npm test # Vitest unit/integration tests
84
+ npm run test:e2e # Playwright browser/e2e tests (Chromium)
85
+ npm run test:electron # built Electron smoke test
86
+ npm run test:all # all tests
87
+ npm run verify # lint + type-check + all tests
88
+ ```