@promptbook/remote-server weekly downloads statistics

<!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->

🐙 Promptbook: Invisible AI Agents

Create persistent AI agents that turn your company's scattered knowledge into action - powered by the Agents Server

🚀 Quick deploy

Run the standalone VPS installer (for example on DigitalOcean) only on a fresh server. Interactive mode asks for the installation values:

sudo curl -fsSL https://raw.githubusercontent.com/webgptorg/promptbook/refs/heads/main/install.sh | bash

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:

sudo curl -fsSL https://raw.githubusercontent.com/webgptorg/promptbook/refs/heads/main/install.sh | bash -s -- \
    --non-interactive \
    --yes-i-understand-that-script-should-be-run-on-fresh-server \
    --env preview \
    --domain my-server.com \
    --openai-api-key sk-proj-xxx \
    --admin-password xxx

<blockquote style="color: #ff8811"> <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>. </blockquote>

📦 Package @promptbook/remote-server

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

To install this package, run:

# Install entire promptbook ecosystem
npm i ptbk

# Install just this package to save space
npm install @promptbook/remote-server

Remote server implementation for Promptbook, enabling distributed execution of promptbook pipelines across network boundaries with REST API and WebSocket support.

🎯 Purpose and Motivation

This package provides a remote server that allows promptbook pipelines to be executed over the network. It enables distributed architectures where promptbook execution can be centralized on powerful servers while clients can access the functionality remotely, making it ideal for scaling promptbook applications and providing API access to promptbook collections.

🔧 High-Level Functionality

The package provides remote server capabilities:

• HTTP REST API: RESTful endpoints for pipeline execution and management
• WebSocket Support: Real-time communication for streaming execution results
• Authentication: Support for both anonymous and application-based authentication
• Pipeline Management: Remote access to promptbook collections and pipelines
• Execution Orchestration: Distributed execution of promptbook pipelines
• OpenAI Compatibility: OpenAI-compatible API endpoints for seamless integration

✨ Key Features

• 🌐 Remote Execution - Execute promptbook pipelines over HTTP/WebSocket
• 🔐 Authentication Modes - Support for anonymous and application-based access
• 📡 Real-time Communication - WebSocket support for streaming results
• 🔌 OpenAI Compatible - Use promptbooks as OpenAI-compatible models
• 🚀 Scalable Architecture - Distribute promptbook execution across servers
• 📊 Pipeline Management - Remote access to collections and individual pipelines
• 🛡️ Security - Configurable authentication and access control
• ⚡ High Performance - Optimized for concurrent pipeline execution

📦 Exported Entities

Version Information

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

Server Management

• startRemoteServer - Start the remote promptbook server

Configuration Types

• RemoteServerOptions - Configuration options for remote server (type)

Authentication Types

• Identification - Base identification interface (type)
• ApplicationModeIdentification - Application mode identification (type)
• AnonymousModeIdentification - Anonymous mode identification (type)…