Getting Started
Installation
Install the uxd CLI globally, from a clone, or run it without installing.
Requirements
| Tool | Version | Required |
|---|---|---|
| Node.js | ≥ 18 | Yes |
git | ≥ 2.38 | Yes |
gh | any | No — enables PR metadata, gh pr diff, and fork push-back |
uxd runs on stock Node. No Bun, Deno, or other runtime is required, and any
package manager installs it.
Every
gh feature degrades gracefully when gh is missing or unauthenticated.
PR checkout, diff, and clean all fall back to plain git.Global install
uxd publishes to npm as @uxfront/uxd and installs a uxd binary onto
your PATH. This is the recommended install.
npm i -g @uxfront/uxd
pnpm add -g @uxfront/uxd
yarn global add @uxfront/uxd
Confirm it landed:
uxd version
Your package manager's global bin directory is not on your
PATH. Add
$(npm prefix -g)/bin (npm), $(pnpm bin -g) (pnpm), or $(yarn global bin)
(yarn) to it.Install from a clone
Working on uxd itself? uxd ships as compiled JavaScript, so a clone install
has two steps — install dependencies, then build the dist/ output the CLI
runs from — before you link it onto your PATH.
Clone and build
git clone git@github.com:uxfront-com/uxd.git
cd uxd
npm install
npm run build # emits dist/bin/uxd.js (the linked bin points here)
Link it onto your PATH
npm link
pnpm link --global # run `pnpm setup` once first
yarn global add "file:$PWD"
Verify
uxd version
npm link points uxd at your clone's dist/, and the CLI runs compiled
output. Re-run npm run build after every git pull or your changes will not
take effect.Run without installing
Skip the global step and call the built entrypoint from the clone:
npm install && npm run build
node dist/bin/uxd.js version
The rest of these docs write uxd. Substitute node dist/bin/uxd.js if you
have not linked it globally.
Next
Head to the quick start to configure your first project and materialize a workspace.