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)

Go

Requires Go 1.22 or later:
Make sure $GOPATH/bin is in your PATH:

Authentication

Set your API key as an environment variable:
Or pass it directly with --api-key:

Usage

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

List accounts

Fetch transactions

Check financial scores

View recurring streams

Get your profile

Financial summary

Paper trading

Output formats

Control how results are displayed with --format:

Transform output

Use --transform with GJSON syntax to extract specific fields:

Global flags

Explore commands

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

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