🚀 Quick Start

This guide will help you publish your first Beepack package in less than 10 minutes.

Prerequisites

• Node.js 18+ installed
• A GitHub account
• An API/integration you want to share

Step 1: Install the CLI

npm install -g beepack

Verify the installation:

beepack --version
# beepack v1.0.0

Step 2: Login

beepack login

This will open your browser for GitHub authentication. Your GitHub username becomes your namespace.

Step 3: Create a Package

Create a folder for your package:

mkdir my-api
cd my-api
beepack init

This generates a HIVE.yaml file:

name: my-api
version: 1.0.0
description: My API description
author: your-username

keywords:
  - keyword1
  - keyword2

capabilities:
  - what_api_does

requires:
  env:
    - API_KEY_REQUIRED

compatible:
  - cursor
  - copilot
  - claude

Step 4: Add Your Code

Add your source files. Recommended structure:

my-api/
├── HIVE.yaml          # Configuration (required)
├── README.md          # Documentation (highly recommended)
├── src/
│   └── index.ts       # Entry point
├── tests/
│   └── index.test.ts  # Tests
└── examples/
    └── basic.ts       # Usage examples

Step 5: Publish

beepack publish

Your package is now available on Beepack! 🎉

# Others can now install it:
beepack install your-username/my-api

Step 6: Update

To publish a new version:

# Edit version in HIVE.yaml
# then:
beepack publish