@promptbook/cli 0.92.0 → 0.93.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.
package/README.md CHANGED
@@ -1,6 +1,8 @@
1
1
  <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
2
2
 
3
- # ✨ Promptbook
3
+ # ✨ Promptbook: AI apps in plain Language
4
+
5
+ Write AI applications using plain human language across multiple models and platforms.
4
6
 
5
7
 
6
8
 
@@ -8,18 +10,18 @@
8
10
  [![NPM Version of ![Promptbook logo - cube with letters P and B](./design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
9
11
  [![Quality of package ![Promptbook logo - cube with letters P and B](./design/logo-h1.png) Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
10
12
  [![Known Vulnerabilities](https://snyk.io/test/github/webgptorg/promptbook/badge.svg)](https://snyk.io/test/github/webgptorg/promptbook)
13
+ [![Build Status](https://github.com/webgptorg/promptbook/actions/workflows/ci.yml/badge.svg)](https://github.com/webgptorg/promptbook/actions)
14
+ [![Coverage Status](https://coveralls.io/repos/github/webgptorg/promptbook/badge.svg?branch=main)](https://coveralls.io/github/webgptorg/promptbook?branch=main)
11
15
  [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
12
16
 
13
17
 
14
18
 
15
-
16
-
17
19
  ## 🌟 New Features
18
20
 
19
- - 📂 We have plugin for [VSCode](https://github.com/webgptorg/book-extension) to support `.book` file extension
20
- - 🐳 Available [Docker image](https://hub.docker.com/r/hejny/promptbook/)
21
- - 💫 Support of [`o3-mini` model by OpenAI](https://openai.com/index/openai-o3-mini/)
22
- - 🐋 **Support of [DeepSeek models](https://www.npmjs.com/package/@promptbook/deepseek)**
21
+ - 💡 VS Code support for `.book` files with syntax highlighting and IntelliSense
22
+ - 🐳 Official Docker image (`hejny/promptbook`) for seamless containerized usage
23
+ - 🔥 Native support for OpenAI `o3-mini`, GPT-4 and other leading LLMs
24
+ - 🔍 DeepSeek integration for advanced knowledge search
23
25
 
24
26
 
25
27
 
@@ -177,65 +179,92 @@ Hello world examples:
177
179
  - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
178
180
  - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
179
181
 
182
+ ### 🌐 Community & Social Media
180
183
 
184
+ Join our growing community of developers and users:
181
185
 
182
- We also have a community of developers and users of **Promptbook**:
183
-
184
- - [Discord community](https://discord.gg/x3QWNaa89N)
185
- - [Landing page `ptbk.io`](https://ptbk.io)
186
- - [Github discussions](https://github.com/webgptorg/promptbook/discussions)
187
- - [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
188
- - [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
189
-
190
- And **Promptbook.studio** branded socials:
191
-
192
-
193
-
194
- - [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
195
-
196
- And **Promptujeme** sub-brand:
197
-
198
- _/Subbrand for Czech clients/_
199
-
200
-
186
+ <table>
187
+ <thead>
188
+ <tr>
189
+ <th>Platform</th>
190
+ <th>Description</th>
191
+ </tr>
192
+ </thead>
193
+ <tbody>
194
+ <tr>
195
+ <td><a href="https://discord.gg/x3QWNaa89N">💬 Discord</a></td>
196
+ <td>Join our active developer community for discussions and support</td>
197
+ </tr>
198
+ <tr>
199
+ <td><a href="https://github.com/webgptorg/promptbook/discussions">🗣️ GitHub Discussions</a></td>
200
+ <td>Technical discussions, feature requests, and community Q&A</td>
201
+ </tr>
202
+ <tr>
203
+ <td><a href="https://linkedin.com/company/promptbook">👔 LinkedIn</a></td>
204
+ <td>Professional updates and industry insights</td>
205
+ </tr>
206
+ <tr>
207
+ <td><a href="https://www.facebook.com/61560776453536">📱 Facebook</a></td>
208
+ <td>General announcements and community engagement</td>
209
+ </tr>
210
+ <tr>
211
+ <td><a href="https://ptbk.io">🔗 ptbk.io</a></td>
212
+ <td>Official landing page with project information</td>
213
+ </tr>
214
+ </tbody>
215
+ </table>
201
216
 
217
+ ### 🖼️ Product & Brand Channels
202
218
 
203
- - [Promptujeme.cz](https://www.promptujeme.cz/)
204
- - [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
219
+ #### Promptbook.studio
205
220
 
206
- And **Promptbook.city** branded socials:
221
+ <table>
222
+ <tbody>
223
+ <tr>
224
+ <td><a href="https://www.instagram.com/promptbook.studio/">📸 Instagram @promptbook.studio</a></td>
225
+ <td>Visual updates, UI showcases, and design inspiration</td>
226
+ </tr>
227
+
228
+ </tbody>
229
+ </table>
207
230
 
208
- _/Sub-brand for images and graphics generated via Promptbook prompting/_
209
231
 
210
- - [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
211
- - [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
212
232
 
213
233
 
214
234
 
215
235
 
236
+ ## 📘 Book Language Blueprint
216
237
 
238
+ _A concise, Markdown-based DSL for crafting AI workflows and automations._
217
239
 
218
- ## 💙 The Book language
240
+ ---
219
241
 
242
+ ### 📑 Table of Contents
220
243
 
244
+ - [Introduction](#introduction)
245
+ - [Example](#example)
246
+ - [1. What: Workflows, Tasks & Parameters](#1-what-workflows-tasks--parameters)
247
+ - [2. Who: Personas](#2-who-personas)
248
+ - [3. How: Knowledge, Instruments & Actions](#3-how-knowledge-instruments-and-actions)
249
+ - [General Principles](#general-principles)
221
250
 
222
- Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
251
+ ### Introduction
223
252
 
224
- Book is a language that can be used to write AI applications, agents, workflows, automations, knowledgebases, translators, sheet processors, email automations and more. It allows you to harness the power of AI models in human-like terms, without the need to know the specifics and technicalities of the models.
253
+ Book is a Markdown-based language that simplifies the creation of AI applications, workflows, and automations. With human-readable commands, you can define inputs, outputs, personas, knowledge sources, and actions—without needing model-specific details.
225
254
 
226
255
  ### Example
227
256
 
228
- ```markdown
229
- # 🌟 My first Book
257
+ ```book
258
+ # 🌟 My First Book
230
259
 
231
260
  - BOOK VERSION 1.0.0
232
261
  - URL https://promptbook.studio/hello.book
233
262
  - INPUT PARAMETER {topic}
234
263
  - OUTPUT PARAMETER {article}
235
264
 
236
- # Write an article
265
+ # Write an Article
237
266
 
238
- - PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
267
+ - PERSONA Jane, marketing specialist with prior experience in tech and AI writing
239
268
  - KNOWLEDGE https://wikipedia.org/
240
269
  - KNOWLEDGE ./journalist-ethics.pdf
241
270
  - EXPECT MIN 1 Sentence
@@ -243,20 +272,20 @@ Book is a language that can be used to write AI applications, agents, workflows,
243
272
 
244
273
  > Write an article about {topic}
245
274
 
246
- -> {article}
275
+ {article}
247
276
  ```
248
277
 
249
278
  Each part of the book defines one of 3 circles:
250
279
 
251
- ### **What:** Workflows, Tasks and Parameters
280
+ ### **1. What:** Workflows, Tasks and Parameters
252
281
 
253
- What work needs to be done. Each book defines a [workflow *(scenario or pipeline)*](https://github.com/webgptorg/promptbook/discussions/88), which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.
282
+ What work needs to be done. Each book defines a [workflow _(scenario or pipeline)_](https://github.com/webgptorg/promptbook/discussions/88), which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.
254
283
 
255
284
  **Related commands:**
256
285
 
257
286
  - [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
258
287
 
259
- ### **Who:** Personas
288
+ ### **2. Who:** Personas
260
289
 
261
290
  Who does the work. Each task is performed by a persona. A persona is a description of your virtual employee. It is a higher abstraction than the model, tokens, temperature, top-k, top-p and other model parameters.
262
291
 
@@ -270,7 +299,7 @@ Personas can have access to different knowledge, tools and actions. They can als
270
299
 
271
300
 
272
301
 
273
- ### **How:** Knowledge, Instruments and Actions
302
+ ### **3. How:** Knowledge, Instruments and Actions
274
303
 
275
304
  The resources used by the personas are used to do the work.
276
305
 
@@ -280,7 +309,7 @@ The resources used by the personas are used to do the work.
280
309
  - [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md) for real-time data like time, location, weather, stock prices, searching the internet, calculations, etc.
281
310
  - [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
282
311
 
283
- ### General principles of book language
312
+ ### General Principles
284
313
 
285
314
  Book language is based on markdown. It is subset of markdown. It is designed to be easy to read and write. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
286
315
 
@@ -294,6 +323,10 @@ But unlike programming languages, it is designed to be understandable by non-pro
294
323
 
295
324
 
296
325
 
326
+ ## 📚 Documentation
327
+
328
+ See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
329
+
297
330
  ## 🔒 Security
298
331
 
299
332
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
@@ -374,25 +407,56 @@ _Note: This section is not complete dictionary, more list of general AI / LLM te
374
407
  - [🤼 Personas](https://github.com/webgptorg/promptbook/discussions/22)
375
408
  - [⭕ Parameters](https://github.com/webgptorg/promptbook/discussions/83)
376
409
  - [🚀 Pipeline execution](https://github.com/webgptorg/promptbook/discussions/84)
377
- - [🧪 Expectations](https://github.com/webgptorg/promptbook/discussions/30)
378
- - [✂️ Postprocessing](https://github.com/webgptorg/promptbook/discussions/31)
379
- - [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
380
- - [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
410
+ - [🧪 Expectations](https://github.com/webgptorg/promptbook/discussions/30) - Define what outputs should look like and how they're validated
411
+ - [✂️ Postprocessing](https://github.com/webgptorg/promptbook/discussions/31) - How outputs are refined after generation
412
+ - [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29) - The human-friendly way to think about text generation
413
+ - [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32) - How Book language organizes different aspects of AI workflows
381
414
 
382
- #### Advanced concepts
415
+ ### Advanced concepts
416
+
417
+ <table>
418
+ <tr>
419
+ <th>Data & Knowledge Management</th>
420
+ <th>Pipeline Control</th>
421
+ </tr>
422
+ <tr>
423
+ <td>
424
+ <ul>
425
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/41">📚 Knowledge (RAG)</a> - Retrieve and use external information</li>
426
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/54">📽 Media handling</a> - Working with images, audio, video, spreadsheets</li>
427
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/40">🔴 Anomaly detection</a> - Identifying unusual patterns or outputs</li>
428
+ </ul>
429
+ </td>
430
+ <td>
431
+ <ul>
432
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/89">🌏 Remote server</a> - Executing workflows on remote infrastructure</li>
433
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/66">🃏 Jokers (conditions)</a> - Adding conditional logic to workflows</li>
434
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/35">🔳 Metaprompting</a> - Creating prompts that generate other prompts</li>
435
+ </ul>
436
+ </td>
437
+ </tr>
438
+ <tr>
439
+ <th>Language & Output Control</th>
440
+ <th>Advanced Generation</th>
441
+ </tr>
442
+ <tr>
443
+ <td>
444
+ <ul>
445
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/53">🌏 Linguistically typed languages</a> - Type systems for natural language</li>
446
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/42">🌍 Auto-Translations</a> - Automatic multilingual support</li>
447
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/39">👮 Agent adversary expectations</a> - Safety and control mechanisms</li>
448
+ </ul>
449
+ </td>
450
+ <td>
451
+ <ul>
452
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/37">🔙 Expectation-aware generation</a> - Outputs that meet defined criteria</li>
453
+ <li><a href="https://github.com/webgptorg/promptbook/discussions/33">⏳ Just-in-time fine-tuning</a> - Dynamic model adaptation</li>
454
+ </ul>
455
+ </td>
456
+ </tr>
457
+ </table>
383
458
 
384
- - [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
385
- - [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
386
- - [🃏 Jokers (conditions)](https://github.com/webgptorg/promptbook/discussions/66)
387
- - [🔳 Metaprompting](https://github.com/webgptorg/promptbook/discussions/35)
388
- - [🌏 Linguistically typed languages](https://github.com/webgptorg/promptbook/discussions/53)
389
- - [🌍 Auto-Translations](https://github.com/webgptorg/promptbook/discussions/42)
390
- - [📽 Images, audio, video, spreadsheets](https://github.com/webgptorg/promptbook/discussions/54)
391
- - [🔙 Expectation-aware generation](https://github.com/webgptorg/promptbook/discussions/37)
392
- - [⏳ Just-in-time fine-tuning](https://github.com/webgptorg/promptbook/discussions/33)
393
- - [🔴 Anomaly detection](https://github.com/webgptorg/promptbook/discussions/40)
394
- - [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
395
- - [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
459
+ <p align="center"><a href="https://github.com/webgptorg/promptbook/discussions/categories/concepts">🔍 View more concepts</a></p>
396
460
 
397
461
 
398
462
 
@@ -447,36 +511,28 @@ If you have a question [start a discussion](https://github.com/webgptorg/promptb
447
511
  - [❔ Is Promptbook using RAG _(Retrieval-Augmented Generation)_?](https://github.com/webgptorg/promptbook/discussions/123)
448
512
  - [❔ Is Promptbook using function calling?](https://github.com/webgptorg/promptbook/discussions/124)
449
513
 
450
- ## Changelog
514
+ ## 📅 Changelog
451
515
 
452
516
  See [CHANGELOG.md](./CHANGELOG.md)
453
517
 
454
518
  ## 📜 License
455
519
 
456
- Promptbook project is under [BUSL 1.1 is an SPDX license](https://spdx.org/licenses/BUSL-1.1.html)
520
+ This project is licensed under [BUSL 1.1](./LICENSE.md).
457
521
 
458
- ## 🎯 Todos
522
+ ## 🤝 Contributing
459
523
 
460
- See [TODO.md](./TODO.md)
524
+ We welcome contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
461
525
 
462
- ## 🤝 Partners
463
-
464
- <div style="display: flex; align-items: center; gap: 20px;">
465
-
466
- <a href="https://promptbook.studio/">
467
- <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
468
- </a>
469
-
470
- <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
471
- <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
472
- </a>
473
-
474
- </div>
526
+ You can also ⭐ star the project, [follow us on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).We are open to [pull requests, feedback, and suggestions](./CONTRIBUTING.md).
475
527
 
476
- ## 🖋️ Contributing
528
+ ## 🆘 Support & Community
477
529
 
478
- You can also star the project, [follow us on GitHub](https://github.com/hejny) or [various other social networks](https://www.pavolhejny.com/contact/).We are open to [pull requests, feedback, and suggestions](./CONTRIBUTING.md).
530
+ Need help with Book language? We're here for you!
479
531
 
480
- ## 📞 Support
532
+ - 💬 [Join our Discord community](https://discord.gg/x3QWNaa89N) for real-time support
533
+ - 📝 [Browse our GitHub discussions](https://github.com/webgptorg/promptbook/discussions) for FAQs and community knowledge
534
+ - 🐛 [Report issues](https://github.com/webgptorg/book/issues) for bugs or feature requests
535
+ - 📚 Visit [ptbk.io](https://ptbk.io) for more resources and documentation
536
+ - 📧 Contact us directly through the channels listed in our [signpost](./SIGNPOST.md)
481
537
 
482
- If you need help or have questions, please check our [Support Resources](./SUPPORT.md).
538
+ We welcome contributions and feedback to make Book language better for everyone!
package/esm/index.es.js CHANGED
@@ -47,7 +47,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
47
47
  * @generated
48
48
  * @see https://github.com/webgptorg/promptbook
49
49
  */
50
- const PROMPTBOOK_ENGINE_VERSION = '0.92.0';
50
+ const PROMPTBOOK_ENGINE_VERSION = '0.93.0';
51
51
  /**
52
52
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
53
53
  * 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.92.0-35`).
18
+ * It follows semantic versioning (e.g., `0.92.0`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@promptbook/cli",
3
- "version": "0.92.0",
4
- "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
3
+ "version": "0.93.0",
4
+ "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
5
5
  "private": false,
6
6
  "sideEffects": false,
7
7
  "repository": {
package/umd/index.umd.js CHANGED
@@ -57,7 +57,7 @@
57
57
  * @generated
58
58
  * @see https://github.com/webgptorg/promptbook
59
59
  */
60
- const PROMPTBOOK_ENGINE_VERSION = '0.92.0';
60
+ const PROMPTBOOK_ENGINE_VERSION = '0.93.0';
61
61
  /**
62
62
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
63
63
  * Note: [💞] Ignore a discrepancy between file name and entity name