@promptbook/components weekly downloads statistics

🐙 Promptbook: Invisible AI Agents

Create persistent AI agents that turn your company's scattered knowledge into action - powered by the Agents Server

Promptbook](https://www.npmjs.com/package/promptbook) Promptbook](https://packagequality.com/#?package=promptbook)

🚀 Quick deploy

Run the standalone VPS installer _(for example on DigitalOcean)_ only on a fresh server. Interactive mode asks for the installation values:

Non-interactive mode takes defaults from command-line options. Use --env live, --env preview, --env production, or --env lts to pick the installed environment; the default is preview. When --openai-api-key is provided with the default OpenAI Codex runner, the installer installs and configures Codex automatically; other runner authentication can be configured later from the UI or SSH:

⚠ Warning: This is a pre-release version of the library. It is not yet ready for production use. Please look at latest stable release.

📦 Package @promptbook/components

• Promptbooks are divided into several packages, all are published from single monorepo. • This package @promptbook/components is one part of the promptbook ecosystem.

To install this package, run:

Reusable React components for the Promptbook ecosystem, providing a comprehensive set of UI components for building promptbook-powered applications.

🎯 Purpose and Motivation

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.

🔧 High-Level Functionality

This package provides a complete set of React components for promptbook applications:

• Book Editor: Styled editor with syntax highlighting for promptbook commitment types • Chat Components: Full-featured chat interfaces for LLM interactions • Avatar Components: Profile and chip components for user representation • Icon Library: Consistent iconography for promptbook applications • Markdown Rendering: Utilities for rendering markdown content in chat contexts

✨ Key Features

• 🎨 Styled Components - Pre-styled components that work out of the box • 💬 Chat Interface - Complete chat UI with LLM integration support • ✏️ Book Editor - Syntax-highlighted editor for promptbook files • 👤 Avatar System - Flexible avatar components with profile support • 🎯 TypeScript Support - Full TypeScript definitions for all components • 📱 Responsive Design - Components work across different screen sizes • 🔧 Customizable - Easy to customize with CSS classes and props • ⚡ Performance Optimized - Efficient rendering and minimal bundle size

Example Usage

Next.js (App Router)

Note: The component contains a top-level "use client" directive so it can be imported directly in client components.

Create React App / Vite / Other React apps

Component API

Styling

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.

Compatibility

• Frameworks: Next.js, CRA, Vite, Remix, and other React apps • Rendering: Client-side • Bundles: ESM and UMD

📦 Exported Entities

Version Information

• BOOK_LANGUAGE_VERSION - Current book language version • PROMPTBOOK_ENGINE_VERSION - Current engine version

Avatar Components

• AvatarChip - Compact avatar display component • AvatarChipProps - Props interface for AvatarChip (type) • AvatarChipFromSource - Avatar chip with source-based loading • AvatarChipFromSourceProps - Props interface for AvatarChipFromSource (type) • AvatarProfile - Full avatar profile component • AvatarProfileProps - Props interface for AvatarProfile (type) • AvatarProfileFromSource - Avatar profile with source-based loading • AvatarProfileFromSourceProps - Props interface for AvatarProfileFromSource (type)

Book Editor Components

• BookEditor - Main book editor component with syntax highlighting • BookEditorProps - Props interface for BookEditor (type)

Chat Components

• Chat - Basic chat interface component • ChatProps - Props interface for Chat component (type) • LlmChat - Enhanced chat component with LLM integration • LlmChatProps - Props interface for LlmChat component (type)

Chat Types and Utilities

• ChatMessage - Type definition for chat messages (type) • ChatParticipant - Type definition for chat participants (type) • renderMarkdown - Utility function for rendering markdown content • isMarkdownContent - Utility to check if content is markdown

Icon Components

• ArrowIcon - Arrow icon component • ResetIcon - Reset/refresh icon component • SendIcon - Send message icon component • TemplateIcon - 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:

📖 The Book Whitepaper

Promptbook lets you create persistent AI agents that work on real goals for your company. The Agents Server is the heart of the project - a place where your AI agents live, remember context, collaborate in teams, and get things done.

Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as Claude Mythos, GPT-5.6 or Kimi K2.7 are incredibly capable.

The main challenge lies in managing the context, providing rules and knowledge, and narrowing the personality.

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.

Lawyer…

Description from the npm listing.