BKT(1)

✨ BKT(1) — bestie edition ✨

okay so like. welcome to the User Commands section of your manual, and today's main character is bkt 💖 it's a whole subprocess caching utility and honestly? she eats. let's get into it 🫶

---

🌸 NAME 🌸

bkt — a subprocess caching utility. yes that's the whole vibe. it caches subprocess invocations so you don't have to run the same thing over and over like a clown 🤡

---

🦋 SYNOPSIS 🦋

bkt [OPTIONS] -- <COMMAND>...

note the -- bestie!! it's lowkey important, don't skip it ✨

---

💅 DESCRIPTION 💅

it's a CLI and a Rust library for caching subprocess invocations. both. she's multifaceted like that 👑

---

🎀 Arguments 🎀

• <COMMAND>... — the command to run. that's it, that's the argument. slay 💅

---

🔥 OPTIONS 🔥

• --ttl <DURATION> — how long the cached result stays valid, as in, how long it's still iconic before it's expired and embarrassing [env: BKT_TTL=] [default: 60s] [aliases: time-to-live]
• --stale <DURATION> — after this long, the result gets asynchronously refreshed. like, she's getting old but we're quietly updating her in the background, no drama ✨
• --warm — asynchronously execute and cache the given command, even if it's already cached. pre-heating the vibes fr fr 🔥
• --force — execute and cache the given command, even if it's already cached. no thoughts, just run it 💀
• --cwd — includes the current working directory in the cache key, so that the same command run in different directories caches separately. she knows where she is 🧭 [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. context matters bestie 🌈 [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. timestamp girlies rise 🕐 [aliases: use-file-modtime]
• --discard-failures — don't cache invocations that fail (non-zero exit code).

⚠️ USE CAUTION when passing this flag, bestie!! unexpected failures can lead to a spike in invocations which can exacerbate ongoing issues — effectively a DDoS. that's not a vibe. that's the opposite of a vibe. please be careful 😭

• --scope <NAME> — if set, all cached data will be scoped to this value, preventing collisions with commands cached with different scopes. keep your little worlds separate, it's healthy 💅 [env: BKT_SCOPE=]
• --cache-dir <DIR> — the directory under which to persist cached invocations; defaults to the system's temp directory. setting this to a directory backed by RAM or an SSD, such as a tmpfs partition, will significantly reduce caching overhead. speed queen behavior 👑 [env: BKT_CACHE_DIR=]
• -h, --help — print help. when in doubt, ask for help. it's giving self-care 🫶
• -V, --version — print version. check who you're dealing with ✨

---

👀 SEE ALSO 👀

the full documentation for bkt is maintained as a Texinfo manual. if the info and bkt programs are properly installed at your site, the command

info bkt

should give you access to the complete manual. literally the whole lore, no cap 📖

---

okay that's the whole page!! thanks for reading bestie, go cache something 💖✨

signed, sealed, delivered — bkt 0.6.1, September 2024, from the folks who keep this page at BKT(1) status 🌈💅