The Logbook project provides a desktop and command-line application for chronological note taking.
Linux
The Logbook desktop app is distributed as compressed tar file (*.tar.gz) containing the release output of the flutter build linux command.
It can be installed by downloading the logbookapp-${RELEASE_VERSION}-linux-x86_64.tar.gz file from the latest GitHub release, unpacking it, moving it into a custom installation directory, and creating a Desktop file.
Those steps may be done automatically by executing the install_linux.sh script:
./packages/logbook_app/tool/install_linux.sh -hTo use the command-line interface of the Logbook app, the Dart SDK needs to be installed, first. Then one can clone the Git repository and globally activate the Logbook package.
git clone [email protected]:experimental-software/logbook.git
cd logbook/packages/logbook_cli
dart pub get
dart pub global activate --source path .In the ~/.config/logbook/config.yaml file it can be configured what directories are used for reading and writing log entries.
The following snippet shows the configuration options with their default values:
# The directory where new log entries are added.
logDirectory: ~/Logs
# The directory where log entries are moved when they are archived.
archiveDirectory: ~/Archive
# The path of a text editor (needs to start with "/usr/", e.g. "/usr/local/bin/code")
textEditor:Add log entry
A new log entry can be added with the add command an the log title as positional parameter.
$ logbook add "Hello, World!"
/Users/jdoe/Logs/2022/12/19/10.38_hello-world
The program will print out the directory that got created for the log entry.
Search log entries
With the help of the search command, the logs can be found. If no search term gets provided, all available log entries are listed.
$ logbook search
+------------------+----------------+-----------------------------------------------+
| Time | Title | Path |
+------------------+----------------+-----------------------------------------------+
| 2022-12-19 10:38 | Hello, World! | /Users/jdoe/Logs/2022/12/19/10.38_hello-world |
+------------------+----------------+-----------------------------------------------+
Details
For an overview over all the options, call the logbook program and/or the respective sub-command with the --help flag.
$ logbook -h
$ logbook add -h
Given lcov has been install via Homebrew or Apt, the test coverage report can be generated like this:
./tool/create_test_coverage_report.sh