Installation

Install the BotPhi CLI and SDKs for your platform.

BotPhi offers a CLI for managing bots from the terminal and SDKs for integrating BotPhi into your applications programmatically.

CLI Installation

The BotPhi CLI is distributed as an npm package. Install it globally:

npm install -g @botphi/cli

# Verify installation
botphi --version

Requires Node.js 18 or later. We recommend using the latest LTS version.

Authentication

After installation, authenticate with your BotPhi account:

botphi login

# This opens your browser for OAuth authentication.
# Once approved, your CLI is linked to your account.

SDK Installation

Node.js / TypeScript

npm install @botphi/sdk

example.ts

import { BotPhi } from "@botphi/sdk";

const client = new BotPhi({
  apiKey: process.env.BOTPHI_API_KEY,
});

const bot = await client.bots.get("my-first-bot");
console.log(bot.status); // "running"

Python

pip install botphi

example.py

from botphi import BotPhi

client = BotPhi(api_key="your-api-key")

bot = client.bots.get("my-first-bot")
print(bot.status)  # "running"

Quick Start

Bots