idx-cli/web/src/content/docs/cli/reference.md at 21bf6b204a45d96407d2c612a2695cc2f5bebac7

mirror of https://github.com/0xrsydn/idx-cli.git synced 2026-11-07 01:35:36 +00:00

hermes e6805474f5 feat(web): idx website and user docs (Astro Starlight)

Landing page plus docs for install, quickstart, config, the stocks and
ownership CLI, output and exit codes, the MCP server and per-agent setup,
agent usage, and an agent-led install page (agents/install.md) that a
coding agent follows from a one-line prompt.

- Every docs page is also served as Markdown at <path>.md; llms.txt and
  llms-full.txt come from starlight-llms-txt; a SKILL.md for skill-based
  harnesses is under /skills/idx/.
- The CLI reference and MCP tools pages are generated from idx --help and
  the tools golden; a new web-generated flake check fails when they drift.
- nix develop .#web provides bun; Cloudflare Pages builds web/ on pushes.
- Package homepage metadata points at https://idx.rasyidanaf.com.
- .cloudflare/ (the cf CLI's account cache) is git-ignored.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

2026-10-15 05:12:45 +00:00

33 KiB

Raw Blame History

title	description
Command reference	Every idx command and flag, generated from idx --help.

This page is generated from idx --help, so it always matches the released CLI. For explanations and examples, see the stocks and ownership guides.

`idx`

idx-cli is a Rust command-line tool for Indonesian stock market (IDX) analysis.
It supports quote lookup, historical data, local caching, and output formats for both humans and AI agents.

Usage: idx [OPTIONS] <COMMAND>

Commands:
  stocks       Stock data and analysis
  config       Manage configuration
  cache        Manage local cache
  ownership    Ownership intelligence (bootstrap with `ownership sync`)
  completions  Generate shell completions
  version      Show idx-cli version
  help         Print this message or the help of the given subcommand(s)

Options:
  -o, --output <OUTPUT>
          Output format [default: auto = table on a terminal, json when piped]

          [possible values: auto, table, json, jsonl]

      --no-color
          Disable colored output

  -q, --quiet
          Suppress non-essential output

  -v, --verbose...
          Increase verbosity (-v, -vv)

      --offline
          Run without network requests

      --no-cache
          Bypass local cache

  -h, --help
          Print help (see a summary with '-h')

`idx stocks`

Stock data and analysis

Usage: idx stocks [OPTIONS] <COMMAND>

Commands:
  quote        Get real-time stock quotes
  history      Get historical OHLC data
  technical    Run technical analysis on a stock
  growth       Run growth analysis on a stock
  valuation    Run valuation analysis on a stock
  risk         Run risk analysis on a stock
  fundamental  Run full fundamental analysis on a stock
  profile      Get company profile
  financials   Get financial statements
  earnings     Get earnings report
  sentiment    Get crowd sentiment
  insights     Get AI insights
  news         Get stock news
  screen       MSN screener
  compare      Compare fundamentals across stocks
  help         Print this message or the help of the given subcommand(s)

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx stocks quote`

Get real-time stock quotes

Usage: idx stocks quote [OPTIONS] <SYMBOLS>...

Arguments:
  <SYMBOLS>...  One or more symbols, comma-separated or space-separated; `-` reads them from stdin

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

Examples:
  idx stocks quote BBCA
  idx stocks quote BBCA,BBRI,BMRI
  idx -o json stocks quote BBCA
  echo BBCA BBRI | idx stocks quote -

`idx stocks history`

Get historical OHLC data

Usage: idx stocks history [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>  Single ticker symbol (e.g. BBCA)

Options:
  -o, --output <OUTPUT>
          Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --period <PERIOD>
          [default: 3mo] [possible values: 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y]
      --interval <INTERVAL>
          [default: 1d] [possible values: 1d, 1wk, 1mo]
      --no-color
          Disable colored output
      --history-provider <HISTORY_PROVIDER>
          [possible values: auto, yahoo, msn]
  -q, --quiet
          Suppress non-essential output
  -v, --verbose...
          Increase verbosity (-v, -vv)
      --offline
          Run without network requests
      --no-cache
          Bypass local cache
  -h, --help
          Print help

Examples:
  idx stocks history BBCA --period 3mo
  idx stocks history BBCA --period 1y --interval 1wk

`idx stocks technical`

Run technical analysis on a stock

Usage: idx stocks technical [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>  Single ticker symbol (e.g. BBCA)

Options:
      --history-provider <HISTORY_PROVIDER>
          [possible values: auto, yahoo, msn]
  -o, --output <OUTPUT>
          Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color
          Disable colored output
  -q, --quiet
          Suppress non-essential output
  -v, --verbose...
          Increase verbosity (-v, -vv)
      --offline
          Run without network requests
      --no-cache
          Bypass local cache
  -h, --help
          Print help

Examples:
  idx stocks technical BBCA
  idx -o json stocks technical BBCA

`idx stocks growth`

Run growth analysis on a stock

Usage: idx stocks growth [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>  Single ticker symbol (e.g. BBCA)

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

Examples:
  idx stocks growth BBCA
  idx -o json stocks growth BBCA

`idx stocks valuation`

Run valuation analysis on a stock

Usage: idx stocks valuation [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>  Single ticker symbol (e.g. BBCA)

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

Examples:
  idx stocks valuation BBCA
  idx -o json stocks valuation BBCA

`idx stocks risk`

Run risk analysis on a stock

Usage: idx stocks risk [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>  Single ticker symbol (e.g. BBCA)

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

Examples:
  idx stocks risk BBCA
  idx -o json stocks risk BBCA

`idx stocks fundamental`

Run full fundamental analysis on a stock

Usage: idx stocks fundamental [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>  Single ticker symbol (e.g. BBCA)

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

Examples:
  idx stocks fundamental BBCA
  idx -o json stocks fundamental BBCA

`idx stocks profile`

Get company profile

Usage: idx stocks profile [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx stocks financials`

Get financial statements

Usage: idx stocks financials [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>

Options:
  -o, --output <OUTPUT>           Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --statement <STATEMENT>...  Limit output to one or more statements [possible values: income, balance, cashflow]
      --no-color                  Disable colored output
  -q, --quiet                     Suppress non-essential output
  -v, --verbose...                Increase verbosity (-v, -vv)
      --offline                   Run without network requests
      --no-cache                  Bypass local cache
  -h, --help                      Print help

Examples:
  idx stocks financials BBCA
  idx stocks financials BBCA --statement income
  idx stocks financials BBCA --statement income,balance

`idx stocks earnings`

Get earnings report

Usage: idx stocks earnings [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>

Options:
      --forecast         Only include forward earnings rows
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --history          Only include historical earnings rows
      --no-color         Disable colored output
      --annual           Only include annual periods
  -q, --quiet            Suppress non-essential output
      --quarterly        Only include quarterly periods
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

Examples:
  idx stocks earnings BBCA
  idx stocks earnings BBCA --history --quarterly
  idx -o json stocks earnings BBCA --forecast --annual

`idx stocks sentiment`

Get crowd sentiment

Usage: idx stocks sentiment [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx stocks insights`

Get AI insights

Usage: idx stocks insights [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx stocks news`

Get stock news

Usage: idx stocks news [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>

Options:
      --limit <LIMIT>    [default: 10]
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx stocks screen`

MSN screener

Usage: idx stocks screen [OPTIONS]

Options:
      --filter <FILTER>  [default: top-performers]
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
      --region <REGION>  [default: id]
      --limit <LIMIT>    [default: 50]
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx stocks compare`

Compare fundamentals across stocks

Usage: idx stocks compare [OPTIONS] <SYMBOLS>...

Arguments:
  <SYMBOLS>...  One or more symbols, comma-separated or space-separated; `-` reads them from stdin

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

Examples:
  idx stocks compare BBCA BBRI BMRI
  idx stocks compare BBCA,BBRI,BMRI
  idx -o json stocks compare BBCA,BBRI
  idx stocks screen --filter low-pe | jq -r '.[].symbol' | idx stocks compare -

`idx config`

Manage configuration

Usage: idx config [OPTIONS] <COMMAND>

Commands:
  init  Create default configuration file
  get   Get a configuration value by key
  set   Set a configuration value by key
  path  Print configuration file path
  help  Print this message or the help of the given subcommand(s)

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx config init`

Create default configuration file

Usage: idx config init [OPTIONS]

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx config get`

Get a configuration value by key

Usage: idx config get [OPTIONS] <KEY>

Arguments:
  <KEY>

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx config set`

Set a configuration value by key

Usage: idx config set [OPTIONS] <KEY> <VALUE>

Arguments:
  <KEY>
  <VALUE>

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx config path`

Print configuration file path

Usage: idx config path [OPTIONS]

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx cache`

Manage local cache

Usage: idx cache [OPTIONS] <COMMAND>

Commands:
  info   Show cache usage information
  clear  Clear all cached files
  help   Print this message or the help of the given subcommand(s)

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx cache info`

Show cache usage information

Usage: idx cache info [OPTIONS]

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx cache clear`

Clear all cached files

Usage: idx cache clear [OPTIONS]

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership`

Ownership intelligence (KSEI + Bing).

Preferred bootstrap path:
  1. Run `idx ownership sync` to install or refresh a maintained SQLite snapshot.
  2. If no snapshot manifest is available, run `idx ownership discover` and then `idx ownership import --url <pdf-url>`.
  3. Local `.xlsx`, `.pdf`, `.zip`, and `.txt` imports remain available for manual or fallback workflows.

Usage: idx ownership [OPTIONS] <COMMAND>

Commands:
  discover       Discover the latest IDX-hosted ownership report URLs
  import         Import ownership data directly from source files
  sync           Install or refresh a maintained ownership SQLite snapshot
  ticker         Show all holders for a ticker (KSEI + Bing combined)
  entity         Show all holdings for an entity across tickers
  search         Search entities by name
  cross-holders  Rank entities by cross-ownership breadth
  concentration  Rank tickers by ownership concentration
  flow           Show Bing institutional flow for a ticker
  changes        Diff two KSEI releases
  graph          Ownership network graph
  resolve        Manual entity resolution workflow
  releases       List imported KSEI releases
  help           Print this message or the help of the given subcommand(s)

Options:
  -o, --output <OUTPUT>
          Output format [default: auto = table on a terminal, json when piped]

          [possible values: auto, table, json, jsonl]

      --no-color
          Disable colored output

  -q, --quiet
          Suppress non-essential output

  -v, --verbose...
          Increase verbosity (-v, -vv)

      --offline
          Run without network requests

      --no-cache
          Bypass local cache

  -h, --help
          Print help (see a summary with '-h')

Examples:
  idx ownership sync
  idx ownership sync --manifest /path/to/ownership-snapshot-manifest.json
  idx ownership discover --limit 1
  idx ownership import --url <pdf-url>
  idx ownership releases

`idx ownership discover`

Discover the latest IDX-hosted ownership report URLs

Usage: idx ownership discover [OPTIONS]

Options:
      --family <FAMILY>  Report family to discover: above1 (default), all, above5, or investor-type [default: above1]
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --limit <LIMIT>    Maximum number of discovered report URLs to print [default: 6]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

Examples:
  idx ownership discover --limit 1
  idx ownership discover --family all --limit 6

Use this when no snapshot manifest is available and you need a direct XLSX or PDF URL for `idx ownership import --url`.

`idx ownership import`

Import ownership data directly from source files.

Prefer `idx ownership sync` for normal bootstrap/update flows. Use `import` when you need a direct PDF import from IDX discovery output, a local PDF, or a local KSEI archive fallback file.

Usage: idx ownership import [OPTIONS]

Options:
  -o, --output <OUTPUT>
          Output format [default: auto = table on a terminal, json when piped]

          [possible values: auto, table, json, jsonl]

      --url <URL>
          Direct URL to a remote above-1% XLSX or PDF, typically from `ownership discover`

      --file <FILE>
          Path to a local ownership file: above-1% XLSX or PDF (primary), ZIP/TXT archive (fallback)

      --no-color
          Disable colored output

      --fetch-bing <FETCH_BING>
          Fetch Bing institutional data for these symbols

  -q, --quiet
          Suppress non-essential output

      --force
          Re-import even if the release SHA-256 has already been seen

  -v, --verbose...
          Increase verbosity (-v, -vv)

      --offline
          Run without network requests

      --no-cache
          Bypass local cache

  -h, --help
          Print help (see a summary with '-h')

Examples:
  idx ownership import --url <pdf-url-from-discover>
  idx ownership import --file /path/to/peng-2026-08-00017-satu-persen.xlsx
  idx ownership import --file /path/to/ksei.pdf
  idx ownership import --file /path/to/BalanceposEfek20260227.zip

`idx ownership sync`

Install or refresh a maintained ownership SQLite snapshot.

This is the normal bootstrap/update path for ownership data.

Manifest lookup order:
  1. `--manifest`
  2. `IDX_OWNERSHIP_SNAPSHOT_MANIFEST`
  3. `ownership.snapshot_manifest` in config

Usage: idx ownership sync [OPTIONS]

Options:
      --manifest <MANIFEST>
          Snapshot manifest location (URL or local path). If omitted, idx falls back through env/config and then the published default URL

  -o, --output <OUTPUT>
          Output format [default: auto = table on a terminal, json when piped]

          [possible values: auto, table, json, jsonl]

      --force
          Replace the local DB even when it is already current or newer than the snapshot

      --no-color
          Disable colored output

  -q, --quiet
          Suppress non-essential output

  -v, --verbose...
          Increase verbosity (-v, -vv)

      --offline
          Run without network requests

      --no-cache
          Bypass local cache

  -h, --help
          Print help (see a summary with '-h')

Examples:
  idx ownership sync
  idx ownership sync --manifest /path/to/ownership-snapshot-manifest.json
  IDX_OWNERSHIP_SNAPSHOT_MANIFEST=https://example.com/latest.json idx ownership sync

If none of the above are set, `ownership sync` falls back to the built-in published manifest URL.

`idx ownership ticker`

Show all holders for a ticker (KSEI + Bing combined)

Usage: idx ownership ticker [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --source <SOURCE>  [default: all]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership entity`

Show all holdings for an entity across tickers

Usage: idx ownership entity [OPTIONS] <NAME>

Arguments:
  <NAME>

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership search`

Search entities by name

Usage: idx ownership search [OPTIONS] <QUERY>

Arguments:
  <QUERY>

Options:
      --limit <LIMIT>    [default: 20]
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership cross-holders`

Rank entities by cross-ownership breadth

Usage: idx ownership cross-holders [OPTIONS]

Options:
  -o, --output <OUTPUT>            Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --top <TOP>                  [default: 20]
      --min-tickers <MIN_TICKERS>  [default: 2]
      --no-color                   Disable colored output
  -q, --quiet                      Suppress non-essential output
  -v, --verbose...                 Increase verbosity (-v, -vv)
      --offline                    Run without network requests
      --no-cache                   Bypass local cache
  -h, --help                       Print help

`idx ownership concentration`

Rank tickers by ownership concentration

Usage: idx ownership concentration [OPTIONS]

Options:
      --by <BY>          [default: hhi]
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
      --top <TOP>        [default: 20]
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership flow`

Show Bing institutional flow for a ticker

Usage: idx ownership flow [OPTIONS] <SYMBOL>

Arguments:
  <SYMBOL>

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership changes`

Diff two KSEI releases

Usage: idx ownership changes [OPTIONS] --from <FROM> --to <TO>

Options:
      --from <FROM>
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
      --to <TO>
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership graph`

Ownership network graph

Usage: idx ownership graph [OPTIONS] <ROOT>

Arguments:
  <ROOT>  Ticker code or entity name to start from

Options:
      --depth <DEPTH>    Traversal depth (default 2) [default: 2]
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --format <FORMAT>  Output format: table or dot (Graphviz) [default: table]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership resolve`

Manual entity resolution workflow

Usage: idx ownership resolve [OPTIONS] <COMMAND>

Commands:
  unresolved  List unresolved or low-confidence entity aliases
  map         Manually map a raw investor name to a canonical entity name
  merge       Merge two entities (keep first, merge second into it)
  help        Print this message or the help of the given subcommand(s)

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership resolve unresolved`

List unresolved or low-confidence entity aliases

Usage: idx ownership resolve unresolved [OPTIONS]

Options:
      --limit <LIMIT>    [default: 50]
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership resolve map`

Manually map a raw investor name to a canonical entity name

Usage: idx ownership resolve map [OPTIONS] <ALIAS> <ENTITY>

Arguments:
  <ALIAS>   The raw name as it appears in the data
  <ENTITY>  The canonical entity name to map to

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership resolve merge`

Merge two entities (keep first, merge second into it)

Usage: idx ownership resolve merge [OPTIONS] <KEEP> <MERGE>

Arguments:
  <KEEP>   Entity ID to keep
  <MERGE>  Entity ID to merge and delete

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx ownership releases`

List imported KSEI releases

Usage: idx ownership releases [OPTIONS]

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx completions`

Generate shell completions

Usage: idx completions [OPTIONS] <SHELL>

Arguments:
  <SHELL>  [possible values: bash, zsh, fish]

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

`idx version`

Show idx-cli version

Usage: idx version [OPTIONS]

Options:
  -o, --output <OUTPUT>  Output format [default: auto = table on a terminal, json when piped] [possible values: auto, table, json, jsonl]
      --no-color         Disable colored output
  -q, --quiet            Suppress non-essential output
  -v, --verbose...       Increase verbosity (-v, -vv)
      --offline          Run without network requests
      --no-cache         Bypass local cache
  -h, --help             Print help

33 KiB Raw Blame History

idx

idx stocks

idx stocks quote

idx stocks history

idx stocks technical

idx stocks growth

idx stocks valuation

idx stocks risk

idx stocks fundamental

idx stocks profile

idx stocks financials

idx stocks earnings

idx stocks sentiment

idx stocks insights

idx stocks news

idx stocks screen

idx stocks compare

idx config

idx config init

idx config get

idx config set

idx config path

idx cache

idx cache info

idx cache clear

idx ownership

idx ownership discover

idx ownership import

idx ownership sync

idx ownership ticker

idx ownership entity

idx ownership search

idx ownership cross-holders

idx ownership concentration

idx ownership flow

idx ownership changes

idx ownership graph

idx ownership resolve

idx ownership resolve unresolved

idx ownership resolve map

idx ownership resolve merge

idx ownership releases

idx completions

idx version