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

docs: catch up the site and README with v0.4.0

Browse source 
The MCP overview and README still counted 11 tools and left out broker
summaries, bandarmology and foreign flow; the providers note still said
foreign flow comes from IDX, though IPOT is the default since #68; the
quickstart had no example of the new commands; and the stocks guide never
explained the behind-session note on quotes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012YsmjNoLBrGi9daeU3kj7k
This commit is contained in:
Rasyidan Akbar F. 2026-10-20 16:10:46 +07:00
commit 018d9ba936
4 changed files with 16 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

10
web/src/content/docs/cli/stocks.md
View file

@ -14,8 +14,10 @@ idx stocks history BBCA --period 1y --interval 1wk
```
`quote` takes several tickers, separated by spaces or commas, or `-` to read
them from stdin. `history` takes `--period` (`1d` to `5y`) and `--interval`
(`1d`, `1wk`, `1mo`).
them from stdin. When a quote's last trade is from before the latest IDX
session, the table says so under it, and JSON sets `behind_session`: the
provider may still show the previous close. `history` takes `--period` (`1d`
to `5y`) and `--interval` (`1d`, `1wk`, `1mo`).
## Company data
@ -139,7 +141,7 @@ idx stocks screen --filter high-dividend | jq -r '.[].symbol' | idx stocks compa
## Providers
MSN is the default for quotes, company data and screening; Yahoo serves
price history. Indo Premier (IPOT) serves broker summaries and IDX's own site
serves foreign flow, whichever provider is selected. Switch with `IDX_PROVIDER=msn|yahoo` and
price history. Indo Premier (IPOT) serves broker summaries and foreign flow
(IDX's own site with `flow --source idx`), whichever provider is selected. Switch with `IDX_PROVIDER=msn|yahoo` and
`IDX_HISTORY_PROVIDER=auto|yahoo|msn`, or the matching
[config keys](/start/config/).

5
web/src/content/docs/mcp/index.md
View file

@ -5,8 +5,9 @@ description: idx-mcp serves idx's stock and ownership data to AI agents over MCP
`idx-mcp` is a [Model Context Protocol](https://modelcontextprotocol.io)
server over stdio. It gives an agent the same data as the `idx` CLI, as
[11 tools](/mcp/tools/) (plus an opt-in `ownership_sync`): quotes, price history, screening, company data,
analysis, comparison, and the KSEI ownership queries.
[14 tools](/mcp/tools/) (plus an opt-in `ownership_sync`): quotes, price history, screening, company data,
analysis, comparison, broker summaries, bandarmology, foreign flow, and the KSEI
ownership queries.
It shares idx's [config, cache and ownership database](/start/config/#files-idx-keeps),
so `idx ownership sync` in a terminal also feeds the server.

3
web/src/content/docs/start/quickstart.md
View file

@ -15,6 +15,9 @@ idx stocks technical BBCA # trend, RSI, MACD, moving averages
idx stocks fundamental BBCA # growth, valuation and risk together
idx stocks compare BBCA BBRI BMRI # fundamentals side by side
idx stocks screen --filter high-dividend
idx stocks broker BBCA # top buying and selling brokers
idx stocks bandar BBCA BBRI BMRI # accumulation or distribution
idx stocks flow BBCA # foreign buy, sell and net by session
```
## Ownership