JSPM

@promptbook/cli

0.74.0-0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 723
  • Score
    100M100P100Q98684F
  • License CC-BY-4.0

Supercharge your use of large language models

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 logo - cube with letters P and B Promptbook

    Build responsible, controlled and transparent applications on top of LLM models!

    [NPM Version of ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://www.npmjs.com/package/promptbook) [Quality of package ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://packagequality.com/#?package=promptbook) Known Vulnerabilities Issues

    ✨ New Features

    ⚠ 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 ./promptbook-collection --format typescript --verbose

    This will emit index.ts with getPipelineCollection function file in promptbook-collection directory.

    Then just use it:

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

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

// ▶ 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);

// ▶ Fail if the execution was not successful
assertsExecutionSuccessful(result);

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

    This is simmilar 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/**/*.ptbk.md

    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 Promptbook Whitepaper

    If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.

    But often you will struggle with the limitations of LLMs, such as hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd resp0nses. When this happens, you generally have three options:

    1. Fine-tune the model to your specifications or even train your own.
    2. Prompt-engineer the prompt to the best shape you can achieve.
    3. Orchestrate multiple prompts in a pipeline to get the best result.

    In all of these situations, but especially in 3., the ✨ Promptbook can make your life waaaaaaaaaay easier.

    • Separates concerns between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic. For this purpose, it introduces a new language called the 💙 Book.
    • Book allows you to focus on the business logic without having to write code or deal with the technicalities of LLMs.
    • Forget about low-level details like choosing the right model, tokens, context size, temperature, top-k, top-p, or kernel sampling. Just write your intent and persona who should be responsible for the task and let the library do the rest.
    • We have built-in orchestration of pipeline execution and many tools to make the process easier, more reliable, and more efficient, such as caching, compilation+preparation, just-in-time fine-tuning, expectation-aware generation, agent adversary expectations, and more.
    • Sometimes even the best prompts with the best framework like Promptbook :) can't avoid the problems. In this case, the library has built-in anomaly detection and logging to help you find and fix the problems.
    • Versioning is build in. You can test multiple A/B versions of pipelines and see which one works best.
    • Promptbook is designed to use RAG (Retrieval-Augmented Generation) and other advanced techniques to bring the context of your business to generic LLM. You can use knowledge to improve the quality of the output.

    💜 The Promptbook Project

    Promptbook whitepaper Basic motivations and problems which we are trying to solve https://github.com/webgptorg/book
    Promptbook (system) Promptbook ...
    Book language Book is a markdown-like language to define projects, pipelines, knowledge,... in the Promptbook system. It is designed to be understandable by non-programmers and non-technical people
    Promptbook typescript project Implementation of Promptbook in TypeScript published into multiple packages to NPM https://github.com/webgptorg/promptbook
    Promptbook studio Promptbook studio https://github.com/hejny/promptbook-studio
    Promptbook miniapps Promptbook miniapps

    💙 Book language (for prompt-engineer)

    Promptbook pipelines are written in markdown-like language called Book. It is designed to be understandable by non-programmers and non-technical people.

    # 🌟 My first Book

-   INPUT PARAMETER {subject}
-   OUTPUT PARAMETER {article}

## Sample subject

> Promptbook

-> {subject}

## Write an article

-   PERSONA Jane, marketing specialist with prior experience in writing articles about technology and artificial intelligence
-   KNOWLEDGE https://ptbk.io
-   KNOWLEDGE ./promptbook.pdf
-   EXPECT MIN 1 Sentence
-   EXPECT MAX 1 Paragraph

> Write an article about the future of artificial intelligence in the next 10 years and how metalanguages will change the way AI is used in the world.
> Look specifically at the impact of {subject} on the AI industry.

-> {article}

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

    Basic terms

    Core concepts

    Advanced concepts

    🔌 Usage in Typescript / Javascript

    ➕➖ 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

    Promptbook by Pavol Hejný is licensed under CC BY 4.0

    🎯 Todos

    See TODO.md

    🖋️ Contributing

    I am open to pull requests, feedback, and suggestions. Or if you like this utility, you can ☕ buy me a coffee or donate via cryptocurrencies.

    You can also ⭐ star the promptbook package, follow me on GitHub or various other social networks.