summaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000..725de11
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,48 @@
+/*
+forge -- a tool to git repos at go.wit.com
+
+ but you can probably use it for other things
+
+A video demonstration of the terminal UI is available at:
+https://mirrors.wit.com/guidemo/forge-gocui-demo.webm
+
+forge v0.22.124-2-g8c25ed1 Built on 2025.07.21_1348
+Usage: forge [--debugger] [--logger] [--no-gui] [--gui GUI] [--gui-file GUI-FILE] [--gui-test GUI-TEST] [--gui-verbose] [--connect CONNECT] [--all] [--build BUILD] [--install INSTALL] [--forge-rebuild] [--force] [--verbose] [--bash] [--auto-complete AUTO-COMPLETE] <command> [<args>]
+
+Options:
+
+ --debugger open the debugger window
+ --logger open the log.* control window
+ --no-gui ignore all these gui problems
+ --gui GUI Use this gui toolkit [andlabs,gocui,nocui,stdin]
+ --gui-file GUI-FILE Use a specific plugin.so file
+ --gui-test GUI-TEST test a specific plugin.so will load
+ --gui-verbose enable all logging
+ --connect CONNECT forge url
+ --all git commit --all
+ --build BUILD build a repo
+ --install INSTALL install a repo
+ --forge-rebuild download and rebuild forge
+ --force try to strong arm things
+ --verbose show more output
+ --bash generate bash completion
+ --auto-complete AUTO-COMPLETE
+ todo: move this to go-arg
+ --help, -h display this help and exit
+ --version display version and exit
+
+Commands:
+
+ checkout switch branches using 'git checkout'
+ clean start over at the beginning
+ commit 'git commit' but errors out if on wrong branch
+ config show your .config/forge/ settings
+ debug debug forge
+ dirty show dirty git repos
+ fetch run 'git fetch master'
+ list print a table of the current repos
+ merge merge branches
+ patch make patchsets
+ pull run 'git pull'
+*/
+package main