CLI Installation
The Hype Doc CLI (hype) lets you log wins and list achievements from your terminal.
Install
Section titled “Install”npm install -g @hypedoc/clinpx @hypedoc/cli log "My first win" --space WorkRequires Node.js 20+.
Authenticate
Section titled “Authenticate”-
Browser login (recommended)
Terminal window hype auth loginOpens your browser for OAuth authentication. The token is saved automatically.
-
Or set a token directly (for CI/scripts)
Terminal window hype auth token hdoc_xxxxxxxxxxxxxxxxxxxx -
Verify
Terminal window hype auth status
Quick examples
Section titled “Quick examples”# Log a winhype log "Shipped the new API endpoint" --space Work --tags impact,backend
# List recent winshype list --last 7d
# List wins in a spacehype list --space Work --limit 10
# See your spaceshype spaces
# Create a spacehype spaces create Leadership --emoji 👑
# See your tagshype tags
# Rename a taghype tags rename backend infrastructureCommands
Section titled “Commands”| Command | Description |
|---|---|
hype log | Log a new win |
hype list | List your wins |
hype spaces | List, create, and delete spaces |
hype tags | List, rename, and delete tags |
hype auth | Manage authentication |
Configuration
Section titled “Configuration”The CLI stores its config at ~/.hypedoc/config.json. See Configuration for environment variables and advanced setup.