mirror of
https://github.com/0xrsydn/idx-cli.git
synced 2026-11-07 09:45:36 +00:00
docs(cli): help for config keys and output, changes dates, alias search
`idx config --help` lists the keys and says when it prints JSON; `ownership changes` says both dates must be imported releases and that accounts are summed; `ownership search` and `entity` describe alias and substring matching. Regenerated the CLI reference page. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01V3syn2fN2LNo5pvTSqc6eh
This commit is contained in:
parent
57eccc5843
commit
5cff14bf90
5 changed files with 177 additions and 42 deletions
|
|
@ -1,6 +1,8 @@
|
|||
exit: 0
|
||||
--- stdout
|
||||
Manage configuration
|
||||
Manage configuration in ~/.config/idx/config.toml (or $XDG_CONFIG_HOME/idx/config.toml).
|
||||
|
||||
Results print as plain text, even when piped, so `$(idx config path)` works in scripts. Ask for JSON with `-o json`, `IDX_OUTPUT=json`, or `general.output = "json"`.
|
||||
|
||||
Usage: idx config [OPTIONS] <COMMAND>
|
||||
|
||||
|
|
@ -12,11 +14,37 @@ Commands:
|
|||
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
|
||||
-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')
|
||||
|
||||
Keys:
|
||||
general.provider, general.history_provider, general.exchange, general.output,
|
||||
general.color, cache.quote_ttl, cache.fundamental_ttl, ownership.db_path,
|
||||
ownership.snapshot_manifest
|
||||
|
||||
Examples:
|
||||
idx config init
|
||||
idx config set general.output json
|
||||
idx config get cache.quote_ttl
|
||||
idx config path
|
||||
--- stderr
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ Commands:
|
|||
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
|
||||
search Search entities by name or KSEI alias
|
||||
cross-holders Rank entities by cross-ownership breadth
|
||||
concentration Rank tickers by ownership concentration
|
||||
flow Show Bing institutional flow for a ticker
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue