bubblewand/embed/templates
2025-07-25 16:01:48 -04:00
..
cmd embeded templates 2025-07-25 16:01:48 -04:00
config embeded templates 2025-07-25 16:01:48 -04:00
internal/logger embeded templates 2025-07-25 16:01:48 -04:00
tui embeded templates 2025-07-25 16:01:48 -04:00
.envrc.tmpl embeded templates 2025-07-25 16:01:48 -04:00
flake.nix.tmpl embeded templates 2025-07-25 16:01:48 -04:00
go.mod.tmpl embeded templates 2025-07-25 16:01:48 -04:00
go.sum.tmpl embeded templates 2025-07-25 16:01:48 -04:00
justfile.tmpl embeded templates 2025-07-25 16:01:48 -04:00
main.go.tmpl embeded templates 2025-07-25 16:01:48 -04:00
README.md.tmpl embeded templates 2025-07-25 16:01:48 -04:00

# {{.PackageName}}

## TLDR;
{{.ProgramDesc}}


## Getting started

- make sure you have [nix](https://nixos.org/download/) and [direnv](https://direnv.net/) installed
- run `direnv allow`
- start coding in your desired editor

### Project structure
./
├── cmd
│   ├── root.go -> the entrypoint for your cli
│   └── version.go -> an example sub command
├── config
│   └── config.go -> viper configuration init
├── flake.nix -> project flake for packaging and devshell
├── go.mod -> go module config
├── go.sum
├── internal
│   └── logger
│       └── logger.go -> charmbracelet/log logger init
├── justfile -> rusty makefile used to ease development environment commands
├── main.go -> app entrypoint
├── README.md -> YOU ARE HERE.
└── tui
    ├── model.go -> bubbletea model data goes here
    ├── run.go -> tui entrypoint
    ├── update.go -> bubbletea model update functions go here
    └── view.go -> bubbletea view functions go here

### Generating sub-commands
use cobra-cli to generate sub-commands