JSPM

@promptbook/cli

0.105.0-11
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 946
  • Score
    100M100P100Q99647F
  • License BUSL-1.1

Promptbook: Turn your company's scattered knowledge into AI ready books

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@promptbook/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    ✨ Promptbook: AI Agents

    Turn your company's scattered knowledge into AI ready Books

    [NPM Version of ![Promptbook logo](./design/logo-h1.png) Promptbook](https://www.npmjs.com/package/promptbook) [Quality of package ![Promptbook logo](./design/logo-h1.png) Promptbook](https://packagequality.com/#?package=promptbook) Known Vulnerabilities 🧪 Test Books 🧪 Test build 🧪 Lint 🧪 Spell check 🧪 Test types Issues

    🌟 New Features

    • Gemini 3 Support
    ⚠ 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/cli

    To install this package, run:

    # Install entire promptbook ecosystem
npm i ptbk

# Install as dev dependency
npm install --save-dev @promptbook/cli

# Or install globally
npm install --global @promptbook/cli

    CLI utilities for Promptbook that provide command-line tools for building, prettifying, and managing promptbook collections. After installation, you can use the ptbk command in your terminal.

    🎯 Purpose and Motivation

    The CLI package provides essential command-line tools for Promptbook development workflows. It enables developers to build optimized promptbook libraries, prettify promptbook files, and manage collections efficiently from the command line, making it easier to integrate Promptbook into development and deployment pipelines.

    🔧 High-Level Functionality

    The package provides command-line tools for:

    • Library Building: Pre-compile promptbook collections into optimized formats
    • Code Generation: Generate TypeScript, JavaScript, or JSON libraries
    • Prettification: Format and enhance promptbook files with diagrams
    • Validation: Check promptbooks for errors during build time
    • Knowledge Building: Build RAG (Retrieval-Augmented Generation) knowledge bases
    • Provider Registration: Include all LLM providers and scrapers for CLI operations

    ✨ Key Features

    • 🏗️ Pre-compilation - Build optimized promptbook libraries at build time
    • 📝 Code Generation - Generate TypeScript, JavaScript, or JSON outputs
    • 🎨 Auto-prettification - Format promptbooks and add Mermaid diagrams
    • ✅ Build-time Validation - Catch errors early in the development process
    • 🧠 Knowledge Building - Automatically build RAG knowledge bases
    • 🔧 All Providers Included - Complete set of LLM providers and scrapers
    • 🚀 Performance Optimization - Pre-built libraries for faster runtime execution

    Make your Promptbook Library

    You can prebuild your own Promptbook library with ptbk make command:

    npx ptbk make ./books --format typescript --verbose

    This will emit index.ts with getPipelineCollection function file in books directory.

    Then just use it:

    import { createPipelineExecutor } from '@promptbook/core';
import { $provideExecutionToolsForNode } from '@promptbook/node';
import { $provideFilesystemForNode } from '@promptbook/node';
import { getPipelineCollection } from './books'; // <- Importing from pre-built library
import { JavascriptExecutionTools } from '@promptbook/javascript';
import { OpenAiExecutionTools } from '@promptbook/openai';

// ▶ Get single Pipeline
const promptbook = await getPipelineCollection().getPipelineByUrl(
    `https://promptbook.studio/my-collection/write-article.book`,
);

// ▶ Create executor - the function that will execute the Pipeline
const pipelineExecutor = createPipelineExecutor({ pipeline, tools: await $provideExecutionToolsForNode() });

// ▶ Prepare input parameters
const inputParameters = { word: 'cat' };

// 🚀▶ Execute the Pipeline
const result = await pipelineExecutor(inputParameters).asPromise({ isCrashedOnError: true });

// ▶ Handle the result
const { isSuccessful, errors, outputParameters, executionReport } = result;
console.info(outputParameters);

    This is similar to compilation process, during the build time the ptbk make command will check promptbooks for errors, convert them to the more optimized format and build knowledge (RAG) for the pipeline collection.

    There is also a javascript and json format available.

    Prettify

    npx ptbk prettify 'promptbook/**/*.book'

    This will prettify all promptbooks in promptbook directory and adds Mermaid graphs to them.

    📦 Exported Entities

    Version Information

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

    CLI Core

    • _CLI - Main CLI application implementation

    LLM Provider Registrations

    • _AnthropicClaudeMetadataRegistration - Anthropic Claude metadata registration
    • _AnthropicClaudeRegistration - Anthropic Claude provider registration
    • _AzureOpenAiMetadataRegistration - Azure OpenAI metadata registration
    • _AzureOpenAiRegistration - Azure OpenAI provider registration
    • _DeepseekMetadataRegistration - Deepseek metadata registration
    • _DeepseekRegistration - Deepseek provider registration
    • _GoogleMetadataRegistration - Google metadata registration
    • _GoogleRegistration - Google provider registration
    • _OllamaMetadataRegistration - Ollama metadata registration
    • _OllamaRegistration - Ollama provider registration
    • _OpenAiMetadataRegistration - OpenAI metadata registration
    • _OpenAiAssistantMetadataRegistration - OpenAI Assistant metadata registration
    • _OpenAiCompatibleMetadataRegistration - OpenAI Compatible metadata registration
    • _OpenAiRegistration - OpenAI provider registration
    • _OpenAiAssistantRegistration - OpenAI Assistant provider registration
    • _OpenAiCompatibleRegistration - OpenAI Compatible provider registration

    Scraper Registrations

    • _BoilerplateScraperRegistration - Boilerplate scraper registration
    • _BoilerplateScraperMetadataRegistration - Boilerplate scraper metadata registration
    • _LegacyDocumentScraperRegistration - Legacy document scraper registration
    • _LegacyDocumentScraperMetadataRegistration - Legacy document scraper metadata registration
    • _DocumentScraperRegistration - Document scraper registration
    • _DocumentScraperMetadataRegistration - Document scraper metadata registration
    • _MarkdownScraperRegistration - Markdown scraper registration
    • _MarkdownScraperMetadataRegistration - Markdown scraper metadata registration
    • _MarkitdownScraperRegistration - Markitdown scraper registration
    • _MarkitdownScraperMetadataRegistration - Markitdown scraper metadata registration
    • _PdfScraperRegistration - PDF scraper registration
    • _PdfScraperMetadataRegistration - PDF scraper metadata registration
    • _WebsiteScraperRegistration - Website scraper registration
    • _WebsiteScraperMetadataRegistration - Website scraper metadata registration

    Rest of the documentation is common for entire promptbook ecosystem:

    📖 The Book Whitepaper

    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.

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

    In Promptbook, you can define your context using simple Books that are very explicit, easy to understand and write, reliable, and highly portable.

    Paul Smith

    PERSONA You are a company lawyer.
    Your job is to provide legal advice and support to the company and its employees.
    RULE You are knowledgeable, professional, and detail-oriented.
    TEAM 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.

    Aspects of great AI agent

    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.

    Commitments are special syntax elements that define contracts between you and the AI agent. They are transformed by Promptbook Engine into low-level parameters like which model to use, its temperature, system message, RAG index, MCP servers, and many other parameters. For some commitments (for example RULE commitment) Promptbook Engine can even create adversary agents and extra checks to enforce the rules.

    Persona commitment

    Personas 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

    PERSONA You are a company lawyer.

    Knowledge commitment

    Knowledge 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

    PERSONA You are a company lawyer.
    Your job is to provide legal advice and support to the company and its employees.
    You are knowledgeable, professional, and detail-oriented.

    KNOWLEDGE https://company.com/company-policies.pdf
    KNOWLEDGE https://company.com/internal-documents/employee-handbook.docx

    Rule commitment

    Rules 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

    PERSONA You are a company lawyer.
    Your job is to provide legal advice and support to the company and its employees.
    You are knowledgeable, professional, and detail-oriented.

    RULE Always ensure compliance with laws and regulations.
    RULE Never provide legal advice outside your area of expertise.
    RULE Never provide legal advice about criminal law.
    KNOWLEDGE https://company.com/company-policies.pdf
    KNOWLEDGE https://company.com/internal-documents/employee-handbook.docx

    Team commitment

    Team commitment allows you to define the team structure and advisory fellow members the AI can consult with. This allows the AI to simulate collaboration and consultation with other experts, enhancing the quality of its responses.

    Paul Smith & Associés

    PERSONA You are a company lawyer.
    Your job is to provide legal advice and support to the company and its employees.
    You are knowledgeable, professional, and detail-oriented.

    RULE Always ensure compliance with laws and regulations.
    RULE Never provide legal advice outside your area of expertise.
    RULE Never provide legal advice about criminal law.
    KNOWLEDGE https://company.com/company-policies.pdf
    KNOWLEDGE https://company.com/internal-documents/employee-handbook.docx
    TEAM 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.

    Promptbook Ecosystem

    !!!@@@

    Promptbook Server

    !!!@@@

    Promptbook Engine

    !!!@@@

    💜 The Promptbook Project

    Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:

    Project About
    Agents Server Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
    Book language 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.
    There is also a plugin for VSCode to support .book file extension
    Promptbook Engine Promptbook engine can run AI agents based on Book language. It is released as multiple NPM packages and Promptbook Agent Server as Docker Package Agent Server is based on Promptbook Engine.

    🌐 Community & Social Media

    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
    👔 LinkedIn Professional updates and industry insights
    📱 Facebook General announcements and community engagement
    🔗 ptbk.io Official landing page with project information

    🖼️ Product & Brand Channels

    Promptbook.studio

    📸 Instagram @promptbook.studio Visual updates, UI showcases, and design inspiration

    📚 Documentation

    See detailed guides and API reference in the docs or online.

    🔒 Security

    For information on reporting security vulnerabilities, see our Security Policy.

    📦 Packages (for developers)

    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

    📚 Dictionary

    The following glossary is used to clarify certain concepts:

    General LLM / AI terms

    • Prompt drift is a phenomenon where the AI model starts to generate outputs that are not aligned with the original prompt. This can happen due to the model's training data, the prompt's wording, or the model's architecture.
    • Pipeline, workflow scenario or chain is a sequence of tasks that are executed in a specific order. In the context of AI, a pipeline can refer to a sequence of AI models that are used to process data.
    • Fine-tuning is a process where a pre-trained AI model is further trained on a specific dataset to improve its performance on a specific task.
    • Zero-shot learning is a machine learning paradigm where a model is trained to perform a task without any labeled examples. Instead, the model is provided with a description of the task and is expected to generate the correct output.
    • Few-shot learning is a machine learning paradigm where a model is trained to perform a task with only a few labeled examples. This is in contrast to traditional machine learning, where models are trained on large datasets.
    • Meta-learning is a machine learning paradigm where a model is trained on a variety of tasks and is able to learn new tasks with minimal additional training. This is achieved by learning a set of meta-parameters that can be quickly adapted to new tasks.
    • Retrieval-augmented generation is a machine learning paradigm where a model generates text by retrieving relevant information from a large database of text. This approach combines the benefits of generative models and retrieval models.
    • Longtail refers to non-common or rare events, items, or entities that are not well-represented in the training data of machine learning models. Longtail items are often challenging for models to predict accurately.

    Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook

    💯 Core concepts

    Advanced concepts

    Data & Knowledge Management Pipeline Control
    Language & Output Control Advanced Generation

    🔍 View more concepts

    🚂 Promptbook Engine

    Schema of Promptbook Engine

    ➕➖ When to use Promptbook?

    ➕ When to use

    • When you are writing app that generates complex things via LLM - like websites, articles, presentations, code, stories, songs,...
    • When you want to separate code from text prompts
    • When you want to describe complex prompt pipelines and don't want to do it in the code
    • When you want to orchestrate multiple prompts together
    • When you want to reuse parts of prompts in multiple places
    • When you want to version your prompts and test multiple versions
    • When you want to log the execution of prompts and backtrace the issues

    See more

    ➖ When not to use

    • When you have already implemented single simple prompt and it works fine for your job
    • When OpenAI Assistant (GPTs) is enough for you
    • When you need streaming (this may be implemented in the future, see discussion).
    • When you need to use something other than JavaScript or TypeScript (other languages are on the way, see the discussion)
    • 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)
    • When you need to use recursion (see the discussion)

    See more

    🐜 Known issues

    🧼 Intentionally not implemented features

    ❔ FAQ

    If you have a question start a discussion, open an issue or write me an email.

    📅 Changelog

    See CHANGELOG.md

    📜 License

    This project is licensed under BUSL 1.1.

    🤝 Contributing

    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.

    🆘 Support & Community

    Need help with Book language? We're here for you!

    We welcome contributions and feedback to make Book language better for everyone!