@inkd/cli

Command-line interface for the Inkd Protocol — permanent on-chain file ownership on Base.

Installation

# Global install
npm install -g @inkd/cli

# Or use without installing
npx @inkd/cli help

Quick Start

# 1. Scaffold config
inkd init

# 2. Set your wallet private key
export INKD_PRIVATE_KEY=0xabc123...

# 3. Check network status
inkd status

# 4. Create your first project (costs $0.10 USDC via x402)
inkd project create --name my-agent --agent --endpoint https://api.example.com

# 5. Push a version
inkd version push --id 1 --hash <arweave-hash> --tag v0.1.0 --changelog "initial release"

Configuration

The CLI reads from inkd.config.json in the current directory. Scaffold it with:

inkd init           # testnet (default)
inkd init --mainnet # mainnet

inkd.config.json

{
  "network": "testnet",
  "rpcUrl": "https://your-rpc-endpoint"
}

⚠️ Never store your private key in the config file. Use the environment variable instead.

Environment Variables

| Variable | Description | |--------------------|-----------------------------------------------| | INKD_PRIVATE_KEY | Wallet private key (hex, 0x optional) | | INKD_NETWORK | mainnet or testnet (overrides config) | | INKD_RPC_URL | Custom RPC endpoint | | INKD_DEBUG | Set to any value to show full error stacks |

Commands

inkd init

Scaffold inkd.config.json in the current directory.

inkd init           # testnet
inkd init --mainnet # mainnet
inkd init --force   # overwrite existing

inkd status

Show network info, contract addresses, and current protocol fees.

inkd status

inkd project create

Register a new project. Locks 1 $INKD in the registry contract.

inkd project create \
  --name my-agent \
  --description "An AI agent that does things" \
  --license MIT \
  --agent \
  --endpoint https://api.example.com

Flags:

| Flag | Required | Description | |-----------------|----------|-------------------------------------------------| | --name | ✅ | Project name (unique, lowercased) | | --description | | Short description | | --license | | SPDX license ID (default: MIT) | | --readme | | Arweave hash of README document | | --private | | Make project private (default: public) | | --agent | | Flag as AI agent project | | --endpoint | | Agent endpoint URL (used with --agent) |

inkd project get <id>

Fetch and display project details.

inkd project get 1
inkd project get --id 42

inkd project list <address>

List all projects owned by an address.

inkd project list 0xDead...

inkd project transfer

Transfer ownership of a project. Requires transferFee ETH.

inkd project transfer --id 1 --to 0xNewOwner...

inkd project collab add|remove

Add or remove a collaborator on a project.

inkd project collab add    --id 1 --address 0xCollaborator...
inkd project collab remove --id 1 --address 0xCollaborator...

inkd version push

Push a new version to a project. Requires versionFee ETH.

inkd version push \
  --id 1 \
  --hash <arweave-tx-id> \
  --tag v0.2.0 \
  --changelog "Bug fixes and performance improvements"

inkd version list <id>

List all versions for a project (newest first).

inkd version list 1

inkd version show

Show details for a specific version by index.

inkd version show --id 1 --index 0

inkd agent list

Browse registered AI agent projects.

inkd agent list
inkd agent list --offset 25 --limit 50

inkd agent lookup <name>

Find an agent project by name.

inkd agent lookup my-agent

Development

git clone https://github.com/inkdprotocol/inkdprotocol.git
cd inkd-protocol/cli
npm install
npm run build
node dist/index.js help

License

MIT — see LICENSE