@promptbook/cli 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/cli

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

To install this package, run:

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.

Project commands

ptbk coder run --harness openai-codex uses the invocation's current directory, its agents/developer.book, and the UTF-8 contents of its AGENTS.md. The explicit equivalent is ptbk coder run --harness openai-codex --path . --agent ./agents/developer.book --context ./AGENTS.md. --path selects an existing project directory; relative Book/context files resolve inside it, even in a nested Git project. Explicit context replaces the default; --context "" disables additional context. Missing implicit AGENTS.md warns and continues, while unreadable files or invalid explicit Book/context references fail clearly.

ptbk init and ptbk coder init share initialization and preserve custom Books, context, scripts and settings. coder plan also defaults to Developer, retaining PRD-only permissions; --agent ./agents/planner.book selects Planner explicitly. coder list has no default Book filter. See the command inventory and precedence reference for execution, authoring, listing, folder-runner, and legacy-command distinctions.

🎯 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:

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

Then just use it:

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

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…

Description from the npm listing.