[opensourcedex]

Botpress is a free, open source automation project written in TypeScript and released under MIT. It has 14,920 GitHub stars, 2,293 forks and 52 open issues, and was last pushed 3 hours ago. On this registry it ranks #12 of 54 tracked projects in Automation, with 5 head-to-head comparisons available. It gained 16 stars over the last 6 tracked days.

Botpress — Build powerful AI agents with cutting-edge LLM technology

What is Botpress?

What it is

Botpress is open-source hub to build and deploy GPT/LLM agents. It lives in Botpress Cloud ecosystem. Project uses TypeScript, MIT license, npm packages @botpress/cli and @botpress/sdk. Repository contains public integrations, devtools, example bots as code, and plugins for Botpress Studio, marked coming soon.

It solves concrete problem: developers need reusable way to connect bots to services, create integrations, deploy versions, share packages, and build assistants powered by OpenAI. Instead of hand-writing separate glue code, Botpress provides CLI, SDK, API Client, templates, and Hub deployment path. It separates Botpress Cloud work from on-premise Botpress v12. Issues for v12 belong to separate repository. Community can contribute integrations or publish own to Botpress Hub. Pull requests and issues are welcomed for code contained in repository.

Key capabilities

  • Maintains public integrations in /integrations for Botpress Hub.
  • Provides Botpress CLI package @botpress/cli for global install with npm, yarn, or pnpm.
  • Creates new integration with bp init, generating code from proposed templates. Development can happen in any directory and git repository, without forking repository.
  • Lets developers edit integration definition in integration.definition.ts and implementation in src/index.ts.
  • Deploys current integration version to workspace with bp deploy, updating existing version or creating new version.
  • By default integrations are private to workspace. Publishing with bp deploy --visibility public makes version available to all Botpress users on Hub. Once public, version cannot be updated again.
  • Includes devtools for Botpress Cloud: CLI, SDK, API Client, and example bots built as code.

Who uses it and how

  • Integration developers install CLI globally, run bp init, modify definition and source, then deploy to workspace. They can work in any directory and git repository.
  • Teams use private deployed integrations across all bots in their Botpress workspace.
  • Community contributors publish public integration versions to Botpress Hub for other Botpress users.
  • Developers study or build bots as code using client, SDK, and CLI examples in /bots.
  • Users needing on-premise Botpress v12 go to separate Botpress v12 repository instead of this repository.

Getting started

Typical path is global install of @botpress/cli with npm, yarn, or pnpm, then bp init, bp deploy, and optionally bp deploy --visibility public; hosted Botpress Cloud is available at https://app.botpress.cloud.

When to use it — and when not to

Use Botpress when building Botpress Cloud integrations, bots as code, or public Hub packages with CLI and SDK. Do not use it for on-premise Botpress v12, because README directs those problems to separate repository. Also note plugins on Botpress Studio are marked coming soon, and once public, integration version cannot be updated again.

project readme (upstream, from github) — read inline

Botpress Cloud

Discord YouTube Subscribe Documentation @botpress/sdk @botpress/cli

Botpress is the ultimate platform for building next-generation chatbots and assistants powered by OpenAI. Start building incredible assistants for your projects or businesses at lightning speed.

Getting started • Cloud • Documentation • Integrations • Plugins

This Repository

This repository contains:

Contributing

We love contributions from the community!

We welcome pull requests and issues relevant for any code contained in this repository. See the This Repository section for more details.

For bugs or features related to Botpress Cloud, you may create an issue on this repository, but keep in mind that you will get a faster response by talking to us on Discord instead!

For any problem related to on-premise Botpress v12, please see the Botpress v12 repository.

Integrations

The /integrations folder contains all our public and open-source integrations. We invite the community to contribute to our integrations or to publish their own to the Botpress Hub.

Integration Development

To develop an integration, start by installing the Botpress CLI:

npm install -g @botpress/cli # for npm
yarn global add @botpress/cli # for yarn
pnpm install -g @botpress/cli # for pnpm

Then, in the directory of your choice, create a new integration:

bp init

This command will generate an integration from one of the proposed templates.

This step can be executed in any directory and git repository of your choice. You don't have to fork this repository to create an integration.

You can then modify both the definition and implementation of your integration respectively located in the integration.definition.ts and src/index.ts files.

For more information on how to develop an integration, please refer to the Documentation.

Integration Deployment

To try out your integration, you can deploy its current version to your workspace using the Botpress CLI:

bp deploy

This will deploy your integration's current version to your workspace and make it available to all your bots. If this version is already deployed, it will be updated. Otherwise, a new version will be created.

By default, all integrations are private to the workspace they have been deployed in. When you are ready to share your version with the community, you can make it public by running:

bp deploy --visibility public

This will make your integration available to all Botpress users on the Botpress Hub. Once a version of your integration is public, it cannot be updated again.

Bots

The /bots folder contains examples of bots "as code" made only using the client, the SDK and the CLI.

This is not the recommended way to build bots and is in no way a replacement for the Botpress Studio.

However it can be useful for experienced developers who want to build bots in a more programmatic way.

It is also used internally by the Botpress team since the Studio and SDK both use the same underlying primitives.

Plugins

Coming soon.

Devtools

Package Description Docs Code
@botpress/cli Build, Deploy and Manage Bots, Integrations and Plugins Docs Code
@botpress/client Type-safe clients to consume the Botpress APIs Docs Code
@botpress/sdk SDK used by to build integrations Docs Code

Local Development

Prerequisites

The development environment requires the following tools to be installed:

  • git: Git is a free and open source distributed version control system.
  • node: Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
  • pnpm: PNPM is a fast, disk space efficient package manager.
Windows-specific prerequisites

Building from sources

# Clone the repository
git clone https://github.com/botpress/botpress.git
cd botpress

# Install dependencies
pnpm install

# Build all packages
pnpm run build

# Run Checks
pnpm run check

Licensing

All packages in this repository are open-source software and licensed under the MIT License. By contributing in this repository, you agree to release your code under this license as well.

Let's build the future of chatbot development together! 🤖🚀

Frequently asked questions

Is Botpress free to use?

Botpress is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does Botpress do?

Build powerful AI agents with cutting-edge LLM technology

What is Botpress written in?

Botpress is primarily written in TypeScript. Its source is publicly available at https://github.com/botpress/botpress, and it has 14,920 GitHub stars.