Reading the repo

Opening the box…

How to set up pixel-agents (pixel-agents-hq/pixel-agents) · gitmanual

Assembly instructions

pixel-agents-hq/pixel-agents

Pixel office.

Node.js

Difficulty: Easy
Time: about 5 min
Stars: ★ 10,067
Activity: Updated this month
License: MIT
Open issues: 112
Got it running: Be the first
Looked up: 1 h ago

Saved setup from 1 h ago

Start here

Will it work on my device?

Yes, it installs on your macOS

The README gives a npm install for macOS.

Checking for

Install with a package manager

npm

npm install --global pixel-agents

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 9 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js 22runtime
1×npm package manager

1× settings in .env

PIXEL_AGENTS_DEBUG

Featured in Zain Finds

▶ Watch the Reel ↗Your AI coding agents turn into pixel characters in a tiny office, typing at their desks w

Share this manual

Good to know

Monorepo (workspaces) — install from the repo root.
Has CLAUDE.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: server/package.json, webview-ui/package.json

package.json scripts (33)

vscode:prepublishnpm run package
vscode:uninstallnode ./dist/uninstall.js
prepacknpm run package
build:extensionnode esbuild.js --production
build:webviewcd webview-ui && npm run build
compilenpm run asyncapi:generate && npm run check-types && npm run lint && node esbuild.js && npm run build:webview
buildnpm run compile
watchnpm-run-all -p watch:*
watch:esbuildnode esbuild.js --watch
watch:tsctsc --noEmit --watch --project tsconfig.json
packagenpm run asyncapi:generate && npm run check-types && npm run lint && node esbuild.js --production && npm run build:webview
asyncapi:generatetsx scripts/generate-messages.ts
asyncapi:validatenode scripts/validate-asyncapi.mjs
check-typestsc --noEmit && tsc --noEmit -p server/tsconfig.test.json
preparehusky
linteslint adapters/vscode server core && cd webview-ui && eslint .
lint:fixeslint adapters/vscode server core --fix && cd webview-ui && eslint . --fix
import-tilesettsx scripts/import-tileset-cli.ts
formatprettier --write "adapters/vscode/**/*.ts" "server/**/*.ts" "core/src/**/*.ts" "webview-ui/src/**/*.{ts,tsx,css}" "*.{js,mjs}" "webview-ui/*.{js,ts}"
format:checkprettier --check "adapters/vscode/**/*.ts" "server/**/*.ts" "core/src/**/*.ts" "webview-ui/src/**/*.{ts,tsx,css}" "*.{js,mjs}" "webview-ui/*.{js,ts}"
test:webviewcd webview-ui && npm test
test:servercd server && npm test
test:package-contractnode --test scripts/npm-package-contract.test.mjs
testnpm run test:webview && npm run test:server && npm run test:package-contract
verify:npm-packagenode scripts/verify-npm-package.mjs

Files we read (9)

.env.example

.github/workflows/ci.yml

.github/workflows/pr-title.yml

.github/workflows/publish-extension.yml

.github/workflows/update-badges.yml

.nvmrc

CONTRIBUTING.md

README.md

package.json

Branch main · 464 files in the repo