https://github.com/boykaframework/boyka-cli

🧑🏻‍💻 Command line assistant for Boyka framework
https://github.com/boykaframework/boyka-cli

cli-app command-line-tool configuration-files typescript

Last synced: about 1 month ago
JSON representation

🧑🏻‍💻 Command line assistant for Boyka framework

• Host: GitHub
• URL: https://github.com/boykaframework/boyka-cli
• Owner: BoykaFramework
• License: mit
• Created: 2023-11-05T16:19:21.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-03T19:32:53.000Z (about 2 months ago)
• Last Synced: 2024-12-03T20:30:45.677Z (about 2 months ago)
• Topics: cli-app, command-line-tool, configuration-files, typescript
• Language: TypeScript
• Homepage: https://boykaframework.github.io/boyka-framework/
• Size: 1.02 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# boyka-cli

Command line assistant for Boyka framework

## Install

To install the assistant, run the following command on the terminal:

```shell

npm i -g @boykaframework/boyka-cli

```

## Commands

### `boyka doctor`

This command will check whether your machine setup for Boyka Framework is done properly or not.

If there is any problem in the setup, the assistant will accordingly suggest solution to fix the problem.

### `boyka init [name]`

This will create Maven project on your machine along with the config file for Boyka Framework.

This will also add sample tests for API, Web, Android and iOS applications.

### `boyka configure init --path /path/to/config`

This command will create a basic Boyka-framework config file named `boyka-config.json` at the specified path.

If the optional `--path` option is not provided, it will create the config at `src/test/resources` folder by default.

### `boyka configure api [name] --path /path/to/config`

This will add API configuration in the config file with the given name to the config block.

This will ask a set of questions to the user and depending on their answers, it will configure the API config.

If the default config path is not `src/test/resources`, then you can set the config path by using the optional param of `--path `.

### `boyka configure web [name] --path /path/to/config`

This will add Web configuration in the config file with the given name to the config block.

This will ask a set of questions to the user and depending on their answers, it will configure the Web config.

If the default config path is not `src/test/resources`, then you can set the config path by using the optional param of `--path `.

### `boyka configure android [name] --path /path/to/config`

This will add Mobile Android configuration in the config file with the given name to the config block.

This will ask a set of questions to the user and depending on their answers, it will configure the Mobile config.

If the default config path is not `src/test/resources`, then you can set the config path by using the optional param of `--path `.

### `boyka configure ios [name] --path /path/to/config`

This will add Mobile iOS configuration in the config file with the given name to the config block.

This will ask a set of questions to the user and depending on their answers, it will configure the Mobile config.

If the default config path is not `src/test/resources`, then you can set the config path by using the optional param of `--path `.