@promptbook/documents 0.112.0-46 → 0.112.0-47
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 +16 -16
- package/esm/index.es.js +2 -2
- package/esm/index.es.js.map +1 -1
- package/esm/src/avatars/AvatarOrImage.d.ts +45 -0
- package/esm/src/avatars/index.d.ts +1 -0
- package/esm/src/avatars/types/AvatarVisualDefinition.d.ts +6 -1
- package/esm/src/avatars/visuals/asciiOctopusAvatarVisual.d.ts +7 -0
- package/esm/src/avatars/visuals/octopus3AvatarVisual.d.ts +7 -0
- package/esm/src/avatars/visuals/octopusAvatarVisualShared.d.ts +125 -0
- package/esm/src/book-components/Chat/Chat/ChatMessageItem.d.ts +1 -1
- package/esm/src/book-components/Chat/Chat/ChatMessageList.d.ts +1 -1
- package/esm/src/book-components/Chat/Chat/ChatProps.d.ts +1 -1
- package/esm/src/book-components/Chat/Chat/ChatToolCallModalComponents.d.ts +8 -2
- package/esm/src/book-components/Chat/hooks/useChatCompleteNotification.d.ts +2 -0
- package/esm/src/book-components/Chat/types/ChatParticipant.d.ts +10 -0
- package/esm/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts +1 -1
- package/esm/src/config.d.ts +2 -2
- package/esm/src/llm-providers/agent/RemoteAgent.d.ts +3 -0
- package/esm/src/utils/agents/resolveAgentAvatarImageUrl.d.ts +49 -5
- package/esm/src/utils/agents/resolveAgentAvatarImageUrl.test.d.ts +1 -0
- package/esm/src/version.d.ts +1 -1
- package/package.json +3 -3
- package/umd/index.umd.js +2 -2
- package/umd/index.umd.js.map +1 -1
- package/umd/src/avatars/AvatarOrImage.d.ts +45 -0
- package/umd/src/avatars/index.d.ts +1 -0
- package/umd/src/avatars/types/AvatarVisualDefinition.d.ts +6 -1
- package/umd/src/avatars/visuals/asciiOctopusAvatarVisual.d.ts +7 -0
- package/umd/src/avatars/visuals/octopus3AvatarVisual.d.ts +7 -0
- package/umd/src/avatars/visuals/octopusAvatarVisualShared.d.ts +125 -0
- package/umd/src/book-components/Chat/Chat/ChatMessageItem.d.ts +1 -1
- package/umd/src/book-components/Chat/Chat/ChatMessageList.d.ts +1 -1
- package/umd/src/book-components/Chat/Chat/ChatProps.d.ts +1 -1
- package/umd/src/book-components/Chat/Chat/ChatToolCallModalComponents.d.ts +8 -2
- package/umd/src/book-components/Chat/hooks/useChatCompleteNotification.d.ts +2 -0
- package/umd/src/book-components/Chat/types/ChatParticipant.d.ts +10 -0
- package/umd/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts +1 -1
- package/umd/src/config.d.ts +2 -2
- package/umd/src/llm-providers/agent/RemoteAgent.d.ts +3 -0
- package/umd/src/utils/agents/resolveAgentAvatarImageUrl.d.ts +49 -5
- package/umd/src/utils/agents/resolveAgentAvatarImageUrl.test.d.ts +1 -0
- package/umd/src/version.d.ts +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
<!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# 🐙 Promptbook: Invisible AI Agents
|
|
4
4
|
|
|
5
|
-
Create persistent AI agents that turn your company's scattered knowledge into action
|
|
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
|
|
|
@@ -63,13 +63,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
63
63
|
|
|
64
64
|
## 📖 The Book Whitepaper
|
|
65
65
|
|
|
66
|
-
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
|
|
66
|
+
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.
|
|
67
67
|
|
|
68
68
|
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.
|
|
69
69
|
|
|
70
70
|
The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
|
|
71
71
|
|
|
72
|
-
In Promptbook, you define your agents **using simple Books**
|
|
72
|
+
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.
|
|
73
73
|
|
|
74
74
|
<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
|
|
75
75
|
|
|
@@ -170,7 +170,7 @@ Your job is to provide legal advice and support to the company and its employees
|
|
|
170
170
|
|
|
171
171
|
#### `Use` commitments
|
|
172
172
|
|
|
173
|
-
Use commitments grant the agent real capabilities
|
|
173
|
+
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.
|
|
174
174
|
|
|
175
175
|
These are what turn a chatbot into a persistent agent that actually does work.
|
|
176
176
|
|
|
@@ -219,7 +219,7 @@ Your job is to provide legal advice and support to the company and its employees
|
|
|
219
219
|
|
|
220
220
|
### Promptbook Ecosystem
|
|
221
221
|
|
|
222
|
-
Promptbook is an ecosystem of tools centered around the **Agents Server**
|
|
222
|
+
Promptbook is an ecosystem of tools centered around the **Agents Server** - a production-ready platform for running persistent AI agents.
|
|
223
223
|
|
|
224
224
|
#### Agents Server
|
|
225
225
|
|
|
@@ -241,7 +241,7 @@ The [Promptbook Engine](https://github.com/webgptorg/promptbook) is the open-sou
|
|
|
241
241
|
|
|
242
242
|
## 💜 The Promptbook Project
|
|
243
243
|
|
|
244
|
-
Promptbook project is an ecosystem centered around the **Agents Server**
|
|
244
|
+
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:
|
|
245
245
|
|
|
246
246
|
<table>
|
|
247
247
|
<thead>
|
|
@@ -254,7 +254,7 @@ Promptbook project is an ecosystem centered around the **Agents Server** — a p
|
|
|
254
254
|
<tr>
|
|
255
255
|
<td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
|
|
256
256
|
<td>
|
|
257
|
-
The primary way to use Promptbook. A production-ready platform where your AI agents live
|
|
257
|
+
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>.
|
|
258
258
|
</td>
|
|
259
259
|
</tr>
|
|
260
260
|
<tr>
|
|
@@ -344,8 +344,8 @@ For information on reporting security vulnerabilities, see our [Security Policy]
|
|
|
344
344
|
|
|
345
345
|
The fastest way to get started is with the **Agents Server**:
|
|
346
346
|
|
|
347
|
-
- 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)**
|
|
348
|
-
- ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)**
|
|
347
|
+
- 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Self-host the Agents Server with full control over your data
|
|
348
|
+
- ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** - Start creating agents immediately, no setup required
|
|
349
349
|
|
|
350
350
|
### NPM Packages _(for developers embedding the Engine)_
|
|
351
351
|
|
|
@@ -490,7 +490,7 @@ npx ptbk coder verify
|
|
|
490
490
|
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------ | ---- | ----- | ------------------------------------------------------------------------ |
|
|
491
491
|
| `ptbk coder init` | Creates `prompts/`, `prompts/done/`, the project-generic template files materialized in `prompts/templates/` (currently `common.md`), and a starter `AGENTS.md`; ensures `.env` contains `CODING_AGENT_GIT_NAME`, `CODING_AGENT_GIT_EMAIL`, and `CODING_AGENT_GIT_SIGNING_KEY`; adds helper coder scripts to `package.json`; ensures `.gitignore` contains `/.tmp`; and configures `.vscode/settings.json` to save pasted prompt images into `prompts/screenshots/`. |
|
|
492
492
|
| `ptbk coder generate-boilerplates` | Creates new prompt markdown files with fresh emoji tags so you can quickly fill in coding tasks; `--template` accepts either a built-in alias or a markdown file path relative to the project root. |
|
|
493
|
-
| `ptbk coder run` | Picks the next ready prompt, appends optional context, runs it through the selected coding agent, can optionally verify each attempt with a shell test command and feed failing output back for retries, then marks success or failure, commits the result, and pushes only when `--auto-push` is enabled.
|
|
493
|
+
| `ptbk coder run` | Picks the next ready prompt, appends optional context, runs it through the selected coding agent, can optionally verify each attempt with a shell test command and feed failing output back for retries, then marks success or failure, commits the result, and pushes only when `--auto-push` is enabled. |
|
|
494
494
|
| `ptbk coder find-refactor-candidates` | Scans the repository for oversized or overpacked files and writes prompt files for likely refactors; `--level <xlow | low | medium | high | xhigh | extreme>` ranges from a very benevolent scan to a very aggressive sweep. |
|
|
495
495
|
| `ptbk coder verify` | Walks through completed prompts, archives truly finished work, and adds follow-up repair prompts for unfinished results. |
|
|
496
496
|
|
|
@@ -501,7 +501,7 @@ npx ptbk coder verify
|
|
|
501
501
|
| `--agent <name>` | Selects the coding backend. |
|
|
502
502
|
| `--model <model>` | Chooses the runner model; required for `openai-codex` and `gemini`, optional for `github-copilot`. |
|
|
503
503
|
| `--context <text-or-file>` | Appends extra instructions inline or from a file like `AGENTS.md`. |
|
|
504
|
-
| `--test <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries.
|
|
504
|
+
| `--test <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries. |
|
|
505
505
|
| `--thinking-level <level>` | Sets reasoning effort for supported runners. |
|
|
506
506
|
| `--no-wait` | Skips interactive pauses between prompts for unattended execution. |
|
|
507
507
|
| `--ignore-git-changes` | Disables the clean-working-tree guard. |
|
|
@@ -604,8 +604,8 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
|
|
|
604
604
|
|
|
605
605
|
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.
|
|
606
606
|
|
|
607
|
-
- **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/)
|
|
608
|
-
- **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/)
|
|
607
|
+
- **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) - start creating agents immediately
|
|
608
|
+
- **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) - full control over your data and infrastructure
|
|
609
609
|
- **API** for integrating agents into your own applications
|
|
610
610
|
|
|
611
611
|
## 🚂 Promptbook Engine
|
|
@@ -623,7 +623,7 @@ The Engine is the open-source core that powers the Agents Server. If you need to
|
|
|
623
623
|
- When you want agents that **collaborate in teams** and consult each other
|
|
624
624
|
- When you need to **integrate AI agents into your existing applications** via API
|
|
625
625
|
- When you want to **self-host** your AI agents with full control over data and infrastructure
|
|
626
|
-
- When you are writing an app that generates complex things via LLM
|
|
626
|
+
- When you are writing an app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
|
|
627
627
|
- When you want to **version** your agent definitions and **test multiple versions**
|
|
628
628
|
- When you want to **log** agent execution and backtrace issues
|
|
629
629
|
|
|
@@ -635,7 +635,7 @@ The Engine is the open-source core that powers the Agents Server. If you need to
|
|
|
635
635
|
- When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
|
|
636
636
|
- When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
|
|
637
637
|
- 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))_
|
|
638
|
-
- When your main focus is on something other than text
|
|
638
|
+
- 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))_
|
|
639
639
|
- When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
|
|
640
640
|
|
|
641
641
|
[See more](https://github.com/webgptorg/promptbook/discussions/112)
|
package/esm/index.es.js
CHANGED
|
@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
|
|
|
26
26
|
* @generated
|
|
27
27
|
* @see https://github.com/webgptorg/promptbook
|
|
28
28
|
*/
|
|
29
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.112.0-
|
|
29
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.112.0-47';
|
|
30
30
|
/**
|
|
31
31
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
32
32
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -1056,7 +1056,7 @@ Color.fromHex('#1D4ED8');
|
|
|
1056
1056
|
*
|
|
1057
1057
|
* @public exported from `@promptbook/core`
|
|
1058
1058
|
*/
|
|
1059
|
-
const DEFAULT_BOOK_TITLE =
|
|
1059
|
+
const DEFAULT_BOOK_TITLE = `🐙 Untitled agent`;
|
|
1060
1060
|
/**
|
|
1061
1061
|
* Maximum file size limit
|
|
1062
1062
|
*
|