DocumentationGetting Started Guide

Docs v0.1.0•Install & verify

Get up and running with upd CLI in a few minutes. Follow every step in order — especially global install + verify — so the upd command works from any folder.

Run commands from the correct folder

All install commands must be run inside the cloned upd repository root — the directory that contains both package.json and bin/upd.js. After git clone and cd upd, confirm with:

ls package.json bin/upd.js

If you keep a local monorepo (e.g. upd/cli), use cd cli before install — not the parent folder. Running install from the wrong path breaks the global upd shell alias.

100% Auditable & Open Code

upd CLI runs fully locally. All code is plain JavaScript — no obfuscated binaries.

Clone & install dependencies

After purchase you receive access to the private GitHub repository.

# Clone and enter repo root (must contain bin/upd.js)

git clone https://github.com/dimarud1995/upd.git

cd upd

# Sanity check — both files must exist

ls package.json bin/upd.js

# Install Node dependencies (Node 18+)

pnpm install

# or: npm install

chmod +x bin/upd.js

Register the global `upd` command

Still inside the repo root, run the installer. It writes (or updates) a shell alias pointing at this copy of bin/upd.js and runs npm link. Do this again if you move the repo to a new path.

# Required — from repo root only

node bin/upd.js install

# Reload shell config

source ~/.zshrc

# macOS bash: source ~/.bash_profile

Alternative: npm install -g . from the same folder — but you should still run node bin/upd.js install once so the shell alias stays in sync.

✓

Verify before continuing

From any directory (e.g. your home folder), these must succeed. If you see Cannot find module .../bin/upd.js, go back to step 2 and re-run install from the correct repo root.

# Should show path ending in .../upd/bin/upd.js (not a missing file)

type upd

# Should print JSON list of engines

upd --get-ai-engines --json

Until verification passes, use node /full/path/to/upd/bin/upd.js instead of upd.

Run setup wizard

Configures projects folder, AI CLI, git identity, Slack, and scan period. Installs ~/.cursor/skills/upd/SKILL.md for AI agents.

upd init

Generate your standup

# Interactive

upd

# Agent workflow

upd prepare --yes --json

upd send slack --date today --yes --json

AI Agents guide →

Troubleshooting

Error: Cannot find module '.../bin/upd.js': Your shell alias points at an old or wrong path. cd into the repo that contains bin/upd.js, run node bin/upd.js install, then source ~/.zshrc and verify with upd --get-ai-engines --json.
node bin/upd.js works but upd does not: You skipped global install or did not reload the shell. Run step 2 and open a new terminal tab.
Moved or renamed the repo folder: Re-run node bin/upd.js install from the new location. The installer replaces stale aliases automatically.

NextSettings & AI