Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/queaxtra/zvelte/llms.txt

Use this file to discover all available pages before exploring further.

Zvelte is a command-line interface (CLI) tool designed to streamline the creation of new SvelteKit projects. It provides a rapid way to scaffold projects by cloning a pre-configured, production-ready template that integrates modern tools and best practices.

​
What is Zvelte?

Zvelte eliminates the tedious setup process when starting a new SvelteKit project. Instead of manually configuring build tools, UI libraries, and internationalization from scratch, Zvelte gives you a fully configured project in seconds.
Zvelte is published as @queaxtra/zvelte on npm and can be used instantly with bunx without global installation.

​
Key Features

Zvelte comes packed with features that make project scaffolding fast and reliable:

Zero Installation

Use bunx to run Zvelte directly without global installation. No clutter in your system.

Production-Ready Template

Pre-configured with Shadcn UI, Tailwind CSS, and i18n support for immediate development.

Smart Package Management

Choose your preferred package manager (bun, pnpm, npm, yarn) or let Zvelte detect available options.

Automatic Configuration

Updates package.json automatically with your project name, version, and description.

​
What’s Included in the Template?

When you create a project with Zvelte, you get a complete SvelteKit application with:
  • Shadcn UI - Modern, accessible component library built on Radix UI
  • Tailwind CSS - Utility-first CSS framework for rapid styling
  • i18n Support - Built-in internationalization for multi-language applications
  • Clean Git History - The .git directory is removed, giving you a fresh start
  • Optimized Configuration - Pre-configured build tools and development environment

​
Why Use Zvelte?

1

Save Time

Skip hours of manual configuration and start building features immediately.
2

Best Practices Built-In

Leverage a template that follows SvelteKit and modern web development best practices.
3

Consistent Setup

Ensure every project starts with the same solid foundation across your team.
4

Lightweight & Fast

Minimal dependencies mean fast installation and no bloat in your development workflow.

​
Quick Example

Get started with Zvelte in one command: 
bunx @queaxtra/zvelte create my-awesome-project --install=bun
This single command clones the template, sets up your project, and installs all dependencies.

​
Next Steps

Installation

Learn how to install and verify Zvelte on your system.

Quickstart

Create your first SvelteKit project with Zvelte in minutes.
Zvelte is open source and licensed under MIT. Contributions are welcome on GitHub.

Build docs developers (and LLMs) love

Get started for freeTalk to us