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(web): Stockbit intraday on the quickstart, landing page and agent notes

Browse source
This commit is contained in:
hermes 2026-10-23 07:15:24 +00:00
commit 570439369e
4 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
web/astro.config.mjs
View file

@ -56,7 +56,7 @@ export default defineConfig({
projectName: 'idx-cli',
details: [
'- `idx` is a CLI; `idx-mcp` is an MCP server over the same library. Both read the same config, cache and ownership database.',
'- Output is JSON whenever stdout is not a terminal. Errors are one JSON object on stderr; exit codes: 2 invalid input, 3 not found, 4 upstream unavailable, 5 unsupported, 1 other.',
'- Output is JSON whenever stdout is not a terminal. Errors are one JSON object on stderr; exit codes: 2 invalid input, 3 not found, 4 upstream unavailable or blocked, 5 unsupported, 1 other.',
'- Every page is also available as Markdown by appending `.md` to its path, for example `/agents/install.md`.',
].join('\n'),
}),

6
web/src/content/docs/agents/index.md
View file

@ -19,10 +19,14 @@ What an agent needs to know:
- On failure stdout is empty and stderr holds one JSON object,
`{"error": true, "code": "...", "message": "..."}`.
- Exit codes say what to do next: `2` fix the input, `3` not found (or no
cached data offline), `4` provider unavailable, retry later, `5`
cached data offline), `4` provider unavailable or blocked, retry later, `5`
unsupported, `1` other.
- Tickers are IDX codes (`BBCA`); `.JK` is optional. Several tickers can be
passed at once to `stocks quote` and `stocks compare`.
- `stocks intraday` and `--provider stockbit` read Stockbit's public page,
paced to one request a second across idx processes. Ask for the symbols
you need rather than looping over the market; on `UPSTREAMBLOCKED`, stop
instead of retrying.
- Ownership queries need `idx ownership sync` once; after that they run
offline. `idx -o json ownership releases` shows which months exist.

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

@ -11,6 +11,7 @@ Tickers are IDX codes; the `.JK` suffix is optional.
idx stocks quote BBCA # one quote
idx stocks quote BBCA BBRI BMRI # several (spaces or commas)
idx stocks history BBCA --period 1y # daily OHLCV
idx stocks intraday BBCA # today by the minute (Stockbit)
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

4
web/src/pages/index.astro
View file

@ -127,7 +127,7 @@ TLKM.JK 2,250 <span class="up">+0.45%</span> 87,159,900
<div>
<svg width="28" height="28" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" aria-hidden="true"><path d="M3 17l6-6 4 4 8-8"></path><path d="M15 7h6v6"></path></svg>
<h2>Stocks</h2>
<p>Quotes, OHLC history, financial statements and a screener. Technical, growth, valuation and risk analysis, and side-by-side compare.</p>
<p>Quotes, today's session by the minute, OHLC history, financial statements and a screener. Technical, growth, valuation and risk analysis, and side-by-side compare.</p>
<code>idx stocks fundamental BBRI</code>
</div>
<div>
@ -219,7 +219,7 @@ TLKM.JK 2,250 <span class="up">+0.45%</span> 87,159,900
<dl class="codes">
<dt>2</dt><dd>invalid input or config</dd>
<dt>3</dt><dd>not found, or no cached data offline</dd>
<dt>4</dt><dd>upstream unavailable, retry later</dd>
<dt>4</dt><dd>upstream unavailable or blocked, retry later</dd>
<dt>5</dt><dd>unsupported</dd>
</dl>
</div>