0xrsydn/idx-cli
1
mirror of https://github.com/0xrsydn/idx-cli.git synced 2026-11-07 09:45:36 +00:00
Code Issues Projects Releases 1 Packages Wiki Activity
idx-cli/README.md
hermes a142a3718f feat: add curl | sh install script 
- install.sh: POSIX sh installer that detects OS/arch (incl. Rosetta),
  resolves the newest vX.Y.Z release via the GitHub API (skipping
  ownership-snapshot-current), verifies SHA256SUMS, sanity-runs the
  binary, and installs atomically into ~/.local/bin without sudo.
  Supports --version/--dir and IDX_* env overrides; prints a PATH
  hint, a NixOS flake suggestion, and helper-tool install hints
  instead of calling package managers.
- scripts/install-sh-test.sh: fixture tests against a local fake
  release server (latest, pinned, piped, checksum mismatch, missing
  release, unsupported OS, PATH hint, reinstall).
- ci.yml: install-script job (ShellCheck, sh + dash on Linux, sh on
  macOS).
- release.yml: attach install.sh to each release.
- README + docs/INSTALL.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017a5Cv5Z1NzdYKgKnTiAF4E
2026-09-24 19:29:52 +00:00

2.4 KiB
Raw Permalink Blame History

idx-cli

CLI tool for Indonesian stock market (IDX) analysis, built in Rust for humans and AI agents.

Installation

Install script (Linux, macOS)

curl -fsSL https://raw.githubusercontent.com/0xrsydn/idx-cli/main/install.sh | sh

Downloads the prebuilt idx 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 with sh -s -- --version v0.2.3 --dir ~/bin. See docs/INSTALL.md.

Cargo

cargo install idx-cli

This installs the idx binary. idx-cli currently requires Rust 1.85+.

If you use the install script or the Cargo install path directly, some commands also require helper tools at runtime:

  • Yahoo-authenticated flows require a curl_chrome* binary from curl-impersonate-chrome in PATH, or IDX_CURL_IMPERSONATE_BIN pointing at that binary.
  • Ownership PDF import requires mutool from MuPDF in PATH.

Install those helpers with your OS package manager, or use the Nix app/package below so they are wrapped automatically.

Nix

nix run github:0xrsydn/idx-cli -- version
nix profile install github:0xrsydn/idx-cli#default

The Nix app wraps idx with curl-impersonate and mupdf, so the Yahoo auth and ownership PDF helper tools are available automatically.

Quick start

idx stocks quote BBCA
idx stocks quote BBCA,BBRI,BMRI
idx -o json stocks quote BBCA
idx stocks history BBCA --period 3mo
idx config init
idx cache info
idx --offline stocks quote BBCA

Features

  • Provider abstraction (swap data sources behind one interface)
  • Local file cache with TTL
  • Offline mode with stale-cache fallback
  • Human table output and machine-friendly JSON output

Configuration

Config file location:

  • ~/.config/idx/config.toml

You can configure using:

  • Config file (idx config init, idx config set)
  • Environment variables
  • CLI flags

Precedence order:

  1. CLI flags
  2. Environment variables
  3. Config file
  4. Built-in defaults

Agent-friendly usage

  • Use idx --help and subcommand help for discoverability
  • Use -o json / --output json for structured output

Development

nix develop
cargo test

Prek hooks are configured for quality gates:

  • pre-commit: cargo fmt --check + cargo clippy -- -D warnings
  • pre-push: cargo test

License

MIT