rob/octoplex
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore: improve CLI help message

Browse Source
This commit is contained in:
Rob Watson 2025-04-01 15:59:30 +02:00
parent d3a6d6acdb
commit 036366a875
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
main.go
View File

@ -1,6 +1,7 @@
package main package main
import ( import (
"cmp"
"context" "context"
"flag" "flag"
"fmt" "fmt"
@ -54,8 +55,7 @@ func run(ctx context.Context) error {
case "version": case "version":
return printVersion() return printVersion()
case "help", "-h", "--help": case "help", "-h", "--help":
// TODO: improve help message printUsage()
flag.Usage()
return nil return nil
} }
} }
@ -133,10 +133,22 @@ func printConfigPath(configPath string) error {
// printVersion prints the version of the application to stderr. // printVersion prints the version of the application to stderr.
func printVersion() error { func printVersion() error {
fmt.Fprintf(os.Stderr, "%s version %s\n", domain.AppName, "0.0.0") fmt.Fprintf(os.Stderr, "%s version %s\n", domain.AppName, cmp.Or(version, "0.0.0-dev"))
return nil return nil
} }
func printUsage() {
os.Stderr.WriteString("Usage: octoplex [command]\n\n")
os.Stderr.WriteString("Commands:\n\n")
os.Stderr.WriteString(" edit-config Edit the config file\n")
os.Stderr.WriteString(" print-config Print the path to the config file\n")
os.Stderr.WriteString(" version Print the version of the application\n")
os.Stderr.WriteString(" help Print this help message\n")
os.Stderr.WriteString("\n")
os.Stderr.WriteString("Additionally, Octoplex can be configured with the following environment variables:\n\n")
os.Stderr.WriteString(" OCTO_DEBUG Enables debug logging if set\n")
}
// buildLogger builds the logger, which may be a no-op logger. // buildLogger builds the logger, which may be a no-op logger.
func buildLogger(cfg config.LogFile) (*slog.Logger, error) { func buildLogger(cfg config.LogFile) (*slog.Logger, error) {
if !cfg.Enabled { if !cfg.Enabled {