Skip to content

Commit 0d39795

Browse files
committed
docs: npm coming soon, v4 constructor shorthand, update CLI references
- Quick Start: git clone instead of npm install, 'npm coming soon' banner - CLI section: node dist/cli/talox.js instead of npx talox - Observe example: local CLI invocation - All code examples: v4 TaloxController({ ... }) shorthand - Version badge: 4.0.0 - HTML comments with npm install block for easy swap when published
1 parent 9f7bca5 commit 0d39795

1 file changed

Lines changed: 26 additions & 12 deletions

File tree

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<img src="https://img.shields.io/badge/Playwright-Chromium-45ba4b?style=flat-square&logo=playwright&logoColor=white" alt="Playwright" />
3030
<img src="https://img.shields.io/badge/Node.js-18+-339933?style=flat-square&logo=nodedotjs&logoColor=white" alt="Node.js" />
3131
<img src="https://img.shields.io/badge/License-AGPL--3.0--only-0d9488?style=flat-square&logo=opensourceinitiative&logoColor=white" alt="AGPL-3.0-only" />
32-
<img src="https://img.shields.io/badge/version-3.0.0-0d9488?style=flat-square" alt="version" />
32+
<img src="https://img.shields.io/badge/version-4.0.0-0d9488?style=flat-square" alt="version" />
3333
</p>
3434

3535
<p align="center">
@@ -63,9 +63,7 @@ Talox is a **local browser runtime** — agents work inside a real browser with
6363
```typescript
6464
import { TaloxController } from 'talox';
6565

66-
const talox = new TaloxController('./profiles', {
67-
settings: { verbosity: 0 } // silent by default
68-
});
66+
const talox = new TaloxController({ settings: { verbosity: 0 } }); // v4 shorthand
6967

7068
// Agent does everything with full stealth — always on
7169
await talox.launch('my-agent', 'ops');
@@ -77,9 +75,7 @@ await talox.stop();
7775

7876
```typescript
7977
// Headed mode — shows browser with glow frame + fake cursor overlay
80-
const talox = new TaloxController('./profiles', {
81-
settings: { headed: true } // overlay auto-activates
82-
});
78+
const talox = new TaloxController({ headed: true }); // v4 shorthand
8379

8480
// Human Takeover — agent pauses, human does a step (e.g., login, 2FA)
8581
await talox.requestHumanTakeover('Need 2FA code');
@@ -120,11 +116,24 @@ Talox's mission is to be the obvious local-first browser runtime. The table belo
120116

121117
## Quick Start
122118

119+
> **npm package coming soon.** For now, install directly from GitHub:
120+
121+
```bash
122+
git clone https://github.com/AVANT-ICONIC/Talox.git
123+
cd Talox
124+
npm install
125+
npm run build
126+
# Install Playwright Chromium (first time or on a new server)
127+
npx playwright install chromium --with-deps
128+
```
129+
130+
<!-- Once published to npm, replace the block above with:
123131
```bash
124132
npm install talox
125133
# Install Playwright Chromium system dependencies (first time or on a new server)
126134
npx playwright install chromium --with-deps
127135
```
136+
-->
128137

129138
### Dependencies explained
130139

@@ -140,7 +149,8 @@ Both share the same API surface — Talox uses Playwright by default and falls b
140149
```typescript
141150
import { TaloxController } from 'talox';
142151

143-
const talox = new TaloxController('./profiles');
152+
// v4: config object as first arg
153+
const talox = new TaloxController({ headless: true });
144154

145155
await talox.launch('my-agent', 'ops');
146156

@@ -158,8 +168,11 @@ See [examples/minimal-agent.ts](./examples/minimal-agent.ts) for a copy-paste st
158168

159169
## Talox CLI & Packaging
160170

161-
- `npx talox observe` starts the human-visible observe mode with headed browser, overlay, Markdown/HTML reporting, and the `window.__taloxEmit__` bridge so you can annotate interactions while the agent runs.
162-
- `npx talox init` (aka the `create-talox-app` workflow) scaffolds a clean `talox-app` starter project with `PRESETS.observe`, `ts-node`/`typescript` tooling, Playwright install scripts, and `examples/browser-lab.ts`.
171+
> **npm package coming soon.** Until then, run the CLI from the repo:
172+
> `node dist/cli/talox.js observe --help`
173+
174+
- `node dist/cli/talox.js observe` starts the human-visible observe mode with headed browser, overlay, Markdown/HTML reporting, and the `window.__taloxEmit__` bridge so you can annotate interactions while the agent runs.
175+
- `node dist/cli/talox.js init` (aka the `create-talox-app` workflow) scaffolds a clean `talox-app` starter project with `PRESETS.observe`, `ts-node`/`typescript` tooling, Playwright install scripts, and `examples/browser-lab.ts`.
163176
- Exported presets (`ops`, `qa`, `observe`, `research`, `login-heavy`) live in `src/presets.ts` so you can reuse curated verbosity, headedness, and human-takeover posture with a single spread or merge.
164177
- The practical tools from `getPracticalTools(talox)` demonstrate background tabs, API response capture, Markdown snapshot export, on-site search, and visible structured content extraction, so your packaged profiles already include actionable browser lab helpers.
165178

@@ -169,7 +182,7 @@ See [examples/minimal-agent.ts](./examples/minimal-agent.ts) for a copy-paste st
169182

170183
- launches `PRESETS.observe` with headed overlay/recording enabled,
171184
- exercises every practical tool (background tab, API capture, Markdown snapshot, search, structured content), and
172-
- writes the generated Markdown/JSON report artifacts into `talox-sessions/` (useful as a sanity check after `npm install` + `npx playwright install chromium`).
185+
- writes the generated Markdown/JSON report artifacts into `talox-sessions/` (useful as a sanity check after `npm install && npm run build` + `npx playwright install chromium`).
173186

174187
Run the demo to validate the packaged presets, tools, and reporting output in one headed experiment.
175188

@@ -599,7 +612,8 @@ await talox.evaluate(`window.__taloxEmit__('session:end', {})`);
599612
If you just want to launch an ad-hoc observe session, the bundled CLI makes it one command:
600613

601614
```bash
602-
npx talox observe --profile my-observe-run --class qa --browser chromium --output-dir ./talox-sessions --format both
615+
# From the repo (npm package coming soon)
616+
node dist/cli/talox.js observe --profile my-observe-run --class qa --browser chromium --output-dir ./talox-sessions --format both
603617
```
604618

605619
That command opens a headed Chromium session with the overlay + annotation buffer already armed, logs console/network errors, and writes JSON/Markdown reports. Run `talox observe --help` to tune the profile class, browser, verbosity, or report directory without touching code.

0 commit comments

Comments
 (0)