bestbuy-cli's Introduction

bestbuy-cli

Download data from the Best Buy Catalog API in bulk from the command line.

Get an API key at developer.bestbuy.com.

Install

npm install --global bestbuy-cli

Can't install node? Download a standalone executable from the GitHub Releases page!

Usage

>bestbuy --help

Best Buy Bulk Download Tool (https://github.com/BestBuyAPIs/bestbuy-cli)

Usage: bestbuy [resource] [options]

    Examples:
      bestbuy categories
      bestbuy products --query "active=true" --show "name,sku" --output products.json
      bestbuy stores --format xml --output stores.xml
      bestbuy stores --query "region=GA&storeType='outlet center'" --output stores.json

    resource              resource to download: products, categories, stores
    --query, -q           use a custom query to filter the results (ampersand separated)
    --show, -s            fields to show (comma separated)
    --sort, -r            sort results by fields (comma separated)
    --key, -k             Best Buy API key (default: "BBY_API_KEY environment variable")
    --format, -f          format of the response as json, xml, csv or tsv (default: "json")
    --output, -o          name of file to send output (optional; If not present, out will go to stdout)
    --bare, -b            newline delimited - each item on own line without extra cruft (default: false)
    --version, -v         show version information
    --help, -h            show help

Visit the Best Buy API Documentation for more details on writing custom queries.

License

MIT

bestbuy-cli's People

Contributors

Stargazers

Watchers

bestbuy-cli's Issues

timeout - Edit resolved

Was having trouble with time outs , fixed my issue by editing it in index.js.
thanks for great tool :)

Throws when missing CLI

bret-netlify:~ bret$ bestbuy-cli categories
/usr/local/lib/node_modules/bestbuy-cli/node_modules/bestbuy/index.js:14
  if (!options.key) throw new Error('A Best Buy developer API key is required');
                    ^

Error: A Best Buy developer API key is required
    at bestbuy (/usr/local/lib/node_modules/bestbuy-cli/node_modules/bestbuy/index.js:14:27)
    at run (/usr/local/lib/node_modules/bestbuy-cli/index.js:13:13)
    at cli (/usr/local/lib/node_modules/bestbuy-cli/bin.js:104:3)
    at Object.<anonymous> (/usr/local/lib/node_modules/bestbuy-cli/bin.js:108:3)
    at Module._compile (module.js:624:30)
    at Object.Module._extensions..js (module.js:635:10)
    at Module.load (module.js:545:32)
    at tryModuleLoad (module.js:508:12)
    at Function.Module._load (module.js:500:3)
    at Function.Module.runMain (module.js:665:10)

Not sure if you want to stack trace or not here.