cli

README

badaas-cli

badaas-cli is the command line tool that makes it possible to configure and run a badaas application.

• Install with go install
• Build from sources
• Commands
  • badaas-cli gen docker
  • badaas-cli gen conditions
• Contributing
• License

Install with go install

For simply installing it, use:

go install github.com/ditrit/badaas-cli

Or you can build it from sources.

Build from sources

Get the sources of the project, either by visiting the releases page and downloading an archive or clone the main branch (please be aware that is it not a stable version).

To build the project:

• Install go v1.18

• Install project dependencies

  go get
  

• Run build command

  go build .
  

Well done, you have a binary badaas-cli at the root of the project.

Commands

You can see the available commands by running:

badaas-cli help

For more information about the functionality provided and how to use each command use:

badaas-cli help [command]

badaas-cli gen docker

gen docker is the command you can use to generate the files and configurations necessary for your project to use badaas in a simple way.

gen docker will generate the docker and configuration files needed to run the application in the badaas/docker and badaas/config folders respectively.

All these files can be modified in case you need different values than those provided by default. For more information about the configuration head to configuration docs.

A Makefile will be generated for the execution of a badaas server, with the command:

make badaas_run

badaas-cli gen conditions

gen conditions is the command you can use to generate conditions to query your objects using badaas-orm. For each BaDaaS Model found in the input packages a file containing all possible Conditions on that object will be generated, allowing you to use badaas-orm.

Its use is recommended through go generate. To see an example of how to do it click here.

Contributing

See this section.

License

badaas-cli is Licensed under the Mozilla Public License Version 2.0.