@promptbook/cli 0.44.0-20 → 0.44.0-21
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 +48 -0
- package/esm/index.es.js +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +1 -1
package/README.md
CHANGED
|
@@ -8,10 +8,42 @@ Library to supercharge your use of large language models
|
|
|
8
8
|
[](https://github.com/webgptorg/promptbook/blob/main/LICENSE)
|
|
9
9
|
[](https://snyk.io/test/github/webgptorg/promptbook)
|
|
10
10
|
[](https://github.com/webgptorg/promptbook/issues)
|
|
11
|
+
[](https://socket.dev/npm/package/@promptbook/cli)
|
|
11
12
|
|
|
12
13
|
<!--/Badges-->
|
|
13
14
|
|
|
15
|
+
## 📦 Package `@promptbook/cli`
|
|
16
|
+
|
|
17
|
+
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
18
|
+
- This package `@promptbook/cli` is one part of the promptbook ecosystem.
|
|
19
|
+
|
|
20
|
+
To install this package, run:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# Install as dev dependency
|
|
24
|
+
npm i -D @promptbook/cli
|
|
25
|
+
|
|
26
|
+
# Or install globally
|
|
27
|
+
npm i -g @promptbook/cli
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
CLI utils for Promptbook. After install you can use `promptbook` command in terminal:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npx promptbook prettify promptbook/**/*.ptbk.md
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This will prettify all promptbooks in `promptbook` directory and adds Mermaid graphs to them.
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
Rest of the documentation is common for entire promptbook ecosystem:
|
|
42
|
+
|
|
43
|
+
<!--
|
|
44
|
+
TODO: Probbably remove this section only in packages
|
|
14
45
|
> ⚠ Warning: This library is still in early development.
|
|
46
|
+
-->
|
|
15
47
|
|
|
16
48
|
## 🤍 Whitepaper
|
|
17
49
|
|
|
@@ -282,6 +314,22 @@ flowchart LR
|
|
|
282
314
|
|
|
283
315
|
_Note: We are using [postprocessing functions](#postprocessing-functions) like `unwrapResult` that can be used to postprocess the result._
|
|
284
316
|
|
|
317
|
+
## 📦 Packages
|
|
318
|
+
|
|
319
|
+
This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook):
|
|
320
|
+
|
|
321
|
+
<!--[🔠]-->
|
|
322
|
+
|
|
323
|
+
- **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
|
|
324
|
+
- **[@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
|
|
325
|
+
- _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
|
|
326
|
+
- **[@promptbook/execute-javascript](https://www.npmjs.com/package/@promptbook/execute-javascript)** - Execution tools for javascript inside promptbooks
|
|
327
|
+
- **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
|
|
328
|
+
- **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
|
|
329
|
+
- **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
|
|
330
|
+
- **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
|
|
331
|
+
- **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
|
|
332
|
+
|
|
285
333
|
## 📚 Dictionary
|
|
286
334
|
|
|
287
335
|
The following glossary is used to clarify certain basic concepts:
|
package/esm/index.es.js
CHANGED
|
@@ -143,7 +143,7 @@ new Function("\n try {\n if (typeof WorkerGlobalScope !== 'undefined'
|
|
|
143
143
|
/**
|
|
144
144
|
* The version of the Promptbook library
|
|
145
145
|
*/
|
|
146
|
-
var PROMPTBOOK_VERSION = '0.44.0-
|
|
146
|
+
var PROMPTBOOK_VERSION = '0.44.0-20';
|
|
147
147
|
|
|
148
148
|
/**
|
|
149
149
|
* This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/cli",
|
|
3
|
-
"version": "0.44.0-
|
|
3
|
+
"version": "0.44.0-21",
|
|
4
4
|
"description": "Library to supercharge your use of large language models",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"waitasecond": "1.11.33"
|
|
43
43
|
},
|
|
44
44
|
"peerDependencies": {
|
|
45
|
-
"@promptbook/core": "0.44.0-
|
|
45
|
+
"@promptbook/core": "0.44.0-21"
|
|
46
46
|
},
|
|
47
47
|
"main": "./umd/index.umd.js",
|
|
48
48
|
"module": "./esm/index.es.js",
|
package/umd/index.umd.js
CHANGED
|
@@ -146,7 +146,7 @@
|
|
|
146
146
|
/**
|
|
147
147
|
* The version of the Promptbook library
|
|
148
148
|
*/
|
|
149
|
-
var PROMPTBOOK_VERSION = '0.44.0-
|
|
149
|
+
var PROMPTBOOK_VERSION = '0.44.0-20';
|
|
150
150
|
|
|
151
151
|
/**
|
|
152
152
|
* This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
|