← Back to Skills Marketplace
astinz

DeepBook CLI. Watch, Make & Take the Sui Market

by astinz · GitHub ↗ · v0.0.1
cross-platform ✓ Security Clean
1497
Downloads
1
Stars
1
Active Installs
1
Versions
Install in OpenClaw
/install deepbook-cli
Description
Operate the deepbook CLI for DeepBook reads (REST/SSE), global ~/.deepbook config/account management, on-chain spot trading, top-level swap execution, balance-manager ops, and margin trading.
README (SKILL.md)

DeepBook CLI Skill

Use this skill when the user wants to use deepbook end to end: market data, wallet/config setup, and on-chain execution (spot, swap, manager, margin).

Installation

Check if deepbook is installed:

deepbook --version

If not, install it:

npm install -g deepbook-cli

Setup

  1. Work from the deepbook-cli project directory.
  2. Ensure ~/.deepbook/config.json exists (auto-created on first run).
  3. Configure global defaults in ~/.deepbook (works from any path).
  4. Optional one-off overrides can still be provided via global flags.

mainnet/testnet are aliases used consistently for both provider-side reads/streams and on-chain RPC.

Global flags

  • --json
  • --provider \x3Cname>
  • --base-url \x3Curl>
  • --stream-base-url \x3Curl>
  • --network \x3Cmainnet|testnet>
  • --rpc-url \x3Curl>
  • --private-key \x3Csuiprivkey>
  • --address \x3Caddress>
  • --manager \x3Cid>
  • --trade-cap \x3Cid>

Available commands

  • Top-level:

    • deepbook providers
    • deepbook pools
    • deepbook orderbook \x3Cpool> (alias: deepbook book \x3Cpool>)
    • deepbook trades \x3Cpool>
    • deepbook ohlcv \x3Cpool>
    • deepbook stream ...
    • deepbook spot ...
    • deepbook swap ...
    • deepbook margin ...
    • deepbook manager ...
    • deepbook config ...
    • deepbook account ...

  • deepbook config:

    • show
    • set-network \x3Cnetwork>
    • set-provider \x3Cprovider>
    • set-rpc-url \x3Cnetwork> \x3Curl>
    • set-address \x3Caddress>
    • set-trade-cap \x3Cid>
    • set-read-key [apiKey]
    • set-stream-key \x3Cpool> [apiKey]
    • set-provider-base-url \x3Cnetwork> \x3Curl>
    • set-provider-stream-base-url \x3Cnetwork> \x3Curl>
    • import-key [privateKey]

  • deepbook account:

    • details
    • list
    • balance
    • import \x3Calias> [privateKey]
    • use \x3Calias>

  • deepbook stream:

    • trades \x3Cpool>

  • deepbook spot:

    • pools
    • buy \x3Cpool>
    • sell \x3Cpool>
    • limit \x3Cpool>

  • deepbook swap:

    • base-for-quote \x3Cpool>
    • quote-for-base \x3Cpool>

  • deepbook margin:

    • pools
    • managers
    • deposit \x3Cpool>
    • market \x3Cpool>
    • limit \x3Cpool>
    • position \x3Cpool>
    • close \x3Cpool>

  • deepbook manager:

    • ls
    • create
    • deposit
    • withdraw
    • balance

Command cheat sheet (required args/options)

  • deepbook providers

  • deepbook pools

  • deepbook orderbook \x3Cpool>

  • deepbook trades \x3Cpool>

  • deepbook ohlcv \x3Cpool>

  • deepbook stream trades \x3Cpool>

  • deepbook spot pools

  • deepbook spot buy \x3Cpool> --quantity \x3Cvalue> [--price \x3Cvalue>] [--manager \x3Cid>]

  • deepbook spot sell \x3Cpool> --quantity \x3Cvalue> [--price \x3Cvalue>] [--manager \x3Cid>]

  • deepbook spot limit \x3Cpool> --side \x3Cbuy|sell> --price \x3Cvalue> --quantity \x3Cvalue> [--manager \x3Cid>]

  • deepbook spot limit \x3Cpool> --cancel \x3Cid> [--manager \x3Cid>]

  • deepbook config show

  • deepbook config set-network \x3Cmainnet|testnet>

  • deepbook config set-provider \x3Csurflux>

  • deepbook config set-rpc-url \x3Cmainnet|testnet> \x3Curl>

  • deepbook config set-address \x3Caddress>

  • deepbook config set-trade-cap \x3CobjectId>

  • deepbook config set-read-key [apiKey] (or --stdin)

  • deepbook config set-stream-key \x3Cpool> [apiKey] (or --stdin)

  • deepbook config set-provider-base-url \x3Cmainnet|testnet> \x3Curl>

  • deepbook config set-provider-stream-base-url \x3Cmainnet|testnet> \x3Curl>

  • deepbook config import-key [privateKey] (or --stdin, optional --alias)

  • deepbook account details

  • deepbook account list

  • deepbook account balance [--coin \x3CSUI|USDC|DEEP|coinType>]

  • deepbook account import \x3Calias> [privateKey] (or --stdin)

  • deepbook account use \x3Calias>

  • deepbook swap base-for-quote \x3Cpool> --amount \x3Cvalue>

  • deepbook swap quote-for-base \x3Cpool> --amount \x3Cvalue>

  • deepbook margin pools

  • deepbook margin managers

  • deepbook margin deposit \x3Cpool> --coin \x3CBASE|QUOTE|DEEP|coinKey> --amount \x3Cvalue> [--margin-manager \x3Cid>]

  • deepbook margin market \x3Cpool> --side \x3Cbuy|sell> --quantity \x3Cvalue> [--margin-manager \x3Cid>]

  • deepbook margin limit \x3Cpool> --side \x3Cbuy|sell> --price \x3Cvalue> --quantity \x3Cvalue> [--margin-manager \x3Cid>]

  • deepbook margin position \x3Cpool> [--margin-manager \x3Cid>]

  • deepbook margin close \x3Cpool> [--margin-manager \x3Cid>] + either:

    • --full
    • OR --side \x3Cbuy|sell> --quantity \x3Cvalue>

  • deepbook manager ls

  • deepbook manager create

  • deepbook manager deposit --coin \x3Ckey> --amount \x3Cvalue> [--manager \x3Cid>]

  • deepbook manager withdraw --coin \x3Ckey> --amount \x3Cvalue> [--manager \x3Cid>]

  • deepbook manager balance --coin \x3Ckey> [--manager \x3Cid>]

Key margin close flags

  • deepbook margin close \x3Cpool> --full --withdraw
  • deepbook margin close \x3Cpool> --full --non-reduce-only
  • deepbook margin close \x3Cpool> --side \x3Cbuy|sell> --quantity \x3Cq> --reduce-only --no-repay

Swap vs spot market buy

  • Swap (deepbook swap quote-for-base) is a direct pool swap with exact-input semantics.
  • Spot market buy (deepbook spot buy \x3Cpool> --quantity ...) is an orderbook market order and uses a balance manager.
  • CLI output now includes execution.kind and execution.type/direction so the mode is explicit.

Safety defaults

  • Prefer --dry-run first for all state-changing commands.
  • Validate pool key and manager object ID before placing/canceling orders.
  • SUI-involved deposit/collateral paths split from gas coin inside the transaction automatically.
  • Never print or log private keys.
  • Margin manager type safety:
    • Margin managers are generic typed objects: MarginManager\x3CBase, Quote>.
    • The margin manager type must match the exact pool pair being traded.
    • Example: MarginManager\x3CDEEP,USDC> works with DEEP_USDC, not DEEP_SUI.
  • Margin manager resolution behavior:
    • If --margin-manager is omitted, CLI auto-selects a compatible manager for that pool, or creates one in-transaction if none exists.
    • If --margin-manager is provided, CLI treats it as explicit and strict: it must match signer + pool; no fallback or auto-create is performed.
  • Internal margin fee buffer behavior:
    • Margin market/limit orders auto-deposit a fee buffer before placing the order.
    • With --no-pay-with-deep, buffer is deposited in trade asset collateral (base for sell, quote for buy).
    • Without --no-pay-with-deep, buffer is deposited as DEEP into the margin manager.
  • Full-close quantity normalization:
    • deepbook margin close \x3Cpool> --full now auto-normalizes inferred quantity to pool lot-size/min-size.
    • If reduce-only full close cannot satisfy lot-size exactly, CLI auto-switches to non-reduce-only and rounds up, then repays debt in the same transaction.
    • If user explicitly passes --reduce-only, CLI keeps reduce-only semantics and errors when full close cannot be represented as a valid lot-size quantity.

End-to-end spot trading flow (fund -> buy -> withdraw)

Use this when executing a real spot trade through a balance manager.

  1. Discover balance managers:
    • deepbook manager ls
  2. If none exist, create one:
    • deepbook manager create
  3. Deposit quote coin to manager (for DEEP_SUI buy, fund SUI):
    • deepbook manager deposit --coin SUI --amount 1 --manager \x3Cid>
  4. Optional balance check:
    • deepbook manager balance --coin SUI --manager \x3Cid>
  5. Simulate buy first:
    • deepbook spot buy DEEP_SUI --quantity 38 --manager \x3Cid> --no-pay-with-deep --dry-run
  6. Execute live buy:
    • deepbook spot buy DEEP_SUI --quantity 38 --manager \x3Cid> --no-pay-with-deep
  7. Withdraw purchased asset to signer address (or explicit recipient):
    • deepbook manager withdraw --coin DEEP --amount 38 --manager \x3Cid>
    • optional recipient: --recipient \x3Caddress>
  8. Verify manager balance:
    • deepbook manager balance --coin DEEP --manager \x3Cid>

Spot trade troubleshooting

  • MoveAbort ... balance_manager::withdraw_with_proof code=3 means manager available balance is too low.
  • This includes fees/reserved amounts, not just raw deposited balance.
  • For spot buys, ensure quote coin is funded in manager (for DEEP_SUI, quote is SUI).
  • If fees are attempted in DEEP and manager lacks DEEP, either deposit DEEP or pass --no-pay-with-deep.
  • When manager is omitted, CLI resolves dynamically:
    • one manager found -> uses it
    • none found -> error
    • multiple found -> require --manager \x3Cid>

Typical workflow

  1. Inspect pools/orderbook (deepbook spot pools, deepbook margin pools, deepbook orderbook ...).
  2. Confirm manager ID (deepbook manager ls).
  3. Simulate order (deepbook spot buy ... --dry-run).
  4. Execute live order (same command without --dry-run).
  5. Monitor with deepbook orderbook --watch and deepbook stream trades ....
Usage Guidance
This skill is coherent for using a trading CLI, but exercise caution before installing or running it: 1) 'npm install -g deepbook-cli' will install a package from the public npm registry — verify the package name, publisher, and source code (or prefer a pinned version) before installing globally. 2) The CLI will ask to import or use private keys and API keys; never paste sensitive keys into an untrusted environment. Use --dry-run and test on testnet first. 3) Consider installing and running the CLI in an isolated environment (container or VM), inspect the package source, and use ephemeral keys or read-only API keys when possible. 4) If you need higher assurance, ask the publisher/source for a homepage/repository or for signed release artifacts; absence of a homepage lowers confidence.
Capability Analysis
Type: OpenClaw Skill Name: deepbook-cli Version: 0.0.1 The skill is designed to operate a financial CLI tool (`deepbook-cli`) for cryptocurrency trading and account management. While it involves inherently high-risk operations such as installing a global npm package (`npm install -g deepbook-cli` in SKILL.md), managing configuration files in `~/.deepbook`, and handling private keys and API keys (via `import-key`, `set-read-key`, `set-stream-key` commands), these capabilities are directly aligned with the stated purpose of a trading skill. The `SKILL.md` file explicitly includes 'Safety defaults' such as 'Never print or log private keys' and recommends `--dry-run` for state-changing commands, indicating an awareness of security best practices. There is no evidence of intentional harmful behavior, data exfiltration, persistence mechanisms, obfuscation, or malicious prompt injection attempts against the AI agent within the provided files.
Capability Assessment
✓ Purpose & Capability
The name/description describe a CLI for market data and on‑chain trading; the SKILL.md contains only CLI usage, config locations (~/.deepbook), and commands for spot/swap/margin/manager operations — all directly related to the stated purpose. There are no unrelated credential or service demands in metadata.
ℹ Instruction Scope
Instructions focus on using the deepbook CLI and its config under ~/.deepbook. They explicitly instruct installing the npm package and performing state-changing commands (buy/sell/deposit/withdraw/import-key). The skill references private-key and apiKey handling (import-key, --private-key, --stdin) — appropriate for a trading CLI but sensitive; SKILL.md does advise not to print private keys and to prefer --dry-run as a safety default.
ℹ Install Mechanism
No formal install spec in the registry; the runtime instructions tell the agent to run 'npm install -g deepbook-cli'. Installing a global npm package is a normal way to obtain a CLI but carries moderate risk because the package source/homepage is not provided in the skill metadata. There's no pinned version or verification step shown.
ℹ Credentials
The skill requests no env vars or credentials in the metadata, but the CLI workflow requires handling private keys and API keys (via flags or stdin). That is proportionate to a trading CLI, but the skill does not declare a primary credential or required config paths beyond ~/.deepbook, so users should be aware secrets will be entered/managed by the CLI rather than provided via declared env vars.
✓ Persistence & Privilege
always is false and the skill is instruction-only (no persistent background hooks). It writes/reads user config at ~/.deepbook and may install a global npm package (which modifies system state). Nothing indicates the skill will modify other skills or system-wide agent settings.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install deepbook-cli
  3. After installation, invoke the skill by name or use /deepbook-cli
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v0.0.1
Initial release of deepbook-cli skill: end-to-end DeepBook CLI operations. - Supports market data retrieval, configuration, account management, spot and margin trading, swaps, balance management, and manager ops via deepbook CLI. - Documents required installation, global config setup, and CLI global flags. - Lists all available top-level and sub-commands, with argument/option cheat sheet for each operation. - Details safety defaults for trading, manager compatibility, margin flows, dry-run, and internal fee buffer handling. - Includes best-practice flows for end-to-end spot trading through a balance manager. - Provides explicit guidance on global network/provider selection, key handling, and on-chain execution aliases.
Metadata
Slug deepbook-cli
Version 0.0.1
License —
All-time Installs 1
Active Installs 1
Total Versions 1
Frequently Asked Questions

What is DeepBook CLI. Watch, Make & Take the Sui Market?

Operate the deepbook CLI for DeepBook reads (REST/SSE), global ~/.deepbook config/account management, on-chain spot trading, top-level swap execution, balance-manager ops, and margin trading. It is an AI Agent Skill for Claude Code / OpenClaw, with 1497 downloads so far.

How do I install DeepBook CLI. Watch, Make & Take the Sui Market?

Run "/install deepbook-cli" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is DeepBook CLI. Watch, Make & Take the Sui Market free?

Yes, DeepBook CLI. Watch, Make & Take the Sui Market is completely free (open-source). You can download, install and use it at no cost.

Which platforms does DeepBook CLI. Watch, Make & Take the Sui Market support?

DeepBook CLI. Watch, Make & Take the Sui Market is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created DeepBook CLI. Watch, Make & Take the Sui Market?

It is built and maintained by astinz (@astinz); the current version is v0.0.1.

More Skills
self-improving agent
Captures learnings, errors, and corrections to enable continuous improvement. Use when: (1) A command or operation fails unexpectedly, (2) User corrects Clau...
⬇ 463283 · by pskoett
Skill Vetter
Security-first skill vetting for AI agents. Use before installing any skill from ClawdHub, GitHub, or other sources. Checks for red flags, permission scope, and suspicious patterns.
⬇ 259410 · by spclaudehome
Polymarket
Query Polymarket prediction markets. Check odds, find trending markets, search events, track price movements.
⬇ 232503 · by joelchance
Self-Improving + Proactive Agent
Self-reflection + Self-criticism + Self-learning + Self-organizing memory. Agent evaluates its own work, catches mistakes, and improves permanently. Use when...
⬇ 200423 · by ivangdavila
Github
Interact with GitHub using the `gh` CLI. Use `gh issue`, `gh pr`, `gh run`, and `gh api` for issues, PRs, CI runs, and advanced queries.
⬇ 191113 · by steipete
ontology
Typed knowledge graph for structured agent memory and composable skills. Use when creating/querying entities (Person, Project, Task, Event, Document), linkin...
⬇ 190156 · by oswalpalash

💬 Comments