https://github.com/rwxrob/conf
🌳 Go YAML/JSON Configuration, centralized management of configuration data for all the commands composed into your Bonzai tree
https://github.com/rwxrob/conf
bonzai configuration go golang json yaml
Last synced: over 1 year ago
JSON representation
🌳 Go YAML/JSON Configuration, centralized management of configuration data for all the commands composed into your Bonzai tree
- Host: GitHub
- URL: https://github.com/rwxrob/conf
- Owner: rwxrob
- License: apache-2.0
- Created: 2022-04-11T10:26:30.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-17T18:02:38.000Z (over 3 years ago)
- Last Synced: 2024-10-11T01:41:41.740Z (over 1 year ago)
- Topics: bonzai, configuration, go, golang, json, yaml
- Language: Go
- Homepage:
- Size: 113 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 🌳 Go YAML/JSON Configuration
Coding simple !go function to grab current !k8s context[](https://godoc.org/github.com/rwxrob/conf)
[](LICENSE)
This `conf` Bonzai branch is for safely managing any configuration as
single, local YAML/JSON using industry standards for local configuration
and system-safe writes. Use it to add a `conf` subcommand to any other
Bonzai command, or to your root Bonzai tree (`z`). All commands that use
`conf` that are composed into a single binary, no matter where in the
tree, will use the same local conf file even though the position
within the file will be qualified by the tree location.
By default, importing `conf` will assigned a new implementation of
`bonzai.Configurer` to `Z.Conf` (satisfying any `Z.Cmd` requirement for
configuration) and will use the name of the binary (`Z.ExeName`) as the
directory name within `os.UserConfDir` with a `config.yaml` file name.
To override this behavior, create a new `pkd/conf.Conf` struct assign
`Id`, `Dir` and `File`, and then assign that to `Z.Conf`.
## Install
This command can be installed as a standalone program (for combined use
with shell scripts perhaps) or composed into a Bonzai command tree.
Standalone
```
go install github.com/rwxrob/conf/cmd/conf@latest
```
Composed
```go
package z
import (
Z "github.com/rwxrob/bonzai/z"
"github.com/rwxrob/conf"
)
var Cmd = &bonzai.Cmd{
Name: `z`,
Commands: []*Z.Cmd{help.Cmd, conf.Cmd},
}
```
Note conf is designed to be composed only in monolith mode (not
multicall binary).
## Tab Completion
To activate bash completion just use the `complete -C` option from your
`.bashrc` or command line. There is no messy sourcing required. All the
completion is done by the program itself.
```
complete -C conf conf
```
If you don't have bash or tab completion check use the shortcut
commands instead.
## Embedded Documentation
All documentation (like manual pages) has been embedded into the source
code of the application. See the source or run the program with help to
access it.