🔨Getting Started

Quick Start — Install the CLI

The fastest way to start building. One command installs the chain binary (bitbadgeschaind, exposed as the friendly alias bb) with 104+ API routes, review tools, and built-in docs.

curl -fsSL https://install.bitbadges.io | sh

Works on Linux, macOS (Intel + Apple Silicon), and Windows (Git Bash / WSL). See Installation for all options.

After installing, set your API key and start querying:

bb settings set apiKey YOUR_KEY             # get one at bitbadges.io/developer
bb api tokens get-collection 1              # query any collection
bb dev docs                                 # browse docs from terminal

For AI agents: The CLI is the recommended interface. See CLI for AI Agents for end-to-end workflows, or use the BitBadges Builder Tools for building tokens with Claude/Cursor.

No-Code / Low-Code

BitBadges also offers no-code flows for all major services. Navigate to the Create tab or the developer portal to create tokens, claims, address lists, and more — no integration needed.

Need help? Join our Discord for support from the BitBadges team and community developers.
Need BADGE? Contact us on Discord - get subsidized credits for developers during chaosnet!

Explore First, Read Later

We strongly recommend, if you have not already, to explore the claim tester and other creation options in-site. Many of your questions should be answered by the interface and is much easier to understand than a bunch of long text here in this documentation. Just go explore and experiment first.

Most of your setup and management (and oftentimes all) will be done directly in-site via the developer portal or Create tab. Get started at https://bitbadges.io/create.

Quick Start - Tokens

📚Overview

Quick Start - Claims

https://github.com/trevormil/bitbadges-docs/blob/master/overview/claim-builder/README.md

Quick Start - API

📚BitBadges API ⚒️BitBadges JS / SDK

npm i bitbadges

import { BitBadgesAPI, BigIntify } from 'bitbadges';

const api = new BitBadgesAPI({
  convertFunction: BigIntify,
  apiKey: 'YOUR_API_KEY' // get one at bitbadges.io/developer
});

const res = await api.getCollection('1');
console.log(res);

Quick Start - BitBadges Builder Tools (AI)

The BitBadges Builder gives any AI assistant (Claude, Cursor, etc.) 30+ tools to build, audit, sign, and broadcast BitBadges transactions — no manual JSON required.

# Install globally
npm install -g bitbadges

# Or run directly with npx
npx -p bitbadges bitbadges-builder

Claude Desktop — add to claude_desktop_config.json:

{
  "mcpServers": {
    "bitbadges-builder": {
      "command": "npx",
      "args": ["-y", "-p", "bitbadges", "bitbadges-builder"],
      "env": {
        "BITBADGES_API_KEY": "your-api-key"
      }
    }
  }
}

Claude Code:

claude mcp add bitbadges-builder -- npx -y -p bitbadges bitbadges-builder

See the full Builder Tools Reference for all tools, schemas, and workflows. For bot/agent guides, see AI Agents & Bots.

Developing with AI

Below, we provide some resources that may be helpful for developing with AI. If there is anything else we can do to make development easier, let us know!

Resource

Link

BitBadges Builder Tools

npm i -g bitbadges — Reference

BitBadges SDK

npm i bitbadges — Docs

AI Quickstarter Repo

github.com/BitBadges/bitbadges-quickstarter-ai

GitBook MCP

docs.bitbadges.io/~gitbook/mcp — searchDocumentation tool

API OpenAPI Spec

openapi.json