Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
BKT(1)				 User Commands				BKT(1)

NAME
       bkt - Subprocess	caching	utility

SYNOPSIS
       bkt [OPTIONS] --ttl <DURATION> -- <COMMAND>...

DESCRIPTION
       CLI and Rust library for	caching	subprocess invocations

   Arguments:
       <COMMAND>...
	      The command to run

OPTIONS
       --ttl <DURATION>
	      Duration	the  cached  result  will be valid for [env: BKT_TTL=]
	      [aliases:	time-to-live]

       --stale <DURATION>
	      Duration after which the result will be asynchronously refreshed

       --warm Asynchronously execute and cache the given command, even if it's
	      already cached

       --force
	      Execute and cache	the given command, even	if it's	already	cached

       --cwd  Includes the current working directory in	the cache key, so that
	      the same command run in different	directories caches  separately
	      [aliases:	use-working-dir]

       --env <NAME>
	      Includes	the  given  environment	 variable in the cache key, so
	      that the same command run	with different values  for  the	 given
	      variables	caches separately [aliases: use-environment]

       --modtime <FILE>
	      Includes	the last modification time of the given	file(s)	in the
	      cache key, so that the same command run with different  modtimes
	      for  the	given  files caches separately [aliases: use-file-mod-
	      time]

       --discard-failures
	      Don't cache invocations that fail	(non-zero exit code). USE CAU-
	      TION when	passing	this flag, as unexpected failures can lead  to
	      a	 spike in invocations which can	exacerbate ongoing issues, ef-
	      fectively	a DDoS

       --scope <NAME>
	      If set, all cached data will be scoped to	this value, preventing
	      collisions with commands	cached	with  different	 scopes	 [env:
	      BKT_SCOPE=]

       --cache-dir <DIR>
	      The  directory  under  which  to persist cached invocations; de-
	      faults to	the system's temp directory. Setting this to a	direc-
	      tory  backed  by	RAM or an SSD, such as a tmpfs partition, will
	      significantly reduce caching overhead [env: BKT_CACHE_DIR=]

       -h, --help
	      Print help

       -V, --version
	      Print version

bkt 0.8.2			  April	2025				BKT(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bkt&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help