Welcome to the rbest CLI tool! This software, currently at version 0.0.1, is designed to manage and run projects in a structured manner. Below you'll find installation steps, basic usage instructions, and detailed explanations for each command.
To use the rbest CLI, make sure it is installed and properly configured in your environment. For specific setup instructions, refer to your development environment's guidelines.
Run the following command to check if rbest is set up correctly:
rbest --version
This should output the current version of rbest and confirm it's working.
To start using rbest, simply run:
rbest <command> [options]
Below is a list of available commands for rbest, along with descriptions and usage examples.
Displays a help message with a list of commands and descriptions.
Usage:
rbest help
Output:
help : For this help message
new $name : To create a new roobi project.
(req: $project_name , $project_type)
(type: `help new` for more info)
run : Runs current project.
rm : Removes current project.
(req: ?$project_dir)
(needs to be in the same dir as `rbest.config.json`)
(type: `rm $project_dir` to delete a project dir)
Creates a new project in the current directory.
Usage:
rbest new <project_name> <project_type>
If <project_name> is not provided, you'll be prompted to enter one manually.
Example:
rbest new MyProject
Runs the current project. Ensure you're in the correct project directory for this command to work.
Usage:
rbest run
Removes an existing project directory. This command expects to find a configuration file named rbest.config.json in the same directory.
Usage:
rbest rm <project_dir>
If <project_dir> is not provided, the command will attempt to read from rbest.config.json.
Example:
rbest rm MyProjectDir
If a required file is missing, rbest will output an error message like this:
file `<filename>` not found!
If you enter an unrecognized command, rbest will display the following message:
no such command `<command>`, try typing `help`
Here's an example workflow using the rbest CLI:
-
Create a new project:
rbest new MyCoolProject WebApp -
Run the project:
rbest run -
Remove the project:
rbest rm MyCoolProject
This software is licensed under the Yuri-Is-On-Rage-Mode License (2024).