Quickstart

The fastest way to get started is the Telegram Bot — no CLI, no setup, just send a file.

Option 1: Telegram Bot (easiest)

Open @inkdbot
Tap 🎓 Tutorial → creates a wallet for you automatically
Fund it with USDC on Base (scan the QR code)
Send any file, text, or GitHub repo link
Done — stored forever on Arweave, registered on Base

That's it. No private keys to manage, no CLI to install.

→ Full Bot Guide

Option 2: CLI (for developers)

If you prefer the command line or need automation, use the CLI.

Prerequisites

Node.js 18 or later
A wallet with Base Mainnet USDC and a small amount of ETH for gas
Your wallet's private key

:::tip Getting USDC on Base Buy USDC on Coinbase and send to Base, or bridge from Ethereum at bridge.base.org. :::

1. Install the CLI

npm install -g @inkd/cli

Verify the installation:

inkd --version
# @inkd/cli 0.2.0

2. Configure your wallet

export INKD_PRIVATE_KEY=0xYOUR_PRIVATE_KEY
export INKD_NETWORK=mainnet

Check that everything is connected:

inkd status

Inkd Protocol
────────────────────────────────────
Network:   mainnet (Base, chain 8453)
Registry:  0xEd3067dDa601f19A5737babE7Dd3AbfD4a783e5d
Wallet:    0xYourWallet
USDC:      12.50
Projects:  9 registered

3. Create a project

inkd project create \
  --name my-agent \
  --description "My first on-chain project" \
  --license MIT \
  --public

The CLI handles the x402 payment automatically:

→ Requesting payment terms from API...
→ Paying $0.10 USDC via EIP-3009...
→ Submitting transaction...
 
✓ Project created
  Name:       my-agent
  Project ID: 10
  Owner:      0xYourWallet
  TX:         0xabc...
  Basescan:   https://basescan.org/tx/0xabc...

4. Push a version

Upload a file and register it on-chain:

inkd version push \
  --id 10 \
  --file ./dist/agent.js \
  --tag v1.0.0 \
  --changelog "Initial release"

→ Uploading dist/agent.js (14.2 KB) to Arweave...
→ Uploaded: ar://QmAbc123xyz...
→ Paying for version push (Arweave cost + 20% markup)...
→ Submitting transaction...
 
✓ Version pushed
  Tag:      v1.0.0
  Content:  ar://QmAbc123xyz...
  URL:      https://arweave.net/QmAbc123xyz
  TX:       0xdef...

Already have an Arweave hash? Skip the upload:

inkd version push --id 10 --hash ar://QmAbc123xyz --tag v1.0.0

5. Verify on-chain

inkd project get 10

Project #10: my-agent
────────────────────────────────────
Owner:    0xYourWallet
License:  MIT
Public:   true
Versions: 1
Created:  2026-03-07 20:40 UTC

inkd version list 10

Versions for my-agent (1 total)
────────────────────────────────────────────────────────
#0  v1.0.0    ar://QmAbc123xyz…    2026-03-07 20:42 UTC

What's next

SDK — Use ProjectsClient in your agent or TypeScript app
API Reference — Call the HTTP API from any language
x402 Payments — Understand how payments work under the hood