# Getting Started

## Quick Start — Install the CLI

The fastest way to start building. One command installs the chain binary (`bitbadgeschaind`) and the SDK CLI (`bitbadges-cli`) with 104+ API routes, review tools, and built-in docs.

```bash
curl -fsSL https://raw.githubusercontent.com/BitBadges/bitbadgeschain/master/install.sh | sh
```

Works on Linux, macOS (Intel + Apple Silicon), and Windows (Git Bash / WSL). See [Installation](https://docs.bitbadges.io/for-developers/cli/installation) for all options.

After installing, set your API key and start querying:

```bash
bitbadges-cli config set apiKey YOUR_KEY    # get one at bitbadges.io/developer
bitbadges-cli api tokens get-collection 1   # query any collection
bitbadges-cli sdk docs                      # browse docs from terminal
```

> **For AI agents:** The CLI is the recommended interface. See [CLI for AI Agents](https://docs.bitbadges.io/for-developers/cli/for-ai-agents) for end-to-end workflows, or use the [BitBadges Builder Tools](https://docs.bitbadges.io/for-developers/ai-agents/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](https://bitbadges.io/create) or the [developer portal](https://bitbadges.io/developer) to create tokens, claims, address lists, and more — no integration needed.

<figure><img src="https://2198930329-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7R34Y0QZwgpUGaJnJ4dq%2Fuploads%2Fgit-blob-91fa63edf06faba1bd3af8ad69e5a0b2991c4d08%2Fimage%20(4).png?alt=media" alt=""><figcaption></figcaption></figure>

> **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

{% content-ref url="../token-standard/x-tokenization" %}
[x-tokenization](https://docs.bitbadges.io/token-standard/x-tokenization)
{% endcontent-ref %}

## Quick Start - Claims

{% content-ref url="<https://github.com/trevormil/bitbadges-docs/blob/master/overview/claim-builder/README.md>" %}
<https://github.com/trevormil/bitbadges-docs/blob/master/overview/claim-builder/README.md>
{% endcontent-ref %}

## Quick Start - API

{% content-ref url="bitbadges-api" %}
[bitbadges-api](https://docs.bitbadges.io/for-developers/bitbadges-api)
{% endcontent-ref %}

{% content-ref url="bitbadges-sdk" %}
[bitbadges-sdk](https://docs.bitbadges.io/for-developers/bitbadges-sdk)
{% endcontent-ref %}

```bash
npm i bitbadges
```

```ts
import { BitBadgesAPI } from 'bitbadges';

const api = new BitBadgesAPI({
  ...
});

await BitBadgesAPI.getCollection(...);
```

## 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.

```bash
# Install globally
npm install -g bitbadges

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

**Claude Desktop** — add to `claude_desktop_config.json`:

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

**Claude Code:**

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

See the full [Builder Tools Reference](https://docs.bitbadges.io/for-developers/ai-agents/builder-tools) for all tools, schemas, and workflows. For bot/agent guides, see [AI Agents & Bots](https://docs.bitbadges.io/for-developers/ai-agents).

## 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](https://docs.bitbadges.io/for-developers/ai-agents/builder-tools)                                                                                                  |
| **BitBadges SDK**           | `npm i bitbadges` — [Docs](https://docs.bitbadges.io/for-developers/bitbadges-sdk/overview)                                                                                                           |
| **AI Quickstarter Repo**    | [github.com/BitBadges/bitbadges-quickstarter-ai](https://github.com/BitBadges/bitbadges-quickstarter-ai)                                                                                              |
| **GitBook MCP**             | [docs.bitbadges.io/\~gitbook/mcp](https://docs.bitbadges.io/~gitbook/mcp) — searchDocumentation tool                                                                                                  |
| **API OpenAPI Spec**        | [openapi.json](https://raw.githubusercontent.com/bitbadges/bitbadgesjs/main/packages/bitbadgesjs-sdk/openapi-hosted/openapi.json)                                                                     |
| **Proto Definitions**       | [github.com/BitBadges/bitbadgeschain/tree/master/proto](https://github.com/BitBadges/bitbadgeschain/tree/master/proto)                                                                                |
| **Full Docs (.txt)**        | [for-llms.txt](https://github.com/trevormil/bitbadges-docs/blob/master/for-llms.txt)                                                                                                                  |
| **SDK Reference**           | [TypeDoc](https://bitbadges.github.io/bitbadgesjs/classes/BitBadgesAPI.html) — [Types JSON](https://github.com/BitBadges/bitbadgesjs/blob/main/packages/bitbadgesjs-sdk/type-map/typedoc-output.json) |