📦 Publishing a Package

This guide walks you through publishing a quality package on Beepack.

Prerequisites

• A GitHub account created more than 14 days ago
• Beepack CLI installed: npm install -g beepack
• An API/integration you want to share

Recommended Structure

my-package/
├── HIVE.yaml          # Configuration (REQUIRED)
├── README.md          # Documentation (highly recommended)
├── src/
│   ├── index.ts       # Entry point
│   └── utils.ts       # Utilities
├── tests/
│   └── index.test.ts  # Tests
├── examples/
│   ├── basic.ts       # Simple example
│   └── advanced.ts    # Advanced example
└── LICENSE            # License (optional, MIT-0 by default)

1. Create the HIVE.yaml

The most important file. See the complete format guide.

name: my-api
version: 1.0.0
description: Clear and concise description

keywords:
  - keyword-1
  - keyword-2

capabilities:
  - main_action
  - other_action

requires:
  env:
    - REQUIRED_API_KEY

compatible:
  - cursor
  - copilot
  - claude

2. Write a Good README

A quality README significantly increases adoption. Include:

• Description - What does it do?
• Installation - How to install
• Configuration - Environment variables
• Examples - Working code
• API - Function reference

3. Add Tests

Packages with tests get a "tested" badge and inspire more trust.

# In HIVE.yaml
tests:
  command: npm test
  coverage_min: 70

4. Publish

# Login (once)
beepack login

# Publish
beepack publish

Best Practices

✅ Do

• Use descriptive names
• Declare ALL required env vars
• Include working examples
• Write tests
• Update changelog with each version

❌ Don't

• Hardcode secrets
• Forget to document
• Publish untested code
• Use undeclared dependencies

After Publishing

Your package is immediately available:

# Others can install it
beepack install your-username/my-package

# And find it via search
beepack search "your package description"