1.7.0 • Published 6 months ago

bikui v1.7.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

BikUI CLI (bikui)

npm version npm downloads License

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


1.7.0

6 months ago

1.6.0

6 months ago

1.5.0

6 months ago

1.4.0

6 months ago

1.3.0

6 months ago

1.2.0

6 months ago

1.1.0

6 months ago

1.0.0

6 months ago