@witchpot/steamboard-cli
v0.2.0
Published
CLI tool for Steamboard API - Steam game data analytics, market research, and tag analysis
Maintainers
Readme
@witchpot/steamboard-cli
Command-line tool for Steamboard API — Steam game data analytics, market research, and tag analysis.
Installation
npm install -g @witchpot/steamboard-cliAuthentication
Option 1: Browser Login (OAuth)
steamboard loginOpens your browser to authenticate via Steamboard. Tokens are stored locally in ~/.steamboard-cli/.
Option 2: API Key
# Via environment variable
export STEAMBOARD_API_KEY=your-api-key
# Or via flag
steamboard search --api-key=your-api-key --tags=roguelikeUsage
steamboard <command> [options]Game Discovery
steamboard search --tags=roguelike,action --sort=rating_desc --limit=10
steamboard get 553420
steamboard batch 553420,570,730
steamboard count --tags=indie --reviewsMin=1000
steamboard stats
steamboard tagsApp Analysis
steamboard snapshots 553420
steamboard benchmark 553420
steamboard details 553420
steamboard dev-links 553420
steamboard reviews 553420Market Analysis
steamboard analyze --groupBy=tag
steamboard analyze-benchmark --tags=roguelike,action --price=1999
steamboard analyze-related --tags=roguelike
steamboard analyze-pricing --tags=indie
steamboard analyze-niches --parentTags=RPG --sort=opportunity_scoreAnalytics
steamboard tags-common
steamboard tags-trends
steamboard languages
steamboard releases
steamboard upcoming
steamboard review-growthSystem
steamboard snapshot-runs
steamboard deep-dive-check
steamboard dev-links-check
steamboard openapiOutput Options
--format=json|table # Output format (default: json)
--raw # Include full response envelope
--fields=name,appid # Filter output fieldsSearch Filters
--keyword=<text> # Text search
--tags=<t1,t2> # Filter by tags (comma-separated slugs)
--tagMode=or|and # Tag matching mode (default: or)
--priceMin=<cents> # Minimum price in cents
--priceMax=<cents> # Maximum price in cents
--reviewsMin=<n> # Minimum review count
--reviewsMax=<n> # Maximum review count
--ratingMin=<n> # Minimum rating percentage
--releaseFrom=<date> # Release date from (YYYY-MM-DD)
--releaseTo=<date> # Release date to (YYYY-MM-DD)
--sort=<option> # Sort: reviews_desc, rating_desc, price_asc, etc.
--limit=<n> # Results per page (default: 20, max: 100)
--page=<n> # Page numberConfiguration
Configuration is resolved in this priority order:
- CLI flags (
--api-key,--api-url) - Environment variables (
STEAMBOARD_API_KEY,STEAMBOARD_API_URL) - Config file (
~/.steamboard-cli/config.json) - Stored OAuth token (from
steamboard login)
Requirements
- Node.js >= 18.0.0
License
See LICENSE for details.
