Bq tool documentation


1. What is bq?

bq is a command line interactive tool that allows creating and managing Bootique projects.

2. Installation

2.1. MacOS

bq available via Homebrew package manager. All you need in order to install bq on MacOS 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/
  • run:

    yum install bq

2.2.2. Ubuntu

Installation process is similar to 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
  • Install:

    apt-get update
    apt-get install bq

2.3. Windows

Windows binary will be distributed with Chocolatey package manager, but this is not implemented yet. For now, you could download nupkg directly from Bintray. Use following command to install this package directly:

choco install bq.portable.{VERSION}.nupkg

3. Usage

Running BQ in an interactive mode:

$ bq

If everything setup correctly you should see welcome banner with some general information about the tool. To see all available commands you could use help command.

To exit from the bq shell run exit.

3.1. Maven

Maven toolchain is set by default.

  1. new multimodule project:

    new parent io.bootique.test:test:1.0
  2. new runnable app:

    new app io.bootique.test:test-app:1.0
  3. new module:

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

3.2. Gradle

To use Gradle as your build tool you need to set it in bq config:

config toolchain gradle

Available commands are same as in Maven case.