bikui v1.7.0
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
- Copies the
bik-lib/
template to the current project directory. - Checks if required dependencies (
dayjs
,url-parse
, etc.) are already installed. - Installs only missing dependencies using
yarn add
. - 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