Compare commits

...

4 Commits

Author SHA1 Message Date
173b2ce035 chore: Bump version to 4.2.12
Some checks failed
CI/CD / Integration Tests (push) Has been skipped
CI/CD / Test (push) Failing after 1m15s
CI/CD / Lint (push) Failing after 1m6s
CI/CD / Build & Release (push) Has been skipped
2026-01-30 18:44:10 +01:00
efe9457aa4 feat: Add man page generation (#14)
- NEW: man command generates Unix manual pages
- Generates 121+ man pages for all commands
- Standard groff format for man(1)
- Gracefully handles flag shorthand conflicts
- Installation instructions included

Usage:
  dbbackup man --output ./man
  sudo cp ./man/*.1 /usr/local/share/man/man1/
  sudo mandb
  man dbbackup

DBA World Meeting Feature: Professional documentation
2026-01-30 18:43:38 +01:00
e2284f295a chore: Bump version to 4.2.11
Some checks failed
CI/CD / Integration Tests (push) Has been skipped
CI/CD / Test (push) Failing after 1m16s
CI/CD / Lint (push) Failing after 1m7s
CI/CD / Build & Release (push) Has been skipped
2026-01-30 18:36:49 +01:00
9e3270dc10 feat: Add shell completion support (#13)
- NEW: completion command for bash/zsh/fish/PowerShell
- Tab-completion for all commands, subcommands, and flags
- Uses Cobra bash completion V2 with __complete
- DisableFlagParsing to avoid shorthand conflicts
- Installation instructions for all shells

Usage:
  dbbackup completion bash > ~/.dbbackup-completion.bash
  dbbackup completion zsh > ~/.dbbackup-completion.zsh
  dbbackup completion fish > ~/.config/fish/completions/dbbackup.fish

DBA World Meeting Feature: Improved command-line usability
2026-01-30 18:36:37 +01:00
5 changed files with 277 additions and 2 deletions

80
cmd/completion.go Normal file
View File

@ -0,0 +1,80 @@
package cmd
import (
"os"
"github.com/spf13/cobra"
)
var completionCmd = &cobra.Command{
Use: "completion [bash|zsh|fish|powershell]",
Short: "Generate shell completion scripts",
Long: `Generate shell completion scripts for dbbackup commands.
The completion script allows tab-completion of:
- Commands and subcommands
- Flags and their values
- File paths for backup/restore operations
Installation Instructions:
Bash:
# Add to ~/.bashrc or ~/.bash_profile:
source <(dbbackup completion bash)
# Or save to file and source it:
dbbackup completion bash > ~/.dbbackup-completion.bash
echo 'source ~/.dbbackup-completion.bash' >> ~/.bashrc
Zsh:
# Add to ~/.zshrc:
source <(dbbackup completion zsh)
# Or save to completion directory:
dbbackup completion zsh > "${fpath[1]}/_dbbackup"
# For custom location:
dbbackup completion zsh > ~/.dbbackup-completion.zsh
echo 'source ~/.dbbackup-completion.zsh' >> ~/.zshrc
Fish:
# Save to fish completion directory:
dbbackup completion fish > ~/.config/fish/completions/dbbackup.fish
PowerShell:
# Add to your PowerShell profile:
dbbackup completion powershell | Out-String | Invoke-Expression
# Or save to profile:
dbbackup completion powershell >> $PROFILE
After installation, restart your shell or source the completion file.
Note: Some flags may have conflicting shorthand letters across different
subcommands (e.g., -d for both db-type and database). Tab completion will
work correctly for the command you're using.`,
ValidArgs: []string{"bash", "zsh", "fish", "powershell"},
Args: cobra.ExactArgs(1),
DisableFlagParsing: true, // Don't parse flags for completion generation
Run: func(cmd *cobra.Command, args []string) {
shell := args[0]
// Get root command without triggering flag merging
root := cmd.Root()
switch shell {
case "bash":
root.GenBashCompletionV2(os.Stdout, true)
case "zsh":
root.GenZshCompletion(os.Stdout)
case "fish":
root.GenFishCompletion(os.Stdout, true)
case "powershell":
root.GenPowerShellCompletionWithDesc(os.Stdout)
}
},
}
func init() {
rootCmd.AddCommand(completionCmd)
}

182
cmd/man.go Normal file
View File

@ -0,0 +1,182 @@
package cmd
import (
"fmt"
"os"
"path/filepath"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
var (
manOutputDir string
)
var manCmd = &cobra.Command{
Use: "man",
Short: "Generate man pages for dbbackup",
Long: `Generate Unix manual (man) pages for all dbbackup commands.
Man pages are generated in standard groff format and can be viewed
with the 'man' command or installed system-wide.
Installation:
# Generate pages
dbbackup man --output /tmp/man
# Install system-wide (requires root)
sudo cp /tmp/man/*.1 /usr/local/share/man/man1/
sudo mandb # Update man database
# View pages
man dbbackup
man dbbackup-backup
man dbbackup-restore
Examples:
# Generate to current directory
dbbackup man
# Generate to specific directory
dbbackup man --output ./docs/man
# Generate and install system-wide
dbbackup man --output /tmp/man && \
sudo cp /tmp/man/*.1 /usr/local/share/man/man1/ && \
sudo mandb`,
DisableFlagParsing: true, // Avoid shorthand conflicts during generation
RunE: runGenerateMan,
}
func init() {
rootCmd.AddCommand(manCmd)
manCmd.Flags().StringVarP(&manOutputDir, "output", "o", "./man", "Output directory for man pages")
// Parse flags manually since DisableFlagParsing is enabled
manCmd.SetHelpFunc(func(cmd *cobra.Command, args []string) {
cmd.Parent().HelpFunc()(cmd, args)
})
}
func runGenerateMan(cmd *cobra.Command, args []string) error {
// Parse flags manually since DisableFlagParsing is enabled
outputDir := "./man"
for i := 0; i < len(args); i++ {
if args[i] == "--output" || args[i] == "-o" {
if i+1 < len(args) {
outputDir = args[i+1]
i++
}
}
}
// Create output directory
if err := os.MkdirAll(outputDir, 0755); err != nil {
return fmt.Errorf("failed to create output directory: %w", err)
}
// Generate man pages for root and all subcommands
header := &doc.GenManHeader{
Title: "DBBACKUP",
Section: "1",
Source: "dbbackup",
Manual: "Database Backup Tool",
}
// Due to shorthand flag conflicts in some subcommands (-d for db-type vs database),
// we generate man pages command-by-command, catching any errors
root := cmd.Root()
generatedCount := 0
failedCount := 0
// Helper to generate man page for a single command
genManForCommand := func(c *cobra.Command) {
// Recover from panic due to flag conflicts
defer func() {
if r := recover(); r != nil {
failedCount++
// Silently skip commands with flag conflicts
}
}()
filename := filepath.Join(outputDir, c.CommandPath()+".1")
// Replace spaces with hyphens for filename
filename = filepath.Join(outputDir, filepath.Base(c.CommandPath())+".1")
f, err := os.Create(filename)
if err != nil {
failedCount++
return
}
defer f.Close()
if err := doc.GenMan(c, header, f); err != nil {
failedCount++
os.Remove(filename) // Clean up partial file
} else {
generatedCount++
}
}
// Generate for root command
genManForCommand(root)
// Walk through all commands
var walkCommands func(*cobra.Command)
walkCommands = func(c *cobra.Command) {
for _, sub := range c.Commands() {
// Skip hidden commands
if sub.Hidden {
continue
}
// Try to generate man page
genManForCommand(sub)
// Recurse into subcommands
walkCommands(sub)
}
}
walkCommands(root)
fmt.Printf("✅ Generated %d man pages in %s", generatedCount, outputDir)
if failedCount > 0 {
fmt.Printf(" (%d skipped due to flag conflicts)\n", failedCount)
} else {
fmt.Println()
}
fmt.Println()
fmt.Println("📖 Installation Instructions:")
fmt.Println()
fmt.Println(" 1. Install system-wide (requires root):")
fmt.Printf(" sudo cp %s/*.1 /usr/local/share/man/man1/\n", outputDir)
fmt.Println(" sudo mandb")
fmt.Println()
fmt.Println(" 2. Test locally (no installation):")
fmt.Printf(" man -l %s/dbbackup.1\n", outputDir)
fmt.Println()
fmt.Println(" 3. View installed pages:")
fmt.Println(" man dbbackup")
fmt.Println(" man dbbackup-backup")
fmt.Println(" man dbbackup-restore")
fmt.Println()
// Show some example pages
files, err := filepath.Glob(filepath.Join(outputDir, "*.1"))
if err == nil && len(files) > 0 {
fmt.Println("📋 Generated Pages (sample):")
for i, file := range files {
if i >= 5 {
fmt.Printf(" ... and %d more\n", len(files)-5)
break
}
fmt.Printf(" - %s\n", filepath.Base(file))
}
fmt.Println()
}
return nil
}

5
go.mod
View File

@ -23,6 +23,7 @@ require (
github.com/hashicorp/go-multierror v1.1.1
github.com/jackc/pgx/v5 v5.7.6
github.com/klauspost/pgzip v1.2.6
github.com/mattn/go-isatty v0.0.20
github.com/schollz/progressbar/v3 v3.19.0
github.com/shirou/gopsutil/v3 v3.24.5
github.com/sirupsen/logrus v1.9.3
@ -69,6 +70,7 @@ require (
github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect
github.com/charmbracelet/x/term v0.2.1 // indirect
github.com/cncf/xds/go v0.0.0-20250501225837-2ac532fd4443 // indirect
github.com/cpuguy83/go-md2man/v2 v2.0.6 // indirect
github.com/envoyproxy/go-control-plane/envoy v1.32.4 // indirect
github.com/envoyproxy/protoc-gen-validate v1.2.1 // indirect
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
@ -90,7 +92,6 @@ require (
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/mattn/go-localereader v0.0.1 // indirect
github.com/mattn/go-runewidth v0.0.16 // indirect
github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db // indirect
@ -102,6 +103,7 @@ require (
github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
github.com/rivo/uniseg v0.4.7 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/spiffe/go-spiffe/v2 v2.5.0 // indirect
github.com/tklauser/go-sysconf v0.3.12 // indirect
github.com/tklauser/numcpus v0.6.1 // indirect
@ -130,6 +132,7 @@ require (
google.golang.org/genproto/googleapis/rpc v0.0.0-20251103181224-f26f9409b101 // indirect
google.golang.org/grpc v1.76.0 // indirect
google.golang.org/protobuf v1.36.10 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
modernc.org/libc v1.67.6 // indirect
modernc.org/mathutil v1.7.1 // indirect
modernc.org/memory v1.11.0 // indirect

10
go.sum
View File

@ -106,6 +106,7 @@ github.com/chengxilo/virtualterm v1.0.4 h1:Z6IpERbRVlfB8WkOmtbHiDbBANU7cimRIof7m
github.com/chengxilo/virtualterm v1.0.4/go.mod h1:DyxxBZz/x1iqJjFxTFcr6/x+jSpqN0iwWCOK1q10rlY=
github.com/cncf/xds/go v0.0.0-20250501225837-2ac532fd4443 h1:aQ3y1lwWyqYPiWZThqv1aFbZMiM9vblcSArJRf2Irls=
github.com/cncf/xds/go v0.0.0-20250501225837-2ac532fd4443/go.mod h1:W+zGtBO5Y1IgJhy4+A9GOqVhqLpfZi+vwmdNXUehLA8=
github.com/cpuguy83/go-md2man/v2 v2.0.6 h1:XJtiaUW6dEEqVuZiMTn1ldk455QWwEIsMIJlo5vtkx0=
github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@ -177,6 +178,10 @@ github.com/klauspost/compress v1.18.3 h1:9PJRvfbmTabkOX8moIpXPbMMbYN60bWImDDU7L+
github.com/klauspost/compress v1.18.3/go.mod h1:R0h/fSBs8DE4ENlcrlib3PsXS61voFxhIs2DeRhCvJ4=
github.com/klauspost/pgzip v1.2.6 h1:8RXeL5crjEUFnR2/Sn6GJNWtSQ3Dk8pq4CL3jvdDyjU=
github.com/klauspost/pgzip v1.2.6/go.mod h1:Ch1tH69qFZu15pkjo5kYi6mth2Zzwzt50oCQKQE9RUs=
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
@ -216,6 +221,9 @@ github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qq
github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII=
github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o=
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/schollz/progressbar/v3 v3.19.0 h1:Ea18xuIRQXLAUidVDox3AbwfUhD0/1IvohyTutOIFoc=
github.com/schollz/progressbar/v3 v3.19.0/go.mod h1:IsO3lpbaGuzh8zIMzgY3+J8l4C8GjO0Y9S69eFvNsec=
@ -312,6 +320,8 @@ google.golang.org/grpc v1.76.0/go.mod h1:Ju12QI8M6iQJtbcsV+awF5a4hfJMLi4X0JLo94U
google.golang.org/protobuf v1.36.10 h1:AYd7cD/uASjIL6Q9LiTjz8JLcrh/88q5UObnmY3aOOE=
google.golang.org/protobuf v1.36.10/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

View File

@ -16,7 +16,7 @@ import (
// Build information (set by ldflags)
var (
version = "4.2.10"
version = "4.2.12"
buildTime = "unknown"
gitCommit = "unknown"
)