AstroCanvas
ProductDemoAnnotationsRoadmapPricing
£5 / month

AstroCanvas · for AI agents

Install instructions for AI agents.

Hand this block to an AI coding agent (Claude Code, Cursor, and the like) to install AstroCanvas into an existing Astro project. It assumes the paid package and licence key are already available — see thegetting-started guide for the human walkthrough.

Agent prompt
You are installing AstroCanvas — a local visual editor for Astro — into this project.

CONTEXT
AstroCanvas lives in Astro's dev toolbar. It edits explicitly marked literal text and writes the change back to the original .astro source file. It runs in development only and never ships in a production build.

PREREQUISITES (the developer must provide these — do not fabricate them)
- An active AstroCanvas subscription.
- The package file "astrocanvas-astro-0.1.0.tgz" present in the project root (from the AstroCanvas subscriber download page). AstroCanvas is not on the public npm registry, so "npm install @astrocanvas/astro" and "npx astro add astrocanvas" will NOT work.
- The licence key from the AstroCanvas purchase email.

STEPS
1. Install the local package:
   npm install ./astrocanvas-astro-0.1.0.tgz

2. Add the integration to astro.config.mjs:
   import astroCanvas from "@astrocanvas/astro";
   // ...
   export default defineConfig({
     integrations: [astroCanvas()],
   });

3. Licence activation is per-developer-machine and interactive. Do NOT automate it — ask the developer to run it themselves:
   npx astrocanvas activate

4. Mark editable content. Add a unique, stable data-astrocanvas ID to LITERAL-TEXT elements only:
   <h1 data-astrocanvas="hero-heading">A clear page heading.</h1>

SAFETY BOUNDARY — do not violate
- Only literal text with a unique data-astrocanvas ID is editable. Never add the attribute to dynamic expressions, nested markup, framework islands, or components — those are read-only by design.
- Do not commit the .tgz archive or the licence key.
- Keep all edits under version control so every change stays reviewable and reversible.

TO EDIT
Run the dev server, open Astro's dev toolbar, choose AstroCanvas, select marked text, preview, and save. Each save makes one atomic change to the .astro source; a failed edit leaves the file byte-for-byte unchanged.

This page is intentionally excluded from search indexing and the sitemap. Share the link directly with an agent or teammate.

AstroCanvas

Visual finishing for Astro. Your site stays yours.

SupportPrivacyTerms & refundsAstro CMS guideAstro WYSIWYG guideGetting startedPricing

© 2026 AstroCanvas

a Roughton concern · roughton.co

Your choice

Useful analytics, only if you allow them.

AstroCanvas uses Google Analytics to understand which pages help people. Essential site features work without analytics. Read the privacy policy.