Usage

Modes

You can run the Numbat command-line application in three different modes:

Mode	Command to run
Start an interactive session (REPL)	`numbat`
Run a Numbat program	`numbat script.nbt`
Evaluate a single expression	`numbat -e '30 km/h -> mi/h'`

Command-line options

See numbat --help for more information.

Interactive sessions

Interactive sessions allow you to perform a sequence of calculations. You can use the special identifiers ans or _ to refer to the result of the last calculation. For example:

>>> 60 kW h / 150 kW

    = 0.4 h

>>> ans -> minutes

    = 24 min

Commands

There is a set of special commands that only work in interactive mode:

Command	Action
`help`, `?`	Show a basic introduction to Numbat
`help commands`	Brief description of all available commands
`info <identifier>`	Get more information about functions, variables, units, or dimensions
`list`	Show all currently defined items
`list <what>`	Show all currently defined `functions`, `dimensions`, `variables`, or `units`
`save`	Save the current session history to `history.nbt` in the current directory
`save <path>`	Save the current session history to file (recommended extension: `.nbt`)
`clear`	Clear the console output
`quit`, `exit`	Close this session

Key bindings

In interactive command-line mode, you can use the following key bindings. Most importantly, Tab for auto-completion, arrow keys and Ctrl-R for browsing the command history, and Ctrl-D for exiting the interactive session.

Key sequence	Action
`Tab` / `Ctrl`+`I`	Auto-completion
`Ctrl`+`D`	Quit
`Ctrl`+`L`	Clear screen
`Up` / `Down`	Browse command history
`Ctrl`+`R`	Search command history
`Ctrl`+`C`	Clear the current line
`Alt`+`Enter`	Insert newline
`Home` / `Ctrl`+`A`	Move cursor to the beginning of the line
`End` / `Ctrl`+`E`	Move cursor to the end of the line
`Ctrl`+`W`	Delete word leading up to cursor