Skip to content

Commit

Permalink
Merge pull request #163 from hengyoush/improve-doc
Browse files Browse the repository at this point in the history
docs: improve docs highlights root privielge
  • Loading branch information
hengyoush authored Dec 11, 2024
2 parents 14640b1 + 1ba8de4 commit cecce79
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,15 +90,15 @@ Kyanos currently supports kernel versions 3.10(from 3.10.0-957) and 4.14 or abov

## 🎯 How to get kyanos

You can download a statically linked binary compatible with x86_64 and arm64 architectures from the [release page](https://github.com/hengyoush/kyanos/releases):
You can download a statically linked binary compatible with amd64 and arm64 architectures from the [release page](https://github.com/hengyoush/kyanos/releases):

```bash
tar xvf kyanos_vx.x.x_linux_x86.tar.gz
tar xvf kyanos_vx.x.x_linux_amd64.tar.gz
```

Then, run:
Then, run kyanos with **root privilege**:
```bash
kyanos watch
sudo ./kyanos watch
```

If the following table appears:
Expand All @@ -114,7 +114,7 @@ If the following table appears:
The simplest usage captures all protocols currently supported by Kyanos:

```bash
./kyanos watch
sudo ./kyanos watch
```

Each request-response record is stored as a row in a table, with each column capturing basic information about that request. You can use the arrow keys or `j/k` to move up and down through the records:
Expand Down
10 changes: 5 additions & 5 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,15 @@ Kyanos当前支持3.10(3.10.0-957以上)及4.14以上版本内核(4.7版本到4.
[Chinese Document](https://kyanos.io/cn/)

## 🎯 How to get kyanos
你可以从 [release page](https://github.com/hengyoush/kyanos/releases) 中下载以静态链接方式编译的适用于 x86_64 和 arm64 架构的二进制文件:
你可以从 [release page](https://github.com/hengyoush/kyanos/releases) 中下载以静态链接方式编译的适用于 amd64 和 arm64 架构的二进制文件:

```bash
tar xvf kyanos_vx.x.x_linux_x86.tar.gz
tar xvf kyanos_vx.x.x_linux_amd64.tar.gz
```

然后输入
然后以 **root 权限**执行如下命令:
```bash
kyanos watch
sudo ./kyanos watch
```

如果显示了下面的表格:
Expand All @@ -105,7 +105,7 @@ kyanos watch
最简单的用法如下,抓取所有 kyanos 当前能够识别的协议

```bash
./kyanos watch
sudo ./kyanos watch
```
每个请求响应记录会记录在表格中的一行,每列记录这个请求的基本信息。你可以通过方向键或者j/k上下移动来选择记录:
![kyanos watch result](docs/public/watch-result.jpg)
Expand Down
8 changes: 4 additions & 4 deletions docs/cn/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ next: false

## 安装并运行 {#prerequire}

你可以从 [release page](https://github.com/hengyoush/kyanos/releases) 中下载以静态链接方式编译的适用于 x86_64 和 arm64 架构的二进制文件:
你可以从 [release page](https://github.com/hengyoush/kyanos/releases) 中下载以静态链接方式编译的适用于 amd64 和 arm64 架构的二进制文件:

```bash
tar xvf kyanos_vx.x.x_linux_x86.tar.gz
tar xvf kyanos_vx.x.x_linux_amd64.tar.gz
```

然后输入
然后以 **root** 权限执行如下命令:
```bash
kyanos watch
sudo ./kyanos watch
```

如果显示了下面的表格:
Expand Down
8 changes: 4 additions & 4 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ next: false

## Installation and Running {#prerequire}

You can download a statically linked binary compatible with x86_64 and arm64 architectures from the [release page](https://github.com/hengyoush/kyanos/releases):
You can download a statically linked binary compatible with amd64 and arm64 architectures from the [release page](https://github.com/hengyoush/kyanos/releases):

```bash
tar xvf kyanos_vx.x.x_linux_x86.tar.gz
tar xvf kyanos_vx.x.x_linux_amd64.tar.gz
```

Then, run:
Then, run kyanos with **root privilege**:
```bash
kyanos watch
sudo ./kyanos watch
```

If the following table appears:
Expand Down

0 comments on commit cecce79

Please sign in to comment.