|
| 1 | +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. |
| 2 | +.TH LBUG "1" "March 15, 2026" "Ladybug 0.15.1" "User Commands" |
| 3 | +.SH NAME |
| 4 | +Lbug \- LadybugDB interactive shell CLI |
| 5 | +.SH SYNOPSIS |
| 6 | +lbug [databasePath] {OPTIONS} |
| 7 | +.SH DESCRIPTION |
| 8 | +lbug is an interactive shell CLI for LadybugDB. |
| 9 | +You can use it to run OpenCypher queries directly on the database. |
| 10 | +.SH DATABASEPATH |
| 11 | +Path to the database. If not given or |
| 12 | +set to ":memory:", the database will be |
| 13 | +opened under in\-memory mode. |
| 14 | +.SH OPTIONS |
| 15 | +.TP |
| 16 | +\fB\-h\fR, \fB\-\-help\fR |
| 17 | +Display this help menu |
| 18 | +.TP |
| 19 | +\fB\-d\fR, \fB\-\-default_bp_size\fR, \fB\-\-defaultbpsize\fR |
| 20 | +Size of buffer pool for default and |
| 21 | +large page sizes in megabytes |
| 22 | +.TP |
| 23 | +\fB\-\-max_db_size\fR=\fI\,[max_db_size]\/\fR, \fB\-\-maxdbsize\fR=\fI\,[max_db_size]\/\fR |
| 24 | +Maximum size of the database in bytes |
| 25 | +.HP |
| 26 | +\fB\-\-no_compression\fR, \fB\-\-nocompression\fR Disable compression |
| 27 | +.TP |
| 28 | +\fB\-r\fR, \fB\-\-read_only\fR, \fB\-\-readonly\fR |
| 29 | +Open database in read\-only mode. |
| 30 | +.TP |
| 31 | +\fB\-p\fR, \fB\-\-path_history\fR |
| 32 | +Path to directory for shell history |
| 33 | +.TP |
| 34 | +\fB\-v\fR, \fB\-\-version\fR |
| 35 | +Display current database version |
| 36 | +.TP |
| 37 | +\fB\-m\fR, \fB\-\-mode\fR |
| 38 | +Set the output mode of the shell |
| 39 | +.TP |
| 40 | +\fB\-s\fR, \fB\-\-no_stats\fR, \fB\-\-nostats\fR |
| 41 | +Disable query stats |
| 42 | +.TP |
| 43 | +\fB\-b\fR, \fB\-\-no_progress_bar\fR, \fB\-\-noprogressbar\fR |
| 44 | +Disable query progress bar |
| 45 | +.TP |
| 46 | +\fB\-w\fR, \fB\-\-ignore_wal_replay_errors\fR |
| 47 | +By default something goes wrong when |
| 48 | +replaying the WAL an exception will be |
| 49 | +thrown. With this flag enabled we will |
| 50 | +instead ignore these errors and stop |
| 51 | +replaying the WAL. |
| 52 | +.TP |
| 53 | +\fB\-i\fR, \fB\-\-init\fR |
| 54 | +Path to the script file to run on |
| 55 | +startup |
| 56 | +.HP |
| 57 | +\fB"\-\-"\fR can be used to terminate flag options and force all following |
| 58 | +arguments to be treated as positional options |
| 59 | +.SH SEE ALSO |
| 60 | +https://docs.ladybugdb.com/client-apis/cli/ |
| 61 | +.br |
| 62 | +https://ladybugdb.github.io/wasm-shell/ (a WASM build of the shell) |
| 63 | +.SH AUTHOR |
| 64 | +LadybugDB contributors |
| 65 | +.SH COPYRIGHT |
| 66 | +LadybugDB contributors |
0 commit comments