🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@promptbook/cli

Package Overview
Dependencies
Maintainers
1
Versions
504
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@promptbook/cli

Promptbook: Run AI apps in plain human language across multiple models and platforms

0.94.0-1
latest
Source
npm
Version published
Weekly downloads
717
16.02%
Maintainers
1
Weekly downloads
 
Created
Source

✨ Promptbook: AI apps in plain Language

Write AI applications using plain human language across multiple models and platforms.

NPM Version of Promptbook logo - cube with letters P and B Promptbook Quality of package Promptbook logo - cube with letters P and B Promptbook Known Vulnerabilities Build Status Coverage Status Issues

🌟 New Features

  • 💡 VS Code support for .book files with syntax highlighting and IntelliSense
  • 🐳 Official Docker image (hejny/promptbook) for seamless containerized usage
  • 🔥 Native support for OpenAI o3-mini, GPT-4 and other leading LLMs
  • 🔍 DeepSeek integration for advanced knowledge search
⚠ 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 utils for Promptbook. After install you can use promptbook command in terminal:

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.

Rest of the documentation is common for entire promptbook ecosystem:

🤍 The Book Abstract

It's time for a paradigm shift! The future of software is in plain English, French or Latin.

During the computer revolution, we have seen multiple generations of computer languages, from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the next revolution!

It's a revolution of writing software in plain human language that is understandable and executable by both humans and machines – and it's going to change everything!

The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.

This shift is going to happen, whether we are ready for it or not. Our mission is to make it excellently, not just good.

Join us in this journey!

🚀 Get started

Take a look at the simple starter kit with books integrated into the Hello World sample applications:

💜 The Promptbook Project

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

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

🌐 Community & Social Media

Join our growing community of developers and users:

PlatformDescription
💬 DiscordJoin our active developer community for discussions and support
🗣️ GitHub DiscussionsTechnical discussions, feature requests, and community Q&A
👔 LinkedInProfessional updates and industry insights
📱 FacebookGeneral announcements and community engagement
🔗 ptbk.ioOfficial landing page with project information

🖼️ Product & Brand Channels

Promptbook.studio

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

📘 Book Language Blueprint

A concise, Markdown-based DSL for crafting AI workflows and automations.

📑 Table of Contents

Introduction

Book is a Markdown-based language that simplifies the creation of AI applications, workflows, and automations. With human-readable commands, you can define inputs, outputs, personas, knowledge sources, and actions—without needing model-specific details.

Example

# 🌟 My First Book

-   BOOK VERSION 1.0.0
-   URL https://promptbook.studio/hello.book
-   INPUT PARAMETER {topic}
-   OUTPUT PARAMETER {article}

# Write an Article

-   PERSONA Jane, marketing specialist with prior experience in tech and AI writing
-   KNOWLEDGE https://wikipedia.org/
-   KNOWLEDGE ./journalist-ethics.pdf
-   EXPECT MIN 1 Sentence
-   EXPECT MAX 5 Pages

> Write an article about {topic}

→ {article}

Each part of the book defines one of 3 circles:

1. What: Workflows, Tasks and Parameters

What work needs to be done. Each book defines a workflow (scenario or pipeline), which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.

Related commands:

2. Who: Personas

Who does the work. Each task is performed by a persona. A persona is a description of your virtual employee. It is a higher abstraction than the model, tokens, temperature, top-k, top-p and other model parameters.

You can describe what you want in human language like Jane, creative writer with a sense of sharp humour instead of gpt-4-2024-13-31, temperature 1.2, top-k 40, STOP token ".\n",....

Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.

Related commands:

3. How: Knowledge, Instruments and Actions

The resources used by the personas are used to do the work.

Related commands:

  • KNOWLEDGE of documents, websites, and other resources
  • INSTRUMENT for real-time data like time, location, weather, stock prices, searching the internet, calculations, etc.
  • ACTION for actions like sending emails, creating files, ending a workflow, etc.

General Principles

Book language is based on markdown. It is subset of markdown. It is designed to be easy to read and write. It is designed to be understandable by both humans and machines and without specific knowledge of the language.

The file has .book extension. It uses UTF-8 non BOM encoding.

Book has two variants: flat - which is just a prompt with no structure, and full - which has a structure with tasks, commands and prompts.

As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.

But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.

📚 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 complete dictionary, more list of general AI / LLM terms that has connection with Promptbook

💯 Core concepts

Advanced concepts

Data & Knowledge ManagementPipeline Control
Language & Output ControlAdvanced 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!

Keywords

ai
llm
prompt
template
language-model
chatgpt

FAQs

Package last updated on 15 May 2025

Did you know?

Socket

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.

Install

Related posts