cli interface refactor

Author: crimist

README.md

@@ -5,6 +5,7 @@ Performance focused BitTorrent tracker supporting HTTP, UDP, IPv4 and IPv6.
 - [Trakx](#trakx)
   - [❤️‍🔥 Instances](#️-instances)
   - [🚀 Install](#-install)
+  - [🧰 CLI](#-cli)
   - [🔧 Configuration](#-configuration)
     - [Configuration file](#configuration-file)
     - [Database backups](#database-backups)
@@ -13,7 +14,6 @@ Performance focused BitTorrent tracker supporting HTTP, UDP, IPv4 and IPv6.
     - [Netdata setup](#netdata-setup)
     - [Build Customization](#build-customization)
       - [**Performance**](#performance)
-      - [**App engines**](#app-engines)
   - [📈 Performance](#-performance)
 
 ## ❤️‍🔥 Instances
@@ -35,22 +35,37 @@ Go 1.21+ required.
 git clone https://github.com/crimist/trakx && cd trakx
 
 # install to go bin
-go install .
+go install ./cli
 trakx status # generates configuration
 
 # or build
-go build .
+go build -o trakx ./cli
 ./trakx status # generates configuration
 ```
 
 See [configuration](#configuration) and [netdata setup](#netdata-setup).
 
+## 🧰 CLI
+
+Common commands:
+
+```sh
+trakx run           # foreground
+trakx start         # background
+trakx stop          # stop daemon
+trakx restart       # restart daemon
+trakx status        # status check
+trakx logs -f       # follow latest log file
+trakx pid show      # inspect pid file
+trakx config path   # show config path
+```
+
 ## 🔧 Configuration
 
 ### Configuration file
 
 The configuration file can be found at `~/.config/trakx/trakx.yaml`.
-You'll have to run the trakx controller at least once to generate this file.
+You'll have to run trakx at least once (for example `trakx status`) to generate this file.
 
 Config settings can be overwritten with environment variables:
 
@@ -73,18 +88,19 @@ Trakx attempts to load the config file from the following directories in order:
 ### Database backups
 
 Trakx persists the in-memory database to a binary snapshot at `db.backup.path`.
-`backup-export` requests a fresh snapshot from the running daemon when available,
+`backup export` requests a fresh snapshot from the running daemon when available,
 and otherwise streams the on-disk backup file.
+`backup import` validates snapshots before replacing the on-disk backup.
 You can stream the snapshot bytes to external storage using:
 
 ```sh
-trakx backup-export > trakx.snapshot
-cat trakx.snapshot | trakx backup-import
+trakx backup export > trakx.snapshot
+cat trakx.snapshot | trakx backup import
 ```
 
 ### Default configuration & webserver files
 
-You can modify the default configuration and files served by the webserver in the `tracker/config/embeded/` folder.
+You can modify the default configuration and files served by the webserver in the `config/embedded/` folder.
 
 **NOTE:** Trakx webserver will only serve files at their full path. `dmca` will 404, `dmca.html` will 200.
 
@@ -114,12 +130,6 @@ Trakx takes advantage of Go's build tags to target different use cases.
 
 The `fast` tag will build Trakx without IP, seed, and leech metrics which will reduce cpu and memory usage.
 
-#### **App engines**
-
-The `heroku` tag will build trakx for app engines. This means the executable will immediately run the tracker rather than provide the daemon controller behavior included in the regular CLI build.
-
-Feel free to customize the tags to suit whichever app engine you prefer in [engine_entry.go](./engine_entry.go).
-
 ## 📈 Performance
 
 The following metrics were collected on Heroku free tier running an HTTP tracker with the `fast` tag disabled.

cli/cmd_backup.go

@@ -0,0 +1,98 @@
+package main
+
+import (
+	"fmt"
+	"io"
+	"os"
+
+	"github.com/crimist/trakx/cmd"
+)
+
+func newBackupRootCommand() *Command {
+	cmd := &Command{
+		Name:  "backup",
+		Short: "Manage DB backups",
+		Usage: "trakx backup <subcommand>",
+	}
+	cmd.Add(exportSubcommand())
+	cmd.Add(importSubcommand())
+	return cmd
+}
+
+func exportSubcommand() *Command {
+	flags, help := newFlagSet("backup export")
+	outPath := flags.String("out", "", "Write backup to file (default: stdout)")
+
+	cmd := &Command{
+		Name:     "export",
+		Short:    "Stream DB backup",
+		Usage:    "trakx backup export [--out <file>]",
+		Flags:    flags,
+		HelpFlag: help,
+		Run: func(ctx *Context, args []string) error {
+			conf, err := ctx.LoadConfig()
+			if err != nil {
+				return err
+			}
+
+			var out io.Writer = ctx.Stdout
+			var file *os.File
+			if *outPath != "" {
+				file, err = os.Create(*outPath)
+				if err != nil {
+					return err
+				}
+				defer file.Close()
+				out = file
+			}
+
+			if err := cmd.ExportBackup(conf, out); err != nil {
+				return err
+			}
+			if *outPath != "" {
+				fmt.Fprintln(ctx.Stdout, "backup exported")
+			}
+			return nil
+		},
+	}
+	return cmd
+}
+
+func importSubcommand() *Command {
+	flags, help := newFlagSet("backup import")
+	inPath := flags.String("in", "", "Read backup from file (default: stdin)")
+
+	cmd := &Command{
+		Name:     "import",
+		Short:    "Load DB backup",
+		Usage:    "trakx backup import [--in <file>]",
+		Flags:    flags,
+		HelpFlag: help,
+		Run: func(ctx *Context, args []string) error {
+			conf, err := ctx.LoadConfig()
+			if err != nil {
+				return err
+			}
+
+			var in io.Reader = os.Stdin
+			var file *os.File
+			if *inPath != "" {
+				file, err = os.Open(*inPath)
+				if err != nil {
+					return err
+				}
+				defer file.Close()
+				in = file
+			}
+
+			if err := cmd.ImportBackup(conf, in); err != nil {
+				return err
+			}
+			if *inPath != "" {
+				fmt.Fprintln(ctx.Stdout, "backup imported")
+			}
+			return nil
+		},
+	}
+	return cmd
+}

cli/cmd_config.go

@@ -0,0 +1,73 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/crimist/trakx/config"
+)
+
+func newConfigCommand() *Command {
+	cmd := &Command{
+		Name:  "config",
+		Short: "Manage configuration",
+		Usage: "trakx config <subcommand>",
+	}
+	cmd.Add(newConfigDumpCommand())
+	cmd.Add(newConfigPathCommand())
+	cmd.Add(newConfigValidateCommand())
+	return cmd
+}
+
+func newConfigDumpCommand() *Command {
+	flags, help := newFlagSet("config dump")
+	cmd := &Command{
+		Name:     "dump",
+		Short:    "Print default config",
+		Usage:    "trakx config dump",
+		Flags:    flags,
+		HelpFlag: help,
+		Run: func(ctx *Context, args []string) error {
+			return config.DumpDefaultConfig()
+		},
+	}
+	return cmd
+}
+
+func newConfigPathCommand() *Command {
+	flags, help := newFlagSet("config path")
+	cmd := &Command{
+		Name:     "path",
+		Short:    "Print resolved config path",
+		Usage:    "trakx config path",
+		Flags:    flags,
+		HelpFlag: help,
+		Run: func(ctx *Context, args []string) error {
+			path, err := ctx.ResolvedConfigPath()
+			if err != nil {
+				return err
+			}
+			fmt.Fprintln(ctx.Stdout, path)
+			return nil
+		},
+	}
+	return cmd
+}
+
+func newConfigValidateCommand() *Command {
+	flags, help := newFlagSet("config validate")
+	cmd := &Command{
+		Name:     "validate",
+		Short:    "Validate config",
+		Usage:    "trakx config validate",
+		Flags:    flags,
+		HelpFlag: help,
+		Run: func(ctx *Context, args []string) error {
+			if _, err := ctx.LoadConfig(); err != nil {
+				return err
+			}
+			fmt.Fprintln(ctx.Stdout, "ok")
+			return nil
+		},
+	}
+	return cmd
+}

cli/cmd_help.go

@@ -0,0 +1,28 @@
+package main
+
+import "fmt"
+
+func newHelpCommand(root *Command) *Command {
+	flags, help := newFlagSet("help")
+	cmd := &Command{
+		Name:     "help",
+		Short:    "Help about any command",
+		Usage:    "trakx help [command]",
+		Flags:    flags,
+		HelpFlag: help,
+		Run: func(ctx *Context, args []string) error {
+			if len(args) == 0 {
+				root.PrintHelp(ctx)
+				return nil
+			}
+
+			if target, ok := root.FindPath(args); ok {
+				target.PrintHelp(ctx)
+				return nil
+			}
+
+			return fmt.Errorf("unknown command: %s", args[0])
+		},
+	}
+	return cmd
+}