Skip to content

Commit

Permalink
add Cli args to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
qishibo committed Feb 1, 2024
1 parent 76b8ab3 commit d8aba78
Show file tree
Hide file tree
Showing 2 changed files with 146 additions and 0 deletions.
73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,79 @@ This project exists thanks to all the people who contribute.
| `/bin/node` | `/home/qii/node_decoder.js {HEX} --key={KEY}` |



## Start From Command Line(CLI)

> If you want to start from command line(CLI), you can pass args to the App.
### Examples

```bash
# Linux
# ./Another Redis Desktop Manager.AppImage

# Mac
# open /Applications/Another\ Redis\ Desktop\ Manager.app --args

# Windows
"D:\xxxx\Another Redis Desktop Manager.exe"

# COMMON
--host 127.0.0.1 --port 6379 --auth 123
--name tmp_connection

# CLUSTER
--cluster

# SSH
--ssh-host 192.168.0.110
--ssh-username root --ssh-password 123

# SENTINEL
--sentinel-master-name mymaster
--sentinel-node-password 123

# save connection
--save
# readonly mode
--readonly
```

### Parameter Description

#### Common

| Args | Description | Args | Description |
| ------ | ------ | ------ | ------ |
| --host | Redis host* | --port | Redis port|
| --auth | Password | --name | Custom name|
| --separator | Key separator | --readonly | Readonly mode|
| --username | Username(Redis6 ACL)| --save| Save connection|

#### SSH

| Args | Description | Args | Description |
| ------ | ------ | ------ | ------ |
| --ssh-host | SSH host | --ssh-port | SSH port(default:22)|
| --ssh-username | Username | --ssh-password | Password|
| --ssh-private-key | Path of private key | --ssh-passphrase | Password of private key|
| --ssh-timeout | SSH timeout(s) | |  |

#### CLUSTER

| Args | Description |
| ------ | ------ |
| --cluster | Enable CLUSTER mode |

#### SENTINEL

| Args | Description |
| ------ | ------ |
| --sentinel-master-name | Name of master group,like 'mymaster' |
| --sentinel-node-password | Password of Redis node |



## FAQ

#### 1. How to connect to Redis Cluster in internal network (such as Docker, LAN, AWS)?
Expand Down
73 changes: 73 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,79 @@ npm run pack:linux
| `/bin/node` | `/home/qii/node_decoder.js {HEX} --key={KEY}` |



## 命令行启动

> 如果你有需求从命令行启动程序,可以通过如下方式,自定义不同的连接参数。
### 示例

```bash
# Linux
# ./Another Redis Desktop Manager.AppImage

# Mac
# open /Applications/Another\ Redis\ Desktop\ Manager.app --args

# Windows
"D:\xxxx\Another Redis Desktop Manager.exe"

# COMMON
--host 127.0.0.1 --port 6379 --auth 123
--name tmp_connection

# CLUSTER
--cluster

# SSH
--ssh-host 192.168.0.110
--ssh-username root --ssh-password 123

# SENTINEL
--sentinel-master-name mymaster
--sentinel-node-password 123

# save connection
--save
# readonly mode
--readonly
```

### 参数说明

#### 通用

| 参数 | 说明 | 参数 | 说明 |
| ------ | ------ | ------ | ------ |
| --host | 地址* | --port | 端口|
| --auth | 密码 | --name | 自定义名称|
| --separator | 分隔符 | --readonly | 开启只读模式|
| --username | 用户名(Redis6 ACL)| --save| 保存连接(默认不保存)|

#### SSH

| 参数 | 说明 | 参数 | 说明 |
| ------ | ------ | ------ | ------ |
| --ssh-host | 地址 | --ssh-port | 端口(默认22)|
| --ssh-username | 用户名 | --ssh-password | 密码|
| --ssh-private-key | 私钥路径 | --ssh-passphrase | 私钥密码|
| --ssh-timeout | 超时(秒) | |  |

#### CLUSTER

| 参数 | 说明 |
| ------ | ------ |
| --cluster | 开启集群模式 |

#### SENTINEL

| 参数 | 说明 |
| ------ | ------ |
| --sentinel-master-name | Master组名称,如mymaster |
| --sentinel-node-password | Redis节点密码 |



## FAQ

#### 1. 内网中的Redis集群如何连接(如Docker内,局域网内,AWS内)?
Expand Down

0 comments on commit d8aba78

Please sign in to comment.