Configure file caches

This is the default configuration:

caches:
  assets:
    dir: :resourceDir/_gen
    maxAge: -1
  getcsv:
    dir: :cacheDir/:project
    maxAge: -1
  getjson:
    dir: :cacheDir/:project
    maxAge: -1
  getresource:
    dir: :cacheDir/:project
    maxAge: -1
  images:
    dir: :resourceDir/_gen
    maxAge: -1
  misc:
    dir: :cacheDir/:project
    maxAge: -1
  modulequeries:
    dir: :cacheDir/modules
    maxAge: 24h
  modules:
    dir: :cacheDir/modules
    maxAge: -1

[caches]
  [caches.assets]
    dir = ':resourceDir/_gen'
    maxAge = -1
  [caches.getcsv]
    dir = ':cacheDir/:project'
    maxAge = -1
  [caches.getjson]
    dir = ':cacheDir/:project'
    maxAge = -1
  [caches.getresource]
    dir = ':cacheDir/:project'
    maxAge = -1
  [caches.images]
    dir = ':resourceDir/_gen'
    maxAge = -1
  [caches.misc]
    dir = ':cacheDir/:project'
    maxAge = -1
  [caches.modulequeries]
    dir = ':cacheDir/modules'
    maxAge = '24h'
  [caches.modules]
    dir = ':cacheDir/modules'
    maxAge = -1

{
   "caches": {
      "assets": {
         "dir": ":resourceDir/_gen",
         "maxAge": -1
      },
      "getcsv": {
         "dir": ":cacheDir/:project",
         "maxAge": -1
      },
      "getjson": {
         "dir": ":cacheDir/:project",
         "maxAge": -1
      },
      "getresource": {
         "dir": ":cacheDir/:project",
         "maxAge": -1
      },
      "images": {
         "dir": ":resourceDir/_gen",
         "maxAge": -1
      },
      "misc": {
         "dir": ":cacheDir/:project",
         "maxAge": -1
      },
      "modulequeries": {
         "dir": ":cacheDir/modules",
         "maxAge": "24h"
      },
      "modules": {
         "dir": ":cacheDir/modules",
         "maxAge": -1
      }
   }
}

Purpose

Hugo uses file caches to store data on disk, avoiding repeated operations within the same build and persisting data from one build to the next.

assets

Caches processed CSS and Sass resources.

getcsv

Caches the results of the data.GetCSV function. Note that the data.GetCSV function was deprecated in v0.123.0 in favor of the resources.GetRemote function.

getjson

Caches the results of the data.GetJSON function. Note that the data.GetJSON function was deprecated in v0.123.0 in favor of the resources.GetRemote function.

getresource

Caches files fetched from remote URLs via the resources.GetRemote function.

images

Caches processed images.

misc

Caches miscellaneous data.

modulequeries

Caches the results of module resolution queries.

modules

Caches downloaded modules.

Keys

dir

(string) The absolute file system path where Hugo stores the cached files. You can begin the path with the :cacheDir or :resourceDir tokens to anchor the cache to specific system or project locations.

maxAge

(string) The duration a cached entry remains valid before being evicted, expressed as a duration. A value of 0 disables the cache for that key, and a value of -1 means the cache entry never expires. Default is -1.

Tokens

:cacheDir

(string) The designated cache directory. See details.

:project

(string) The base directory name of the current Hugo project. This ensures isolated file caches for each project, preventing the hugo --gc command from affecting other projects on the same machine.

:resourceDir

(string) The designated directory for caching output from asset pipelines. See details.

Garbage collection

As you modify your site or change your configuration, cached files from previous builds may remain on disk, consuming unnecessary space. Use the hugo --gc command to remove these expired or unused entries from the file cache.