Install
MarkdownPrebuilt binaries cover Linux x64/arm64 (static) and macOS arm64/x64. On Windows, use WSL.
npm install --global idx-clinpx idx-cli --help # or run without installingThe 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.
curl -fsSL https://raw.githubusercontent.com/0xrsydn/idx-cli/main/install.sh | shDownloads the binary for your platform from GitHub Releases, verifies it
against the release SHA256SUMS, and installs it into ~/.local/bin without
sudo. Pin a version or change the directory:
curl -fsSL https://raw.githubusercontent.com/0xrsydn/idx-cli/main/install.sh | sh -s -- --version v0.3.1 --dir ~/bincargo install idx-cliBuilds from source. Requires Rust 1.89 or newer.
nix profile install github:0xrsydn/idx-clinix run github:0xrsydn/idx-cli -- version # or run without installingThe Nix package bundles the helper tools below.
Check it works:
idx versionHelper tools
Section titled “Helper tools”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 |
The MCP server
Section titled “The MCP server”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.
Shell completions
Section titled “Shell completions”idx completions bash > ~/.local/share/bash-completion/completions/idxidx completions zsh > "${fpath[1]}/_idx"idx completions fish > ~/.config/fish/completions/idx.fish