VALKEY(7)

📦
version 9.0.6 · 2 versions
, in fedora 44

✨ NAME ✨

valkey — the Valkey Documentation, bestie. Yeah, this is the manual page for the docs themselves, section 7 of the manual, filed under the name VALKEY. Very meta. Very iconic. 💅

🎀 DESCRIPTION 🎀

Okay so here's the tea: all the Valkey documentation lives in markdown files inside the valkey-doc repository. That's the whole vibe — no secret sauce, just markdown, tracked, versioned, slaying.

And the licensing? It's released under the Creative Commons Attribution-ShareAlike 4.0 International license. So go ahead and share it, remix it, cite it — just follow the rules of that license, periodt. 🫶

🌈 VALKEY DOCUMENTATION 🌈

📖 1. Introduction

💻 2. Developer Guide

🧠 Core Concepts

  • valkey-data-types(7) — Keys are strings, but values can be of many different data types. Plot twist: the key is boring, the value is the main character.
  • valkey-commands(7) — The full list of commands, with documentation for each of them. Every single one. No skips.
  • valkey-pipelining(7) — How to send multiple commands at once, saving on round trip time. Efficiency queen behavior. 👑
  • valkey-transactions(7) — Valkey's approach to atomic transactions.
  • expire(3valkey) — How to set a Time To Live (TTL) on key so that it will be automatically removed from the server when it expires. It's giving "your fave will ghost you, and that's the feature." 💀
  • valkey-pubsub(7) — Pub/Sub: using Valkey as a message broker using the Publish/Subscribe messaging system.
  • valkey-notifications(7) — Keyspace notifications: get notifications of keyspace events via Pub/Sub.
  • valkey-keyspace(7) — Keyspace management: how to alter, query, and navigate the keyspace.

🌸 Application Patterns & Tutorials

  • valkey-lru-cache(7) — Valkey as an LRU cache: how to configure Valkey as a cache with a fixed amount of memory and automatic eviction of keys.
  • valkey-client-side-caching(7) — How a client can be notified by the server when a key has changed.
  • valkey-distlock(7) — Distributed locks: implementing a distributed lock manager.
  • valkey-indexing(7) — Secondary indexes: how to simulate secondary indexes, composed indexes and traverse graphs using various data structures.
  • valkey-twitter-clone(7) — Writing a simple Twitter clone with PHP and Valkey. Yes, PHP. Yes, it ate. 🍓

🧚 3. Extending Valkey

🐚 Server-side scripting in Valkey

🧩 Valkey modules API

  • valkey-modules-intro(7) — Introduction to Valkey modules: extend Valkey using dynamically linked modules.
  • valkey-modules-native-types(7) — Implementing native data types: modules scan implement new data types (data structures and more) that look like built-in data types. This documentation covers the API to do so.
  • valkey-modules-blocking-ops(7) — Blocking operations: write commands that can block the client (without blocking Valkey) and can execute tasks in other threads.
  • valkey-modules-api-ref(7) — Modules API reference: documentation of all module API functions. Low level details about API usage.

👑 4. Administration

🛠️ Core Management

  • valkey-license(7) — License information for Valkey. The legal lore.
  • valkey-installation(7) — How to install and configure Valkey. This targets people without prior experience with Valkey. Baby's first Valkey, we love to see it. 🫶
  • Release Downloads — Lists links to download all current and previous releases.
  • valkey-cli(1) — The Valkey command line interface, used for administration, troubleshooting and experimenting with Valkey.
  • valkey-server(1) — How to run the Valkey server.
  • valkey.conf(5) — How to configure Valkey.
  • valkey-persistence(7) — Options for configuring durability using disk backups.
  • valkey-signals(7) — Signals Handling: how Valkey handles signals.
  • valkey-clients(7) — Connections Handling: how Valkey handles clients connections.
  • valkey-migration(7) — How to migrate from Redis to Valkey. Glow-up arc. ✨
  • valkey-releases(7) — Releases and Versioning: Valkey's development cycle and version numbering.
  • valkey-admin(7) — Administration: various administration topics.

🌐 Deployment Topology

🔐 Security

  • valkey-security(7) — An overview of Valkey's security.
  • valkey-acl(7) — Access Control Lists: ACLs make it possible to allow users to run only selected commands and access only specific key patterns.
  • valkey-encryption(7) — How to use TLS for communication.

🖥️ Platform Specific

  • valkey-arm(7) — ARM and Raspberry Pi: ARM and the Raspberry Pi are supported platforms. This page contains general information and benchmarks.
  • valkey-rdma(7) — RDMA: an overview of RDMA support.

🔥 5. Performance & Troubleshooting

🧬 6. Low-Level Internals

  • valkey-protocol(7) — Protocol specification: the client-server protocol, for client authors.
  • valkey-key-specs(7) — Command key specifications: how to extract the names of keys accessed by every command.
  • valkey-command-tips(7) — Command tips communicate non-trivial execution modes and post-processing information about commands.
  • valkey-command-arguments(7) — An overview of command arguments as returned by the COMMAND DOCS command.

And that's the whole page, bestie — no notes, no cap, every single reference accounted for. 💖

This was the VALKEY(7) page from the Valkey Manual, version 9.0.0, dated 2025-10-21. Go read some docs, you're literally gonna slay. 🦋✨

📦 where this page comes from