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
idx-cli/AGENTS.md
hermes fe627496dd test: add golden output parity gate and live A/B compare 
Phase 0 of docs/DESIGN.md, before any refactor code:

- tests/golden.rs runs every case in tests/golden/cases.toml (126
  outputs across help, completions, config, cache, all stocks commands
  on MSN and Yahoo mocks, error paths, and ownership queries on a seeded
  fixture DB) and compares exit code, stdout, and stderr byte for byte.
  Regenerate only with UPDATE_GOLDEN=1 for a reviewed output change.
- scripts/live-smoke.sh --compare <old-idx> runs each live case with
  both binaries and fails on differing exit codes, added/missing/retyped
  JSON keys, or changed values for slow-moving data.
- Exclude golden files from the whitespace/EOF pre-commit fixers, which
  would otherwise rewrite pinned help output.

Both gates were fault-injected: a one-word table change fails exactly
the three history goldens, and a binary dropping profile.long_name fails
only the profile live comparison.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 08:33:25 +00:00

2.2 KiB
Raw Blame History

AGENTS.md

idx-cli is a Rust CLI (binary idx) for Indonesian stock market analysis (stocks) and KSEI shareholder ownership (ownership).

Navigation

src/
├── main.rs, config.rs, cache.rs, error.rs, curl_impersonate.rs
├── cli/        clap commands: stocks, ownership, config, cache
├── api/        providers: msn/ (default), yahoo/ (history/OHLCV)
├── analysis/   technical, fundamental, signals
├── ownership/  xlsx + pdf parsers, archive (ZIP/TXT), remote discovery,
│               snapshot sync, db (SQLite/FTS5), entities, search, graph
└── output/     table.rs, json.rs
tests/          cli.rs (behavior), golden.rs + golden/ (output parity), fixtures/
scripts/        smoke, installer, and ownership snapshot publisher

Docs:

  • docs/ARCHITECTURE.md: providers, ownership ingest/discovery, error and output contract
  • docs/CONVENTIONS.md: types, naming, testing, and git rules
  • docs/OWNERSHIP_SYNC.md / docs/OWNERSHIP_PUBLISH.md: snapshot consumer contract / maintainer publishing
  • docs/SMOKE.md: Nix checks, test layout, and the live drift check
  • docs/DESIGN.md: idx-core / idx-mcp design and parity gates
  • ROADMAP.md: open work

Rules

  1. Keep data access provider-driven; no ad hoc fetches in cli/.
  2. Keep parse/normalize functions pure.
  3. Tests use fixtures and IDX_USE_MOCK_PROVIDER=1; never hit the live network.
  4. Output contract: tables on stdout, one JSON document with -o json, errors on stderr (JSON-shaped in JSON mode), stdout empty on failure.
  5. Keep ownership queries (releases, ticker, changes, ...) working across every ingest path: XLSX, legacy PDF, archive ZIP/TXT, and snapshot sync.
  6. ownership import --fetch-bing is intentionally unsupported.
  7. Output parity is a contract: never edit golden files to make a change pass. After changing CLI behavior, run the live check and report its summary; report IDX 403s explicitly rather than counting them as passes.

Verify

nix flake check -L                       # canonical gate (fmt, clippy, tests, package)
nix develop --command cargo test <name>  # focused loop
scripts/live-smoke.sh --compare <old>    # live drift check, A/B against an older build