Back to the start page

Commands

The apps and the commands use the same engine. The operation in a terminal is the same as the operation in a window. Each installer contains the jotbay command.

Every day

Command	Function
jotbay	Shows the status of this machine and of all other machines
jotbay sync	Makes a commit, gets the changes from the repository, and sends your changes
jotbay dash	Shows a live dashboard in the terminal
jotbay path	Shows the path of your notes folder

The other machines

Command	Function
jotbay nodes	Shows each machine, and asks each machine for its status
jotbay nodes --forget <name>	Removes the status of a machine that you do not use again
jotbay activity	Shows the operations of each machine, and also the operations that failed
jotbay log	Shows the git history of the changes to your notes

Setup and maintenance

Command	Function
jotbay init	Prepares a vault on a new machine
jotbay schedule	Shows the background sync, and prepares it if it is absent
jotbay watch	Syncs after each change, and shows each operation
jotbay shortcut	Puts an icon for the app or for your notes folder on the desktop
jotbay settings	Shows or changes the preferences of this machine
jotbay upgrade	Downloads the most recent release, and replaces the files on this machine
jotbay resolve	Completes a rebase that stopped

Options for all commands

Option	Function
--json	Shows the result as JSON, for a script
--at <path>	Uses the vault at this path
--offline	Uses only local data. Available for status and activity.

The macOS app uses jotbay --json for each value that it shows. A script can read the same data.

Set up a vault from the terminal

The command asks the same question as the first start of the app. You can also give the answer as an option.

jotbay init                        # asks the three options
jotbay init --create my-notes      # makes a private GitHub repository
jotbay init --clone <url>          # clones a repository that you have
jotbay init --adopt <path>         # uses a clone on this machine

Only --create needs gh. The other options need only git.