Skip to content
/ boa-cli Public

boa-cli is used to generate new boa projects from a yaml configuration file

License

Notifications You must be signed in to change notification settings

j2udev/boa-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Boa Generator

Build Status GoReportCard Go Reference

Boa generator is a simple tool for generating new CLI projects based on the Boa pkg. It is loosely inspired by the Cobra-CLI and heavily inspired by Bashly.

Disclaimer

This project should be considered unstable until it is officially released. Use at your own risk.

Building from source (for now)

Until this project is officially released, just build from source:

go build -o /somewhere/on/your/path/boa

Then you can use it anywhere.

Initialize

Much like the bashly init command, boa init is used to create a new boa configuration file in the current directory. This config file, boa.yml is in yaml by default, but can be changed to json or toml if desired. It has comments that explain the structure of an example CLI. Modify it as you see fit.

Generate

After defining your CLI in the boa.yml, just run boa generate -i and, assuming your boa.yml is valid, you should have a working CLI! Just add your business logic to the appropriate places under the internal package.

"Day 2 Operations"

Unlike the bashly CLI, the boa generator is not meant to be continuously used to generate overtop of your existing project (it can, but it doesn't come close to extending the entirety of the boa package). The boa package should be easy enough to continue building your project after the initial project generation. The boa generator is simply meant to help with getting started and quickly prototyping a new CLI project. It's expected and even encouraged to throw out your boa.yml/json/toml once you've outgrown its capabilities.

About

boa-cli is used to generate new boa projects from a yaml configuration file

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages