Quick Start from an Existing Astro Project

Already have an Astro project? Link it to Wix and deploy it as a Wix-managed headless project with Wix's Astro integration. The integration handles hosting, authentication, and extensions for you, so there's no client setup or authentication to wire up yourself.

The headless link command provisions a Wix business and site, configures your Astro setup for Wix, and installs the dependencies you need. This is the alternative to scaffolding a new Astro project. For that, see Quick Start with the Wix CLI.

Before you begin

Make sure:

• You're logged in to your Wix account. If you don't have one, sign up.
• You have Node.js (v20.11.0 or higher).
• Your project uses Astro 5 and contains an Astro configuration file (such as astro.config.mjs). Astro 6 isn't supported.
• Your project isn't already linked to Wix (it doesn't contain a wix.config.json file).

Step 1 | Link your project to Wix

1. Navigate to the root folder of your Astro project.

2. Run:

   Copy

3. Enter the name of your business. This becomes the name of your headless project on Wix and is added to your Wix sites list. The command configures your Astro project for Wix, installs dependencies, and provisions a Wix business and site.

   Note: You can run the command non-interactively by passing the --business-name flag. See the headless link flags.

Step 2 | Test the project

Run npm run dev to start the local development environment, then open the link in your terminal to view your site. The environment hot-reloads, so changes appear in the browser immediately.

Step 3 | Continue developing

Your Astro project is now connected to Wix with the Astro integration handling authentication for you, so you can call Wix SDK methods directly. From here you can:

• Call Wix APIs with the JavaScript SDK.
• Install the Wix plugin to set up Wix Skills and the Wix MCP for AI-assisted development.
• Add extensions for custom backend logic and dashboard UIs.

See also

• About Wix-Managed Headless
• create headless link