mirror of
https://github.com/sbrow/envr.git
synced 2026-06-27 10:38:33 -04:00
refactor(odin): Added proper help text to all commands.
This commit is contained in:
181
cli.odin
181
cli.odin
@@ -12,27 +12,29 @@ Command :: struct {
|
||||
}
|
||||
|
||||
CommandInfo :: struct {
|
||||
name: string,
|
||||
usage: string,
|
||||
short: string,
|
||||
long: string,
|
||||
name: string,
|
||||
usage: string,
|
||||
short: string,
|
||||
long: string,
|
||||
aliases: []string,
|
||||
}
|
||||
|
||||
COMMANDS := []CommandInfo{
|
||||
{"init", "envr init", "Set up envr",
|
||||
"The init command generates your initial config and saves it to\n~/.envr/config in JSON format.\n\nDuring setup, you will be prompted to select one or more ssh keys with which to\nencrypt your databse. **Make 100% sure** that you have **a remote copy** of this\nkey somewhere, otherwise your data could be lost forever."},
|
||||
{"scan", "envr scan", "Find and select .env files for backup", ""},
|
||||
{"sync", "envr sync", "Update or restore your env backups", ""},
|
||||
{"backup", "envr backup <path>", "Import a .env file into envr", ""},
|
||||
{"add", "envr add <path>", "Import a .env file into envr", ""},
|
||||
{"restore", "envr restore <path>", "Restore a .env file from the database", ""},
|
||||
{"list", "envr list", "View your tracked files", ""},
|
||||
{"remove", "envr remove <path>", "Remove a .env file from your database", ""},
|
||||
{"check", "envr check [path]", "Check if files are backed up", ""},
|
||||
"The init command generates your initial config and saves it to\n~/.envr/config in JSON format.\n\nDuring setup, you will be prompted to select one or more ssh keys with which to\nencrypt your databse. **Make 100% sure** that you have **a remote copy** of this\nkey somewhere, otherwise your data could be lost forever.",
|
||||
{}},
|
||||
{"scan", "envr scan", "Find and select .env files for backup", "", {}},
|
||||
{"sync", "envr sync", "Update or restore your env backups", "", {}},
|
||||
{"backup", "envr backup <path>", "Import a .env file into envr", "", {"add"}},
|
||||
{"restore", "envr restore <path>", "Restore a .env file from the database", "", {}},
|
||||
{"list", "envr list", "View your tracked files", "", {}},
|
||||
{"remove", "envr remove <path>", "Remove a .env file from your database", "", {}},
|
||||
{"check", "envr check [path]", "Check if files are backed up", "", {}},
|
||||
{"deps", "envr deps", "Check for missing binaries",
|
||||
"envr relies on external binaries for certain functionality.\n\nThe check command reports on which binaries are available and which are not."},
|
||||
{"version", "envr version", "Show envr's version", ""},
|
||||
{"edit-config", "envr edit-config", "Edit your config with your default editor", ""},
|
||||
"envr relies on external binaries for certain functionality.\n\nThe check command reports on which binaries are available and which are not.",
|
||||
{}},
|
||||
{"version", "envr version", "Show envr's version", "", {}},
|
||||
{"edit-config", "envr edit-config", "Edit your config with your default editor", "", {}},
|
||||
}
|
||||
|
||||
parse_args :: proc() -> (cmd: Command, ok: bool) {
|
||||
@@ -102,60 +104,123 @@ find_command :: proc(name: string) -> (CommandInfo, bool) {
|
||||
if c.name == name {
|
||||
return c, true
|
||||
}
|
||||
for a in c.aliases {
|
||||
if a == name {
|
||||
return c, true
|
||||
}
|
||||
}
|
||||
}
|
||||
return CommandInfo{}, false
|
||||
}
|
||||
|
||||
print_command_help :: proc(name: string) {
|
||||
command_help_text :: proc(name: string) -> (string, bool) {
|
||||
info, found := find_command(name)
|
||||
if !found {
|
||||
return "", false
|
||||
}
|
||||
|
||||
b: strings.Builder
|
||||
strings.builder_init(&b)
|
||||
|
||||
fmt.sbprintf(&b, "Usage: %s [flags]\n\n", info.usage)
|
||||
fmt.sbprintf(&b, "%s\n", info.short)
|
||||
|
||||
if len(info.aliases) > 0 {
|
||||
fmt.sbprintf(&b, "\nAliases:\n %s", info.name)
|
||||
for a in info.aliases {
|
||||
fmt.sbprintf(&b, ", %s", a)
|
||||
}
|
||||
fmt.sbprintf(&b, "\n")
|
||||
}
|
||||
|
||||
if len(info.long) > 0 {
|
||||
fmt.sbprintf(&b, "\n%s\n", info.long)
|
||||
}
|
||||
|
||||
fmt.sbprintf(&b, "\nFlags:\n -h, --help help for %s\n", info.name)
|
||||
|
||||
s := strings.clone(strings.to_string(b))
|
||||
strings.builder_destroy(&b)
|
||||
return s, true
|
||||
}
|
||||
|
||||
print_command_help :: proc(name: string) {
|
||||
text, ok := command_help_text(name)
|
||||
if !ok {
|
||||
fmt.printf("Unknown command: %s\n", name)
|
||||
print_usage()
|
||||
return
|
||||
}
|
||||
fmt.printf("Usage: %s\n\n%s\n", info.usage, info.short)
|
||||
if len(info.long) > 0 {
|
||||
fmt.printf("\n%s\n", info.long)
|
||||
fmt.println(text)
|
||||
}
|
||||
|
||||
usage_text :: proc() -> string {
|
||||
b: strings.Builder
|
||||
strings.builder_init(&b)
|
||||
|
||||
fmt.sbprintf(&b, "envr keeps your .env synced to a local, age encrypted database.\n")
|
||||
fmt.sbprintf(&b, "Is a safe and easy way to gather all your .env files in one place where they can\n")
|
||||
fmt.sbprintf(&b, "easily be backed by another tool such as restic or git.\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "All your data is stored in ~/data.age\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "Getting started is easy:\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "1. Create your configuration file and set up encrypted storage:\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "> envr init\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "2. Scan for existing .env files:\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "> envr scan\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "Select the files you want to back up from the interactive list.\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "3. Verify that it worked:\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "> envr list\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "4. After changing any of your .env files, update the backup with:\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "> envr sync\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "5. If you lose a repository, after re-cloning the repo into the same path it was\n")
|
||||
fmt.sbprintf(&b, "at before, restore your backup with:\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "> envr restore ~/<path to repository>/.env\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "Usage:\n")
|
||||
fmt.sbprintf(&b, " envr [command]\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "Available Commands:\n")
|
||||
|
||||
for c in COMMANDS {
|
||||
name_start := len(b.buf)
|
||||
fmt.sbprintf(&b, "%s", c.name)
|
||||
for a in c.aliases {
|
||||
fmt.sbprintf(&b, ", %s", a)
|
||||
}
|
||||
name_len := len(b.buf) - name_start
|
||||
padding := 20 - name_len
|
||||
if padding > 0 {
|
||||
for _ in 0..<padding {
|
||||
strings.write_byte(&b, ' ')
|
||||
}
|
||||
}
|
||||
fmt.sbprintf(&b, " %s\n", c.short)
|
||||
}
|
||||
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "Flags:\n")
|
||||
fmt.sbprintf(&b, " -h, --help help for envr\n")
|
||||
fmt.sbprintf(&b, "\n")
|
||||
fmt.sbprintf(&b, "Use \"envr [command] --help\" for more information about a command.\n")
|
||||
|
||||
s := strings.clone(strings.to_string(b))
|
||||
strings.builder_destroy(&b)
|
||||
return s
|
||||
}
|
||||
|
||||
print_usage :: proc() {
|
||||
fmt.println("envr - Manage your .env files.")
|
||||
fmt.println("")
|
||||
fmt.println("envr keeps your .env synced to a local, age encrypted database.")
|
||||
fmt.println("Is a safe and easy way to gather all your .env files in one place where they can")
|
||||
fmt.println("easily be backed by another tool such as restic or git.")
|
||||
fmt.println("")
|
||||
fmt.println("All your data is stored in ~/data.age")
|
||||
fmt.println("")
|
||||
fmt.println("Getting started is easy:")
|
||||
fmt.println("")
|
||||
fmt.println("1. Create your configuration file and set up encrypted storage:")
|
||||
fmt.println("")
|
||||
fmt.println("> envr init")
|
||||
fmt.println("")
|
||||
fmt.println("2. Scan for existing .env files:")
|
||||
fmt.println("")
|
||||
fmt.println("> envr scan")
|
||||
fmt.println("")
|
||||
fmt.println("Select the files you want to back up from the interactive list.")
|
||||
fmt.println("")
|
||||
fmt.println("3. Verify that it worked:")
|
||||
fmt.println("")
|
||||
fmt.println("> envr list")
|
||||
fmt.println("")
|
||||
fmt.println("Usage: envr <command> [args]")
|
||||
fmt.println("")
|
||||
fmt.println("Commands:")
|
||||
fmt.println(" init Set up envr")
|
||||
fmt.println(" scan Find and select .env files for backup")
|
||||
fmt.println(" sync Update or restore your env backups")
|
||||
fmt.println(" backup <path> Import a .env file into envr")
|
||||
fmt.println(" restore <path> Restore a .env file from the database")
|
||||
fmt.println(" list View your tracked files")
|
||||
fmt.println(" remove <path> Remove a .env file from your database")
|
||||
fmt.println(" check [path] Check if files are backed up")
|
||||
fmt.println(" deps Check for missing binaries")
|
||||
fmt.println(" version Show envr's version")
|
||||
fmt.println(" edit-config Edit your config with your default editor")
|
||||
fmt.print(usage_text())
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user