Liftoff 🚀

Liftoff is the Astro equivalent of Laravel Boost. It supercharges your AI coding assistant (like Cursor or Windsurf) by providing Astro-specific context, strict coding guidelines, and direct access to Astro's documentation via MCP.

Features

• ✅ Interactive Setup: Asks about your editors (Cursor, VS Code, Windsurf) and AI agents (Claude, Gemini, Copilot, Junie).
• ✅ Tailored Guidelines: Scans your package.json to detect your stack (Astro, TypeScript, Tailwind) and generates specific rules.
• 📚 Official Documentation Access: Configures the Astro Docs MCP Server in your editor (e.g., Cursor), giving your AI agent real-time access to the latest Astro docs.
• 🚀 Zero Config: Just run npx liftoff install and you're ready to go.

Installation

You don't need to install liftoff globally. You can run it directly with npx (or pnpm dlx, bun x) within your Astro project.

# In your Astro project root
npx @eliancodes/liftoff install

# Or preview the changes first
npx @eliancodes/liftoff preview

Usage

Once installed, Liftoff will:

1. Scan your project: It detects if you are using Astro, TypeScript, Tailwind CSS, etc.
2. Ask for preferences: Select your editors and agents.
3. Generate Config:
   • Cursor: Creates .cursorrules and .cursor/mcp.json.
   • Claude: Creates CLAUDE.md.
   • Gemini: Creates GEMINI.md.
   • GitHub Copilot: Creates .github/copilot-instructions.md.
   • JetBrains / Junie: Creates .junie/rules.md.

After Installation

Restart your editor (Cmd+R or Reload Window) to ensure the new MCP server and rules are loaded.

Then, you can ask your AI features questions like:

"How do I use Content Collections in Astro?"

And it will query the official documentation for the most up-to-date answer.

How It Works

Liftoff uses the Model Context Protocol (MCP) to bridge your editor and the Astro documentation. It also leverages Cursor Rules to enforce project-specific coding standards.

• MCP Server: https://mcp.docs.astro.build/mcp
• Rules: Derived from Astro's official best practices and community standards.

Contributing

We welcome contributions! Please open an issue or submit a PR if you have suggestions for better prompts or new features.

Publishing

This project is configured to automatically publish to NPM when you create a GitHub Release.

1. Set NPM_TOKEN in your repository secrets (Settings > Secrets and variables > Actions).
2. Create a new Release on GitHub.
3. The Action will build and publish the package.