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 86c108f6eb test: replace mock smoke matrix with a live-only drift check 
The 43-case mock smoke duplicated tests/cli.rs, which already runs the
real binary against fixture providers. Replace the flake's smoke-mock
check with a small packaged-cli check (version JSON, bash completions,
one mock quote), and cut scripts/live-smoke.sh from 672 to ~170 lines:
it now only runs shipped commands against live MSN/Yahoo/IDX and
validates output shape. Rewrite docs/SMOKE.md around the Nix gate and
the drift check.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 07:45:51 +00:00

1.9 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    CLI integration tests; fixtures in tests/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
  • 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.

Verify

nix flake check -L                       # canonical gate (fmt, clippy, tests, package)
nix develop --command cargo test <name>  # focused loop
scripts/live-smoke.sh                    # opt-in live provider drift check