Skip to content

Commit 2208365

Browse files
committed
Add brief on command line configuration
Signed-off-by: Sayan Nandan <[email protected]>
1 parent cee46f3 commit 2208365

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

docs/config-command-line.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Command line configuration
2+
3+
With TerrabaseDB v0.5.0, you can use command line arguments alone for configuration. For the easiest setup, use TerrabaseDB's <a href="https://terrabasedb.github.io/setupapp" target="_blank">Setup Web App</a>.
4+
5+
Every binary ( `tdb` , `tsh` and `tdb-bench` ) that you get with a bundle have extremely helpful help menus:
6+
7+
* `tdb --help` : Brings up the help menu for `tdb`
8+
* `tsh --help` : Brings up the help menu for `tsh`
9+
* `tdb-bench --help` : Brings up the help menu for `tdb-bench`

docs/snapshots.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ TerrabaseDB's snapshotting system is dead simple and works in a similar way to [
55

66
## Enabling snapshots
77

8-
Snapshots aren't enabled by default - you have to enable them by using the configuration file. To your existing configuration file, just add the following block:
8+
Snapshots aren't enabled by default - you have to enable them by using the configuration file or [command line arguments](/config-command-line). To your existing configuration file, just add the following block:
99

1010
``` toml
1111
[snapshot]

docs/tdb-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration Files
22

3-
Since v0.4.1, TerrabaseDB supports custom configuration files to let users customize the functioning of TDB. Arguably, TDB has one of the simplest configuration files around.
3+
Since v0.4.1, TerrabaseDB supports custom configuration files to let users customize the functioning of TDB. Arguably, TDB has one of the simplest configuration files around. With v0.5.0, TerrabaseDB allows configuration via [command line arguments](/config-command-line).
44

55
## An example configuration
66

0 commit comments

Comments
 (0)