Skip to content

Repository files navigation

Playhouse

EnglishEspañolFrançaisDeutschItalianoPortuguêsРусский中文日本語한국어

CI Status npm version GitHub Release MIT License

QA CLI for security, functional testing, performance audits, and agent handoff.
Run headless from shell, CI, or agent tooling. Optional TUI for humans.

Playhouse CLI Demo

Install

Recommended:

npm install -g @nicholasxdavis/playhouse-cli
playhouse install --full   # Trivy, Arkenar, Playwright, Lighthouse, chromium
playhouse init             # set up .playhouse/ and agent skill

Dev dependency:

pnpm add -D @nicholasxdavis/playhouse-cli
npx playhouse doctor
Profile Command Installs
Full (default) playhouse install or --full Trivy, Arkenar, Playwright, Lighthouse, chromium
Minimal playhouse install --minimal Trivy + Arkenar only

Optional project hook:

"scripts": {
  "postinstall": "playhouse-install-tools"
}

Set PLAYHOUSE_INSTALL_STRICT=1 to fail npm install when tool install fails.

Method Command
npm (primary) npm i -g @nicholasxdavis/playhouse-cli
npx npx @nicholasxdavis/playhouse-cli init
GitHub Release Latest binaries
cargo (developers) cargo install --path . --force
manual binary set PLAYHOUSE_BIN or PLAYHOUSE_SKIP_DOWNLOAD=1

The npm package downloads the native binary (~12 MB) from GitHub Releases on postinstall. Current release: v0.2.0.

From source:

git clone https://github.com/nicholasxdavis/playhouse-cli.git
cd playhouse-cli
cargo build --release
cargo install --path . --force

Local npm dev loop:

cargo build --release
cd packages/playhouse && npm run link-local   # bash
# PowerShell 5.x: cd packages/playhouse; npm run link-local

CI: GitHub Actions runs cargo test, npm smoke, and playhouse verify on Ubuntu, macOS, and Windows.

Releases: push tag v0.2.0 (must match Cargo.toml and packages/playhouse/package.json) to publish binaries for npm postinstall.

Quick start

playhouse                    # TUI (humans)
playhouse doctor             # check tools
playhouse verify --json      # full QA suite + 0-100 star rating
playhouse agent --json       # agent manifest (read first)
playhouse upgrade --json     # check GitHub + npm for updates

Browser audits (Lighthouse, Arkenar) need a URL:

playhouse config set default_url http://localhost:3000

Playhouse also reads port hints from package.json, Vite, and Wrangler config, then probes common dev ports.

Monorepos:

playhouse config set scan_root apps/web
playhouse config set test_root apps/web

For agents

Read AGENTS.md first. playhouse init installs .playhouse/SKILL.md and other workspace files.

playhouse skill install
playhouse skill status --json

Commands

Command Description
playhouse agent [--json] Full agent manifest
playhouse agent status Quick health + next actions
playhouse agent plan Phased workflow
playhouse agent handoff Verify + export handoff bundle
playhouse verify Trivy + functional + Arkenar + Lighthouse
playhouse test list|init|run Test baseplates
playhouse score Playhouse Stars (0-100)
playhouse doctor Tool health
playhouse install Auto-install bundled tools
playhouse config Settings (get/set/schema)
playhouse skill .playhouse/SKILL.md management
playhouse upgrade Check GitHub / npm for newer releases

See also: stars.md, playwright.md, lighthouse.md, trivy.md, arkenar.md, THIRD_PARTY_NOTICES.md.

Playhouse Stars

Combined 0-100 audit score after verify. Report at .playhouse/reports/score.json. Default pass threshold: 75.

Project layout

your-project/
  .playhouse/
    SKILL.md
    BRIEF.md
    AGENT.json
    config.json
    reports/score.json

Package managers

Playwright and Lighthouse use npm, pnpm, yarn, or bun:

playhouse config set package_manager pnpm

Exit codes

Code Meaning
0 Pass
1 Failure
2 Lighthouse below threshold
3 Arkenar findings
4 Trivy findings
5 Tool missing

About

QA CLI for security, functional testing, performance audits, and agent handoff. Run headless from shell, CI, or agent tooling. Optional TUI for humans.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages