Croqueta CLI

The official command-line tool for the Croqueta Framework. Scaffold applications, components, and services with ease.

Croqueta CLI is designed to streamline your development workflow by providing powerful scaffolding tools and automated file generation, ensuring your project follows best practices from day one.

NOTE

Croqueta CLI is a work in progress. The API is not stable and may change in future versions.

🚀 Quick Start

No installation required! Run it directly using npx:

npx @mimopo/croqueta-cli

📦 Installation

If you prefer to have it available locally in your project or globally:

Local (Recommended)

Add it as a development dependency:

npm install -D @mimopo/croqueta-cli

Then run it via npx:

npx croqueta

Global

npm install -g @mimopo/croqueta-cli

⚙️ Usage

Croqueta CLI provides a sleek interactive interface to guide you through code generation.

Commands

Generators

You can bypass the interactive prompts by passing the generator name and arguments directly:

# Example: Create a new application
croqueta example my-new-app

# Example: Create a component
croqueta component my-button

🤖 AI Interop

Unlock the power of AI agents with Croqueta CLI. It provides built-in support for generating agent skills, allowing your AI agents to interact seamlessly with the Croqueta ecosystem.

croqueta ai-agent-skills

This will generate the necessary skill definitions to make your AI agent a Croqueta expert.

📄 License

Croqueta CLI is open-source software licensed under the MIT License.

🙇 Special Thanks

This project is built on top of the amazing Plop project.