{"id":13419410,"url":"https://github.com/laixintao/iredis","last_synced_at":"2026-10-19T07:26:16.345Z","repository":{"id":37390838,"uuid":"166371259","full_name":"laixintao/iredis","owner":"laixintao","description":"Interactive Redis: A Terminal Client for Redis with AutoCompletion and Syntax Highlighting.","archived":false,"fork":false,"pushed_at":"2026-09-21T08:43:17.000Z","size":4101,"stargazers_count":2763,"open_issues_count":49,"forks_count":119,"subscribers_count":16,"default_branch":"master","last_synced_at":"2026-10-18T13:14:14.999Z","etag":null,"topics":["command-line-tool","redis","redis-cli","redis-client"],"latest_commit_sha":null,"homepage":"https://iredis.xbin.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/laixintao.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"patreon":"laixintao","custom":["https://www.kawabangga.com/sponsor","http://paypal.me/laixintao"]}},"created_at":"2019-01-18T08:31:15.000Z","updated_at":"2026-10-16T20:31:42.000Z","dependencies_parsed_at":"2023-01-31T08:01:05.064Z","dependency_job_id":null,"html_url":"https://github.com/laixintao/iredis","commit_stats":{"total_commits":1466,"total_committers":31,"mean_commits":47.29032258064516,"dds":"0.26875852660300137","last_synced_commit":"1230f3fba7b7f4965c6e7908a4ae01135f936171"},"previous_names":[],"tags_count":111,"template":false,"template_full_name":null,"purl":"pkg:github/laixintao/iredis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laixintao%2Firedis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laixintao%2Firedis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laixintao%2Firedis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laixintao%2Firedis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/laixintao","download_url":"https://codeload.github.com/laixintao/iredis/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laixintao%2Firedis/sbom","scorecard":{"id":577406,"data":{"date":"2025-08-11","repo":{"name":"github.com/laixintao/iredis","commit":"a1f4be4e3003b5d52d31a6591b0c4d4b668f6dc5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"name":"Code-Review","score":1,"reason":"Found 2/15 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":5,"reason":"5 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/release.yaml:1","Warn: no topLevel permission defined: .github/workflows/test-binary-build.yaml:1","Warn: no topLevel permission defined: .github/workflows/test.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.15.2 not signed: https://api.github.com/repos/laixintao/iredis/releases/238367974","Warn: release artifact v1.15.1 not signed: https://api.github.com/repos/laixintao/iredis/releases/213659735","Warn: release artifact v1.15.0 not signed: https://api.github.com/repos/laixintao/iredis/releases/151134848","Warn: release artifact v1.14.1 not signed: https://api.github.com/repos/laixintao/iredis/releases/142301126","Warn: release artifact v1.14.0 not signed: https://api.github.com/repos/laixintao/iredis/releases/127301631","Warn: release artifact v1.15.2 does not have provenance: https://api.github.com/repos/laixintao/iredis/releases/238367974","Warn: release artifact v1.15.1 does not have provenance: https://api.github.com/repos/laixintao/iredis/releases/213659735","Warn: release artifact v1.15.0 does not have provenance: https://api.github.com/repos/laixintao/iredis/releases/151134848","Warn: release artifact v1.14.1 does not have provenance: https://api.github.com/repos/laixintao/iredis/releases/142301126","Warn: release artifact v1.14.0 does not have provenance: https://api.github.com/repos/laixintao/iredis/releases/127301631"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:128: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:139: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-binary-build.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test-binary-build.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-binary-build.yaml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test-binary-build.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-binary-build.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test-binary-build.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-binary-build.yaml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test-binary-build.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yaml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/laixintao/iredis/test.yaml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating redis/redis-stack-server:latest to redis/redis-stack-server:latest@sha256:3751e8743b31f28190bc93044350cde3ccf9363fda26966529cb00fc42ea54c1","Warn: pipCommand not pinned by hash: Dockerfile:7","Warn: pipCommand not pinned by hash: Dockerfile:11","Warn: pipCommand not pinned by hash: .github/workflows/release.yaml:38","Warn: pipCommand not pinned by hash: .github/workflows/release.yaml:39","Warn: pipCommand not pinned by hash: .github/workflows/release.yaml:92","Warn: pipCommand not pinned by hash: .github/workflows/release.yaml:93","Warn: pipCommand not pinned by hash: .github/workflows/release.yaml:115","Warn: pipCommand not pinned by hash: .github/workflows/test-binary-build.yaml:39","Warn: pipCommand not pinned by hash: .github/workflows/test-binary-build.yaml:40","Warn: pipCommand not pinned by hash: .github/workflows/test-binary-build.yaml:62","Warn: pipCommand not pinned by hash: .github/workflows/test.yaml:45","Warn: pipCommand not pinned by hash: .github/workflows/test.yaml:46","Warn: pipCommand not pinned by hash: .github/workflows/test.yaml:80","Info:   0 out of  18 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   3 out of  16 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 18 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T18:12:29.974Z","repository_id":37390838,"created_at":"2025-08-20T18:12:29.974Z","updated_at":"2025-08-20T18:12:29.974Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38339672,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line-tool","redis","redis-cli","redis-client"],"created_at":"2024-07-30T22:01:15.619Z","updated_at":"2026-10-19T07:26:16.327Z","avatar_url":"https://github.com/laixintao.png","language":"Python","funding_links":["https://patreon.com/laixintao","https://www.kawabangga.com/sponsor","http://paypal.me/laixintao"],"categories":["Python","Development","资源列表","Databases","Command Line Tools","命令行工具","Database Tools","语言资源库","Command-line Tools","CLI","Command-line Tools [🔝](#readme)","\u003ca name=\"data-management\"\u003e\u003c/a\u003eData management","Commandline Tool","Database Clients","Database \u0026 SQL Tools","Linux生态圈Dev\u0026Ops工具与服务"],"sub_categories":["Database","命令行工具","Management Tool","Learning Resources","python"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"100\" height=\"100\" src=\"https://raw.githubusercontent.com/laixintao/iredis/master/docs/assets/logo.png\" /\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eInteractive Redis: A Cli for Redis with AutoCompletion and Syntax Highlighting.\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/laixintao/iredis/actions\"\u003e\u003cimg src=\"https://github.com/laixintao/iredis/actions/workflows/test.yaml/badge.svg?branch=master\" alt=\"Github Action\"\u003e\u003c/a\u003e\n\u003ca href=\"https://badge.fury.io/py/iredis\"\u003e\u003cimg src=\"https://badge.fury.io/py/iredis.svg\" alt=\"PyPI version\"\u003e\u003c/a\u003e\n\u003cimg src=\"https://badgen.net/badge/python/3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14\" alt=\"Python version\"\u003e\n\u003ca href=\"https://pepy.tech/project/iredis\"\u003e\u003cimg src=\"https://pepy.tech/badge/iredis\" alt=\"Download stats\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./docs/assets/demo.svg\" alt=\"demo\"\u003e\n\u003c/p\u003e\n\nIRedis is a terminal client for redis with auto-completion and syntax\nhighlighting. IRedis lets you type Redis commands smoothly, and displays results\nin a user-friendly format.\n\nIRedis is an alternative for redis-cli. In most cases, IRedis behaves exactly\nthe same as redis-cli. Besides, it is safer to use IRedis on production servers\nthan redis-cli: IRedis will prevent accidentally running dangerous commands,\nlike `KEYS *` (see\n[Redis docs / Latency generated by slow commands](https://redis.io/topics/latency#latency-generated-by-slow-commands)).\n\n## Features\n\n- Advanced code completion. If you run command `KEYS` then run `DEL`, IRedis\n  will auto-complete your command based on `KEYS` result.\n- Command validation. IRedis will validate command while you are typing, and\n  highlight errors. E.g. try `CLUSTER MEET IP PORT`, IRedis will validate IP and\n  PORT for you.\n- Command highlighting, fully based on redis grammar. Any valid command in\n  IRedis shell is a valid redis command.\n- Human-friendly result display.\n- _pipeline_ feature, you can use your favorite shell tools to parse redis'\n  response, like `get json | jq .`.\n- Support pager for long output.\n- Support connection via URL, `iredis --url redis://example.com:6379/1`.\n- Support cluster, IRedis will auto reissue command for `MOVED` response in\n  cluster mode.\n- Support NAT mapping for Redis clusters  `--natmap\n  remoteHost:remotePort:localHost:localPort` (comma-separated for multiple\n  nodes).\n- Store server configuration: `iredis -d prod-redis` (see [dsn](#using-dsn) for\n  more).\n- `peek` command to check the key's type then automatically call\n  `get`/`lrange`/`sscan`, etc, depending on types. You don't need to call the\n  `type` command then type another command to get the value. `peek` will also\n  display the key's length and memory usage.\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eC\u003c/kbd\u003e to cancel the current typed command, this won't\n  exit IRedis, exactly like bash behaviour. Use \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eD\u003c/kbd\u003e\n  to send a EOF to exit IRedis.\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eR\u003c/kbd\u003e to open **reverse-i-search** to search through\n  your command history.\n- Auto suggestions. (Like [fish shell](http://fishshell.com/).)\n- Support `--decode=utf-8`, to decode Redis' bytes responses.\n- Command hint on bottom, include command syntax, supported redis version, and\n  time complexity.\n- Official docs with built-in `HELP` command, try `HELP SET`!\n- Written in pure Python, but IRedis was packaged into a single binary with\n  [PyOxidizer](https://github.com/indygreg/PyOxidizer), you can use cURL to\n  download and run, it just works, even you don't have a Python interpreter.\n- You can change the cli prompt using `--prompt` option or set via `~/.iredisrc`\n  config file.\n- Hide password for `AUTH` command.\n- Says \"Goodbye!\" to you when you exit!\n- For full features, please see: [iredis.xbin.io](https://www.iredis.xbin.io)\n\n## Install\n\nIRedis supports Python 3.10–3.14. CI also tests Python 3.15 prereleases in an\nexperimental job; prerelease failures do not block changes.\n\n### Pip\n\nInstall via pip:\n\n```\npip install iredis\n```\n\n[pipx](https://github.com/pipxproject/pipx) is recommended:\n\n```\npipx install iredis\n```\n\n### Brew\n\nFor Mac users, you can install iredis via brew 🍻\n\n```\nbrew install iredis\n```\n\n### Linux\n\nYou can also use your Linux package manager to install IRedis, like `apt` in\nUbuntu (Only available on Ubuntu 21.04+).\n\n```shell\napt install iredis\n```\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/iredis.svg)](https://repology.org/project/iredis/versions)\n\n### Download Binary\n\nOr you can download the executable binary with cURL(or wget), untar, then run.\nIt is especially useful when you don't have a python interpreter(E.g. the\n[official Redis docker image](https://hub.docker.com/_/redis/) which doesn't\nhave Python installed.):\n\n```\nwget  https://github.com/laixintao/iredis/releases/download/v1.15.2/iredis.tar.gz \\\n \u0026\u0026 tar -xzf iredis.tar.gz \\\n \u0026\u0026 ./iredis\n```\n\n(Check the [release page](https://github.com/laixintao/iredis/releases) if you\nwant to download an old version of IRedis.)\n\nPlease note that the single binary build only support until IRedis v1.15.2, all\nversions before IRedis v1.15.2 has the single binary build that you can download\ndirectly. After v1.15.2, as the PyOxidizer [is no longer maintained](\nhttps://gregoryszorc.com/blog/2024/03/17/my-shifting-open-source-priorities/),\nIRedis doesn't do the single binary build either.\n\n## Usage\n\nOnce you install IRedis, you will know how to use it. Just remember, IRedis\nsupports similar options like redis-cli, like `-h` for redis-server's host and\n`-p` for port.\n\nPass a command to execute it once, including from scripts with redirected stdin:\n\n```sh\niredis PING \u003c/dev/null\n```\n\nWhen no command is given, IRedis reads commands from piped stdin (for example,\n`echo PING | iredis`) or starts an interactive session when stdin is a terminal.\nAn explicit command takes precedence over piped input.\n\n```\n$ iredis --help\n\nUsage: iredis [OPTIONS] [CMD]...\n\n  IRedis: Interactive Redis\n\n  When no command is given, IRedis starts in interactive mode.\n\n  Examples:\n    - iredis\n    - iredis -d dsn\n    - iredis -h 127.0.0.1 -p 6379\n    - iredis -h 127.0.0.1 -p 6379 -a \u003cpassword\u003e\n    - iredis --url redis://localhost:7890/3\n\n  Type \"help\" in interactive mode for information on available commands and\n  settings.\n\nOptions:\n  -h TEXT                         Server hostname (default: 127.0.0.1).\n  -p TEXT                         Server port (default: 6379).\n  -s, --socket TEXT               Server socket (overrides hostname and port).\n  -n INTEGER                      Database number.(overwrites dsn/url's db\n                                  number)\n\n  -u, --username TEXT             User name used to auth, will be ignore for\n                                  redis version \u003c 6.\n\n  -a, --password TEXT             Password to use when connecting to the\n                                  server.\n\n  --url TEXT                      Use Redis URL to indicate connection(Can set\n                                  with env `IREDIS_URL`), Example:     redis:/\n                                  /[[username]:[password]]@localhost:6379/0\n                                  rediss://[[username]:[password]]@localhost:6\n                                  379/0     unix://[[username]:[password]]@/pa\n                                  th/to/socket.sock?db=0\n\n  -d, --dsn TEXT                  Use DSN configured into the [alias_dsn]\n                                  section of iredisrc file. (Can set with env\n                                  `IREDIS_DSN`)\n\n  --newbie / --no-newbie          Show command hints and useful helps.\n  --iredisrc TEXT                 Config file for iredis, default is\n                                  ~/.iredisrc.\n\n  --decode TEXT                   decode response, default is No decode, which\n                                  will output all bytes literals.\n\n  --client_name TEXT              Assign a name to the current connection.\n  --raw / --no-raw                Use raw formatting for replies (default when\n                                  STDOUT is not a tty). However, you can use\n                                  --no-raw to force formatted output even when\n                                  STDOUT is not a tty.\n\n  --rainbow / --no-rainbow        Display colorful prompt.\n  --shell / --no-shell            Allow to run shell commands, default to\n                                  True.\n\n  --pager / --no-pager            Using pager when output is too tall for your\n                                  window, default to True.\n\n  --verify-ssl [none|optional|required]\n                                  Set the TLS certificate verification\n                                  strategy\n\n  --prompt TEXT                   Prompt format (supported interpolations:\n                                  {client_name}, {db}, {host}, {path}, {port},\n                                  {username}, {client_addr}, {client_id}).\n\n  --version                       Show the version and exit.\n  --help                          Show this message and exit.\n\n```\n\n### Using DSN\n\nIRedis support storing server configuration in config file. Here is a DSN\nconfig:\n\n```\n[alias_dsn]\ndev=redis://localhost:6379/4\nstaging=redis://username:password@staging-redis.example.com:6379/1\n```\n\nPut this in your `iredisrc` then connect via `iredis -d staging` or\n`iredis -d dev`.\n\n### Using `--natmap` with Redis Cluster\n\nUse `--natmap` when you can connect to a Redis Cluster through local forwarded\nports, but the cluster nodes still advertise different remote or private\naddresses in `MOVED` replies. This usually happens when the cluster is behind\nSSH tunnels, Docker port publishing, Kubernetes port-forwarding, or another NAT\nlayer.\n\n`--natmap` tells IRedis how to translate the address announced by Redis into\nthe address that is actually reachable from your machine.\n\nFormat:\n\n```shell\niredis --natmap remoteHost:remotePort:localHost:localPort\n```\n\nUse a comma-separated list when more than one cluster node needs translation.\n\nExample: suppose the cluster replies with node addresses on a private network:\n\n```text\n10.0.0.11:6379\n10.0.0.12:6379\n10.0.0.13:6379\n```\n\nbut you access those nodes locally through SSH tunnels:\n\n```text\n127.0.0.1:7001\n127.0.0.1:7002\n127.0.0.1:7003\n```\n\nthen start IRedis like this:\n\n```shell\niredis -h 127.0.0.1 -p 7001 \\\n  --natmap 10.0.0.11:6379:127.0.0.1:7001,10.0.0.12:6379:127.0.0.1:7002,10.0.0.13:6379:127.0.0.1:7003\n```\n\nNow when a command hits the wrong node and Redis returns `MOVED 12182\n10.0.0.12:6379`, IRedis will reconnect to `127.0.0.1:7002` and reissue the\ncommand automatically.\n\n### Change The Default Prompt\n\nYou can change the prompt str, the default prompt is:\n\n```shell\n127.0.0.1:6379\u003e\n```\n\nWhich is rendered by `{host}:{port}[{db}]\u003e `, you can change this via `--prompt`\noption or change\n[iredisrc](https://github.com/laixintao/iredis/blob/master/iredis/data/iredisrc)\nconfig file. The prompwt string uses python string format engine, supported\ninterpolations:\n\n- `{client_name}`\n- `{db}`\n- `{host}`\n- `{path}`\n- `{port}`\n- `{username}`\n- `{client_addr}`\n- `{client_id}`\n\nThe `--prompt` utilize\n[Python String format engine](https://docs.python.org/3/library/string.html#formatstrings),\nso as long as it is a valid string formatter, it will work( anything that\n`\"\u003cyour prompt\u003e\".format(...)` accepts). For example, you can limit your Redis\nserver host name's length to 5 by setting `--prompt` to\n`iredis --prompt '{host:.5s}'`.\n\n### Configuration\n\nIRedis supports config files. Command-line options will always take precedence\nover config. Configuration resolution from highest to lowest precedence is:\n\n- _Options from command line_\n- `$PWD/.iredisrc`\n- `~/.iredisrc` (this path can be changed with `iredis --iredisrc $YOUR_PATH`)\n- `/etc/iredisrc`\n- default config in IRedis package.\n\nYou can copy the _self-explained_ default config here:\n\nhttps://raw.githubusercontent.com/laixintao/iredis/master/iredis/data/iredisrc\n\nAnd then make your own changes.\n\n(If you are using an old versions of IRedis, please use the config file below,\nand change the version in URL):\n\nhttps://raw.githubusercontent.com/laixintao/iredis/v1.0.4/iredis/data/iredisrc\n\n### Keys\n\nIRedis support unix/readline-style REPL keyboard shortcuts, which means keys\nlike \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eF\u003c/kbd\u003e to forward work.\n\nAlso:\n\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eD\u003c/kbd\u003e (i.e. EOF) to exit; you can also use the `exit`\n  command.\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eL\u003c/kbd\u003e to clear screen; you can also use the `clear`\n  command.\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eX\u003c/kbd\u003e \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eE\u003c/kbd\u003e to open an\n  editor to edit command, or \u003ckbd\u003eV\u003c/kbd\u003e in vi-mode.\n\n## Development\n\n### Release Strategy\n\nIRedis is built and released by `GitHub Actions`. Whenever a tag is pushed to\nthe `master` branch, a new release is built and uploaded to pypi.org, it's very\nconvenient.\n\nThus, we release as often as possible, so that users can always enjoy the new\nfeatures and bugfixes quickly. Any bugfix or new feature will get at least a\npatch release, whereas big features will get a minor release.\n\n### Setup Environment\n\nIRedis favors [poetry](https://github.com/sdispater/poetry) as package\nmanagement tool. To setup a develop environment on your computer:\n\nFirst, install poetry (you can do it in a python's virtualenv):\n\n```\npip install poetry\n```\n\nThen run (which is similar to `pip install -e .`):\n\n```\npoetry install\n```\n\n**Be careful running testcases locally, it may flush you db!!!**\n\nWith a dedicated Redis server listening on `localhost:6379`, run the full suite\n(including interactive CLI tests) with the matching Redis version:\n\n```bash\nREDIS_VERSION=7.2 poetry run pytest\n```\n\n### Code style\n\nCode is formatted with [black](https://github.com/psf/black). After modifying code, run:\n\n```bash\nblack .\n```\n\nWe recommend installing [pre-commit](https://pre-commit.com/) so black and flake8 run automatically on each `git commit`:\n\n```bash\npoetry run pre-commit install\n```\n\n### Development Logs\n\nThis is a command-line tool, so we don't write logs to stdout.\n\nYou can `tail -f ~/.iredis.log` to see logs, the log is pretty clear, you can\nsee what actually happens from log files.\n\n### Catch Up with Latest Redis-doc\n\nIRedis use a git submodule to track current-up-to-date redis-doc version. To\ncatch up with latest:\n\n1. Git pull in redis-doc\n2. Copy doc files to `/data`: `cp -r redis-doc/commands* iredis/data`\n3. Prettier\n   markdown`prettier --prose-wrap always iredis/data/commands/*.md --write`\n4. Check the diff, update IRedis' code if needed.\n\n## Related Projects\n\n- [redis-tui](https://github.com/mylxsw/redis-tui)\n\nIf you like iredis, you may also like other cli tools by\n[dbcli](https://www.dbcli.com/):\n\n- [pgcli](https://www.pgcli.com) - Postgres Client with Auto-completion and\n  Syntax Highlighting\n- [mycli](https://www.mycli.net) - MySQL/MariaDB/Percona Client with\n  Auto-completion and Syntax Highlighting\n- [litecli](https://litecli.com) - SQLite Client with Auto-completion and Syntax\n  Highlighting\n- [mssql-cli](https://github.com/dbcli/mssql-cli) - Microsoft SQL Server Client\n  with Auto-completion and Syntax Highlighting\n- [athenacli](https://github.com/dbcli/athenacli) - AWS Athena Client with\n  Auto-completion and Syntax Highlighting\n- [vcli](https://github.com/dbcli/vcli) - VerticaDB client\n- [iredis](https://github.com/laixintao/iredis/) - Client for Redis with\n  AutoCompletion and Syntax Highlighting\n\nIRedis is build on the top of\n[prompt_toolkit](https://github.com/jonathanslenders/python-prompt-toolkit), a\nPython library (by [Jonathan Slenders](https://twitter.com/jonathan_s)) for\nbuilding rich commandline applications.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaixintao%2Firedis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaixintao%2Firedis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaixintao%2Firedis/lists"}