Skip to content

CLI Installation

The Hype Doc CLI (hype) lets you log wins and list achievements from your terminal.

Terminal window
npm install -g @hypedoc/cli

Requires Node.js 20+.

  1. Browser login (recommended)

    Terminal window
    hype auth login

    Opens your browser for OAuth authentication. The token is saved automatically.

  2. Or set a token directly (for CI/scripts)

    Terminal window
    hype auth token hdoc_xxxxxxxxxxxxxxxxxxxx
  3. Verify

    Terminal window
    hype auth status
Terminal window
# Log a win
hype log "Shipped the new API endpoint" --space Work --tags impact,backend
# List recent wins
hype list --last 7d
# List wins in a space
hype list --space Work --limit 10
# See your spaces
hype spaces
# Create a space
hype spaces create Leadership --emoji 👑
# See your tags
hype tags
# Rename a tag
hype tags rename backend infrastructure
CommandDescription
hype logLog a new win
hype listList your wins
hype spacesList, create, and delete spaces
hype tagsList, rename, and delete tags
hype authManage authentication

The CLI stores its config at ~/.hypedoc/config.json. See Configuration for environment variables and advanced setup.