Skip to main content

Command-line interface for the COLA Cloud API

Project description

COLA Cloud CLI

Command-line interface for the COLA Cloud API - Access the TTB COLA Registry from your terminal.

COLA Cloud provides access to the United States TTB (Alcohol and Tobacco Tax and Trade Bureau) Certificate of Label Approval registry, containing over 1 million alcohol product label records.

Installation

# Install with pip
pip install colacloud-cli

# Or with uv
uv pip install colacloud-cli

# Or install from source
git clone https://github.com/cola-cloud-us/colacloud-cli.git
cd colacloud-cli
uv sync

After installation, the cola command will be available.

Quick Start

  1. Get your API key from https://app.colacloud.us

  2. Configure the CLI:

    cola config set-key
    # Enter your API key when prompted
    
  3. Start searching:

    cola colas search "buffalo trace"
    

Commands

Configuration

# Set your API key (prompts for input)
cola config set-key

# Set API key directly
cola config set-key --key "your-api-key"

# Show current configuration (API key is masked)
cola config show

# Clear configuration
cola config clear

You can also set the COLACLOUD_API_KEY environment variable instead of using the config file.

COLAs

Search and retrieve COLA (Certificate of Label Approval) records.

# Full-text search
cola colas search "buffalo trace"

# List with filters
cola colas list --product-type wine --origin california

# Filter by date range
cola colas list --date-from 2024-01-01 --date-to 2024-12-31

# Filter by ABV
cola colas list --product-type "distilled spirits" --abv-min 40 --abv-max 50

# Filter by package and derived category
cola colas list --category Beer --derived-subcategory "Beer > Ale" \
  --container-type can --volume-unit "fluid ounces" --volume-min 12 --volume-max 16

# Search generic text, including applicant/company names
cola colas list -q "molson coors"

# Sort text searches by OpenSearch relevance score
cola colas list -q "bourbon" --sort relevance_desc

# Pagination
cola colas list -q "bourbon" --limit 50 --page 2

# Get detailed information about a specific COLA
cola colas get 24001234

# Output as JSON (for scripting)
cola colas list -q "whiskey" --json | jq '.data[].brand_name'

COLA Search Options

Option Description
-q, --query Generic text query across brand, product, permit, applicant/company, and related text
--product-type Filter by TTB type: malt beverage, wine, distilled spirits; can be used multiple times
--category Filter by derived category: Beer, Wine, Liquor; can be used multiple times
--derived-subcategory Filter by derived category path prefix, such as Beer > Ale
--origin Filter by country/state
--domestic-or-imported Filter by domestic or imported
--status Filter by application status
--brand Filter by brand name (partial match)
--permit-number Filter by exact permit number
--barcode Filter by exact main barcode value
--date-from Minimum approval date (YYYY-MM-DD)
--date-to Maximum approval date (YYYY-MM-DD)
--abv-min Minimum ABV percentage
--abv-max Maximum ABV percentage
--volume-unit Package volume unit; required with --volume-min or --volume-max
--volume-min Minimum package volume
--volume-max Maximum package volume
--container-type Derived container type; can be used multiple times
--limit Results per page (max 100)
--page Page number
--json Output as JSON

Permittees

Search and retrieve permittee (alcohol producer/importer) records.

# Search by company name
cola permittees list -q "diageo"

# Sort text searches by OpenSearch relevance score
cola permittees list -q "diageo" --sort relevance_desc

# Filter by state
cola permittees list --state KY

# Filter by active status
cola permittees list --state CA --active
cola permittees list --state NY --inactive

# Get detailed information about a specific permittee
cola permittees get NY-I-136

# Output as JSON
cola permittees list -q "distillery" --json

Permittee Search Options

Option Description
-q, --query Search by company name
--state Filter by state (e.g., CA, NY, KY)
--active/--inactive Filter by active status
--limit Results per page (max 100)
--page Page number
--json Output as JSON

Barcode Lookup

Look up products by their barcode (UPC, EAN, etc.).

# Look up by UPC
cola barcode 012345678901

# Look up by EAN
cola barcode 5000281025155

# Output as JSON
cola barcode 012345678901 --json

Usage Statistics

Check your API usage and limits.

# Show usage stats
cola usage

# Output as JSON
cola usage --json

Output Examples

COLA List

$ cola colas search "buffalo trace"
+------------+-----------------+-----------------------+------------------+------------+
| TTB ID     | Brand           | Product               | Type             | Approved   |
+============+=================+=======================+==================+============+
| 24001234   | Buffalo Trace   | Kentucky Straight...  | distilled spirits| 2024-01-15 |
| 23098765   | Buffalo Trace   | Single Barrel...      | distilled spirits| 2023-12-01 |
+------------+-----------------+-----------------------+------------------+------------+
Showing 1-2 of 156 results (page 1 of 8)

COLA Detail

$ cola colas get 24001234
+----------------------------------------------------------+
|                        24001234                           |
|                                                          |
|  Buffalo Trace                                           |
|  Kentucky Straight Bourbon Whiskey                       |
+----------------------------------------------------------+

Basic Information
  Product Type    distilled spirits
  Class           Whiskey
  Origin          Kentucky
  ABV             45.0%
  Volume          750 ml

Dates & Status
  Application     2024-01-10
  Approval        2024-01-15
  Status          approved

Permit Information
  Permit Number   KY-DSP-0019
  Application     Original Label

Usage Stats

$ cola usage
+--------------------------------------------------+
|              API Usage Statistics                 |
+--------------------------------------------------+

  Tier              standard
  Current Period    2024-01
  Monthly Usage     1,234 / 10,000 (12.3%)
  Remaining         8,766
  Rate Limit        60 requests/minute

JSON Output

All commands support --json flag for scripting and piping to other tools:

# Get all bourbon brands
cola colas list -q "bourbon" --json | jq -r '.data[].brand_name' | sort | uniq

# Count COLAs by product type
cola colas list --json | jq '.data | group_by(.product_type) | map({type: .[0].product_type, count: length})'

# Export permittees to CSV
cola permittees list --state KY --json | jq -r '.data[] | [.permit_number, .company_name, .company_state] | @csv'

Configuration

The CLI stores configuration in ~/.colacloud/config.json. The file is created with restrictive permissions (mode 600) to protect your API key.

Environment Variables

Variable Description
COLACLOUD_API_KEY API key (takes precedence over config file)

Development

# Clone the repository
git clone https://github.com/cola-cloud-us/colacloud-cli.git
cd colacloud-cli

# Install dependencies
uv sync

# Run the CLI in development
uv run cola --help

# Run tests
uv run pytest

# Format code
uv run black .
uv run isort .

License

MIT License - see LICENSE for details.

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

colacloud_cli-0.3.5.tar.gz (27.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

colacloud_cli-0.3.5-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file colacloud_cli-0.3.5.tar.gz.

File metadata

  • Download URL: colacloud_cli-0.3.5.tar.gz
  • Upload date:
  • Size: 27.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for colacloud_cli-0.3.5.tar.gz
Algorithm Hash digest
SHA256 fa45a19717a16286b44e0712b7628be7f7e6f4ad01af9f0fe95e002ca4cf76a5
MD5 87e9e2086216c6c5059b18cc7a5151fb
BLAKE2b-256 bdc67a00bd41e40c9d75294ea5487974893b80d556479f0305dd7086ffd2c827

See more details on using hashes here.

File details

Details for the file colacloud_cli-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: colacloud_cli-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for colacloud_cli-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c3a6d667c71bdbf39dd3eb9ee91609a09f861061df752065c04987da4bc582a3
MD5 409fb8f47e8c73c24eccb798a0ee4869
BLAKE2b-256 2a9dbf7b036cc941d8819d6450c5a8f80527fa23b04fe5678dec0f9bf88f8ecd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page