Bq tool documentation


1. What is bq?

bq is an interactive tool to create and manage Bootique projects.

2. Installation

2.1. Mac

All you need to install bq on Mac is to run:

brew install bootique-tools/repo/bq

2.2. Linux

2.2.1. CentOS

To install bq on CentOS you need to add bintray repo to your yum sources:

wget https://bintray.com/bootique/bq-rpm/rpm -O bintray-bootique-bq-rpm.repo
sudo mv bintray-bootique-bq-rpm.repo /etc/yum.repos.d/

And then run:

yum install bq

2.2.2. Ubuntu

Installation algorithm is similar to installation on CentOS. Add bintray repo to apt sources:

echo "deb [trusted=yes] https://dl.bintray.com/bootique/bq-deb vivid main" | sudo tee -a /etc/apt/sources.list

And then install:

apt-get update
apt-get install bq

2.3. Windows

Chocolatey is require to be installed on your PC. Then run:

choco install bq

3. How to use

Bq tool generates Bootique project or module.

Run bq:

bq

After it user is getting to bq command line.

Command to show help:

help

Command to exit:

exit

User can create configuration. This configuration will be saved and can be reused in next sessions.

Command to show configs:

config

Set group-id:

config group-id io.bootique.test

Set Bootique version to use:

config bq-version 1.0

Set default toolchain to use. Can be either Maven or Gradle:

config toolchain maven

3.1. Maven

To create new Maven project:

new maven app io.bootique.test:bq-test:1.0

or in a short way:

new m a io.bootique.test:bq-test:1.0

To create Maven module:

new maven module io.bootique.test:bq-test:1.0

or in a short way:

new m m io.bootique.test:bq-test:1.0

3.2. Gradle

To create new Gradle project:

new gradle app io.bootique.test:bq-test:1.0

or in a short way:

new g a io.bootique.test:bq-test:1.0

To create Gradle module:

new gradle module io.bootique.test:bq-test:1.0

or in a short way:

new g m io.bootique.test:bq-test:1.0