--- name: pp-qsys description: "Q-SYS specs, configuration, wiring, compatibility, and fault articles in one offline index - answering equipment-list questions no QSC website can take as input. Trigger phrases: `q-sys specs`, `what q-sys designer version does this run on`, `how do I wire this q-sys`, `what does this q-sys fault mean`, `is this q-sys gear end of life`, `check this equipment list against q-sys designer`, `use qsys`, `run qsys`." author: "drummerms" license: "Apache-2.0" argument-hint: " [args] | install cli|mcp" allowed-tools: "Read Bash" metadata: openclaw: requires: bins: - qsys-pp-cli install: - kind: go bins: [qsys-pp-cli] module: github.com/mvanhorn/printing-press-library/library/devices/qsys/cmd/qsys-pp-cli --- # Q-SYS — Printing Press CLI ## Prerequisites: Install the CLI This skill drives the `qsys-pp-cli` binary. **You must verify the CLI is installed before invoking any command from this skill.** If it is missing, install it first: 1. Install via the Printing Press installer. It defaults binaries to `$HOME/.local/bin` on macOS/Linux and `%LOCALAPPDATA%\Programs\PrintingPress\bin` on Windows: ```bash npx -y @mvanhorn/printing-press-library install qsys --cli-only ``` 2. Verify: `qsys-pp-cli --version` 3. Ensure the reported install directory is on `$PATH` for the agent/runtime that will invoke this skill. If the `npx` install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer). This installs into `$GOPATH/bin` (default `$HOME/go/bin`), so add that directory to `$PATH` instead: ```bash go install github.com/mvanhorn/printing-press-library/library/devices/qsys/cmd/qsys-pp-cli@latest ``` If `--version` reports "command not found" after install, the runtime cannot see the binary directory on `$PATH`. Do not proceed with skill commands until verification succeeds. QSC splits every integrator answer across three sites: qsys.com carries the spec-sheet PDFs where the electrical numbers live, help.qsys.com carries configuration and compatibility with zero electrical specs, and support.qsys.com carries the FAQ, application notes, and fault articles. None of them accepts a list of models. This CLI harvests all three into local SQLite, joins them per product, and answers spec, configuration, wiring, compatibility, and fault questions offline - including from a job site with no usable network. ## When to Use This CLI Use this CLI for questions about Q-SYS equipment: what a product's specifications are, how to configure it, how to wire and network it, whether an equipment list runs on a given Q-SYS Designer version, and what a fault string on a Designer screen means. It is built for AV integrators, designers, and commissioning techs working from an equipment list, and it works fully offline once harvested, which matters on job sites with locked-down networks. ## Anti-triggers Do not use this CLI for: - Do not use this CLI to control a live Q-SYS Core - it never connects to hardware; use a QRC client library for that - Do not use it to look up control pin names for Lua or QRC scripting - it indexes equipment documentation, not the schematic control surface - Do not treat extracted spec text as authoritative for engineering sign-off - always confirm against the source PDF URL it returns - Do not use it for pricing, availability, or lead times - it indexes documentation only - Do not use it to create, revise, or version Q-SYS design files - Do not run two qsys-pp-cli processes at once - concurrent invocations against the same store can crash with SIGBUS (upstream defect, cli-printing-press#4349). Invoke commands strictly serially: no parallel MCP tool calls, no `&` fan-out. ## Unique Capabilities These capabilities aren't available in any other tool for this API. ### One record, three sources - **`product get`** — See a Q-SYS product's specs, configuration pages, wiring guidance, known gotchas, and factory-reset procedure in one record. _Reach for this first for any question about a single model; it answers spec, config, wiring, and gotcha questions in one call instead of four._ ```bash qsys-pp-cli product get CX-Q --agent ``` - **`connect`** — Get the networking, wiring, and I/O guidance that actually applies to a given model, including third-party application notes. _Use this for how-do-I-wire-this-in questions instead of reading an entire networking section._ ```bash qsys-pp-cli connect TSC-70-G3 --agent ``` ### Equipment-list answers no vendor site can give - **`bom verify`** — One report per model in an equipment list: Designer-version support, end-of-life status, LTS carry date, and spec-sheet availability. _Use this before quoting to catch an unsupported or end-of-life part while a swap is still free._ ```bash qsys-pp-cli bom verify CX-Q TSC-70-G3 NL-C4 --qds 10.0 --agent ``` - **`bom risks`** — Surface every known issue, awareness note, and troubleshooting article that touches any model on an equipment list, filtered to a Designer release. _Use this alongside bom verify to find the problems that are documented but not reflected in the compatibility matrix._ ```bash qsys-pp-cli bom risks CX-Q TSC-70-G3 --qds 10.0 --agent ``` - **`compat check`** — Check a whole equipment list against a Q-SYS Designer version and get back what is supported and what is not. _Use this for the fast supported/not-supported answer when the client has standardized on a Designer version._ ```bash qsys-pp-cli compat check CX-Q TSC-70-G3 NL-C4 --qds 10.0 --agent ``` ### Release and fault intelligence - **`qds`** — For one Q-SYS Designer release: known issues, LTS status and end date, and which hardware was removed. _Use this when deciding whether to standardize a site on a Designer release, or before recommending an upgrade._ ```bash qsys-pp-cli qds 10.0 --agent ``` - **`fault`** — Paste the literal fault or status string Q-SYS Designer displays and get the article that explains it, plus the models it applies to. _Use this on site when Designer shows a fault and the job network cannot reach a search engine._ ```bash qsys-pp-cli fault "LAN A Streaming Error - Not Connected" --agent ``` ### Trust the local copy - **`coverage`** — Report per source how many pages parsed, how many spec-sheet PDFs were linked versus actually text-extracted, and how many support articles were indexed. _Run this after a harvest; a drop in extracted-PDF count means specs silently stopped being searchable._ ```bash qsys-pp-cli coverage --agent ``` ## Command Reference **harvest** — Build the local corpus (run this first) - `qsys-pp-cli harvest` — walk all three vendor sitemaps (help.qsys.com, qsys.com, and support.qsys.com; roughly 750 help pages, 270 product pages, and 1,900 support articles, rate limited) and build the local corpus every other command reads - `qsys-pp-cli harvest --only pages|products|compat|support` — harvest one source instead of all three - `qsys-pp-cli harvest --only products --limit 25 --with-pdfs` — narrow the walk, and also download and text-extract spec-sheet PDFs (slower; needs `pdftotext`) - `qsys-pp-cli harvest --only support` — harvest support.qsys.com; required for `fault`, `bom risks`, and `qds` **Do not confuse `harvest` with `sync`.** Top-level `sync` walks the generated endpoint resources and refreshes entity lookups; it does not build the corpus. The Q-SYS corpus is three scraped websites plus a PDF layer that must be joined locally, and only `harvest` builds it. Run `qsys-pp-cli coverage` afterwards to confirm the harvest landed. **compat** — Hardware and software compatibility matrices - `qsys-pp-cli compat by-product` — List the Q-SYS Designer versions and compatibility notes for a hardware product, per the compatibility matrix - `qsys-pp-cli compat by-version` — List hardware support by Q-SYS Designer version - `qsys-pp-cli compat deprecations` — List deprecated hardware and feature notices with the release in which each item was deprecated - `qsys-pp-cli compat upgrade-path` — Show firmware and Q-SYS Designer upgrade path requirements, including the supported upgrade sequences **networking** — Connection, wiring, and network setup guidance - `qsys-pp-cli networking ` — Fetch a Q-SYS networking or connection guidance page **page** — Q-SYS Help documentation pages (configuration, networking, hardware) - `qsys-pp-cli page get` — Fetch a Q-SYS Help documentation page as clean text - `qsys-pp-cli page index` — Fetch the Q-SYS Help sitemap listing every documentation page **product** — Q-SYS product pages and spec sheets on qsys.com - `qsys-pp-cli product index` — Fetch the qsys.com sitemap listing every product page - `qsys-pp-cli product page` — Fetch a qsys.com product page as clean text - `qsys-pp-cli product resources` — List spec-sheet and manual PDF links for a product **support** — Q-SYS support knowledge base: FAQ, application notes, awareness, troubleshooting, error/status messages - `qsys-pp-cli support article` — Fetch a Q-SYS support article as clean text - `qsys-pp-cli support index` — Fetch the support.qsys.com sitemap listing every knowledge-base article ### Finding the right command When you know what you want to do but not which command does it, ask the CLI directly: ```bash qsys-pp-cli which "" ``` `which` resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code `0` means at least one match; exit code `2` means no confident match — fall back to `--help` or use a narrower query. ## Recipes ### First run: build the corpus ```bash qsys-pp-cli harvest --timeout 900s qsys-pp-cli coverage ``` `harvest` walks all three vendor sitemaps (help.qsys.com, qsys.com, and support.qsys.com) into the local corpus; every other command reads it. `coverage` then reports how many products resolved a spec sheet, how many pages parsed, and how many support articles were indexed, so an incomplete harvest is visible instead of silent. Narrow a first pass with `--only products --limit 25`, add `--with-pdfs` when spec-sheet text is needed, and use `--only support` for the knowledge base that `fault`, `bom risks`, and `qds` read. ### Pre-quote sweep across an equipment list ```bash qsys-pp-cli bom verify CX-Q TSC-70-G3 NL-C4 --qds 10.0 --agent ``` Returns one row per model with version support, end-of-life status, LTS carry date, and spec-sheet URL. ### Find the documented problems on a list ```bash qsys-pp-cli bom risks CX-Q TSC-70-G3 --qds 10.0 --agent ``` Surfaces known-issue, awareness, and troubleshooting articles touching any model on the list. ### Resolve a fault string from a Designer screen ```bash qsys-pp-cli fault "LAN A Streaming Error - Not Connected" --agent ``` Matches the literal string against error/status and troubleshooting article titles and bodies. ### Narrow a verbose product record for an agent ```bash qsys-pp-cli product get CX-Q --agent --select model,family,spec_pdf_url,discontinued ``` Product records carry full spec-sheet text; --select trims the payload so an agent does not burn context on prose. ### Decide whether to standardize on a Designer release ```bash qsys-pp-cli qds 10.0 --agent ``` Known issues, LTS status and end date, and hardware removed in that release. ## Auth Setup No authentication required. Run `qsys-pp-cli doctor` to verify setup. ## Agent Mode Add `--agent` to any command. Expands to: `--json --compact --no-input --no-color`. - **Pipeable** — JSON on stdout, errors on stderr - **Filterable** — `--select` keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs: ```bash qsys-pp-cli networking mock-value --agent ``` - **Previewable** — `--dry-run` shows the request without sending - **Offline-friendly** — sync/search commands can use the local SQLite store when available - **Non-interactive** — never prompts, every input is a flag - **Read-only** — do not use this CLI for create, update, delete, publish, comment, upvote, invite, order, send, or other mutating requests ### Response envelope Commands that read from the local store or the API wrap output in a provenance envelope: ```json { "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."}, "results": } ``` Parse `.results` for data and `.meta.source` to know whether it's live or local. A human-readable `N results (live)` summary is printed to stderr only when stdout is a terminal AND no machine-format flag (`--json`, `--csv`, `--compact`, `--quiet`, `--plain`, `--select`) is set — piped/agent consumers and explicit-format runs get pure JSON on stdout. ## Paths and state Agents should treat the CLI's path resolver as part of the runtime contract: - Use `--home ` for one invocation, or set `QSYS_HOME=` to relocate all four path kinds under one root. - Use per-kind env vars only when a specific kind must diverge: `QSYS_CONFIG_DIR`, `QSYS_DATA_DIR`, `QSYS_STATE_DIR`, `QSYS_CACHE_DIR`. - Resolution order is per-kind env var, `--home`, `QSYS_HOME`, XDG (`XDG_CONFIG_HOME`, `XDG_DATA_HOME`, `XDG_STATE_HOME`, `XDG_CACHE_HOME`), then platform defaults. - `config` contains settings like `config.toml` and profiles. `data` contains `credentials.toml`, `data.db`, cookies, and auth sidecars. `state` contains persisted queries, jobs, and `teach.log`. `cache` contains regenerable HTTP/cache files. - Stored secrets live in `credentials.toml` under the data dir. Existing legacy `config.toml` secrets are read for compatibility and leave `config.toml` on the first auth write. - Run `qsys-pp-cli doctor --fail-on warn` to surface path and credential-location warnings. `agent-context` exposes a schema v4 `paths` block for agents that need the resolved dirs. - For MCP, pass relocation through the MCP host config. The MCP binary does not inherit CLI flags: ```json { "mcpServers": { "qsys": { "command": "qsys-pp-mcp", "env": { "QSYS_HOME": "/srv/qsys" } } } } ``` Fleet precedence: an inherited per-kind env var overrides an explicit `--home` for that kind. Use `QSYS_HOME` or per-kind vars as durable fleet levers, and use `--home` only for a single invocation. Relocation is not reversible by unsetting env vars; move files manually before clearing `QSYS_HOME`, or `doctor` will not find credentials left under the former root. ## Automatic learning This CLI ships a self-capturing learning loop. The CLI does its own bookkeeping: every invocation is journaled locally, a failed flag followed by a corrected retry auto-derives a `flag_alias` candidate, and a `teach` on a query family without a playbook auto-synthesizes a `playbook_candidate` from the session's journal. Your job is judgment only: `recall` first, act on surfaced candidates, `teach` the final answer, `playbook amend` when you observe a correction. You never record failures by hand. ### Step 1: `recall` before any discovery Before list/search/drill commands on a new user question, run: ```bash qsys-pp-cli recall "" --agent ``` The response envelope: ```json { "query": "...", "normalized": "", "query_entities": ["..."], "found": true | false, "match_score": 0.0, "results": [ { "resource_id": "...", "resource_type": "...", "venue": "...", "confidence": 2, "entity_match": "exact|partial|unknown", "source": "taught|preseed|pattern", "warnings": ["..."] } ], "mismatches": [ /* only when --debug-mismatches */ ], "warnings": [ /* top-level */ ], "candidates": [ { "id": 12, "class": "flag_alias | playbook_candidate", "summary": "...", "sightings": 3, "last_seen": "...", "rationale": "...", "next_action": ["", "qsys-pp-cli learnings confirm 12"] } ], "playbook": { "query_family": "...", "playbook": { "steps": [ { "cmd": "", "purpose": "..." } ], "entity_slots": ["$ENTITY"], "expected_tool_calls": 3 }, "slots_resolved": { "$ENTITY": { "token": "", "canonical": "" } }, "notes": "" }, "notes": "" } ``` Empty-store short-circuit: if the store has no learnings, playbooks, or candidates yet (recall finds nothing and `learnings list` and `learnings candidates` are both empty), skip recall for the rest of this session instead of taxing every query; resume recall-first once something has been taught. ### Step 2: decision tree Read `candidates`, `playbook`, `notes`, `results[0]`, and warnings in that order: ``` if Candidates present (warnings include "candidates_present"): -> candidates are try-then-confirm, never facts. Follow each candidate's two-step next_action verbatim: run the trial command first, then run `learnings confirm ` only after the trial verified the behavior. Reject a wrong candidate with `learnings reject `. -> NEVER re-teach something recall surfaced as a candidate; confirm or reject that candidate instead of teaching a duplicate. -> candidates ride alongside playbooks and resource hits, not instead of them; continue with the branches below after acting on them. if Playbook present: -> READ Playbook.notes verbatim FIRST (workarounds + gotchas the CLI surface doesn't expose) -> replay Playbook.steps in order, substituting Playbook.slots_resolved entries for the entity slot tokens. If a step's slot is unresolved, fall back to discovery for that step only. -> the Playbook's expected_tool_calls is a budget; if you find yourself running materially more, record the divergence via `qsys-pp-cli playbook amend` at end-of-session. elif Notes present (no Playbook): -> read Notes verbatim before any discovery step; they carry known gotchas for this query family even when no structured choreography exists yet. elif Found AND Results[0].EntityMatch == "exact" AND Results[0].Confidence >= 2: -> skip discovery; fetch live data for Results[*].ResourceID one call at a time (never in parallel - see the concurrency anti-trigger) elif Found AND Results[0].EntityMatch == "partial": -> candidate hint, NOT a hit; read the resource title to validate before trusting elif (any row in Mismatches[] when --debug-mismatches was passed): -> treat as cold start; the stored learning is for a different entity (different canonical resolved from query_entities) else: // Found == false, no playbook, no notes -> cold start; run discovery normally; teach the answer afterward (Step 4). If the family has no playbook yet, that teach auto-synthesizes a playbook candidate from this session's journal - you do not need to record one by hand. ``` Playbook and Notes are orthogonal to the per-resource path. A recall response can carry both a Playbook AND a `Results[]` hit - use both: the Playbook tells you which choreography to run; the resource hits short-circuit specific steps. Default to skipping `mismatches`; pass `--debug-mismatches` only when investigating cold-start surprises. Candidate judgment details: `learnings confirm ` prints the candidate's full payload before materializing it - check that the printed payload matches the behavior you verified. `learnings reject ` tombstones the derivation signature so the same candidate does not resurface. The envelope carries only the few candidates worth acting on now; `qsys-pp-cli learnings candidates` lists the full open set. Graceful degradation: if `learnings confirm` is an unknown command, you are driving an older binary - ignore the candidates guidance and follow t