CLI Installation

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

Install

npm install -g @hypedoc/cli

npx @hypedoc/cli log "My first win" --space Work

brew install myhypedoc/tap/hype

# To upgrade later
brew upgrade myhypedoc/tap/hype

Requires Node.js 24+ (for npm/npx). Platform-specific binaries are also available on GitHub Releases.

Authenticate

Browser login (recommended)
Terminal window
```
hype auth login
```
Opens your browser for OAuth authentication. The token is saved automatically.
Or set a token directly (for CI/scripts)
Terminal window
```
hype auth token <your-api-token>
```
Verify
Terminal window
```
hype auth status
```

Quick examples

# Log a win (interactive)
hype log

# Log a win directly
hype log "Shipped the new API endpoint" --space Work --tags impact,backend

# List recent wins
hype wins --last 7d

# List wins in a space
hype wins --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

Commands

Command	Description
`hype log`	Log a new win
`hype wins`	List, show, edit, and delete wins
`hype spaces`	List, create, rename, and delete spaces
`hype tags`	List, rename, and delete tags
`hype auth`	Manage authentication

Configuration

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