https://github.com/netodevel/quarkus-cli
The command line interface for https://code.quarkus.io
https://github.com/netodevel/quarkus-cli
Last synced: 9 months ago
JSON representation
The command line interface for https://code.quarkus.io
- Host: GitHub
- URL: https://github.com/netodevel/quarkus-cli
- Owner: netodevel
- Created: 2019-10-31T11:13:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-01T07:23:16.000Z (over 6 years ago)
- Last Synced: 2025-03-24T20:38:17.907Z (over 1 year ago)
- Language: JavaScript
- Size: 66.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# quarkus-cli
`quarkus-cli` is an unoffical command line interface for `https://code.quarkus.io`. You can use this CLI tool to generate a new [`Quarkus`](https://quarkus.io) project without the usage of the browser.
# Installation
The CLI is written on NodeJs - at least NodeJs v8 is required.
1. Install test runner you can use either of the following options.
- npm: `npm install -g https://github.com/machi1990/quarkus-cli`
- yarn: `yarn global add https://github.com/machi1990/quarkus-cli`
To see if the installation is successfully, run `quarkus -h` which should output the usage information.
# How to use
## create a new project
- To create a new quarkus project you can either use one of the two commands. If the `` is not provided, the project is created on current directory.
- `create `
- `init `
The two commands accept a list of options. Run `quarkus-cli init --help` to see available options.
## configuration
- To generate a configuration property file use `quarkus-cli config generate -f `
- To view the current configuration file use `quarkus-cli config view`
Type `quarkus-cli config -h` for more help
## dev / remote-dev mode
- To run the current project in dev mode use `quarkus-cli dev`
- To run the current project in remote dev mode use `quarkus-cli remote-dev`
# TODO
- [ ] Add gradle support.
- [ ] Add the ability to customize build tool
- [ ] Support of additional commands like `add-extension`, `list-extensions`, `build`, `test`
# Author
Manyanda Chitimbo