______  ___   _____ _____ _   _ 
| ___ \/ _ \ /  ___|_   _| \ | |
| |_/ / /_\ \\ '--.  | | |  \| |
| ___ \  _  | '--. \ | | | . ' |
| |_/ / | | |/\__/ /_| |_| |\  |
\____/\_| |_/\____/ \___/\_| \_/

Basin node

Development

Getting started

Clone the basin-node repo:

git@github.com:basin-dev/basin-node.git

Enter the src directory:

cd src

Command Line Interface (CLI)

Background

Cobra is used to build the CLI for the Basin Node app

Cobra-CLI generator is used to bootstrap application scaffolding for rapid development

Viper is used as a registry for all future application configuration needs as a 12 factor app

OpenAPI Generator is used to automatically generate server stubs and an API client for the node's HTTP interface.

Adding a new command

Use the Cobra-CLI generator to add a new command:

cobra-cli add [COMMAND_NAME]