You've extracted the Developer Kit — the curated starter pack for developers authoring functional contributions that ship to the Vincia Forge. Developers ship blueprints (T0), connectors (T1), workflow-nodes (T2), widgets (T3), and solution packs (T4) that other Vincia builders install onto their builds — or that the developer applies directly to a real-content build for a specific client/product.
README.md ← you are here
docs/
prompt-for-llm.md Entry conversational flow — paste into your LLM first
prompt-for-developer-llm.md Deep structural reference (RULES 1-22) — read before src/index.ts
widget-catalog.html Browseable card grid (open with file://)
widget-catalog-for-llm.md LLM-ingestion: one section per widget
blueprint-json-spec.md BlueprintDef field-by-field reference
developer-tiers.md 1-page summary of all 5 developer tiers
examples/
blueprint-crm-lite/ T0 blueprint — app starter (CRM)
blueprint-invoicing/ T0 blueprint — module (invoicing)
blueprint-support-tickets/ T0 blueprint — module (support)
connector-stripe-payment/ T1 payment — PaymentProvider against Stripe
connector-s3-storage/ T1 storage — StorageProvider against any S3-compatible bucket
connector-slack-notification/ T1 notification — NotificationChannel via Slack webhook
connector-google-auth-provider/ T1 auth-provider — OAuthProvider for Google Sign-In
connector-sendgrid-mailbox/ T1 mailbox — MailboxProvider via SendGrid
workflow-node-pdf-export/ T2 workflow-node — HTML to PDF via platform service
widget-stripe-checkout/ T3 widget — inline Stripe Elements form-field
solution-pack-saas-billing/ T4 solution-pack — one-install SaaS billing bundle
-
Install the CLI (one-time):
# macOS / Linux: curl -fsSL https://get.vincia.io/install | bash
# Windows (PowerShell): iwr -useb https://get.vincia.io/install.ps1 | iex
Windows note: open a fresh PowerShell after install (the npm global bin dir is only on PATH in new terminals). If a default
Restrictedexecution policy blocksnpm/vincia(.ps1shims), run once (no admin needed):Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned— or call the.cmdshims (npm.cmd,vincia.cmd). Requires Node 18+. -
Log in (the default Studio host is
studio.vincia.io, so barevincia loginis all you need for the public Vincia SaaS):vincia login # Self-hosted / enterprise deployment only: vincia login --studio-url https://<your-vincia-host>
-
Refresh the widget catalog to today's platform shape:
vincia widgets sync --out docs
-
Scaffold a new contribution — pick a tier:
vincia create blueprint my-module # T0 — full data + workflows vincia create connector my-stripe-alt --capability payment # T1 vincia create workflow-node my-transform # T2 vincia create widget my-kpi-card # T3 vincia create solution-pack my-clinic-pack # T4
T1 connectors must declare a capability (
payment/storage/notification/auth-provider/mailbox). -
Validate locally:
vincia test -
Preview (T0 blueprints + T3 widgets):
vincia preview
For T1 connectors + T2 workflow-nodes, use:
vincia dev
-
Test-apply a T0 blueprint against an ephemeral sandbox build:
vincia test --sandbox -
Publish when happy:
vincia publish
New kit versions ship regularly (bug fixes, new rules, new examples). This kit is a folder you downloaded — it doesn't auto-update.
- Check your version vs latest: the title line above (
# Vincia Developer Kit — vX.Y.Z) and the## Statusline show what you have; the latest is athttps://get.vincia.io/kits/and in the## What's newchangelog below. - Cloned with git (recommended for staying current):
git pullupdates the rulebook, examples, and editor configs in place, and shows you exactly what changed.git clone https://github.com/vincia-io/developer-kit.git # first time cd developer-kit && git pull # to update
- Downloaded the zip: re-download the latest and unzip it over the folder (back up local edits first).
curl -fsSL https://get.vincia.io/kits/developer-kit-latest.zip -o developer-kit.zip && unzip -o developer-kit.zip - Keep the CLI current too (separate from the kit):
vincia upgrade, or re-runcurl -fsSL https://get.vincia.io/install | bash. After upgrading the CLI or the kit, restart your LLM client / MCP server so it relaunchesvincia mcp serveand surfaces new tools.
Using a web client over the remote MCP surface (
https://mcp.vincia.io/contributor) instead of a local kit? That surface is always current — nothing to upgrade.
Open docs/prompt-for-llm.md in your LLM (Claude / ChatGPT / Cursor / any).
The prompt teaches the LLM:
- The two archetypes (
websiteandportal) —websiteincludes admin sign-in plus optional customer accounts,portalis login-gated chrome. (If you previously saw a third value calledwebsite_as_portal, it's been retired.) - The intent-first conversational flow (Forge vs client build).
- The tier-branched question set: T0 blueprint authoring asks for brand context (since it scaffolds whole apps); T1/T2/T3/T4 skip brand entirely.
- The
BlueprintDefshape (inputs[],steps[],flow,fixtures[]). - How to compose widgets into views (which widget for which intent).
- How to wire workflows + collections without writing custom code.
- Provenance + revenue inheritance for forked contributions.
vincia widgets explain data-table form kanban returns deep-dives the LLM
can paste into its working context.
See docs/developer-tiers.md for a 1-page summary of all 5 developer tiers.
If you're an LLM client reading this kit on a developer's behalf, propose these two terminal commands to the developer to get started:
curl -fsSL https://get.vincia.io/install | bash
vincia login # public SaaS default; self-hosted: vincia login --studio-url https://<their-vincia-host>Then load docs/prompt-for-llm.md and walk the conversational flow from its
top.
- New "Keeping the kit up to date" section (above) — how to refresh an existing
kit to a newer version:
git pullif you cloned (recommended), or re-download the-latestzip; how to check your version vs latest; and a reminder to keep the CLI current + restart your MCP client after an upgrade. Mirrors the hosted https://forge.vincia.io/docs/getting-started "Keeping your kit up to date" section.
- Windows install docs — the PowerShell installer one-liner, an
execution-policy note (
Set-ExecutionPolicy -Scope CurrentUser RemoteSigned), and an "open a fresh terminal" PATH reminder.
vincia logincorrected: docs no longer reference the non-existent--api-hostflag; barevincia loginis the default (Studio host defaults tostudio.vincia.io),--studio-urlis for self-hosted deployments.- Report friction to Studio: the new
vincia_studio_report_issueMCP tool lets an LLM client file kit/CLI/docs bugs directly into Studio so the platform team can fold fixes into the next release;vincia_studio_list_issue_reportslists what you've filed.
- Tool-name rename caught up: 5 LLM-aid files (
CLAUDE.md,AGENTS.md,.cursor/rules/vincia.mdc,.windsurfrules,.github/copilot-instructions.md) now referencevincia_lint_manifest(underscore) — the colon-form was renamed platform-wide in G-S96 and the kit was the last surface still teaching the old name. - Chat-first sandbox loop documented in
docs/prompt-for-llm.md. The localvincia create/dev/test/publishloop is still here; alongside it is the post-G-S97vincia_sandbox_open_draft / write_file / run / publishcloud-sandbox loop that an LLM client can drive without the developer ever opening a terminal. Both loops hit the same draft row and the samesubmitVersionendpoint, so the marketplace listing is identical either way. - Two new clarifying notes in
docs/prompt-for-developer-llm.md(RULES 1-22 unchanged): RULE 13 now flagsvincia_sandbox_runas the chat-first equivalent ofvincia test, and RULE 14 calls out thatvincia_sandbox_publish ≡ vincia publishso the LLM doesn't pick between them as if they were different shipping paths. - Visual debug callout in
examples/widget-stripe-checkout/CLAUDE.md— callvincia_studio_screenshot(slug, page)after each widget edit to see the rendered after-state inline in your LLM client (G-S100). - Built-in widget catalog snapshot: every kit zip bakes in
docs/widget-catalog.{html,json}+docs/widget-catalog-for-llm.mdgenerated from the live platform manifest at build time. If the catalog gains a widget after you extracted the kit, runvincia widgets sync --out docsto refresh the snapshot.
The CLI's widgets * + create * commands are live for all 5 developer
tiers. test, preview, dev, and publish are under active development.
The chat-first vincia_sandbox_* MCP tools are live on mcp.vincia.io/
(40 public tools) — attach the vct_* contributor token to your LLM client
to use them.
Contributions picked from the Forge marketplace earn $1 per recipient per
active month, forever. Forked contributions split that earning with ancestors
(default 50% publisher / 25% each ancestor; declarable as clean-room
rewrite). See docs/blueprint-json-spec.md for the provenance schema.
Dashboard: /admin/contributor.