@nikelyh/offscript 1.0.0 → 1.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.
Files changed (6) hide show
  1. package/README.md +46 -11
  2. package/dist/studio/assets/index-DMnHlGCr.js +9 -0
  3. package/dist/studio/index.html +1 -1
  4. package/offscript.mjs +102 -28
  5. package/package.json +1 -1
  6. package/dist/studio/assets/index-uXpu7a13.js +0 -9
package/README.md CHANGED
@@ -1,7 +1,14 @@
1
1
  # OFFSCRIPT
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/@nikelyh/offscript.svg)](https://www.npmjs.com/package/@nikelyh/offscript)
4
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5
+ [![Documentation](https://img.shields.io/badge/Docs-offscript.nikelyh.tech-teal)](https://offscript.nikelyh.tech)
6
+
3
7
  **Your users don't follow a script. Neither do ours.**
4
8
 
9
+ Current stable release: **v1.0.1** on [npm](https://www.npmjs.com/package/@nikelyh/offscript).
10
+ Online documentation: [offscript.nikelyh.tech](https://offscript.nikelyh.tech).
11
+
5
12
  OFFSCRIPT brings multi-agent software exploration into a local developer workflow: configure a target and goal, choose artificial users, run a bounded session, and inspect observations, investigations and visual evidence in Studio or the terminal.
6
13
 
7
14
  **Execution mode:** The default browser execution uses deterministic decisions, not live autonomous reasoning. Live inference is currently available only through the separate, opt-in controlled-cart demo.
@@ -16,15 +23,42 @@ OFFSCRIPT brings multi-agent software exploration into a local developer workflo
16
23
 
17
24
  Six behavioral profiles are available: Explorer/Raven, Impatient/Fox, Beginner/Compass, Regular/Sparrow, Meticulous/Owl and Distrustful/Badger. Their instructions express different tendencies; the default scripted runner does not demonstrate those differences. An observation or an assigned collaborator is not a confirmed defect.
18
25
 
19
- ## Run from npm
26
+ ## Installation & Quick start
27
+
28
+ ### Install via npm (Recommended)
20
29
 
21
- From your target project's directory, using Node.js 24 or later and npm 11.19 or later:
30
+ Requires Node.js 24 or later and npm 11.19 or later.
22
31
 
23
32
  ```sh
24
- npx --yes @nikelyh/offscript@1.0.0 studio
33
+ npm install -g @nikelyh/offscript
25
34
  ```
26
35
 
27
- Studio starts locally; it does not start your target application or agents automatically. Use the matching Chromium installation instructions below before starting browser exploration.
36
+ Or run directly with `npx`:
37
+
38
+ ```sh
39
+ npx --yes @nikelyh/offscript@1.0.1 studio
40
+ ```
41
+
42
+ For browser exploration, install the required Chromium binary:
43
+
44
+ ```sh
45
+ npx playwright install chromium
46
+ ```
47
+
48
+ ### Launch Studio
49
+
50
+ In your target project's root directory:
51
+
52
+ ```sh
53
+ offscript studio
54
+ ```
55
+
56
+ Studio starts locally on a loopback port and opens the secure entry file in your browser. (Use `offscript studio --no-open` to print the entry link without launching the browser automatically).
57
+
58
+ 1. Start your web application separately (e.g. at `http://localhost:5173`).
59
+ 2. In Studio, select **New simulation**.
60
+ 3. Enter your target URL and exploration goal, pick your user profiles, and save.
61
+ 4. Run the simulation and inspect observations, investigations, and visual evidence.
28
62
 
29
63
  ## Quick start from source
30
64
 
@@ -76,10 +110,10 @@ From the OFFSCRIPT checkout:
76
110
  npm pack
77
111
  ```
78
112
 
79
- This builds `nikelyh-offscript-1.0.0.tgz`. From your target project's directory:
113
+ This builds `nikelyh-offscript-1.0.1.tgz`. From your target project's directory:
80
114
 
81
115
  ```sh
82
- npm exec --yes --package="/absolute/path/nikelyh-offscript-1.0.0.tgz" -- offscript studio
116
+ npm exec --yes --package="/absolute/path/nikelyh-offscript-1.0.1.tgz" -- offscript studio
83
117
  ```
84
118
 
85
119
  The current directory becomes the project root. Use a real absolute archive path; Windows paths are supported. npm installs dependencies in its execution cache without adding OFFSCRIPT to the target's package manifest. The first run can need network access and native dependency setup.
@@ -104,7 +138,8 @@ Arguments follow the executable in an installed package, or `npm start --` in th
104
138
  | `offscript list` | List saved project configurations. |
105
139
  | `offscript results <id>` | Show observations, investigations and finding assessments. |
106
140
  | `offscript recover <id> [--cancel]` | Explicitly resolve an interrupted run; does not resume agents. |
107
- | `offscript --help` / `--version` | Print information without starting the host or creating storage. |
141
+ | `offscript help [command]` | Print detailed help and option descriptions for any command. |
142
+ | `offscript --help` / `--version` | Print general information without starting the host or creating storage. |
108
143
 
109
144
  Common options: `--project <directory>`, `--port <number>` (0 selects an available port), and `--data-directory <directory>` (relative to the target). Flags override the documented `OFFSCRIPT_*` environment values. The installation directory never determines the target project.
110
145
 
@@ -133,8 +168,8 @@ These are explanatory diagrams, not captured evidence of live model behavior. Ed
133
168
 
134
169
  | Symptom | Check |
135
170
  | --- | --- |
136
- | `Distribution is missing` | Run `npm run build:local` in the checkout, or rebuild/reinstall the archive. |
137
- | Chromium executable missing | Install the matching browser as described above. |
171
+ | `Distribution is missing` | Run `npm install -g @nikelyh/offscript` or `npm run build:local` in the checkout. |
172
+ | Chromium executable missing | Install Chromium using `npx playwright install chromium`. |
138
173
  | `401` when entering Studio | Open the current host's printed HTML entry; an old entry/session does not authenticate a restarted host. |
139
174
  | Connection check fails | Start the target separately; verify its actual URL/port. Checks currently support loopback targets. |
140
175
  | `ENOSPC` during install/pack | Free space on the project, npm-cache and browser-cache volumes, then retry. Do not delete project `.offscript` data to repair packaging. |
@@ -142,8 +177,8 @@ These are explanatory diagrams, not captured evidence of live model behavior. Ed
142
177
 
143
178
  ## Documentation and contributing
144
179
 
145
- [Architecture](https://github.com/yohanvillarp/offscript/blob/main/docs/ARCHITECTURE.md) · [Browser adapter](https://github.com/yohanvillarp/offscript/blob/main/docs/BROWSER-INTERACTION.md) · [Mozaik integration](https://github.com/yohanvillarp/offscript/blob/main/docs/MOZAIK-INTEGRATION.md) · [Known limits](https://github.com/yohanvillarp/offscript/blob/main/docs/CONSOLIDATION.md) · [Roadmap](https://github.com/yohanvillarp/offscript/blob/main/docs/ROADMAP.md) · [Contributing](https://github.com/yohanvillarp/offscript/blob/main/CONTRIBUTING.md)
180
+ [Official Documentation](https://offscript.nikelyh.tech) · [Architecture](https://github.com/yohanvillarp/offscript/blob/main/docs/ARCHITECTURE.md) · [Browser adapter](https://github.com/yohanvillarp/offscript/blob/main/docs/BROWSER-INTERACTION.md) · [Mozaik integration](https://github.com/yohanvillarp/offscript/blob/main/docs/MOZAIK-INTEGRATION.md) · [Known limits](https://github.com/yohanvillarp/offscript/blob/main/docs/CONSOLIDATION.md) · [Roadmap](https://github.com/yohanvillarp/offscript/blob/main/docs/ROADMAP.md) · [Contributing](https://github.com/yohanvillarp/offscript/blob/main/CONTRIBUTING.md)
146
181
 
147
- The planned documentation site is **offscript.nikelyh.tech**; it is not deployed by this package. Development commands, checks and the separate public-release plan are documented in the repository. No browser or live model call is required for reading the guides.
182
+ Visit the documentation portal at **[offscript.nikelyh.tech](https://offscript.nikelyh.tech)**. Development commands, checks and release notes are documented in the repository. No browser or live model call is required for reading the guides.
148
183
 
149
184
  Apache-2.0. See [LICENSE](https://github.com/yohanvillarp/offscript/blob/main/LICENSE) and [third-party notices](https://github.com/yohanvillarp/offscript/blob/main/THIRD_PARTY_NOTICES.md). Studio's bundled fonts retain their SIL Open Font License texts in the archive.