0xrsydn/idx-cli
1
mirror of https://github.com/0xrsydn/idx-cli.git synced 2026-11-07 01:35:36 +00:00
Code Issues Projects Releases 1 Packages Wiki Activity
No description
118 commits 54 branches 12 tags 2.9 MiB
  • Rust 82.3%
  • Shell 11.5%
  • Astro 2%
  • Nix 1.3%
  • JavaScript 1.3%
  • Other 1.6%
Find a file
hermes c2d2734739 feat(ownership): build snapshots from XLSX with monthly history 
- build-latest-ownership-snapshot.sh: discover with a wider limit and
  add --history <n> to import the n previous supported above-1% XLSX
  months (one per as-of date, oldest first) before the latest, so
  `idx ownership changes` works straight from a synced snapshot.
- publish-ownership-snapshot.sh: pass --history through (for the
  clan-private systemd timer via extraArgs).
- publish-ownership-snapshot.yml: `history` input (default 5).
- Docs: publish/self-hosted flow now describes the XLSX source,
  observed upload days (2nd-3rd of the month), and --history.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017a5Cv5Z1NzdYKgKnTiAF4E
2026-09-24 21:12:05 +00:00
.agents chore: warm orb local data during setup 2026-09-20 14:30:52 +00:00
.codex/skills/idx-release docs: add idx release skill 2026-04-13 14:39:40 +07:00
.github/workflows feat(ownership): build snapshots from XLSX with monthly history 2026-09-24 21:12:05 +00:00
contrib/systemd ops: draft self-hosted ownership snapshot publish flow 2026-04-13 16:46:53 +07:00
docs feat(ownership): build snapshots from XLSX with monthly history 2026-09-24 21:12:05 +00:00
scripts feat(ownership): build snapshots from XLSX with monthly history 2026-09-24 21:12:05 +00:00
src fix(ownership): harden data-page discovery per review 2026-09-24 21:11:56 +00:00
tests fix(ownership): harden data-page discovery per review 2026-09-24 21:11:56 +00:00
.envrc dev: add flake.nix and .envrc for Rust dev environment 2026-03-05 16:23:49 +00:00
.gitignore Merge pull request #22 from 0xrsydn/feat/npm-distribution 2026-09-25 02:18:04 +07:00
.pre-commit-config.yaml ci: convert prek.toml to .pre-commit-config.yaml (prek 0.3 compat) 2026-03-05 18:32:48 +00:00
AGENTS.md feat(ownership): discover above-1% XLSX on the IDX data page 2026-09-24 21:09:05 +00:00
Cargo.lock fix: handle spaced KSEI PDF headers (SHARE CODE vs SHARE_CODE) 2026-07-29 04:21:54 +00:00
Cargo.toml fix: handle spaced KSEI PDF headers (SHARE CODE vs SHARE_CODE) 2026-07-29 04:21:54 +00:00
CLAUDE.md docs: add AGENTS.md + CLAUDE.md symlink for agent-first development 2026-03-05 18:00:29 +00:00
FEATURE_SPEC.md feat: support explicit MSN chart history 2026-04-15 13:48:27 +07:00
flake.lock feat: implement MVP foundation — quote, history, provider abstraction 2026-03-05 17:59:50 +00:00
flake.nix feat: add npm distribution wrapper for idx-cli 2026-08-18 11:14:55 +00:00
install.sh fix: expand quoted ~ in install dir and trim trailing slashes on mirror URLs 2026-09-24 19:34:18 +00:00
LICENSE docs: add MIT license for 2026 contributors 2026-03-05 19:35:06 +00:00
package.json fix: harden npm distribution release and installer 2026-09-24 18:57:53 +00:00
README.md feat: add curl | sh install script 2026-09-24 19:29:52 +00:00
TODO.md feat: support explicit MSN chart history 2026-04-15 13:48:27 +07:00

README.md

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