@maxiviper117/svelte-artisan

Svelte Artisan CLI

A CLI tool for Svelte projects inspired by Laravel Artisan.

🚀 Quick Start

Install and run a command instantly (no install required):

npx svelte-artisan make:component MyComponent

Or with pnpm:

pnpm dlx svelte-artisan make:component MyComponent

📦 Installation (for local development)

pnpm install

🛠️ Usage

Run with npx (no install required):

npx svelte-artisan make:component MyComponent
npx svelte-artisan make:store MyStore

Run with pnpm dlx (no install required):

pnpm dlx svelte-artisan make:component MyComponent
pnpm dlx svelte-artisan make:store MyStore

🧑‍💻 Development: Running from Source

If you want to run the CLI directly from the source code (for development or debugging):

node ./bin/index.js make:component MyComponent
node ./bin/index.js make:store MyStore

📋 Commands & Flags

Command	Description
make:component <name>	Generate a new Svelte component in src/lib/components/
make:store <name>	Generate a new Svelte store in src/lib/stores/
--typescript	Generate TypeScript files (optional flag)
-h, --help	Show help
-V, --version	Show CLI version

🧑‍💻 Example Output

$ npx svelte-artisan make:component MyComponent
✔ Created src/lib/components/MyComponent.svelte

⚙️ Configuration

No configuration or environment variables required by default.

🐞 Troubleshooting

• If you see a permissions error, try running with elevated privileges or check your Node.js version (requires Node 20+).
• For help, run:

  npx svelte-artisan --help
  

• If you encounter a bug, please open an issue.

🤝 Contributing

Contributions are welcome! Please open issues or pull requests on GitHub.

Development

• Uses ESM (type: module)
• Uses Commander.js, Chalk, fs-extra
• Add your own commands and extend as needed!

License

This project is licensed under the MIT License.