Skip to Content

Getting Started

This guide walks through installing the CLI, running it for the first time, and what to expect in the browser.

Package and Source

Requirements

  • Node.js >= 18
  • pnpm
  • A Solana wallet that can sign transactions (Phantom, Solflare, or any Wallet Standard wallet)
  • Some SOL in the wallet for transaction fees
  • For mainnet-beta: your own RPC endpoint

The CLI runs a local HTTP server on your own machine and opens the studio SPA in your browser. Nothing is sent to any Bonkit-hosted service.

Install and Run

npx @bonkit/airdrop-studio my-campaign

The first run creates a new workspace in ./my-campaign and launches the studio.

Open an Existing Workspace

Any directory that contains a .bonkit/workspace.json file is a studio workspace. Point the CLI at it to reopen:

# Reopen a specific workspace airdrop-studio ./my-campaign # Open the current directory as a workspace airdrop-studio .

Reopening loads your saved state so you can continue from where you stopped, or regenerate the app after changing layout or branding.

What You Will See

The CLI prints a local URL

Studio ready at http://localhost:<port>

The studio opens in your default browser

A left rail shows six sections: Layout, Theme, Brand, Create Airdrop, Review, and Generate App.

Each section edits live state

Saves are written to campaign.config.json and .bonkit/workspace.json in the workspace.

Preview updates as you edit

The right side renders the exact layout the generated app will use.

Image
Studio after first launch

Studio running in the browser after the first launch, showing the left rail with six sections, the inspector panel, and the live preview area.

Workspace Files

my-campaign/ campaign.config.json # Runtime campaign config (brand, network, campaign, ui, content, links) .bonkit/ workspace.json # Studio state (layout, theme, colors, airdrop) batch-draft.json # In-progress recipient append (if any) batch-history.json # Completed batch transactions activity-log.json # Full transaction log

Everything is plain JSON. Commit the workspace to version control if you want a reproducible campaign source.

Common Issues

  • Port already in use → another local studio process is holding the port. Stop it, or launch the new workspace in a different directory so the CLI picks a free port.
  • Cannot find Node.js → install Node.js >= 18 before running the CLI.
  • Wallet extension will not open → browser extensions require HTTPS on production hosts. On localhost, extensions are allowed.

Next Step

Continue to Studio Workflow for the six configuration sections.

Last updated on