BikUI CLI (bikui)

BikUI CLI (bikui) is a command-line tool designed to streamline the setup process for BikUI projects. It automates project initialization, ensures essential dependencies are installed, and optimizes the development workflow.

🚀 Key Features

• ✅ Quick Project Setup – Instantly creates the bik-lib/ folder with preconfigured files.
• ✅ Dependency Management – Automatically checks and installs missing dependencies.
• ✅ Optimized for Yarn – Uses yarn for fast and efficient package installation.
• ✅ Seamless Integration – Works with existing projects without altering configurations.

📦 Installation & Usage

Using npx (Recommended)

You can run the CLI without installing it globally:

npx bikui init

Global Installation

Alternatively, you can install it globally:

npm install -g bikui

Then run:

bikui init

🛠 How It Works

1. Copies the bik-lib/ template to the current project directory.
2. Checks if required dependencies (dayjs, url-parse, etc.) are already installed.
3. Installs only missing dependencies using yarn add.
4. Ensures a smooth project initialization without redundant installations.

📌 Example Output

$ npx bikui init
🚀 Copying template files to: /your-project/bik-lib...
✅ BikUI setup completed!
✅ All required dependencies are already installed.

or, if dependencies are missing:

$ npx bikui init
🚀 Copying template files to: /your-project/bik-lib...
✅ BikUI setup completed!
📦 Installing missing dependencies: dayjs, url-parse...
✅ Dependencies installed successfully!

⚡ Required Dependencies

By default, bikui ensures that the following dependencies are installed:

• dayjs
• url-parse

If they are missing, the CLI will automatically install them.

💡 Troubleshooting

1️⃣ Command Not Found

If bikui is not recognized, install it globally:

npm install -g bikui

Or use npx:

npx bikui init

2️⃣ Dependencies Not Installing

Ensure yarn is installed:

yarn --version

If not, install it:

npm install -g yarn

3️⃣ Files Not Copying

Ensure bikui is installed correctly and has access to the bik-lib folder.

📜 License

This project is licensed under the MIT License.

📞 Support & Contact

For any issues, feature requests, or contributions, please visit:

🔗 Website: bikiran.com
🐞 Report Issues: GitHub Issues