athul-cli
v0.0.18
Published
CLI tool for setting up WordPress projects locally using DDEV with AI error handling
Readme
athul-cli
CLI tool for setting up WordPress projects locally using DDEV with AI-powered error handling.
🚀 Features
- Automated System Checks: Automatically detects OS, Docker, and DDEV status.
- Project Validation: Ensures your project follows the required WordPress structure (
wp-content/themes/...). - Interactive Setup: Guided prompts for starting Docker if it's not running.
- Smart Error Handling: Uses Gemini AI to analyze and explain DDEV/Docker errors in plain English.
- Database Support: Easy database import from
.sql,.sql.gz, or.zipfiles. - Beautiful UI: Modern, colorful terminal interface with spinners and animations.
📋 Prerequisites
Before using this tool, ensure you have the following installed:
- Node.js (v18.0.0 or higher)
- Docker Desktop
- DDEV
🛠️ Installation
You can install the CLI globally:
npm install -g athul-cliOr run it directly using npx:
npx athul-cli initFor development usage:
- Clone the repository
- Install dependencies:
npm install - Build the project:
npm run build - Link the command globally:
npm link
📖 Usage
Navigate to your WordPress project directory (must contain wp-content/themes/) and run:
athul initThe CLI will:
- Check your system environment.
- Validate the project structure.
- Configure DDEV for WordPress.
- Attempt to import a database (optional).
- Launch the project.
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
📄 License
This project is licensed under the MIT License.
