aboutsummaryrefslogtreecommitdiff
path: root/help.txt
diff options
context:
space:
mode:
Diffstat (limited to 'help.txt')
-rw-r--r--help.txt27
1 files changed, 27 insertions, 0 deletions
diff --git a/help.txt b/help.txt
new file mode 100644
index 0000000..5145e46
--- /dev/null
+++ b/help.txt
@@ -0,0 +1,27 @@
+Chaos Billing (cobill) - A CLI bill splitting tool
+
+SYNOPSIS
+ cobill [--help | --version]
+ cobill <command> [<args>]
+
+COMMANDS
+ add Add a new bill item
+ clear Clear all bill items
+ edit Edit bills using a text editor
+ ls List all bills or show optimized split result
+
+EDITOR SHORTCUTS
+ vi Edit bills with vi
+ vim Edit bills with vim
+ nvim Edit bills with neovim
+ helix Edit bills with helix
+ nano Edit bills with nano
+
+EXAMPLES
+ cobill add -p 100 -r "Dinner" -f Alice Bob
+ cobill ls --optimize
+ cobill edit
+ cobill clear
+
+SEE ALSO
+ For detailed help, run `cobill --help`