Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Install

npm install -g @inkd/cli

Configuration

export INKD_PRIVATE_KEY=0xYOUR_PRIVATE_KEY   # required for write operations
export INKD_NETWORK=mainnet                   # mainnet | testnet (default: testnet)
export INKD_RPC_URL=https://...              # optional custom RPC
export INKD_API_URL=https://...              # optional (default: api.inkdprotocol.com)

Or scaffold a local config file:

inkd init

inkd status

Show network connectivity and registry info.

inkd status

inkd project

project create

Register a new project. Costs $5 USDC.

inkd project create \
  --name my-agent \
  --description "An autonomous agent" \
  --license MIT \
  [--agent] \
  [--private] \
  [--endpoint https://my-agent.example.com]
FlagDescription
--nameProject name (required)
--descriptionShort description
--licenseSPDX license (default: MIT)
--agentMark as AI agent project
--privatePrivate project (not publicly listed)
--endpointAgent HTTP endpoint
--readmeArweave hash of README

project get <id>

Fetch project details by ID.

inkd project get 7

project list <address>

List all projects owned by an address.

inkd project list 0xYourAddress

inkd version

version push

Push a new version. Costs $2 USDC.

With file upload (auto-uploads to Arweave first):

inkd version push \
  --id 7 \
  --file ./dist/agent.js \
  --tag v1.0.0
With existing Arweave hash:
inkd version push \
  --id 7 \
  --hash ar://QmAbc123... \
  --tag v1.0.0
FlagDescription
--idProject ID (required)
--fileLocal file to upload to Arweave
--hashPre-existing Arweave hash (ar://...)
--tagVersion tag, e.g. v1.0.0 (required)

version list <id>

List all versions for a project.

inkd version list 7

version show

Show details for a specific version.

inkd version show --id 7 --index 0

Cost summary

OperationCost
project create$5 USDC
version push$2 USDC
project get / version listFree

All payments are made via x402 directly from your wallet. No API key needed.