Skip to main content
The Nile CLI (nile) outputs structured JSON by default, making it a natural subprocess tool for AI agents. With 30+ commands covering reads, writes, and simulations, agents can drive the full protocol lifecycle through shell invocations.

​
Install

curl -fsSL https://mcp.nilemarkets.com/install.sh | bash
Or via Cargo: 
cargo install nile-markets-cli
Verify installation: 
nile --version
The installed binary embeds Sepolia contract addresses, a free public RPC endpoint, and the subgraph URL. No environment variables, config files, or API keys needed for read commands.

​
JSON Output

All commands output JSON by default. You can also set the format explicitly: 
nile pool state                    # JSON by default
nile --format json pool state      # Explicit JSON
nile --format table pool state     # Human-readable table
JSON responses follow a consistent envelope: 
{
  "protocol": { "name": "Nile Markets", "version": "0.3.0" },
  "network": "sepolia",
  "source": "subgraph",
  "data": {
    "totalAssets": "50000000000",
    "utilization": "4500",
    "sharePrice": "1002345678901234567"
  }
}
Pipe JSON output to jq for field extraction: 
nile pool state --format json | jq '.data.totalAssets'
nile oracle state --format json | jq '.data.spot.price'
nile position list --account 0xabc... --format json | jq '.data[] | .id'

​
Command Groups

GroupKey CommandsDescription
poolstate, deposit, withdraw, transactionsLiquidity pool metrics and LP operations
positionlist, get, search, open, closePosition lifecycle and queries
accountbalance, deposit, withdrawMargin account management
oraclestate, priceSpot and forward price feeds
protocolmodeOperating mode (NORMAL, DEGRADED, REDUCE_ONLY, PAUSED)
simulateopenPreview margin, fees, and entry strike before trading
statsdailyVolume, fees, and position activity over time
feeslistFee event breakdown by category
tokenbalance, allowance, approve, mintERC-20 balance checks and approvals
configshow, set-rpc, set-subgraph, set-walletCLI configuration management

​
Agent Workflow Example

A typical agent-driven trade flow chains CLI commands as subprocess calls:
1

Check protocol mode

Verify the protocol is in NORMAL mode before suggesting trades.
nile protocol mode --format json

{ "data": { "mode": "NORMAL" } }
2

Check balances

Read the trader’s USDC wallet balance and margin account state.
nile token balance --account 0xYOUR_ADDR --format json
nile account balance --account 0xYOUR_ADDR --format json
3

Simulate the trade

Preview margin requirements, fees, and entry strike before committing.
nile simulate open --side LONG --tenor 1M --notional 10000 --margin 500 --format json
4

Execute the trade

Open the position. The CLI builds the transaction, delegates signing to OWS, and broadcasts.
nile position open --side LONG --tenor 1M --notional 10000 --margin 500
5

Verify

Confirm the position was created and check real-time PnL.
nile position get --id <POSITION_ID> --format json

​
OWS Wallet Signing

Read commands work immediately after install. Write commands (open/close positions, deposit/withdraw) require an OWS-compatible wallet for transaction signing. 
# Install OWS
curl -fsSL https://openwallet.sh/install.sh | bash

# Import your private key
echo "<your-private-key>" | ows wallet import --name my-wallet --private-key --chain evm

# Configure the CLI to use your wallet
nile config set-wallet my-wallet
The CLI never handles private keys directly. All signing is delegated to the OWS subprocess via ows sign tx. Wallet setup (key import, passphrase configuration) happens entirely outside the Nile workflow.
Write commands require Sepolia ETH for gas. Get testnet ETH from alchemy.com/faucets or sepoliafaucet.com.

​
Configuration

The CLI works zero-config for Sepolia. For advanced use cases, override settings persistently or per-command.

​
Persistent Config

Stored in ~/.nile/config.json: 
nile config show                   # Show current config
nile config set-rpc <url>          # Override default RPC URL
nile config set-subgraph <url>     # Override default subgraph URL
nile config set-wallet <name>      # Set default wallet name
nile config set-signer <binary>    # Use a different signer binary (default: ows)

​
Environment Variables

VariableDescription
NILE_RPC_URLRPC URL override
NILE_SUBGRAPH_URLSubgraph URL override
NILE_NETWORKTarget network (default: sepolia)
NILE_WALLETWallet name
NILE_FORMATOutput format: json or table (default: json)
NILE_FROMSender address override (read-only/simulate commands)

​
Resolution Order

For all configurable values: CLI flag > environment variable > ~/.nile/config.json > embedded default.

​
CLI vs MCP

Both surfaces expose the same protocol operations. Choose based on your agent’s architecture.
AspectCLIMCP
IntegrationSubprocess / shellHTTP server
SigningBuilt-in via OWSReturns unsigned calldata
AuthNone (local binary)None (M2 testnet)
OutputJSON or tableJSON tool responses
Best forLocal agents, automation scripts, CI pipelinesCloud agents, multi-turn chat, hosted services
For agents running locally with shell access, the CLI is the fastest path to end-to-end trades — it handles signing and broadcasting in a single command. For hosted or multi-tenant agents, use the MCP Server which returns unsigned calldata for client-side signing.