mcpField
B
byreal-cli

byreal-cli

github.com/byreal-gitOther44146 installsUpdated 2d ago
Repository

About byreal-cli

A skill guide for using Byreal LP Management through `byreal-cli`. It covers documentation discovery, wallet safety, and safeguards for read and write operations.

Key features

  1. 01Discover commands and parameters
  2. 02Distinguish read-only and wallet-required actions
  3. 03Keep private keys local
  4. 04Preview transactions before confirmation
  5. 05Apply amount and slippage safeguards

Use cases

  1. 01Look up Byreal CLI capabilities
  2. 02Read pool, token, TVL, or stats data
  3. 03Prepare wallet-dependent position or swap actions

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/byreal-git/byreal-agent-skills --skill byreal-cli

After installing, type/byreal-cliin Claude Code to confirm it loaded.

Details

From the project README

Byreal LP Management

Get Full Documentation

Always run these commands first to get complete, up-to-date documentation:

# Complete documentation (commands, parameters, workflows, constraints)
byreal-cli skill

# Structured capability discovery (all capabilities with params)
byreal-cli catalog list

# Detailed parameter info for a specific capability
byreal-cli catalog show <capability-id>

Installation

# Check if already installed
which byreal-cli && byreal-cli --version

# Install
npm install -g @byreal-io/byreal-cli

Check for Updates

byreal-cli update check

If an update is available:

byreal-cli update install

Credentials & Permissions

  • Read-only commands (pool, token, tvl, stats): No wallet required
  • Write commands (swap, position open/close/claim): Require wallet setup via byreal-cli wallet set or byreal-cli setup
  • Private keys are stored locally at ~/.config/byreal/keys/ with strict file permissions (mode 0600)
  • The CLI never transmits private keys over the network — keys are only used locally for transaction signing
  • AI agents should never ask users to paste private keys in chat; always direct them to run byreal-cli setup interactively

Hard Constraints

  1. -o json only for parsing — when showing results to the user, omit it and let the CLI's built-in tables/charts render directly. Never fetch JSON then re-draw charts yourself.
  2. Never truncate on-chain data — always display the FULL string for: transaction signatures (txid), mint addresses, pool addresses, NFT addresses, wallet addresses. Never use xxx...yyy abbreviation.
  3. Never display private keys - use keypair paths only
  4. Preview first with --dry-run, then --confirm
  5. Large amounts (>$1000) require explicit confirmation
  6. High slippage (>200 bps) must warn user
  7. Check wallet before write ops — run wallet address before any wallet-required command

Comments

Markdown supported