@promptbook/components
Advanced tools
Promptbook: Turn your company's scattered knowledge into AI ready books
Turn your company's scattered knowledge into AI ready Books
.book files with syntax highlighting and IntelliSensehejny/promptbook) for seamless containerized usageo3-mini, GPT-4 and other leading LLMs⚠ Warning: This is a pre-release version of the library. It is not yet ready for production use. Please look at latest stable release.
@promptbook/components@promptbook/components is one part of the promptbook ecosystem.To install this package, run:
# Install entire promptbook ecosystem
npm i ptbk
# Install just this package to save space
npm install @promptbook/components
Reusable React components for the Promptbook ecosystem, providing a comprehensive set of UI components for building promptbook-powered applications.
The components package provides ready-to-use React components that integrate seamlessly with the Promptbook ecosystem. It eliminates the need to build UI components from scratch when creating promptbook-powered applications, offering everything from book editors to chat interfaces and avatar components.
This package provides a complete set of React components for promptbook applications:
'use client';
import { BookEditor } from '@promptbook/components';
export default function Page() {
return (
<div className="p-6">
<BookEditor className="max-w-3xl mx-auto" />
</div>
);
}
Note: The component contains a top-level "use client" directive so it can be imported directly in client components.
import { BookEditor } from '@promptbook/components';
function App() {
return (
<div style={{ padding: 24 }}>
<BookEditor />
</div>
);
}
export default App;
import type { BookEditorProps } from '@promptbook/components';
interface BookEditorProps {
// Additional CSS classes for wrapper
className?: string;
// Optional font className (e.g. from next/font)
fontClassName?: string;
// Controlled value of the book text
value?: string;
// Controlled change handler
onChange?: (value: string) => void;
// Explicit list of commitment keywords to highlight (case-insensitive).
// If omitted, a default set (PERSONA, KNOWLEDGE, MEMORY, STYLE, RULE, RULES, SAMPLE, EXAMPLE, FORMAT, MODEL, ACTION, META IMAGE, META LINK, NOTE, GOAL, MESSAGE, SCENARIO, DELETE, CANCEL, DISCARD, REMOVE, EXPECT, SCENARIOS, BEHAVIOUR, BEHAVIOURS, AVOID, AVOIDANCE, GOALS, CONTEXT) is used.
commitmentTypes?: string[];
}
The component comes with built-in styles. You can pass your own className and fontClassName to customize its look or integrate with your design system.
BOOK_LANGUAGE_VERSION - Current book language versionPROMPTBOOK_ENGINE_VERSION - Current engine versionAvatarChip - Compact avatar display componentAvatarChipProps - Props interface for AvatarChip (type)AvatarChipFromSource - Avatar chip with source-based loadingAvatarChipFromSourceProps - Props interface for AvatarChipFromSource (type)AvatarProfile - Full avatar profile componentAvatarProfileProps - Props interface for AvatarProfile (type)AvatarProfileFromSource - Avatar profile with source-based loadingAvatarProfileFromSourceProps - Props interface for AvatarProfileFromSource (type)BookEditor - Main book editor component with syntax highlightingBookEditorProps - Props interface for BookEditor (type)Chat - Basic chat interface componentChatProps - Props interface for Chat component (type)LlmChat - Enhanced chat component with LLM integrationLlmChatProps - Props interface for LlmChat component (type)ChatMessage - Type definition for chat messages (type)ChatParticipant - Type definition for chat participants (type)renderMarkdown - Utility function for rendering markdown contentisMarkdownContent - Utility to check if content is markdownArrowIcon - Arrow icon componentResetIcon - Reset/refresh icon componentSendIcon - Send message icon componentTemplateIcon - Template/document icon component💡 This package provides React components for promptbook applications. For the core functionality, see @promptbook/core or install all packages with
npm i ptbk
Rest of the documentation is common for entire promptbook ecosystem:
For most business applications nowadays, the biggest challenge isn't about the raw capabilities of AI models. Large language models like GPT-5 or Claude-4.1 are extremely capable.
The main challenge is to narrow it down, constrain it, set the proper context, rules, knowledge, and personality. There are a lot of tools which can do exactly this. On one side, there are no-code platforms which can launch your agent in seconds. On the other side, there are heavy frameworks like Langchain or Semantic Kernel, which can give you deep control.
Promptbook takes the best from both worlds. You are defining your AI behavior by simple books, which are very explicit. They are automatically enforced, but they are very easy to understand, very easy to write, and very reliable and portable.
|
Paul Smith & Associés |
We have created a language called Book, which allows you to write AI agents in their native language and create your own AI persona. Book provides a guide to define all the traits and commitments.
You can look at it as prompting (or writing a system message), but decorated by commitments.
Persona commitmentPersonas define the character of your AI persona, its role, and how it should interact with users. It sets the tone and style of communication.
|
Paul Smith & Associés |
Knowledge commitmentKnowledge Commitment allows you to provide specific information, facts, or context that the AI should be aware of when responding.
This can include domain-specific knowledge, company policies, or any other relevant information.
Promptbook Engine will automatically enforce this knowledge during interactions. When the knowledge is short enough, it will be included in the prompt. When it is too long, it will be stored in vector databases and RAG retrieved when needed. But you don't need to care about it.
|
Paul Smith & Associés |
Rule commitmentRules will enforce specific behaviors or constraints on the AI's responses. This can include ethical guidelines, communication styles, or any other rules you want the AI to follow.
Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
|
Paul Smith & Associés |
Action commitmentAction Commitment allows you to define specific actions that the AI can take during interactions. This can include things like posting on a social media platform, sending emails, creating calendar events, or interacting with your internal systems.
|
Paul Smith & Associés |
Books can be useful in various applications and scenarios. Here are some examples:
Create your own chat shopping assistant and place it in your eShop. You will be able to answer customer questions, help them find products, and provide personalized recommendations. Everything is tightly controlled by the book you have written.
Create your own AI agent, which will look at your emails and reply to them. It can even create drafts for you to review before sending.
Do you love Vibecoding, but the AI code is not always aligned with your coding style and architecture, rules, security, etc.? Create your own coding agent to help enforce your specific coding standards and practices.
This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
They will work the same as you are used to, but with your specific rules written in book.
Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
You can avoid struggle with choosing the best model, its settings like temperature, max tokens, etc., by writing a book agent and using it as your AI expertise.
Doesn't matter if you do automations, data analysis, customer support, sentiment analysis, classification, or any other task. Your AI agent will be tailored to your specific needs and requirements.
Even works in no-code platforms!
Now you want to use it. There are several ways how to write your first book:
We have written ai asistant in book who can help you with writing your first book.
Copy your own behavior, personality, and knowledge into book and create your AI twin. It can help you with your work, personal life, or any other task.
Or you can pick from our library of pre-written books for various roles and tasks. You can find books for customer support, coding, marketing, sales, HR, legal, and many other roles.
Take a look at the simple starter kit with books integrated into the Hello World sample applications:
Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
| Project | About |
|---|---|
| Book language |
Book is a human-understandable markup language for writing AI applications such as chatbots, knowledge bases, agents, avarars, translators, automations and more.
There is also a plugin for VSCode to support .book file extension
|
| Promptbook Engine | Promptbook engine can run applications written in Book language. It is released as multiple NPM packages and Docker HUB |
| Promptbook Studio | Promptbook.studio is a web-based editor and runner for book applications. It is still in the experimental MVP stage. |
Hello world examples:
Join our growing community of developers and users:
| Platform | Description |
|---|---|
| 💬 Discord | Join our active developer community for discussions and support |
| 🗣️ GitHub Discussions | Technical discussions, feature requests, and community Q&A |
| Professional updates and industry insights | |
| General announcements and community engagement | |
| 🔗 ptbk.io | Official landing page with project information |
| 📸 Instagram @promptbook.studio | Visual updates, UI showcases, and design inspiration |
See detailed guides and API reference in the docs or online.
For information on reporting security vulnerabilities, see our Security Policy.
This library is divided into several packages, all are published from single monorepo. You can install all of them at once:
npm i ptbk
Or you can install them separately:
⭐ Marked packages are worth to try first
⭐ ptbk - Bundle of all packages, when you want to install everything and you don't care about the size
promptbook - Same as ptbk
⭐🧙♂️ @promptbook/wizard - Wizard to just run the books in node without any struggle
@promptbook/core - Core of the library, it contains the main logic for promptbooks
@promptbook/node - Core of the library for Node.js environment
@promptbook/browser - Core of the library for browser environment
⭐ @promptbook/utils - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
@promptbook/markdown-utils - Utility functions used for processing markdown
(Not finished) @promptbook/wizard - Wizard for creating+running promptbooks in single line
@promptbook/javascript - Execution tools for javascript inside promptbooks
@promptbook/openai - Execution tools for OpenAI API, wrapper around OpenAI SDK
@promptbook/anthropic-claude - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@promptbook/vercel - Adapter for Vercel functionalities
@promptbook/google - Integration with Google's Gemini API
@promptbook/deepseek - Integration with DeepSeek API
@promptbook/ollama - Integration with Ollama API
@promptbook/azure-openai - Execution tools for Azure OpenAI API
@promptbook/fake-llm - Mocked execution tools for testing the library and saving the tokens
@promptbook/remote-client - Remote client for remote execution of promptbooks
@promptbook/remote-server - Remote server for remote execution of promptbooks
@promptbook/pdf - Read knowledge from .pdf documents
@promptbook/documents - Integration of Markitdown by Microsoft
@promptbook/documents - Read knowledge from documents like .docx, .odt,…
@promptbook/legacy-documents - Read knowledge from legacy documents like .doc, .rtf,…
@promptbook/website-crawler - Crawl knowledge from the web
@promptbook/editable - Editable book as native javascript object with imperative object API
@promptbook/templates - Useful templates and examples of books which can be used as a starting point
@promptbook/types - Just typescript types used in the library
@promptbook/color - Color manipulation library
⭐ @promptbook/cli - Command line interface utilities for promptbooks
🐋 Docker image - Promptbook server
The following glossary is used to clarify certain concepts:
Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook
| Data & Knowledge Management | Pipeline Control |
|---|---|
|
|
| Language & Output Control | Advanced Generation |
|
|
If you have a question start a discussion, open an issue or write me an email.
See CHANGELOG.md
This project is licensed under BUSL 1.1.
We welcome contributions! See CONTRIBUTING.md for guidelines.
You can also ⭐ star the project, follow us on GitHub or various other social networks.We are open to pull requests, feedback, and suggestions.
Need help with Book language? We're here for you!
We welcome contributions and feedback to make Book language better for everyone!
FAQs
Promptbook: Turn your company's scattered knowledge into AI ready books
We found that @promptbook/components demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A malicious Chrome extension posing as an Ethereum wallet steals seed phrases by encoding them into Sui transactions, enabling full wallet takeover.
Security News
Socket is heading to London! Stop by our booth or schedule a meeting to see what we've been working on.
Security News
OWASP’s 2025 Top 10 introduces Software Supply Chain Failures as a new category, reflecting rising concern over dependency and build system risks.