@agentdeck/setup
v1.4.0
Published
One-command installer for AgentDeck — put AI coding agents (Claude Code, Codex, OpenCode) on physical control surfaces
Downloads
2,006
Maintainers
Readme
@agentdeck/setup
One-command installer for AgentDeck — put your AI coding agents (Claude Code, Codex, OpenCode) on a physical control surface: Stream Deck, tablets, e-ink readers, ESP32 panels, LED matrices, or just your terminal.
Install
npx @agentdeck/setupThat is the whole install, on every platform. The wizard:
- Checks prerequisites (Node.js 22, 24, or 26; your agent CLIs; platform build tools)
- Installs the
@agentdeck/bridgepackage globally — this provides theagentdeckCLI and the local daemon - Registers Claude Code lifecycle hooks so sessions report state automatically
- Seeds the local data directory
Then start the daemon and run your agent normally:
agentdeck daemon install
claude # or: codex / opencode
agentdeck dashboard # optional terminal dashboardThe legacy agentdeck claude, agentdeck codex, agentdeck opencode, and
agentdeck monitor session bridges remain functional compatibility paths with
no removal date. Workflow design is discussed in
Discussion #278 and
implementation is tracked in
#273.
No Stream Deck required — the daemon is the product; decks and other devices are optional ways to look at it.
Platform notes
Node.js 22, 24, or 26 is required everywhere. Node 20 reached end of life in April 2026 and is intentionally unsupported; short-lived odd Node releases are unsupported as well. Native modules (node-pty, sharp, better-sqlite3) install from prebuilt binaries first. Setup runs agentdeck diag native after installing the bridge so a missing SQLite binding is reported before the daemon starts recording sessions. On macOS, AgentDeck repairs the known missing execute bit in the stable node-pty spawn-helper at first PTY use, including for direct bridge installs.
macOS
- Nothing else is required to install.
- Xcode Command Line Tools (
xcode-select --install) are needed only in two cases: a native-module prebuild fails, or you use the voice features — the on-device voice/judge helper compiles on demand (macOS 26+). - Autostart:
agentdeck daemon installregisters a LaunchAgent.
Windows 11
- Install Node.js with
winget install OpenJS.NodeJS, then runnpx @agentdeck/setupin PowerShell. - Hooks are written as PowerShell one-liners; no bash required at runtime.
- Autostart:
agentdeck daemon installregisters a per-user Scheduled Task (AgentDeckDaemon) — no admin elevation. - Details: Windows guide
Linux
- The Elgato Stream Deck desktop app does not exist on Linux, so the Stream Deck plugin is skipped — the daemon,
agentdeck dashboardterminal dashboard, hardware devices, and the Android/iOS companion apps all work. - If the prebuilt
node-ptybinary fails: Debian/Ubuntusudo apt install build-essential python3, Fedorasudo dnf install gcc-c++ make python3, Archsudo pacman -S base-devel python. - Autostart:
agentdeck daemon installregisters a systemd--userunit; for headless boot runloginctl enable-linger $USERonce. - Details: Linux guide
Links
- Project website: https://puritysb.github.io/AgentDeck/
- Repository & docs: https://github.com/puritysb/AgentDeck
- Mac App Store dashboard (standalone, no Node.js needed): https://apps.apple.com/app/id6784822497
- Issues: https://github.com/puritysb/AgentDeck/issues
License
MIT
