laixintao/iredis 源码下载与部署教程

项目概述

Interactive Redis: A Terminal Client for Redis with AutoCompletion and Syntax Highlighting.

项目地址

https://github.com/laixintao/iredis

项目页面预览

关键指标

• Stars：2723
• 主要语言：Python
• License：BSD 3-Clause “New” or “Revised” License
• 最近更新：2025-08-07T16:06:12Z
• 默认分支：master

本站高速下载（国内可用）

点击下载（本站镜像）
– SHA256：c576374445d5f64ea7935e6c501d76f4c140cd69f9165dcaeed7c1095ac97b0d

安装部署要点（README 精选）

Install

Usage

Once you install IRedis, you will know how to use it. Just remember, IRedis
supports similar options like redis-cli, like -h for redis-server’s host and
-p for port.

$ iredis --help

Usage: iredis [OPTIONS] [CMD]...

  IRedis: Interactive Redis

  When no command is given, IRedis starts in interactive mode.

  Examples:
    - iredis
    - iredis -d dsn
    - iredis -h 127.0.0.1 -p 6379
    - iredis -h 127.0.0.1 -p 6379 -a <password>
    - iredis --url redis://localhost:7890/3

  Type "help" in interactive mode for information on available commands and
  settings.

Options:
  -h TEXT                         Server hostname (default: 127.0.0.1).
  -p TEXT                         Server port (default: 6379).
  -s, --socket TEXT               Server socket (overrides hostname and port).
  -n INTEGER                      Database number.(overwrites dsn/url's db
                                  number)

  -u, --username TEXT             User name used to auth, will be ignore for
                                  redis version < 6.

  -a, --password TEXT             Password to use when connecting to the
                                  server.

  --url TEXT                      Use Redis URL to indicate connection(Can set
                                  with env `IREDIS_URL`), Example:     redis:/
                                  /[[username]:[password]]@localhost:6379/0
                                  rediss://[[username]:[password]]@localhost:6
                                  379/0     unix://[[username]:[password]]@/pa
                                  th/to/socket.sock?db=0

  -d, --dsn TEXT                  Use DSN configured into the [alias_dsn]
                                  section of iredisrc file. (Can set with env
                                  `IREDIS_DSN`)

  --newbie / --no-newbie          Show command hints and useful helps.
  --iredisrc TEXT                 Config file for iredis, default is
                                  ~/.iredisrc.

  --decode TEXT                   decode response, default is No decode, which
                                  will output all bytes literals.

  --client_name TEXT              Assign a name to the current connection.
  --raw / --no-raw                Use raw formatting for replies (default when
                                  STDOUT is not a tty). However, you can use
                                  --no-raw to force formatted output even when
                                  STDOUT is not a tty.

  --rainbow / --no-rainbow        Display colorful prompt.
  --shell / --no-shell            Allow to run shell commands, default to
                                  True.

  --pager / --no-pager            Using pager when output is too tall for your
                                  window, default to True.

  --verify-ssl [none|optional|required]
                                  Set the TLS certificate verification
                                  strategy

  --prompt TEXT                   Prompt format (supported interpolations:
                                  {client_name}, {db}, {host}, {path}, {port},
                                  {username}, {client_addr}, {client_id}).

  --version                       Show the version and exit.
  --help                          Show this message and exit.

Configuration

IRedis supports config files. Command-line options will always take precedence
over config. Configuration resolution from highest to lowest precedence is:

• Options from command line
• $PWD/.iredisrc
• ~/.iredisrc (this path can be changed with iredis --iredisrc $YOUR_PATH)
• /etc/iredisrc
• default config in IRedis package.

You can copy the self-explained default config here:

https://raw.githubusercontent.com/laixintao/iredis/master/iredis/data/iredisrc

And then make your own changes.

(If you are using an old versions of IRedis, please use the config file below,
and change the version in URL):

https://raw.githubusercontent.com/laixintao/iredis/v1.0.4/iredis/data/iredisrc

Setup Environment

IRedis favors poetry as package
management tool. To setup a develop environment on your computer:

First, install poetry (you can do it in a python’s virtualenv):

pip install poetry

Then run (which is similar to pip install -e .):

poetry install

Be careful running testcases locally, it may flush you db!!!

常用命令（从 README 提取）

pip install iredis

pipx install iredis

brew install iredis

通用部署说明

1. 下载源码并阅读 README
2. 安装依赖（pip/npm/yarn 等）
3. 配置环境变量（API Key、模型路径、数据库等）
4. 启动服务并测试访问
5. 上线建议：Nginx 反代 + HTTPS + 进程守护（systemd / pm2）

免责声明与版权说明

本文仅做开源项目整理与教程索引，源码版权归原作者所有，请遵循对应 License 合规使用。