@promptbook/cli 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 +689 -250
- package/esm/index.es.js.map +1 -1
- package/esm/scripts/run-codex-prompts/common/waitForPause.d.ts +13 -1
- package/esm/scripts/run-codex-prompts/ui/buildCoderRunOctopusVisual.d.ts +13 -0
- package/esm/scripts/run-codex-prompts/ui/buildCoderRunUiFrame.d.ts +3 -1
- package/esm/scripts/run-codex-prompts/ui/coderRunUiRefresh.d.ts +8 -2
- package/esm/scripts/run-codex-prompts/ui/coderRunUiText.d.ts +36 -0
- package/esm/scripts/utils/emojiTags/scanEmojiTagUsage.d.ts +51 -0
- 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 +4 -2
- package/umd/index.umd.js +688 -249
- package/umd/index.umd.js.map +1 -1
- package/umd/scripts/run-codex-prompts/common/waitForPause.d.ts +13 -1
- package/umd/scripts/run-codex-prompts/ui/buildCoderRunOctopusVisual.d.ts +13 -0
- package/umd/scripts/run-codex-prompts/ui/buildCoderRunUiFrame.d.ts +3 -1
- package/umd/scripts/run-codex-prompts/ui/coderRunUiRefresh.d.ts +8 -2
- package/umd/scripts/run-codex-prompts/ui/coderRunUiText.d.ts +36 -0
- package/umd/scripts/utils/emojiTags/scanEmojiTagUsage.d.ts +51 -0
- 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
|
|
|
@@ -181,13 +181,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
181
181
|
|
|
182
182
|
## 📖 The Book Whitepaper
|
|
183
183
|
|
|
184
|
-
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
|
|
184
|
+
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.
|
|
185
185
|
|
|
186
186
|
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.
|
|
187
187
|
|
|
188
188
|
The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
|
|
189
189
|
|
|
190
|
-
In Promptbook, you define your agents **using simple Books**
|
|
190
|
+
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.
|
|
191
191
|
|
|
192
192
|
<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
|
|
193
193
|
|
|
@@ -288,7 +288,7 @@ Your job is to provide legal advice and support to the company and its employees
|
|
|
288
288
|
|
|
289
289
|
#### `Use` commitments
|
|
290
290
|
|
|
291
|
-
Use commitments grant the agent real capabilities
|
|
291
|
+
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.
|
|
292
292
|
|
|
293
293
|
These are what turn a chatbot into a persistent agent that actually does work.
|
|
294
294
|
|
|
@@ -337,7 +337,7 @@ Your job is to provide legal advice and support to the company and its employees
|
|
|
337
337
|
|
|
338
338
|
### Promptbook Ecosystem
|
|
339
339
|
|
|
340
|
-
Promptbook is an ecosystem of tools centered around the **Agents Server**
|
|
340
|
+
Promptbook is an ecosystem of tools centered around the **Agents Server** - a production-ready platform for running persistent AI agents.
|
|
341
341
|
|
|
342
342
|
#### Agents Server
|
|
343
343
|
|
|
@@ -359,7 +359,7 @@ The [Promptbook Engine](https://github.com/webgptorg/promptbook) is the open-sou
|
|
|
359
359
|
|
|
360
360
|
## 💜 The Promptbook Project
|
|
361
361
|
|
|
362
|
-
Promptbook project is an ecosystem centered around the **Agents Server**
|
|
362
|
+
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:
|
|
363
363
|
|
|
364
364
|
<table>
|
|
365
365
|
<thead>
|
|
@@ -372,7 +372,7 @@ Promptbook project is an ecosystem centered around the **Agents Server** — a p
|
|
|
372
372
|
<tr>
|
|
373
373
|
<td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
|
|
374
374
|
<td>
|
|
375
|
-
The primary way to use Promptbook. A production-ready platform where your AI agents live
|
|
375
|
+
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>.
|
|
376
376
|
</td>
|
|
377
377
|
</tr>
|
|
378
378
|
<tr>
|
|
@@ -462,8 +462,8 @@ For information on reporting security vulnerabilities, see our [Security Policy]
|
|
|
462
462
|
|
|
463
463
|
The fastest way to get started is with the **Agents Server**:
|
|
464
464
|
|
|
465
|
-
- 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)**
|
|
466
|
-
- ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)**
|
|
465
|
+
- 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Self-host the Agents Server with full control over your data
|
|
466
|
+
- ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** - Start creating agents immediately, no setup required
|
|
467
467
|
|
|
468
468
|
### NPM Packages _(for developers embedding the Engine)_
|
|
469
469
|
|
|
@@ -608,7 +608,7 @@ npx ptbk coder verify
|
|
|
608
608
|
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------ | ---- | ----- | ------------------------------------------------------------------------ |
|
|
609
609
|
| `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/`. |
|
|
610
610
|
| `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. |
|
|
611
|
-
| `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.
|
|
611
|
+
| `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. |
|
|
612
612
|
| `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. |
|
|
613
613
|
| `ptbk coder verify` | Walks through completed prompts, archives truly finished work, and adds follow-up repair prompts for unfinished results. |
|
|
614
614
|
|
|
@@ -619,7 +619,7 @@ npx ptbk coder verify
|
|
|
619
619
|
| `--agent <name>` | Selects the coding backend. |
|
|
620
620
|
| `--model <model>` | Chooses the runner model; required for `openai-codex` and `gemini`, optional for `github-copilot`. |
|
|
621
621
|
| `--context <text-or-file>` | Appends extra instructions inline or from a file like `AGENTS.md`. |
|
|
622
|
-
| `--test <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries.
|
|
622
|
+
| `--test <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries. |
|
|
623
623
|
| `--thinking-level <level>` | Sets reasoning effort for supported runners. |
|
|
624
624
|
| `--no-wait` | Skips interactive pauses between prompts for unattended execution. |
|
|
625
625
|
| `--ignore-git-changes` | Disables the clean-working-tree guard. |
|
|
@@ -722,8 +722,8 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
|
|
|
722
722
|
|
|
723
723
|
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.
|
|
724
724
|
|
|
725
|
-
- **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/)
|
|
726
|
-
- **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/)
|
|
725
|
+
- **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) - start creating agents immediately
|
|
726
|
+
- **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) - full control over your data and infrastructure
|
|
727
727
|
- **API** for integrating agents into your own applications
|
|
728
728
|
|
|
729
729
|
## 🚂 Promptbook Engine
|
|
@@ -741,7 +741,7 @@ The Engine is the open-source core that powers the Agents Server. If you need to
|
|
|
741
741
|
- When you want agents that **collaborate in teams** and consult each other
|
|
742
742
|
- When you need to **integrate AI agents into your existing applications** via API
|
|
743
743
|
- When you want to **self-host** your AI agents with full control over data and infrastructure
|
|
744
|
-
- When you are writing an app that generates complex things via LLM
|
|
744
|
+
- When you are writing an app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
|
|
745
745
|
- When you want to **version** your agent definitions and **test multiple versions**
|
|
746
746
|
- When you want to **log** agent execution and backtrace issues
|
|
747
747
|
|
|
@@ -753,7 +753,7 @@ The Engine is the open-source core that powers the Agents Server. If you need to
|
|
|
753
753
|
- When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
|
|
754
754
|
- When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
|
|
755
755
|
- 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))_
|
|
756
|
-
- When your main focus is on something other than text
|
|
756
|
+
- 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))_
|
|
757
757
|
- When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
|
|
758
758
|
|
|
759
759
|
[See more](https://github.com/webgptorg/promptbook/discussions/112)
|