Runtime Keys

The playbook keys configured under runtime manage the console output, resource update behavior, and cache location.

runtime key

The runtime key specifies the cache directory location and when the cache is updated.

Example 1. antora-playbook.yml
runtime: (1)
  cache_dir: ./.cache/antora (2)
  fetch: true (3)
1 Optional runtime key
2 Optional cache_dir key
3 Optional fetch key

The runtime key and the key-value pairs it accepts are optional. When runtime isn’t set in a playbook, Antora uses the default cache directory and fetch settings.

Available runtime keys

Runtime Keys Description Required


Specifies the directory where the remote content sources git repositories and UI bundles are cached.



When set to true, the fetch key refreshes the files in the cache each time Antora runs.