@promptbook/cli
Advanced tools
PromptbookBuild responsible, controlled and transparent applications on top of LLM models!
.docx, .doc and .pdf documentsโ Warning: This is a pre-release version of the library. It is not yet ready for production use. Please look at latest stable release.
@promptbook/cli@promptbook/cli is one part of the promptbook ecosystem.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:
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.
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:
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:
In all of these situations, but especially in 3., the โจ Promptbook can make your life waaaaaaaaaay easier.
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.:) 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.Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
| Project | Description | Link |
|---|---|---|
| Core | Promptbook core is a description and documentation of basic innerworkings how should be Promptbook implemented and defines which fetures must be descriable by book language | https://ptbk.io https://github.com/webgptorg/book |
| Book language | Book is a markdown-like language to define core entities like projects, pipelines, knowledge,.... 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 + Multiple packages on NPM |
| Promptbook studio | No-code studio to write book without need to write even the markdown | https://promptbook.studio https://github.com/hejny/promptbook-studio |
| Promptbook miniapps | Builder of LLM miniapps from book notation |
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}
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
ptbk.pdf documents.docx, .odt,โฆ.doc, .rtf,โฆThe following glossary is used to clarify certain concepts:
Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook
If you have a question start a discussion, open an issue or write me an email.
See CHANGELOG.md
Promptbook by Pavol Hejnรฝ is licensed under CC BY 4.0
See TODO.md
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.
FAQs
Supercharge your use of large language models
The npm package @promptbook/cli receives a total of 410 weekly downloads. As such, @promptbook/cli popularity was classified as not popular.
We found that @promptbook/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.ย It has 0 open source maintainers collaborating on the project.
Did you know?
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.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.