@highlyreco/cli

Command-line client for the highlyreco API. Create and read recommendations from your terminal.

npm install -g @highlyreco/cli

Getting started

1. Create an API key at highlyreco.com/settings/api-keys — copy the secret (shown once).
2. Add a profile:

highlyreco config profiles add me \
  --api-key hrk_xxxxxxxxxxxx \
  --api-secret xxxxxxxxxxxxxxxx

3. Confirm it works:

highlyreco whoami

Usage

highlyreco <resource> <action> [target] [options]

Profiles

Credentials live in ~/.highlyreco/config.yml (mode 0600). Multiple profiles are supported; switch with use or override per-command with --profile.

highlyreco config profiles list
highlyreco config profiles use me
highlyreco config profiles current
highlyreco --profile staging reviews list

Reviews

highlyreco reviews list --kind book --min-rating 4
highlyreco reviews get 8994
highlyreco reviews create "The parota at Mallu Dhaba" --body "Worth the detour." --kind dish --rating 5
highlyreco reviews update 8994 --rating 4
highlyreco reviews upvote 8994
highlyreco reviews bookmark 8994
highlyreco reviews delete 8994

Users

highlyreco users list
highlyreco users get alexjv89
highlyreco users reviews alexjv89

Output

Human-readable tables by default. Pass --json (or --format json|csv on reviews list) for machine-readable output. Data goes to stdout; hints and errors to stderr. Set HIGHLYRECO_DEBUG=1 for stack traces.

As a library

import { highlyreco } from '@highlyreco/cli';

const hr = highlyreco({ api_key: 'hrk_…', api_secret: '…' });
const { data } = await hr.reviews.list({ kind: 'book' });

Docs

Full API reference: highlyreco.com/docs