@upgraide/ui-notes-cli

Command-line tool to manage UI Notes — pull feedback, resolve issues, and manage projects from your terminal.

Installation

npm install -g @upgraide/ui-notes-cli

Requires: Bun >= 1.0.0

Quick Start

# Configure your API key
uinotes config set apiUrl https://my-api.example.com
uinotes config set apiKey <your-key>

# Pull open notes for your project
uinotes pull --project my-app

# Resolve a note
uinotes resolve 42 "Fixed in latest deploy"

Commands

uinotes config

View or update configuration.

uinotes config                              # Show current config
uinotes config set apiUrl https://my-api.example.com
uinotes config set apiKey <your-key>

uinotes set project

Bind a project to the current directory (creates .uinotes file).

uinotes set project my-app

uinotes projects

Manage projects.

uinotes projects                              # List all projects
uinotes projects --archived                   # Include archived
uinotes projects create my-app "My App" --url "https://myapp.com/*"
uinotes projects get my-app
uinotes projects rename my-app "New Name"
uinotes projects add-url my-app "https://staging.myapp.com/*"
uinotes projects remove-url my-app "https://old.myapp.com/*"
uinotes projects delete my-app                # Archive

uinotes pull

Fetch notes from the API.

uinotes pull
uinotes pull --project my-app --status open --type bug --limit 50
uinotes pull --resolve-files --root-dir .     # Map notes to source files

uinotes context

AI-optimized digest of open notes.

uinotes context --project my-app
uinotes context --format xml --component Header
uinotes context --resolve-files --root-dir .

uinotes explain

Full context for a single note (body, comments, history, visual diffs).

uinotes explain <note-id>
uinotes explain <note-id> --format json

uinotes resolve / uinotes wontfix

Mark a note as resolved or won't fix.

uinotes resolve <id> [message]
uinotes wontfix <id> [message]

uinotes comment / uinotes comments

Add or list comments on a note.

uinotes comment <id> "Comment text"
uinotes comments <id>

uinotes resolve-by-component / uinotes resolve-by-selector

Bulk resolve notes matching a component or selector.

uinotes resolve-by-component OldWidget "Replaced with NewWidget"
uinotes resolve-by-selector ".deprecated" "Removed" --dry-run

uinotes changelog

Generate a changelog from resolved notes.

uinotes changelog --since HEAD~5
uinotes changelog --since v1.2.0 --format conventional

uinotes visual-diff

Capture and compare page screenshots.

uinotes visual-diff --project my-app
uinotes visual-diff --compare --width 1440

uinotes batch

Execute NDJSON batch operations.

echo '{"op":"resolve","id":"abc","message":"Fixed"}' | uinotes batch -
uinotes batch ops.ndjson --dry-run --concurrency 10

uinotes schema

List or print API resource schemas.

uinotes schema
uinotes schema --resource notes

uinotes install-skills

Install Claude Code skill files into .claude/skills/.

uinotes install-skills
uinotes install-skills --dir /path/to/project/.claude/skills
uinotes install-skills --check

uinotes doctor

Check CLI configuration, API connectivity, and version.

uinotes doctor

Checks: config file, API URL, API key, API reachability, project binding, skills installed, CLI version.

uinotes update

Check for and install CLI updates.

uinotes update

Configuration

The CLI looks for config in two places (local takes priority):

1. Local: .uinotes.json in the current directory
2. Global: ~/.uinotes.json in your home directory

{
  "apiUrl": "http://localhost:3000",
  "apiKey": "your-api-key"
}

Project Binding

Run uinotes set project <slug> to create a .uinotes file in the current directory. This binds the project to the directory tree so all commands automatically use it — no --project flag needed.

The CLI resolves the project in this order:

1. --project flag (explicit override)
2. .uinotes file in current directory or nearest parent
3. No project (commands that require one will error)

API keys are redacted when displayed with uinotes config.

Global Options

| Option | Description | |--------|-------------| | --project <name> | Override default project for this command | | --help, -h | Show help |

License

MIT