@promptbook/wizard 0.112.0-16 → 0.112.0-17

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
@@ -2,7 +2,7 @@
2
2
 
3
3
  # ✨ Promptbook: AI Agents
4
4
 
5
- Turn your company's scattered knowledge into AI ready Books
5
+ Create persistent AI agents that turn your company's scattered knowledge into action powered by the [Agents Server](https://gallery.ptbk.io/)
6
6
 
7
7
 
8
8
 
@@ -72,11 +72,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
72
72
 
73
73
  ## 📖 The Book Whitepaper
74
74
 
75
+ Promptbook lets you create **persistent AI agents** that work on real goals for your company. The [**Agents Server**](https://gallery.ptbk.io/) is the heart of the project — a place where your AI agents live, remember context, collaborate in teams, and get things done.
76
+
75
77
  Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as GPT-5.2 and Claude-4.5 are incredibly capable.
76
78
 
77
79
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
78
80
 
79
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
81
+ In Promptbook, you define your agents **using simple Books** — a human-readable language that is explicit, easy to understand and write, reliable, and highly portable. You then deploy them to the **Agents Server**, where they run persistently and work toward their goals.
80
82
 
81
83
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
82
84
 
@@ -84,8 +86,13 @@ In Promptbook, you can define your context **using simple Books** that are very
84
86
  <br/>
85
87
  **PERSONA** You are a company lawyer.<br/>
86
88
  Your job is to provide legal advice and support to the company and its employees.<br/>
89
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
87
90
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
88
- TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
91
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
92
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
93
+ **USE EMAIL**<br/>
94
+ **USE BROWSER**<br/>
95
+ **TEAM** You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
89
96
 
90
97
  </td></tr></table>
91
98
 
@@ -108,6 +115,22 @@ Personas define the character of your AI persona, its role, and how it should in
108
115
  **<ins>Paul Smith & Associés</ins>**<br/>
109
116
  <br/>
110
117
  **PERSONA** You are a company lawyer.<br/>
118
+ Your job is to provide legal advice and support to the company and its employees.<br/>
119
+
120
+ </td></tr></table>
121
+
122
+ #### `Goal` commitment
123
+
124
+ Goals define what the agent should actively work toward. Unlike a chatbot that only responds when asked, an agent with goals takes initiative and works on tasks persistently on the Agents Server.
125
+
126
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
127
+
128
+ **<ins>Paul Smith & Associés</ins>**<br/>
129
+ <br/>
130
+ **PERSONA** You are a company lawyer.<br/>
131
+ Your job is to provide legal advice and support to the company and its employees.<br/>
132
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
133
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
111
134
 
112
135
  </td></tr></table>
113
136
 
@@ -125,9 +148,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
125
148
  <br/>
126
149
  **PERSONA** You are a company lawyer.<br/>
127
150
  Your job is to provide legal advice and support to the company and its employees.<br/>
128
- You are knowledgeable, professional, and detail-oriented.<br/>
129
- <br/>
130
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
151
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
152
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
153
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
131
154
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
132
155
 
133
156
  </td></tr></table>
@@ -144,13 +167,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
144
167
  <br/>
145
168
  **PERSONA** You are a company lawyer.<br/>
146
169
  Your job is to provide legal advice and support to the company and its employees.<br/>
147
- You are knowledgeable, professional, and detail-oriented.<br/>
170
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
171
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
172
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
173
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
174
+ **RULE** Never provide legal advice about criminal law.<br/>
175
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
176
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
177
+
178
+ </td></tr></table>
179
+
180
+ #### `Use` commitments
181
+
182
+ Use commitments grant the agent real capabilities — tools it can use to interact with the outside world. `USE EMAIL` lets the agent send emails, `USE BROWSER` lets it access and read web content, `USE SEARCH ENGINE` lets it search the web, and many more.
183
+
184
+ These are what turn a chatbot into a persistent agent that actually does work.
185
+
186
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
187
+
188
+ **<ins>Paul Smith & Associés</ins>**<br/>
148
189
  <br/>
149
- **RULE** Always ensure compliance with laws and regulations.<br/>
190
+ **PERSONA** You are a company lawyer.<br/>
191
+ Your job is to provide legal advice and support to the company and its employees.<br/>
192
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
193
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
194
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
150
195
  **RULE** Never provide legal advice outside your area of expertise.<br/>
151
196
  **RULE** Never provide legal advice about criminal law.<br/>
152
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
197
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
153
198
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
199
+ **USE EMAIL**<br/>
200
+ **USE BROWSER**<br/>
201
+ **USE SEARCH ENGINE**<br/>
154
202
 
155
203
  </td></tr></table>
156
204
 
@@ -164,32 +212,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
164
212
  <br/>
165
213
  **PERSONA** You are a company lawyer.<br/>
166
214
  Your job is to provide legal advice and support to the company and its employees.<br/>
167
- You are knowledgeable, professional, and detail-oriented.<br/>
168
- <br/>
169
- **RULE** Always ensure compliance with laws and regulations.<br/>
215
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
216
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
217
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
170
218
  **RULE** Never provide legal advice outside your area of expertise.<br/>
171
219
  **RULE** Never provide legal advice about criminal law.<br/>
172
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
220
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
173
221
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
174
- TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
222
+ **USE EMAIL**<br/>
223
+ **USE BROWSER**<br/>
224
+ **USE SEARCH ENGINE**<br/>
225
+ **TEAM** You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
175
226
 
176
227
  </td></tr></table>
177
228
 
178
-
179
-
180
229
  ### Promptbook Ecosystem
181
230
 
182
- !!!@@@
231
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
183
232
 
184
- #### Promptbook Server
233
+ #### Agents Server
185
234
 
186
- !!!@@@
235
+ The [**Agents Server**](https://gallery.ptbk.io/) is the primary way to use Promptbook. It is a web application where your AI agents live and work. You can create agents, give them knowledge and rules using the Book language, organize them into teams, and let them work on goals persistently. The Agents Server provides a UI for managing agents, an API for integrating them into your applications, and can be self-hosted via [Docker](https://hub.docker.com/r/hejny/promptbook/) or deployed on Vercel.
187
236
 
188
237
  #### Promptbook Engine
189
238
 
190
- !!!@@@
191
-
192
-
239
+ The [Promptbook Engine](https://github.com/webgptorg/promptbook) is the open-source core that powers everything. It parses the Book language, applies commitments, manages LLM provider integrations, and executes agents. The Agents Server is built on top of the Engine. If you need to embed agent capabilities directly into your own application, you can use the Engine as a standalone TypeScript/JavaScript library via [NPM packages](https://www.npmjs.com/package/@promptbook/core).
193
240
 
194
241
 
195
242
 
@@ -203,7 +250,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
203
250
 
204
251
  ## 💜 The Promptbook Project
205
252
 
206
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
253
+ Promptbook project is an ecosystem centered around the **Agents Server** — a platform for creating, deploying, and running persistent AI agents. Following is a list of the most important pieces of the project:
207
254
 
208
255
  <table>
209
256
  <thead>
@@ -214,9 +261,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
214
261
  </thead>
215
262
  <tbody>
216
263
  <tr>
217
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
264
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
218
265
  <td>
219
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
266
+ The primary way to use Promptbook. A production-ready platform where your AI agents live create, manage, deploy, and interact with persistent agents that work on goals. Available as a hosted service or <a href="https://hub.docker.com/r/hejny/promptbook/">self-hosted via Docker</a>.
220
267
  </td>
221
268
  </tr>
222
269
  <tr>
@@ -230,17 +277,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
230
277
  <tr>
231
278
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
232
279
  <td>
233
- Promptbook engine can run AI agents based on Book language.
234
- It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Promptbook Agent Server as Docker Package</a>
235
- Agent Server is based on Promptbook Engine.
280
+ The open-source core that powers the Agents Server. Can also be used as a standalone TypeScript/JavaScript library to embed agent capabilities into your own applications.
281
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
236
282
  </td>
237
283
  </tr>
238
284
 
239
285
  </tbody>
240
286
  </table>
241
287
 
242
-
243
-
244
288
  ### 🌐 Community & Social Media
245
289
 
246
290
  Join our growing community of developers and users:
@@ -297,8 +341,6 @@ Join our growing community of developers and users:
297
341
 
298
342
 
299
343
 
300
-
301
-
302
344
  ## 📚 Documentation
303
345
 
304
346
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -307,9 +349,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
307
349
 
308
350
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
309
351
 
310
- ## 📦 Packages _(for developers)_
352
+ ## 📦 Deployment & Packages
353
+
354
+ The fastest way to get started is with the **Agents Server**:
311
355
 
312
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
356
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
357
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
358
+
359
+ ### NPM Packages _(for developers embedding the Engine)_
360
+
361
+ If you want to embed the Promptbook Engine directly into your application, the library is divided into several packages published from a [single monorepo](https://github.com/webgptorg/promptbook).
313
362
  You can install all of them at once:
314
363
 
315
364
  ```bash
@@ -328,7 +377,6 @@ Or you can install them separately:
328
377
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
329
378
  - ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
330
379
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
331
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
332
380
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
333
381
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
334
382
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -350,8 +398,7 @@ Or you can install them separately:
350
398
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
351
399
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
352
400
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
353
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
354
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
401
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
355
402
 
356
403
 
357
404
 
@@ -375,8 +422,6 @@ The following glossary is used to clarify certain concepts:
375
422
 
376
423
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
377
424
 
378
-
379
-
380
425
  ### 💯 Core concepts
381
426
 
382
427
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -438,31 +483,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
438
483
 
439
484
 
440
485
 
486
+ ## � Agents Server
487
+
488
+ The **[Agents Server](https://gallery.ptbk.io/)** is the primary way to use Promptbook. It is a production-ready platform where you create, deploy, and manage persistent AI agents that work toward goals. Agents remember context across conversations, collaborate in teams, and follow the rules and knowledge you define in the Book language.
489
+
490
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
491
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
492
+ - **API** for integrating agents into your own applications
493
+
441
494
  ## 🚂 Promptbook Engine
442
495
 
496
+ The Engine is the open-source core that powers the Agents Server. If you need to embed agent capabilities directly into your TypeScript/JavaScript application, you can use it as a standalone library.
497
+
443
498
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
444
499
 
445
500
  ## ➕➖ When to use Promptbook?
446
501
 
447
502
  ### ➕ When to use
448
503
 
449
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
450
- - When you want to **separate code from text prompts**
451
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
452
- - When you want to **orchestrate multiple prompts** together
453
- - When you want to **reuse** parts of prompts in multiple places
454
- - When you want to **version** your prompts and **test multiple versions**
455
- - When you want to **log** the execution of prompts and backtrace the issues
504
+ - When you want to **deploy persistent AI agents** that work on goals for your company
505
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
506
+ - When you want agents that **collaborate in teams** and consult each other
507
+ - When you need to **integrate AI agents into your existing applications** via API
508
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
509
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
510
+ - When you want to **version** your agent definitions and **test multiple versions**
511
+ - When you want to **log** agent execution and backtrace issues
456
512
 
457
513
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
458
514
 
459
515
  ### ➖ When not to use
460
516
 
461
- - When you have already implemented single simple prompt and it works fine for your job
517
+ - When a single simple prompt already works fine for your job
462
518
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
463
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
519
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
464
520
  - When you need to use something other than JavaScript or TypeScript _(other languages are on the way, [see the discussion](https://github.com/webgptorg/promptbook/discussions/101))_
465
- - When your main focus is on something other than text - like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
521
+ - When your main focus is on something other than text like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
466
522
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
467
523
 
468
524
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -38,7 +38,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
38
38
  * @generated
39
39
  * @see https://github.com/webgptorg/promptbook
40
40
  */
41
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
41
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
42
42
  /**
43
43
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
44
44
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.112.0-15`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/wizard",
3
- "version": "0.112.0-16",
3
+ "version": "0.112.0-17",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -98,7 +98,7 @@
98
98
  "module": "./esm/index.es.js",
99
99
  "typings": "./esm/typings/src/_packages/wizard.index.d.ts",
100
100
  "peerDependencies": {
101
- "@promptbook/core": "0.112.0-16"
101
+ "@promptbook/core": "0.112.0-17"
102
102
  },
103
103
  "dependencies": {
104
104
  "@ai-sdk/deepseek": "0.1.17",
package/umd/index.umd.js CHANGED
@@ -49,7 +49,7 @@
49
49
  * @generated
50
50
  * @see https://github.com/webgptorg/promptbook
51
51
  */
52
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
52
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
53
53
  /**
54
54
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
55
55
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.112.0-15`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */