An open API service indexing awesome lists of open source software.

https://github.com/mathsgod/hktv-cli


https://github.com/mathsgod/hktv-cli

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# hktv-cli

**CLI for [HKTVmall](https://www.hktvmall.com) — built for humans and AI agents.**

A command-line tool for searching products and checking prices on HKTVmall, Hong Kong's leading e-commerce platform.

## Installation

```bash
npm install -g hktv-cli
```

## AI Agent Skills

This repo ships Agent Skills (`SKILL.md` files) for every command — ready to use with GitHub Copilot, Cursor, and any MCP-compatible AI agent.

```bash
# Install all hktv skills at once
npx skills add https://github.com/mathsgod/hktv-cli

# Or pick only what you need
npx skills add https://github.com/mathsgod/hktv-cli/tree/main/skills/hktv-search
```

## Usage

```
hktv [options] [command]
```

### Options

| Option | Description |
|--------|-------------|
| `-V, --version` | Display version number |
| `-h, --help` | Display help information |

### Commands

| Command | Description |
|---------|-------------|
| `search ` | Search products on HKTVmall |
| `price get ` | Get product price history |

## Search

Search for products on HKTVmall using Algolia search API.

```bash
hktv search
```

### Options

| Option | Description |
|--------|-------------|
| `-p, --page ` | Page number (default: `1`) |
| `-n, --hits ` | Results per page (default: `60`) |
| `-j, --json` | Output as JSON |
| `-h, --help` | Display help information |

### Examples

```bash
# Basic search
hktv search 牛奶

# Search page 2 with 20 results per page
hktv search 牛奶 -p 2 -n 20

# Output as JSON for scripting
hktv search 牛奶 -j
```

## Price

Query historical price data for a product.

The `` is the product code (商品編號). You can find it in the `search` results — each product displays a `Code` field. For example:

```
$ hktv search 牛奶

Found 60 results:

1. Meiji 牛乳
Code: A1234567 <-- Use this code
Price: HK$29.9
Link: https://www.hktvmall.com/...
```

Then use the code to check price history:

```bash
hktv price get
```

### Options

| Option | Description |
|--------|-------------|
| `-j, --json` | Output as JSON |
| `-h, --help` | Display help information |

### Examples

```bash
# Get price history
hktv price get A1234567

# Output as JSON
hktv price get A1234567 -j
```

### Output Fields

- **Current price**: Latest recorded price in HKD
- **Lowest price**: Historical minimum with date
- **Highest price**: Historical maximum
- **Average price**: Mean price over time
- **Recent changes**: Last 10 price fluctuations

## Options

| Option | Description |
|--------|-------------|
| `--json` | Output results as JSON |

## License

ISC