mirror of
https://github.com/0xrsydn/idx-cli.git
synced 2026-08-07 01:33:52 +00:00
chore: prepare v0.2.1 release
This commit is contained in:
parent
1f5c4b2798
commit
c94c826307
32 changed files with 2483 additions and 382 deletions
19
README.md
19
README.md
|
|
@ -4,14 +4,30 @@ CLI tool for Indonesian stock market (IDX) analysis, built in Rust for humans an
|
|||
|
||||
## Installation
|
||||
|
||||
### Cargo
|
||||
|
||||
```bash
|
||||
cargo install idx-cli
|
||||
```
|
||||
|
||||
This installs the `idx` binary. `idx-cli` currently requires Rust `1.85+`.
|
||||
|
||||
If you use the Cargo install path directly, some commands also require helper tools at runtime:
|
||||
|
||||
- Yahoo-authenticated flows require a `curl_chrome*` binary from `curl-impersonate-chrome` in `PATH`, or `IDX_CURL_IMPERSONATE_BIN` pointing at that binary.
|
||||
- Ownership PDF import requires `mutool` from MuPDF in `PATH`.
|
||||
|
||||
Install those helpers with your OS package manager, or use the Nix app/package below so they are wrapped automatically.
|
||||
|
||||
### Nix
|
||||
|
||||
```bash
|
||||
nix run github:0xrsydn/idx-cli
|
||||
nix run github:0xrsydn/idx-cli -- version
|
||||
nix profile install github:0xrsydn/idx-cli#default
|
||||
```
|
||||
|
||||
The Nix app wraps `idx` with `curl-impersonate` and `mupdf`, so the Yahoo auth and ownership PDF helper tools are available automatically.
|
||||
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
|
|
@ -54,7 +70,6 @@ Precedence order:
|
|||
|
||||
- Use `idx --help` and subcommand help for discoverability
|
||||
- Use `-o json` / `--output json` for structured output
|
||||
- See `skills/` for agent workflows and task recipes
|
||||
|
||||
## Development
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue