使用文档

从零基础到熟练运用,完整指南助您快速掌握 ARDM 的全部能力。

快速上手

Another Redis Desktop Manager 的设计目标就是「下载即用」。完成安装后,您只需三步即可开始管理 Redis 数据库:创建连接、选择数据库、查看键值。无需阅读冗长文档,无需复杂配置,从安装到查看第一个 Key 全程不超过一分钟。

对于已经熟悉 Redis 命令行的资深用户,ARDM 同样提供了完整的命令行模式,您可以在图形界面与命令行之间自由切换,既享受可视化带来的便捷,又不失去命令行的灵活与强大。无论是查看一个 Hash 的全部字段,还是执行 EVAL 调用一段 Lua 脚本,ARDM 都能游刃有余。

💡 准备工作

在开始之前,请确保您已经下载并安装了 ARDM,并且拥有一个可访问的 Redis 实例(可以是本地、远程、云数据库或 Docker 容器中的 Redis)。如尚未下载,请前往下载中心获取最新版本。

安装与启动

ARDM 的安装过程与大多数桌面应用一致。Windows 用户下载 .exe 或 .msi 安装包后双击运行,按安装向导提示完成安装。macOS 用户下载 .dmg 文件后,将其中的 ARDM 图标拖拽到 Applications 文件夹即可。Linux 用户推荐使用 .AppImage 格式,下载后执行 chmod +x ARDM-*.AppImage 赋予执行权限即可双击运行,无需安装。

首次启动时,ARDM 会自动创建本地配置目录,所有连接配置、偏好设置均以加密形式存储在用户目录下,不会上传到任何服务器。您也可以通过配置文件 ~/.config/ardm/config.json(macOS/Linux)或 %APPDATA%\ardm\config.json(Windows)进行手动备份与迁移。

首次启动注意事项

macOS 用户首次启动 ARDM 时,系统可能会提示「无法验证开发者」或「来自身份不明的开发者」。这是 macOS Gatekeeper 的安全机制,您只需前往「系统设置 → 隐私与安全性」,点击「仍要打开」即可。Windows 用户若遇到 SmartScreen 拦截,请点击「更多信息 → 仍要运行」。Linux 的 .AppImage 在某些发行版下需要先安装 libfuse2 依赖。

创建第一个 Redis 连接

启动 ARDM 后,主界面会显示「新建连接」按钮,点击后弹出连接配置对话框。最基本的连接只需要填写三个字段:主机地址(Host)、端口(Port)、密码(Password)。如果您的 Redis 没有设置密码,密码字段可以留空。

# 基本连接配置示例
Host:     127.0.0.1
Port:     6379
Password: your_redis_password
Name:     本地开发 Redis (自定义名称,便于识别)

填写完成后,建议先点击「测试连接」按钮验证配置是否正确。测试成功后,点击「保存」即可将连接添加到左侧连接列表。双击连接名即可展开数据库列表,默认显示 db0 ~ db15(实际数量取决于 Redis 配置的 databases 参数)。点击任意数据库即可查看其中的键列表。

命名规范建议

为了便于管理多个 Redis 实例,建议在「Name」字段使用统一的命名规范,例如「环境-项目-角色」格式:prod-ecommerce-masterstaging-api-slavelocal-dev。这样在连接列表中可以一目了然地区分不同环境与用途,避免误操作生产环境。

查看与编辑数据

选择数据库后,主区域会显示该数据库中的键列表,默认按名称排序。点击任意键,右侧详情面板会根据键的数据类型自动展示对应的查看器:String 类型显示原始值并提供 JSON、Hex 视图切换;Hash 类型以键值对表格展示;List、Set、ZSet 类型以列表或有序集合形式展示;Stream 类型按 ID 时间线展示消息流。

所有数据类型均支持就地编辑。双击任意字段即可进入编辑模式,修改后按 Enter 保存,按 Esc 取消。对于 Hash 类型,您可以单独编辑某个字段的值而不影响其他字段;对于 List 类型,您可以按索引修改特定元素;对于 ZSet 类型,您可以调整成员的分值(score)从而改变其排序位置。

ℹ️ 大 Key 处理

当键的元素数量超过 1000 时,ARDM 会自动启用分页加载(每页 100 条),避免一次性加载导致界面卡顿。对于超大 Key(如包含百万级元素的 Hash),建议使用 SCAN 命令在命令行模式下分批查看,或使用 ARDM 提供的「数据导出」功能导出为 JSON 文件后用其他工具分析。

在生产环境中,单个数据库可能包含数百万甚至上亿个键,直接列出全部键既不现实也无必要。ARDM 使用 SCAN 命令进行增量式键扫描,配合模糊匹配模式,可以在亿级数据量下流畅查找目标键。

在键列表上方的搜索框中输入模式(如 user:session:**:cart:*),按 Enter 即可执行搜索。搜索结果会实时更新,您可以继续在结果中二次过滤。右键点击任意键,可执行重命名、设置 TTL、复制键名、删除等操作。批量操作时,可勾选多个键后使用工具栏的批量按钮。

TTL 过期管理

TTL(Time To Live)是 Redis 键的重要属性,决定了键的过期时间。在 ARDM 中,每个键的 TTL 都会以可读的方式显示在键列表中(如「3600s」「1h 0m 0s」「永不过期」)。您可以右键点击键,选择「设置 TTL」来修改过期时间,支持秒、分钟、小时、天等多种单位。

对于批量设置 TTL,您可以勾选多个键后使用「批量设置 TTL」功能。这对于清理临时缓存、定期过期数据等场景非常实用。同时,ARDM 还支持通过 PERSIST 命令移除键的过期时间,使其变为永久键。

命令行模式

对于习惯使用 redis-cli 的用户,ARDM 提供了完整的命令行模式。在主界面顶部点击「命令行」按钮,即可打开一个内嵌的命令行窗口,所有命令均会在当前选中的连接与数据库上下文中执行。命令行支持常用的 Redis 命令自动补全、历史记录上下方向键浏览、命令结果语法高亮等特性。

# 命令行示例
127.0.0.1:6379[0]> SET user:1001:name "张三"
OK
127.0.0.1:6379[0]> GET user:1001:name
"张三"
127.0.0.1:6379[0]> EXPIRE user:1001:name 3600
(integer) 1
127.0.0.1:6379[0]> TTL user:1001:name
(integer) 3599

SSH 隧道与 SSL 加密

生产环境的 Redis 通常部署在内网,外部无法直接访问。通过 SSH 隧道,您可以将本地端口转发到内网 Redis,实现安全访问。在新建连接对话框中,展开「高级」选项,勾选「使用 SSH 隧道」,填写 SSH 主机、端口、用户名,选择认证方式(密码或私钥),即可建立 SSH 隧道。

对于启用了 TLS 的 Redis 实例(如阿里云数据库 Redis 版、AWS ElastiCache 等),在「高级」选项中勾选「使用 SSL/TLS」,根据服务端要求选择单向或双向认证。单向认证只需提供 CA 证书;双向认证需要同时提供客户端证书与私钥。所有证书文件均支持 PEM 格式。

Redis Cluster 集群管理

连接 Redis Cluster 时,只需填写集群中任意一个节点的地址,ARDM 会自动通过 CLUSTER NODES 命令发现全部节点,并构建完整的集群拓扑视图。在集群视图下,您可以清晰看到每个主节点的 Slot 范围、对应的从节点、节点状态(在线/离线/故障)。

查看键时,ARDM 会自动通过 CLUSTER KEYSLOT 计算键所在的 Slot,并路由到对应节点执行命令,无需手动切换节点。对于跨 Slot 的批量操作(如 MGET 多个键),ARDM 会自动按 Slot 分组执行并合并结果,最大程度兼容单机模式下的操作习惯。

Lua 脚本开发

ARDM 内置了 Lua 脚本编辑器,是开发复杂业务原子化操作的利器。在主界面顶部点击「Lua 脚本」按钮,即可打开脚本编辑器。编辑器提供语法高亮、自动缩进、括号匹配等专业 IDE 级别的编辑体验。

在编辑器中编写脚本后,可以在「参数」区域配置 KEYS 与 ARGV 参数,模拟真实调用场景。点击「执行」按钮即可运行脚本,结果会在下方面板即时显示。若脚本存在语法错误,错误信息会精确定位到行号;若执行过程中抛出异常,完整的错误堆栈会显示在结果面板中。

-- Lua 脚本示例:原子化扣减库存
local key = KEYS[1]
local qty = tonumber(ARGV[1])
local stock = tonumber(redis.call('GET', key) or '0')
if stock >= qty then
    redis.call('DECRBY', key, qty)
    return 1  -- 扣减成功
end
return 0  -- 库存不足

发布订阅

Redis 的发布订阅(Pub/Sub)是构建实时消息系统的常用组件。在 ARDM 中,您可以可视化订阅频道,实时查看 PUBLISH 推送的消息内容。在主界面顶部点击「发布订阅」按钮,输入要订阅的频道模式(支持通配符 *),点击「订阅」即可开始监听。

订阅后,所有匹配频道的消息会实时显示在消息列表中,每条消息包含频道名、消息内容、接收时间。您可以暂停/恢复监听、清空消息列表、导出消息为文件。对于发布消息,只需在下方输入框中输入频道名与消息内容,点击「发布」即可。

快捷键一览

ARDM 提供了丰富的快捷键支持,熟练使用可以大幅提升操作效率。以下是 Windows/Linux 下的常用快捷键(macOS 用户请将 Ctrl 替换为 Cmd)。

通用快捷键

  • Ctrl + N — 新建连接
  • Ctrl + T — 新建标签页
  • Ctrl + W — 关闭当前标签页
  • Ctrl + F — 搜索键
  • Ctrl + R — 刷新键列表
  • Ctrl + L — 打开命令行
  • Ctrl + , — 打开设置

数据操作

  • F2 — 重命名键
  • Del — 删除键
  • Ctrl + D — 复制键
  • Ctrl + E — 编辑值
  • Ctrl + Shift + T — 设置 TTL
  • Ctrl + Shift + R — 移除 TTL
  • Enter — 确认编辑
  • Esc — 取消编辑

配置文件说明

ARDM 的所有配置(连接列表、偏好设置、主题、语言等)均存储在用户目录下的 JSON 配置文件中。您可以手动编辑此文件来批量管理连接配置、备份配置、迁移到其他设备。

# 配置文件位置
Windows: %APPDATA%\ardm\config.json
macOS:   ~/Library/Application Support/ardm/config.json
Linux:   ~/.config/ardm/config.json
⚠️ 安全提示

配置文件中包含连接密码等敏感信息,虽然经过加密处理,但仍建议您不要将配置文件提交到版本控制系统或公开分享。如需迁移配置,建议使用 ARDM 内置的「导出/导入连接」功能,导出时支持设置独立的加密密码。

更多问题请查阅 常见问题,或在 GitHub Issues 提交反馈。我们的社区非常活跃,通常 24 小时内即可获得回复。