Skip to content
AssureSwarm Docs

Agent Operating Guide

/coach-artifact-install

Install a live-artifact template shipped with the plugin: pre-flight-validated against your schema and installed as a local preview file or to Canvas via suggest_change.

Installs a live artifact, an HTML template plus a manifest, that ships with the plugin. The skill first pre-flights the artifact against your schema snapshot, confirming your tenant has the item types and fields it queries; if anything is missing it prints exactly what and stops, because a broken artifact is worse than none. It then installs to one of two targets: a local HTML file under your workspace for preview, or a Canvas live-artifact page. The Canvas target goes through suggest_change, so nothing lands in your tenant until you approve it; the local target just writes to disk.

When to use

Section titled “When to use”

Once your schema is in place, to stand up a dashboard or other shipped artifact against your tenant, a portfolio view, an onboarding checklist, a coverage matrix, either as a quick local preview or as a live Canvas page. To build a dashboard from scratch instead of installing a shipped one, use /coach-dashboard-create.

Inputs

Section titled “Inputs”
Flag Required Notes
<plugin>:<slug> Yes Positional: the plugin namespace and artifact slug, joined by a colon. The artifact must ship in an installed plugin.
--target local|canvas|both No Where to install. Local preview file, Canvas live-artifact page (via suggest_change), or both. Asked if unset.
--name <display-name> No Override the artifact’s display name. Canvas-target only.

Example

Section titled “Example”

/coach-artifact-install auditcanvas:portfolio-manager-dashboard loads the artifact’s template and manifest, then pre-flights it against your schema snapshot: this dashboard needs an audit item type with fields like phase, lead_auditor, status, and progress_percent. If any are missing, the skill lists them and stops. If the schema matches, it asks where to install: a local preview at .coworkcanvas/artifacts/portfolio-manager-dashboard.html, or a Canvas live-artifact page submitted for approval via suggest_change.

Good to know

Section titled “Good to know”
  • Pre-flight is a hard stop: an artifact whose required item types or fields your schema lacks won’t install. The skill prints each missing piece and suggests a fix, rename a type, add the field, or skip the artifact, rather than install something broken.
  • Local vs Canvas differ: a local install writes a self-contained preview file (with the shared lib/ copied alongside) for fast iteration; a Canvas install inlines all lib/ into one self-contained page and submits it via suggest_change, pending your approval.
  • Re-installing overwrites the local file but creates a NEW Canvas suggestion each time: you retire the old one manually. Idempotency is at the file level only.
  • If the artifact’s manifest declares a min_canvas_version newer than your tenant, the Canvas install halts with an upgrade message.
Section titled “Related”