JSPM

@hypedoc/cli

1.0.2
    • ESM via JSPM
    • ES Module Entrypoint
    • Export Map
    • Keywords
    • License
    • Repository URL
    • TypeScript Types
    • README
    • Created
    • Published
      • 0
    • Score
      100M100P100Q37086F
    • License MIT

    CLI for Hype Doc — log and track your wins from the terminal

    Package Exports

      This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hypedoc/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

      Readme

      @hypedoc/cli

      CLI for Hype Doc: log and track your wins from the terminal.

      Installation

      # Run directly (no install needed)
npx @hypedoc/cli

# Install globally via npm
npm install -g @hypedoc/cli

# Homebrew
brew install myhypedoc/tap/hype

# Binary download
# See GitHub Releases for platform-specific binaries

      Requires Node.js 24+ (for npm/npx).

      Quick Start

      # 1. Authenticate (opens browser)
hype auth login

# 2. Log your first win
hype log "Shipped the new dashboard"

# 3. View your wins
hype wins

      Authentication

      # Interactive login via browser (OAuth)
hype auth login

# Direct token entry (for CI/scripts)
hype auth token <your-api-token>

# Check auth status
hype auth status

# Log out
hype auth logout

      Credentials are stored in ~/.hypedoc/config.json.

      Commands

      Log a win

      Run hype log with no arguments for an interactive experience, or pass options directly:

      # Interactive mode (walks you through space, tags, and date)
hype log

# Direct mode
hype log "Shipped the new dashboard" --space work --tags impact,product
hype log "Gave a talk at the team offsite" --date 2026-02-15
      Flag Description
      --space, -s Space name (e.g. "work", "personal")
      --tags, -t Comma-separated tags
      --date, -d Date (YYYY-MM-DD), defaults to today

      Wins

      # List wins
hype wins
hype wins --space work --last 7d
hype wins --tag impact --last 30d
hype wins --limit 5

# Show a specific win
hype wins show <id>

# Edit a win
hype wins edit <id> --body "Updated text" --tags newtag

# Delete a win
hype wins delete <id>
      Flag Description
      --space, -s Filter by space name
      --tag, -t Filter by tag
      --last, -l Time window (e.g. 7d, 2w, 1m)
      --limit, -n Max results (default: 20)

      Win IDs are shown as short prefixes in hype wins output. You can use the prefix or the full UUID.

      Spaces

      # List spaces
hype spaces

# Create a space
hype spaces create "work" --emoji "💼"

# Rename a space (optionally change emoji)
hype spaces rename "work" "career" --emoji "🚀"

# Delete a space
hype spaces delete "old-space"

      Tags

      # List tags
hype tags

# Rename a tag
hype tags rename "old-name" "new-name"

# Delete a tag (wins are kept, only the tag is removed)
hype tags delete "unused-tag"

      Configuration

      Config file: ~/.hypedoc/config.json

      Environment variable overrides:

      Variable Description
      HYPEDOC_TOKEN API token (overrides config file)
      HYPEDOC_API_URL API base URL (overrides config file)

      Error Handling

      The CLI provides clear error messages for common scenarios:

      Development

      mise run setup     # pnpm install
mise run dev       # tsc --watch
mise run build     # tsc
mise run test      # vitest run
mise run lint      # oxlint
mise run fmt       # oxfmt