Elim CLI
Elim CLI is a TypeScript-based command-line tool that lets you interact with Elimapi directly from your terminal. Instead of integrating the API through code, you can search products, look up details, and manage your configuration with a single command.
Open source: github.com/alvintran/elim-cli
Installation
Requires: Node.js >= 16
npm install -g elim-cli
Verify the installation:
elim --version
Configuration
Before using the CLI, configure your Elimapi API key:
elim config
This prompts for your API key and stores it in a local config file at your OS home directory, keeping credentials secure across sessions.
Commands
Keyword Search
elim search <keyword>
Example:
elim search "cotton t-shirt"
Filter options:
--min-price/--max-priceβ filter by price range--min-soldβ filter by minimum quantity sold--langβ response language (vi,en,zh)
Image-Based Search
elim search-img --url <image_url>
elim search-img --id <image_id>
Find visually similar products using an image URL or a previously uploaded image ID.
Product Details
elim find <product_id>
Returns full product information: price, inventory, variants, images, and description.
Upload Image
elim upload-image <file_path>
Upload a local image to obtain an image_id for use with image-based search.
Unshorten URL
elim unshorten <url>
Expand shortened Taobao/1688 links to their full product URLs.
Output Formats
| Format | Command | Description |
|---|---|---|
| Table (default) | elim search "keyword" | Human-readable table |
| JSON | elim search "keyword" --json | Raw JSON output |
| Custom columns | elim search "keyword" --columns name,price | Show selected columns only |
JSON output is useful for piping results into scripts or automation pipelines.
Links
- GitHub: github.com/alvintran/elim-cli
- Issues / Contributions: Issues
- API Documentation: elim.asia/docs