Skip to content

Getting Started

Terminal window
curl -fsSL https://cli.stocksmith.dev/install | bash

This downloads the right binary for your OS/architecture, verifies its checksum, and installs stocksmith to /usr/local/bin (or ~/.local/bin). Homebrew (brew install craftybase/tap/stocksmith) and go install github.com/craftybase/stocksmith-cli/cmd/stocksmith@latest also work.

Terminal window
stocksmith auth login

Paste your Stocksmith API key when prompted (input is hidden). Credentials are saved to ~/.stocksmith/config.toml. See Authentication.

Terminal window
stocksmith materials list

Add --json for the raw API envelope or --ndjson to stream every page. See Output Formats.