\n ⚠ Warning: This is a pre-release version of the library. It is not yet ready for production use. Please look at latest stable release.\n\n\n## 📦 Package `@promptbook/node`\n\n- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).\n- This package `@promptbook/node` is one part of the promptbook ecosystem.\n\nTo install this package, run:\n\n```bash\n# Install entire promptbook ecosystem\nnpm i ptbk\n\n# Install just this package to save space\nnpm install @promptbook/node\n```\n\nThe Node.js package provides Node.js-specific functionality for Promptbook, including filesystem operations, command execution, and automatic provider configuration. It serves as the bridge between Promptbook's core functionality and Node.js runtime capabilities.\n\n## 🎯 Purpose and Motivation\n\nThis package extends Promptbook's core functionality with Node.js-specific features that are essential for server-side and desktop applications. It provides filesystem access, command execution, automatic LLM provider detection, and other Node.js runtime capabilities that enable full-featured Promptbook applications.\n\n## 🔧 High-Level Functionality\n\nThe package provides Node.js-specific integrations and utilities:\n\n- **Filesystem Operations**: Read promptbooks from directories and manage file-based collections\n- **Automatic Provider Setup**: Detect and configure LLM providers from environment variables\n- **Command Execution**: Execute system commands and scripts\n- **Knowledge Scraping**: Node.js-specific scrapers for various content sources\n- **File-based Storage**: Persistent storage using the filesystem\n- **Environment Integration**: Seamless integration with Node.js environment and tooling\n\n## ✨ Key Features\n\n- 📁 **Directory-based Collections** - Load promptbook collections from filesystem directories\n- 🔧 **Auto-configuration** - Automatically detect and configure LLM providers from environment\n- 💾 **File Storage** - Persistent caching and storage using the filesystem\n- 🛠️ **Command Execution** - Execute system commands and scripts from promptbooks\n- 🌐 **Knowledge Scraping** - Scrape content from files, websites, and other sources\n- 🔌 **Provider Detection** - Automatically discover available LLM providers\n- 📊 **Executable Management** - Manage and execute external tools and scripts\n- 🚀 **Performance Optimization** - File-based caching for improved performance\n\n## 📦 Exported Entities\n\n### Version Information\n\n- `BOOK_LANGUAGE_VERSION` - Current book language version\n- `PROMPTBOOK_ENGINE_VERSION` - Current engine version\n\n### Collection Management\n\n- `createPipelineCollectionFromDirectory` - Create promptbook collection from filesystem directory\n\n### Provider Configuration\n\n- `$provideExecutablesForNode` - Provide executable tools for Node.js environment\n- `$provideExecutionToolsForNode` - Auto-configure all execution tools from environment\n- `$provideLlmToolsConfigurationFromEnv` - Create LLM tools configuration from environment variables\n- `$provideLlmToolsFromEnv` - Create LLM tools from environment variables\n- `$provideFilesystemForNode` - Provide filesystem access for Node.js\n- `$provideScrapersForNode` - Provide knowledge scrapers for Node.js environment\n- `$provideScriptingForNode` - Provide scripting capabilities for Node.js\n\n### Storage\n\n- `FileCacheStorage` - File-based cache storage implementation\n\n### Command Execution\n\n- `$execCommand` - Execute single system command\n- `$execCommands` - Execute multiple system commands\n\n> 💡 This package does not make sense on its own, look at [all promptbook packages](#-packages) or just install all by `npm i ptbk`\n\n\n---\n\nRest of the documentation is common for **entire promptbook ecosystem**:\n\n\n\n\n## 📖 The Book Whitepaper\n\nPromptbook 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.\n\nNowadays, 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.\n\nThe main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.\n\nIn 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.\n\n
| \n\n**Lawyer** \n \nGOAL You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nRespond to incoming legal inquiries via email and keep the company website updated with the latest legal policies. \n \n**RULE** You are knowledgeable, professional, and detail-oriented. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \n \n \nTEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law. \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \n\n |
| \n\n**Company Lawyer** \n \nGOAL \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n**RULE** Always ensure compliance with local laws and regulations. \n**RULE** Never provide legal advice outside your area of expertise. \n**RULE** Never provide legal advice about criminal law. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n**RULE** Always ensure compliance with local laws and regulations. \n**RULE** Never provide legal advice outside your area of expertise. \n**RULE** Never provide legal advice about criminal law. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \n\n |
| \n\n**Paul Smith & Associés** \n \n**PERSONA** You are a company lawyer. \nYour job is to provide legal advice and support to the company and its employees. \nGOAL Respond to incoming legal inquiries via email within 24 hours. \nGOAL Keep the company website updated with the latest legal policies and compliance information. \n**RULE** Always ensure compliance with local laws and regulations. \n**RULE** Never provide legal advice outside your area of expertise. \n**RULE** Never provide legal advice about criminal law. \n**KNOWLEDGE** https://company.com/company-policies.pdf \n**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx \nTEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law. \n\n |
| Project | \nAbout | \n
|---|---|
| ⭐ Agents Server | \n\n 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 self-hosted via Docker.\n | \n
| Book language | \n\n Human-friendly, high-level language that abstracts away low-level details of AI. It allows to focus on personality, behavior, knowledge, and rules of AI agents rather than on models, parameters, and prompt engineering.\n \n There is also a plugin for VSCode to support .book file extension\n | \n
| Promptbook Engine | \n\n The open-source core that powers the Agents Server. Can also be used as a standalone TypeScript/JavaScript library to embed agent capabilities into your own applications.\n Released as multiple NPM packages.\n | \n
| Platform | \nDescription | \n
|---|---|
| 💬 Discord | \nJoin our active developer community for discussions and support | \n
| 🗣️ GitHub Discussions | \nTechnical discussions, feature requests, and community Q&A | \n
| Professional updates and industry insights | \n|
| General announcements and community engagement | \n|
| 🔗 ptbk.io | \nOfficial landing page with project information | \n
| 📸 Instagram @promptbook.studio | \nVisual updates, UI showcases, and design inspiration | \n
| Data & Knowledge Management | \nPipeline Control | \n
|---|---|
\n
| \n \n
| \n
| Language & Output Control | \nAdvanced Generation | \n
\n
| \n \n
| \n