@shelby-protocol/cli

Shelby – A CLI tool for preparing, uploading, and reading data on Shelby.

Installation

For End Users

Install globally via npm:

npm install -g @shelby-protocol/cli

Verify installation:

shelby --version

Scripts

| Script | Command | Description | | ------- | --------------------------------- | ---------------------------------------- | | lint | biome check . | Run linter to catch style & error issues | | fmt | biome check . --write | Auto-format and fix issues | | build | rimraf dist && rimraf bin; tsup | Clean & bundle the CLI into dist/ | | start | node dist/entry.js | Run the compiled CLI (production build) | | test | vitest run | Run the test suite once (CI / pre-commit)|

NPM Release

1. Bump version
2. Run npm publish

Contributing

Development Setup

# Install dependencies
pnpm install

# Run from typescript dir / turborepo root
# This ensures dependencies are also built (i.e., sdk)
pnpm build --filter @shelby-protocol/cli

# Local testing
pnpm start

# Or link globally for testing
pnpm link --global
shelby <command> [options]

Development Workflow

# Run linter
pnpm lint

# Auto-format code
pnpm fmt

# Run tests
pnpm test

# Build
pnpm build

Testing Commands

During development, you can test CLI commands using pnpm dev instead of shelby:

# Instead of: shelby init
pnpm dev init

# Instead of: shelby upload <input> <output> -e <expiration>
pnpm dev upload ./myfile.txt myfile.txt -e 1735689600

# Instead of: shelby account list
pnpm dev account list