Crunch Protocol CLI Skill
Translates natural language queries into crunch-cli commands. Supports profiles and output formatting for Slack, Telegram, Discord, or plain text.
Prerequisites
- Node.js 18+ with
npm - Solana wallet keypair (for on-chain operations)
Package Installation
This skill installs packages via npm (global):
| Package | Source | Purpose |
|---|---|---|
@crunchdao/crunch-cli | npm | CrunchDAO protocol CLI (coordinators, competitions, staking) |
Agent rules for package installation:
- Only install
@crunchdao/crunch-clifrom the official npm registry - No custom registry URLs — no
--registryoverrides - Ask the user before installing if not already present
Credentials
Solana Wallet Keypair (required for on-chain operations)
- What it is: A JSON file containing a Solana private key, used to sign transactions
- How it's configured: Set via
crunch-cli config set wallet /path/to/wallet.jsonor-wflag per command - Stored in: User-managed file on disk; path referenced in
~/.crunch/config.json
Agent rules for wallets:
- Never create or generate wallet keypairs unless the user explicitly asks and understands the security implications
- Never read or display the contents of wallet keypair files
- Never commit wallet files to git — always verify
.gitignorecovers them - Ask the user for the wallet path — never assume or search for keypair files
Profile Config (~/.crunch/config.json)
- Stores network, wallet path, and RPC URL per profile
- Managed via
crunch-cli configcommands — no need to edit manually - Never modify or delete existing profiles unless explicitly asked
Setup
npm install -g @crunchdao/crunch-cli
crunch-cli --version
Profiles
The CLI has built-in profile management via ~/.crunch/config.json:
crunch-cli config show # Show current config
crunch-cli config active # Show resolved active values
crunch-cli config list-profiles # List available profiles
crunch-cli config save-profile <name> # Save current config as profile
crunch-cli config use <profile> # Switch profile
crunch-cli config set <key> <value> # Set config value
Global flags can override config per-command:
| Flag | Description |
|---|---|
-n, --network | Solana network: mainnet-beta, devnet, localhost |
-u, --url | Custom RPC URL |
-w, --wallet | Path to Solana keypair |
-o, --output | Output format: json, table, yaml |
Direct Phrase Mapping
| User Phrase | CLI Command |
|---|---|
get/show crunch <name> | crunch-cli crunch get "<name>" |
list crunches | crunch-cli crunch list |
get/show coordinator [address] | crunch-cli coordinator get [address] |
list coordinators | crunch-cli coordinator list |
get config | crunch-cli coordinator get-config |
checkpoint for <name> | crunch-cli crunch checkpoint-get-current "<name>" |
create checkpoint <name> | crunch-cli crunch checkpoint-create "<name>" prizes.json |
deposit reward <name> <amount> | crunch-cli crunch deposit-reward "<name>" <amount> |
drain <name> | crunch-cli crunch drain "<name>" |
create/register cruncher | crunch-cli cruncher create |
register for <name> | crunch-cli cruncher register "<name>" |
claim rewards <name> | crunch-cli cruncher claim "<name>" |
show staking positions | crunch-cli staking positions |
stake/deposit <amount> | crunch-cli staking deposit <amount> |
delegate to <coordinator> | crunch-cli staking delegate "<coordinator>" <amount> |
show staking rewards | crunch-cli staking rewards |
claim staking rewards | crunch-cli staking claim |
undelegate from <coordinator> | crunch-cli staking undelegate "<coordinator>" <amount> |
withdraw stake <amount> | crunch-cli staking withdraw <amount> |
init workspace <name> | crunch-cli init-workspace "<name>" |
list scenarios/simulations | crunch-cli model list |
run simulation <scenario> | crunch-cli model run "<scenario>" |
register coordinator <name> | crunch-cli coordinator register "<name>" |
create crunch <name> | crunch-cli crunch create "<name>" <amount> [maxModels] |
start/end crunch <name> | crunch-cli crunch start/end "<name>" |
Execution Pattern
- Parse — Identify action, target, name/identifier, parameters
- Resolve profile — If mentioned, switch profile or use flags
- Map — Use phrase mapping table
- Execute — Run command
- Format — Output for requested medium (Slack/Telegram/Discord/plain)
Output Formatting
Detect medium from user request ("for slack", "telegram format", etc.):
- Slack:
*bold*,•bullets,━separators - Telegram:
<b>bold</b>, emoji prefixes - Discord:
## headers,**bold** - Plain: Simple key: value pairs
Error Handling
If command fails, suggest fixes:
- Wrong network? Add
-n mainnet-betaor-n devnet - Missing wallet? Add
-w /path/to/wallet.json - Not found? List available with
crunch-cli crunch list
Coordinator Node Setup
Scaffold a new competition workspace:
crunch-cli init-workspace my-challenge
This generates a full node workspace. See the coordinator-node-starter skill for customization.
Reference
For full CLI documentation: references/cli-reference.md