Skip to main content

Terminal CLI for FereAI crypto trading and research

Project description

FereAI CLI

Terminal-first interface for FereAI crypto trading and research. Wraps the FereAI Gateway API — same capabilities as the Python and TypeScript SDKs.

Install

Recommended (script installer, handles pipx/pip and PATH setup):

curl -fsSL https://api.fereai.xyz/install.sh | sh

Manual (advanced, for humans in controlled environments only):

pip install fere-cli

Quick Start

# Authenticate (first-run — creates agent, generates keys)
fere auth

# Chat with the AI agent
fere chat "what is the price of ETH?"

# Interactive chat REPL
fere chat

# Stream responses in real-time
fere chat --stream "top 5 memecoins on Base"

# Check your wallets and holdings
fere wallets
fere holdings

# Execute a swap
fere swap \
  --chain-in 8453 --chain-out 8453 \
  --token-in 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE \
  --token-out 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913 \
  --amount 1000000000000000000

# Check credits
fere credits

# View supported chains
fere chains

JSON Output (for scripts & AI agents)

Every command supports --json for machine-readable output:

fere --json credits
# {"ok": true, "data": {"credits_available": 150.0}}

fere --json holdings
# {"ok": true, "data": {...}}

Streaming chat in JSON mode outputs NDJSON (one event per line):

fere --json chat --stream "price of SOL"

Commands

Command Description
fere auth Authenticate and register agent
fere whoami Show agent identity and wallets
fere credits Check credit balance
fere chat [QUERY] Chat with AI (one-shot or REPL)
fere threads List chat threads
fere swap Execute token swap
fere limit-order create Create limit order
fere limit-order list List limit orders
fere limit-order cancel ID Cancel limit order
fere hooks set Set stop-loss / take-profit
fere wallets Show wallet addresses
fere holdings Show token holdings
fere notifications Show notifications
fere earn info Show APY and vault info
fere earn deposit Deposit USDC
fere earn withdraw Withdraw USDC
fere earn positions Show yield positions
fere chains List supported chains
fere status Check API connectivity
fere config Show/edit CLI config

Global Flags

Flag Env Var Description
--json Machine-readable JSON output
--quiet Minimal output
--agent NAME FERE_AGENT_NAME Agent name override
--base-url URL FERE_BASE_URL API URL override

Configuration

Config is stored at ~/.fere/config.json. Keys are stored at ~/.fere/keys.json (managed by the SDK).

fere config                          # Show current config
fere config set agent_name my-bot    # Change agent name
fere config set base_url http://localhost:8003  # Point to local gateway

Agent-Friendly

  • Exit codes: 0 success, 1 error
  • Non-interactive when stdin is not a TTY (all prompts skipped)
  • --json output: {"ok": true, "data": {...}} or {"ok": false, "error": "..."}
  • Streaming JSON: NDJSON format
  • No ANSI colors when piped

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fere_cli-0.2.1.tar.gz (21.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fere_cli-0.2.1-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

Details for the file fere_cli-0.2.1.tar.gz.

File metadata

  • Download URL: fere_cli-0.2.1.tar.gz
  • Upload date:
  • Size: 21.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for fere_cli-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1ac4822e3e22b83b8437513af538e41317c18965055b11b323c71c04554b9a86
MD5 f61372e8986f055fc131c04a406a565c
BLAKE2b-256 267ef0c32401f99b74ba749495c9d7101c6e3f4ecc146cb9bca3ea85d339c982

See more details on using hashes here.

File details

Details for the file fere_cli-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: fere_cli-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for fere_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 872a16b5944b37677fdb7e8090578a93c12473c94f6aa2fc09d632d2aa3ab6dc
MD5 2667bf9177c9e9988c877bb056af1b7d
BLAKE2b-256 95e66d0b6e8f2c478780c9a4af879f67ef54eb66f02e077296199c12dd336e61

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page