feat: add CLI arguments and binary compilation

- Add CLI flags: --pair, --interval, --start, --end, --output
- Support non-interactive mode when all arguments provided
- Support hybrid mode with partial arguments
- Add input validation (dates, intervals)
- Configure pkg for binary compilation (macOS, Linux, Windows)
- Add GitHub workflow to build and release binaries
- Update README with new CLI usage examples

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Author: maxgfr

.github/workflows/release-binaries.yml

@@ -0,0 +1,104 @@
+name: Build and Release Binaries
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Release tag to attach binaries to'
+        required: true
+        type: string
+
+permissions:
+  contents: write
+
+jobs:
+  build-binaries:
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: node20-linux-x64
+            output: binance-historical-linux-x64
+          - os: macos-latest
+            target: node20-macos-x64
+            output: binance-historical-macos-x64
+          - os: macos-latest
+            target: node20-macos-arm64
+            output: binance-historical-macos-arm64
+          - os: windows-latest
+            target: node20-win-x64
+            output: binance-historical-win-x64.exe
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build TypeScript
+        run: yarn build
+
+      - name: Build binary
+        run: yarn pkg . --target ${{ matrix.target }} --output dist/${{ matrix.output }}
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.output }}
+          path: dist/${{ matrix.output }}
+
+  upload-to-release:
+    needs: build-binaries
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+
+      - name: Display structure of downloaded files
+        run: ls -la dist/
+
+      - name: Get release tag
+        id: get_tag
+        run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            echo "tag=${{ inputs.tag }}" >> $GITHUB_OUTPUT
+          else
+            echo "tag=${{ github.event.release.tag_name }}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create checksums
+        run: |
+          cd dist
+          for dir in */; do
+            for file in "$dir"*; do
+              if [ -f "$file" ]; then
+                sha256sum "$file" >> checksums.txt
+              fi
+            done
+          done
+          cat checksums.txt
+
+      - name: Upload binaries to release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.get_tag.outputs.tag }}
+          files: |
+            dist/binance-historical-linux-x64/binance-historical-linux-x64
+            dist/binance-historical-macos-x64/binance-historical-macos-x64
+            dist/binance-historical-macos-arm64/binance-historical-macos-arm64
+            dist/binance-historical-win-x64.exe/binance-historical-win-x64.exe
+            dist/checksums.txt
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -21,6 +21,9 @@ node_modules/
 # Transpiled files
 build/
 
+# Binary distribution
+dist/
+
 # .env you know
 .env
 

README.md

@@ -4,19 +4,70 @@ Utility to retrieve historical data from Binance
 
 ![Alt Text](https://raw.githubusercontent.com/maxgfr/binance-historical/main/.github/assets/main.gif)
 
-## Usage
+## Installation
 
-### With the cli
+### Via Homebrew (macOS/Linux)
+
+```sh
+brew tap maxgfr/tap
+brew install binance-historical
+```
+
+### Via npm
 
 ```sh
 npm install -g binance-historical
+```
+
+### Download binary
+
+Download the latest binary for your platform from the [releases page](https://github.com/maxgfr/binance-historical/releases).
+
+## Usage
+
+### CLI
+
+#### Interactive mode
+
+```sh
 binance-historical download
+```
+
+#### Non-interactive mode
+
+Pass all options as arguments:
+
+```sh
+binance-historical download \
+  --pair BTCUSDT \
+  --interval 4h \
+  --start 2024-01-01 \
+  --end 2024-12-31 \
+  --output ./data/
+```
+
+#### CLI Options
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--pair <symbol>` | `-p` | Trading pair (e.g., BTCUSDT, ETHUSDT) |
+| `--interval <interval>` | `-i` | Kline interval (1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w) |
+| `--start <date>` | `-s` | Start date (YYYY-MM-DD or ISO 8601) |
+| `--end <date>` | `-e` | End date (YYYY-MM-DD or ISO 8601) |
+| `--output <path>` | `-o` | Output directory path (filename is auto-generated) |
+| `--help` | `-h` | Display help |
+| `--version` | `-V` | Display version |
 
-# or by using npx
-npx binance-historical download
+#### Hybrid mode
+
+You can also provide some options and be prompted for the rest:
+
+```sh
+binance-historical download --pair ETHUSDT --interval 1h
+# You will be prompted for start date, end date, and output path
 ```
 
-### With the library
+### Library
 
 ```ts
 import { getKline, Kline } from 'binance-historical';

package.json

@@ -19,6 +19,19 @@
   "bin": {
     "binance-historical": "./build/index.js"
   },
+  "pkg": {
+    "scripts": "build/**/*.js",
+    "assets": [
+      "node_modules/axios/dist/node/axios.cjs"
+    ],
+    "targets": [
+      "node20-macos-x64",
+      "node20-macos-arm64",
+      "node20-linux-x64",
+      "node20-win-x64"
+    ],
+    "outputPath": "dist"
+  },
   "keywords": [
     "node",
     "typescript",
@@ -42,14 +55,20 @@
     "build:swc:watch": "npm run build:swc -- -w",
     "lint": "eslint ./src --ext .ts",
     "prettier": "prettier --write './src/**/*.{ts,js,json}'",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "build:binaries": "pkg . --out-path dist",
+    "build:binary:macos": "pkg . --target node20-macos-x64 --output dist/binance-historical-macos-x64",
+    "build:binary:macos-arm": "pkg . --target node20-macos-arm64 --output dist/binance-historical-macos-arm64",
+    "build:binary:linux": "pkg . --target node20-linux-x64 --output dist/binance-historical-linux-x64",
+    "build:binary:win": "pkg . --target node20-win-x64 --output dist/binance-historical-win-x64.exe"
   },
   "dependencies": {
     "axios": "1.13.2",
     "commander": "^12.0.0",
     "prompts": "2.4.2"
   },
   "devDependencies": {
+    "@yao-pkg/pkg": "^6.3.0",
     "@semantic-release/commit-analyzer": "^12.0.0",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "10.3.5",