Command line parameters

Zettelstore is not just a service that provides services of a zettelkasten. It allows to some tasks to be executed at the command line. Typically, the task (“sub-command”) will be given at the command line as the first parameter.

If no parameter is given, the Zettelstore is called as

zettelstore

This is equivalent to call it this way:

mkdir -p ./zettel
zettelstore run -d ./zettel -c ./.zscfg

Typically this is done by starting Zettelstore via a graphical user interface by double-clicking to its file icon.

Sub-commands

• zettelstore help lists all available sub-commands.
• zettelstore version to display version information of Zettelstore.
• zettelstore run to start the Zettelstore service.
• zettelstore run-simple is typically called, when you start Zettelstore by a double.click in your GUI.
• zettelstore file to render files manually without activated/running Zettelstore services.
• zettelstore password to calculate data for user authentication.

Every sub-command allows the following command line options:

-h (or --help)

Does not execute the sub-command, but shows allowed command line options (except -h / --help).

-l LOGSPEC

Makes the given logging level specification effective for this command. Details, including syntax, can be found in the description for the log-level key of the startup configuration.

To measure potential bottlenecks within the software Zettelstore, there are some command line flags for profiling the application.