Configuration

The zshot configuration file ( zshot.toml ) is used to store licensing information. If you have a valid license key, you should store it in the file in the following format:

license = "MY-ZSHOT-LICENSE-KEY"

This file should be readable by the same user that the zshot process is running as. Additionally, if the file is writable, zshot will write back license caching information to the file to prevent frequent re-licensing checks with the zshot licensing server.

You can specify a specific configuration file via the --config flag, which will override the default lookup.

Lookup order

zshot resolves the license key in priority order: the --license-key argument, then the ZSHOT_LICENSE environment variable, then the license value from the first zshot.toml it finds. Without --config, it searches:

1. zshot.toml in the current working directory
2. $XDG_CONFIG_HOME/zshot.toml, defaulting to ~/.config/zshot.toml
3. on macOS, zshot.toml next to the .app bundle
4. zshot.toml in the directory containing the zshot binary

When the resolved file is writable, zshot caches the signed license back to it; if no config exists, it creates one at $XDG_CONFIG_HOME/zshot.toml, else ~/.config/zshot.toml.

If you do not want to store your license key in a configuration file, you can also provide it via a command line argument --license-key or via the environment variable ZSHOT_LICENSE.