wb

README

whiteboard

virtual whiteboard for terminal

---

The intention behind this program is to provide a space for quickly retrieving and saving notes from command line

Installation

1. Make sure you have Go installed and put $GOPATH/bin in your $PATH
2. run go get github.com/rigelrozanski/wb
3. run go install wb

Example Usage

The following are a list of commands that can be run in terminal. wb can be run while navigated to any directory.

wb [name]               -> vim into a wb
wb [name] [entry]       -> fast entry appended as new line in wb
wb new [name]           -> create a new wb
wb cp [copy] [name]     -> duplicate a wb
wb rename [old] [name]  -> rename a wb
wb cat [name]           -> print wb contents to console
wb rm [name]            -> remove a wb (add to trash)
wb recover [name]       -> remove a wb from trash
wb empty-trash          -> empty trash
wb ls                   -> list all the wb in console
wb log                  -> list the log
wb stats                -> list git statistics per wb
wb push [msg]           -> git push the boards directory

notes:
- if the [name] is not provided, 
  the default board named 'wb' will be used
- special reserved wb names: wb, lsls, loglog

Other Notes

• a file in the root of this repo named config.txt can be used to setup a custom location for your whiteboards, but by default the text files are stored under the repo root folder.
• a file in the root of this repo named push.sh set's the custom commands to trigger when the command wb push is used. I use these to backup my wbs in a private git repository :)
• shortcuts can be defined within the wb named shortcuts. Each shortcut is defined on a new line as follows: shortcut-name wb-name
• The following are reserved words which can not be used for custom boards:
  • new
  • cat
  • rm
  • ls
  • log
  • stats

License

whiteboard is released under the Apache 2.0 license.