mirror of
https://github.com/0xrsydn/idx-cli.git
synced 2026-11-07 01:35:36 +00:00
15947de51a
Phase 2 of docs/DESIGN.md, no behavior change: - crates/idx-core (library): api, analysis, cache, config file handling and provider selection, curl_impersonate, error, ownership, runtime, plus the shared test fixtures. clap derives are behind an optional `clap` feature so the library does not require clap. - crates/idx-cli (binary `idx`): cli/, output/, and IdxConfig (output format and color resolution). Package and binary names are unchanged. - config.rs is split: file read/write and validation move to core; a CLI test keeps core's OUTPUT_VALUES in sync with OutputSetting. - ownership::db::open_db/db_path drop their unused IdxConfig argument. - One workspace version; shared dependency versions; no third-party version changes in Cargo.lock. LICENSE is symlinked into each crate. - flake: workspace version, new source paths, and a per-crate package check (idx-cli is built from its tarball against packaged idx-core, since idx-core is not on crates.io yet). CI cache key, release path filter, and the golden whitespace-hook exclusion follow the new layout. Parity: all 143 golden outputs match byte for byte without regeneration; 157 core + 17 CLI unit tests (173 before plus the new OUTPUT_VALUES sync test), 62 CLI tests pass. Live A/B against main: 16/16 stocks cases identical; ownership discover got IDX 403 on both (exit 4 vs 1 is the phase 1 exit-code change). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
49 lines
2.6 KiB
Markdown
49 lines
2.6 KiB
Markdown
# AGENTS.md
|
|
|
|
`idx-cli` is a Rust CLI (binary `idx`) for Indonesian stock market analysis
|
|
(`stocks`) and KSEI shareholder ownership (`ownership`).
|
|
|
|
## Navigation
|
|
```text
|
|
crates/idx-core/ library: all data access and analysis
|
|
├── src/api/ providers: msn/ (default), yahoo/ (history/OHLCV)
|
|
├── src/analysis/ technical, fundamental, signals
|
|
├── src/ownership/ xlsx + pdf parsers, archive (ZIP/TXT), remote discovery,
|
|
│ snapshot sync, db (SQLite/FTS5), entities, search, graph
|
|
├── src/{cache,config,error,curl_impersonate}.rs, lib.rs (runtime)
|
|
└── tests/fixtures/ shared fixtures (also read by the mock provider)
|
|
crates/idx-cli/ binary `idx`
|
|
├── src/cli/ clap commands: stocks, ownership, config, cache
|
|
├── src/config.rs IdxConfig: output format and color resolution
|
|
├── src/output/ table.rs, json.rs, style.rs
|
|
└── tests/ cli.rs (behavior), golden.rs + golden/ (output parity)
|
|
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 `403`s explicitly rather than counting them as passes.
|
|
|
|
## Verify
|
|
```bash
|
|
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
|
|
```
|