Skip to main content
The Yoshi CLI lets you interact with the API directly from your terminal. It’s built with Go and generated from the same OpenAPI spec that powers the SDKs.

​
Installation

​
Homebrew (macOS/Linux)

brew install yoshi-ai-dev/yoshi-cli/yoshi

​
Go

Requires Go 1.22 or later: 
go install github.com/yoshi-ai-dev/yoshi-cli/cmd/yoshi@latest
Make sure $GOPATH/bin is in your PATH: 
export PATH="$PATH:$(go env GOPATH)/bin"

​
Authentication

Set your API key as an environment variable: 
export YOSHI_API_KEY=yoshi_3xK9mP...
Or pass it directly with --api-key: 
yoshi accounts list --api-key yoshi_3xK9mP...

​
Usage

The CLI follows a yoshi [resource] <command> structure:

​
List accounts

yoshi accounts list

​
Fetch transactions

yoshi transactions list --limit 10

​
Check financial scores

yoshi scores list

​
View recurring streams

yoshi recurring list

​
Get your profile

yoshi me retrieve

​
Financial summary

yoshi me summary

​
Paper trading

# List paper trading accounts
yoshi paper-trading accounts list

# View holdings
yoshi paper-trading accounts holdings list acc_paper123

​
Output formats

Control how results are displayed with --format:
FormatDescription
autoPretty output for terminals, JSON for pipes (default)
jsonStandard JSON
jsonlJSON Lines (one object per line)
prettyIndented, colored JSON
yamlYAML output
rawRaw API response body
exploreInteractive explorer
# Get JSON for piping
yoshi accounts list --format json | jq '.data.accounts[].name'

# YAML for readability
yoshi scores list --format yaml

​
Transform output

Use --transform with GJSON syntax to extract specific fields: 
# Get just account names
yoshi accounts list --transform "data.accounts.#.name"

# Get the Yoshi score
yoshi scores list --transform "data.yoshi"

​
Global flags

FlagDescription
--api-keyAPI key (or set YOSHI_API_KEY)
--base-urlCustom API base URL
--formatOutput format
--transformGJSON transform expression
--debugShow HTTP request/response details
--version, -vShow CLI version
--helpShow help for any command

​
Explore commands

Run yoshi --help to see all available resources, or yoshi [resource] --help for command-specific options: 
yoshi --help
yoshi transactions --help
yoshi transactions list --help

​
What’s next

SDKs

Use the TypeScript or Python SDK for programmatic access.

Authentication

Create and manage your API key.
Last modified on April 17, 2026