Skip to content

Install

Markdown

Prebuilt binaries cover Linux x64/arm64 (static) and macOS arm64/x64. On Windows, use WSL.

Terminal window
npm install --global idx-cli
npx idx-cli --help # or run without installing

The package downloads the checksum-verified release binary during postinstall. pnpm 10+ and bun skip install scripts by default; allow them with pnpm add --global --allow-build=idx-cli idx-cli or bun add --global --trust idx-cli.

Check it works:

Terminal window
idx version

Everyday use needs nothing else: stock data with the default MSN provider, price history, ownership sync and every local ownership query. A few commands call external tools:

Tool Needed for
curl_chrome* from curl-impersonate, or IDX_CURL_IMPERSONATE_BIN ownership discover and ownership import --url (IDX sits behind Cloudflare), and Yahoo fundamentals with IDX_PROVIDER=yahoo
mutool from MuPDF importing legacy PDF ownership reports

idx-mcp installs the same ways (npx -y idx-mcp, cargo install idx-mcp, or nix profile install github:0xrsydn/idx-cli#idx-mcp). See MCP setup.

Terminal window
idx completions bash > ~/.local/share/bash-completion/completions/idx
idx completions zsh > "${fpath[1]}/_idx"
idx completions fish > ~/.config/fish/completions/idx.fish