https://github.com/hujun-open/shouchan
a Golang module does simple configuration managment, support commandline and YAML file
https://github.com/hujun-open/shouchan
command-line configuration golang yaml
Last synced: 5 months ago
JSON representation
a Golang module does simple configuration managment, support commandline and YAML file
- Host: GitHub
- URL: https://github.com/hujun-open/shouchan
- Owner: hujun-open
- License: apache-2.0
- Created: 2023-06-02T21:30:45.000Z (about 3 years ago)
- Default Branch: v2
- Last Pushed: 2025-01-31T23:48:31.000Z (over 1 year ago)
- Last Synced: 2025-02-01T00:25:08.105Z (over 1 year ago)
- Topics: command-line, configuration, golang, yaml
- Language: Go
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/hujun-open/shouchan/actions/workflows/main.yml)
[](https://pkg.go.dev/github.com/hujun-open/shouchan/v2)
## Overview
Package shouchan provides simple configuration management for Golang application, with following features:
- read configuration from command line flag and/or YAML file, mix&match, into a struct
- 3 sources: default value, YAML file and flag
- priority:in case of multiple source returns same config struct field, the preference is flag over YAML over default value
include support following field types:
- integer types
- float type
- string
- time.Duration
- and all types that implement `encoding.TextMarshaler` and `encoding.TextUnmarshaler` interface
- there is also `github.com/hujun-open/shouchantypes` include some other types
Additional types could be supported by using `Register`, see [github.com/hujun-open/shouchantypes](https://github.com/hujun-open/shouchantypes) for example.
## curent release is `github.com/hujun-open/shouchan/v2`
## CLI & YAML Support
- YAML: shouchan uses [extyaml](https://pkg.go.dev/github.com/hujun-open/extyaml) for YAML marshal and unmarshal
- CLI Flag: shouchan uses [myflags](https://pkg.go.dev/github.com/hujun-open/myflags) for command line flag generation
refer to corresponding doc for details on CLI & YAML support.
## Example:
https://github.com/hujun-open/shouchan/blob/6d6eda8b423d48cd7461804b4beb5c7693b6c3ba/example/main.go#L1-L63
Output:
- Usage
```
.\test.exe --help
shouchan example
Usage:
example [flags]
Flags:
--addr string employee address (default "defAddrPointer")
--cfgfromfile string config file path (default "test.yaml")
--employer-name string company name (default "defCom")
-h, --help help for example
--ipaddr net.IP employee IP address (default 1.2.3.4)
--jointtime time.Time employee join time (default 2023-01-02 13:22:33)
--mac net.HardwareAddr employee MAC address (default 11:22:33:44:55:66)
--n2addr (default 1.1.1.1)
--naddr (default 2.2.2.2)
--name string employee name (default "defName")
--r retired
--subnet net.IPNet employee IP subnet (default 192.168.1.0/24)
ferr failed to open config file test.yaml, open test.yaml: The system cannot find the file specified.,aerr
final result is &{Name:defName Addr:0xc000028ee0 Naddr:2.2.2.2 N2addr:1.1.1.1 IPAddr:1.2.3.4 Subnet:{IP:192.168.1.0 Mask:ffffff00} MAC:11:22:33:44:55:66 JointTime:2023-01-02 13:22:33 +0000 UTC IsRetired:false Employer:{Name:defCom}}
```
- no command line args, no config file, default is used
```
.\test.exe
ferr failed to open config file test.yaml, open test.yaml: The system cannot find the file specified.,aerr
final result is &{Name:defName Addr:0xc0000528b0 Naddr:2.2.2.2 N2addr:1.1.1.1 IPAddr:1.2.3.4 Subnet:{IP:192.168.1.0 Mask:ffffff00} MAC:11:22:33:44:55:66 JointTime:2023-01-02 13:22:33 +0000 UTC Employer:{Name:defCom}}
```
- config file via "-f" command args, value from file take procedence
```
.\test.exe --cfgfromfile cfg.yaml
ferr ,aerr
final result is &{Name:nameFromFile Addr:0xc0000528b0 Naddr:2.2.2.2 N2addr:1.1.1.1 IPAddr:1.2.3.4 Subnet:{IP:192.168.1.0 Mask:ffffff00} MAC:11:22:33:44:55:66 JointTime:2023-01-02 13:22:33 +0000 UTC Employer:{Name:comFromFile}}
```
- mix command line args and config file, args to override employee name:
```
.\test.exe --cfgfromfile cfg.yaml --name nameFromArg
ferr ,aerr
final result is &{Name:nameFromArg Addr:0xc000088880 Naddr:2.2.2.2 N2addr:1.1.1.1 IPAddr:1.2.3.4 Subnet:{IP:192.168.1.0 Mask:ffffff00} MAC:11:22:33:44:55:66 JointTime:2023-01-02 13:22:33 +0000 UTC Employer:{Name:comFromFile}}
```
- mix command line args and config file, args to override company name:
```
.\test.exe --cfgfromfile cfg.yaml --employer-name comFromArg
ferr ,aerr
final result is &{Name:nameFromFile Addr:0xc000104880 Naddr:2.2.2.2 N2addr:1.1.1.1 IPAddr:1.2.3.4 Subnet:{IP:192.168.1.0 Mask:ffffff00} MAC:11:22:33:44:55:66 JointTime:2023-01-02 13:22:33 +0000 UTC Employer:{Name:comFromArg}}
```
## Code Generation
shouchan also provides a code generation tool to deal with large amount of constants, see [shouchangen](https://github.com/hujun-open/shouchangen).