aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2020-02-02 12:15:27 +0100
committerDaniel Mueller <deso@posteo.net>2020-09-05 11:36:12 -0700
commit9a6d04f3bfffe63021d68efad9fbf0ae3987064c (patch)
treea94de2af31b9e37bf5029f256129d42e6d018641 /doc
parentaa28268d9087572dc7eb62df46fcdc9db12d6de5 (diff)
downloadnitrocli-9a6d04f3bfffe63021d68efad9fbf0ae3987064c.tar.gz
nitrocli-9a6d04f3bfffe63021d68efad9fbf0ae3987064c.tar.bz2
Add config test case and example config file
This patch adds a simple configuration file that demonstrates the syntax and contains some documentation. We suggest to ship this file together with nitrocli and to install it e.g., in the /usr/share/doc/nitrocli directory. This patch also adds a simple test case that makes sure that the example file is parsed correctly.
Diffstat (limited to 'doc')
-rw-r--r--doc/config.example.toml10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/config.example.toml b/doc/config.example.toml
new file mode 100644
index 0000000..a427749
--- /dev/null
+++ b/doc/config.example.toml
@@ -0,0 +1,10 @@
+# This is an example configuration file for nitrocli. To use it, place it at
+# ${XDG_CONFIG_HOME}/nitrocli/config.toml, where XDG_CONFIG_HOME defaults to
+# ${HOME}.
+
+# The model to connect to (string, "pro" or "storage", default: not set).
+model = "pro"
+# Do not cache secrets (boolean, default: false).
+no_cache = true
+# The log level (integer, default: 0).
+verbosity = 2