Skip to main content

Quick Start

Get up and running with Subscriberbot in minutes. This guide covers installing the CLI, signing in, and making your first API call.

Environment selection

Subscriberbot targets production by default. To use local or alpha infrastructure, set the environment variable before any command:

# Alpha
BURDENOFF_ENV=alpha subscriberbot auth login

# Local dev
BURDENOFF_ENV=local subscriberbot auth login

See Environment Selection for the full endpoint matrix.

1. Install the CLI​

# From npmjs (public)
npm install -g @subscriberbot/cli
# or
bun add -g @subscriberbot/cli

The subscriberbot binary is now available.

2. Sign in​

subscriberbot auth login

This opens your browser for the OAuth2 device-code flow. After approval, the CLI stores tokens at ~/.config/subscriberbot-cli/auth.json (mode 0600).

3. Set a workspace​

subscriberbot workspace list
subscriberbot workspace set <id>

All subsequent commands are scoped to this workspace.

4. Run your first commands​

# List providers in the global registry
subscriberbot subscriberbot providers list

# List your relationships (subscriptions)
subscriberbot subscriberbot relationships list

# Check auth status
subscriberbot auth status

5. Install the Node SDK (optional)​

bun add @subscriberbot/sdk
# or
npm install @subscriberbot/sdk
import { SubscriberbotSDK } from '@subscriberbot/sdk';

const sdk = new SubscriberbotSDK();
await sdk.auth.signIn({ username: '[email protected]', password: 'secret' });
const providers = await sdk.subscriberbot.providers.list();
console.log(providers);

6. Install the Python SDK (optional)​

pip install subscriberbot-sdk
from subscriberbot_sdk import SubscriberbotSDK

sdk = SubscriberbotSDK()
await sdk.auth.sign_in(email="[email protected]", password="secret")
providers = await sdk.subscriberbot.providers.list()
print(providers)

7. Load the browser extension (optional)​

git clone https://github.com/algoshred/subscriberbot-browser-extension.git
cd subscriberbot-browser-extension
bun install
bun run build

Load dist/ as an unpacked extension at chrome://extensions (Developer mode).

8. Install the VS Code extension (optional)​

Download the latest .vsix from GitHub Releases or build from source:

git clone https://github.com/algoshred/subscriberbot-code-extension.git
cd subscriberbot-code-extension
bun install
bun run build
bun run package

Then install the .vsix via VS Code → Extensions → ... → Install from VSIX....

Next steps​