@bitbybit-labs/bbb-cli
v1.5.1
Published
bitbybit internal tools to speed up DX
Downloads
39
Readme
bitbybit-cli
bitbybit internal tools to speed up DX
Environment Setup
Before using the @bitbybit-labs/bbb-cli
, it's essential to set up your development environment correctly. Follow these steps to ensure everything is ready:
1. Node.js Installation
Make sure you have Node.js installed on your system. You can download it from the official Node.js website.
To check if Node.js is installed, open your terminal and run:
node -v
2. NPM Installation
The @bitbybit-labs/bbb-cli is distributed via npm, which comes bundled with Node.js. To check if npm is installed, run:
To check if Node.js is installed, open your terminal and run:
npm -v
3. CLI Installation
Use the following command to install the project:
npm install -g @bitbybit-labs/bbb-cli
This installs the CLI and makes it accessible from the command line as:
bbb <command>
Development Setup
If you want to contribute to the @bitbybit-labs/bbb-cli or simply want to run it locally for development purposes, follow these steps:
1. Clone the Repository
First, clone the @bitbybit-labs/bbb-cli repository to your local machine using Git:
git clone https://github.com/bitbybit-labs/bbb-cli.git
2. Navigate to the Project Directory
Change your working directory to the project folder:
cd bbb-cli
3. Install Dependencies
Install the project dependencies using yarn:
yarn install
4. Link the CLI Globally
To make your local development version of the CLI accessible globally as bbb, run:
npm link
5. Connect the link to another directory you wish
In your target folder directory, run:
npm link @bitbybit-labs/bbb-cli
6. Start Development
Now, you can work on the CLI locally and test your changes by running bbb commands as if it were the global version.
Available Commands
Here are some of the available commands you can use with bbb:
- create-svc : Create a new microservice project using the provided project name and slug.
Issues and Contributions
If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository:
https://github.com/AsmaraKu/bitbybit-cli
We welcome contributions! Feel free to submit pull requests.
License
This project is licensed under the MIT License - see the LICENSE file for details.