Elim CLI — Command Reference
Summary
Elim CLI is a command-line tool (TypeScript) that interacts directly with Elimapi from your terminal: search products, look up information, and manage configuration with a single command — no integration code required.
Open source: github.com/alvintran/elim-cli
Requirements and installation
| Item | Value |
|---|---|
| Requirement | Node.js >= 16 |
| Install | npm install -g elim-cli |
| Verify | elim --version |
| Configure API key | elim config (prompts for the API key and stores it in a local config file in your home directory) |
Command reference
| Command | Description | Main options |
|---|---|---|
elim search <keyword> | Search products by keyword | --min-price, --max-price, --min-sold, --lang (vi/en/zh), --json, --columns name,price |
elim search-img --url <url> | Search similar products by image URL | --json, --columns |
elim search-img --id <image_id> | Search similar products by uploaded image ID | --json, --columns |
elim find <product_id> | Look up product details: price, stock, variants, images, description | — |
elim upload-image <file_path> | Upload an image to get an image_id for image search | — |
elim unshorten <url> | Expand shortened Taobao/1688 links to the full URL | — |
Examples:
elim search "cotton t-shirt" --min-price 50000 --max-price 200000 --lang vi
elim search "sneakers" --json
elim find 734467086498
elim unshorten "https://e.tb.cn/h.hPY04k4RPfAco8F?tk=0CCI430IUqd"
Output formats
| Format | Command | Description |
|---|---|---|
| Table (default) | elim search "keyword" | Readable data table |
| JSON | elim search "keyword" --json | Raw JSON — useful for scripts and automation pipelines |
| Custom columns | elim search "keyword" --columns name,price | Show only selected columns |
Related links
- GitHub: github.com/alvintran/elim-cli
- Report issues / contribute: Issues
- API reference: Product API · openapi.elim.asia/api