From 7f236219ddbd040764dd821cbcbd44899dd57c90 Mon Sep 17 00:00:00 2001 From: hengyunabc Date: Mon, 17 Sep 2018 10:56:21 +0800 Subject: [PATCH] update doc about install. --- site/src/site/sphinx/install-detail.md | 22 ++++++++++++++++++---- site/src/site/sphinx/manual-install.md | 10 ++++++---- site/src/site/sphinx/quick-start.md | 8 +++++++- 3 files changed, 31 insertions(+), 9 deletions(-) diff --git a/site/src/site/sphinx/install-detail.md b/site/src/site/sphinx/install-detail.md index 3f44da0d6..3984ed2f1 100644 --- a/site/src/site/sphinx/install-detail.md +++ b/site/src/site/sphinx/install-detail.md @@ -12,14 +12,26 @@ curl -L https://alibaba.github.io/arthas/install.sh | sh 上述命令将会下载的启动脚本文件 `as.sh` 到当前目录，你可以放在任何地方或将其加入到 $PATH 中。 +直接在shell下面执行`./as.sh`，就会进入交互界面。 + +也可以执行`./as.sh -h`来获取更多参数信息。 + ## Windows -下载最新的 zip 包，解压后运行 bin 目录下的 `as.bat`。 +最新版本：[![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22) + -下载地址：[arthas-packaging-3.0.0-RC-bin.zip](https://search.maven.org/remotecontent?filepath=com/taobao/arthas/arthas-packaging/3.0.0-RC/arthas-packaging-3.0.0-RC-bin.zip) +在`Download`栏下载最新的 `bin.zip` 包，解压后在bin目录有 `as.bat`。此脚本暂时只接受一个参数 pid，即只能诊断本机上的 Java 进程。（欢迎精通bat脚本的开发者改进） -Windows用户如果在cmd里不能正常显示颜色，可以使用[conemu](https://sourceforge.net/projects/conemu)。 +``` +as.bat pid +``` + +如果需要更好的体验，可以在本地使用 `as.bat pid` 启动 Arthas Server 后，然后在另外的 Linux/Mac 上使用 as.bat pid@ip:port 来远程诊断。 + + +> Windows用户如果在cmd里不能正常显示颜色，可以使用[conemu](https://sourceforge.net/projects/conemu)。 ## 手动安装 @@ -28,7 +40,9 @@ Windows用户如果在cmd里不能正常显示颜色，可以使用[conemu](http ## 离线帮助文档 -下载地址：[arthas-packaging-3.0.0-RC-doc.zip](https://search.maven.org/remotecontent?filepath=com/taobao/arthas/arthas-packaging/3.0.0-RC/arthas-packaging-3.0.0-RC-doc.zip) +最新版本：[![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22) + +在`Download`栏下载最新的 `doc.zip` 包， ## 卸载 diff --git a/site/src/site/sphinx/manual-install.md b/site/src/site/sphinx/manual-install.md index bf2476d03..501cd5274 100644 --- a/site/src/site/sphinx/manual-install.md +++ b/site/src/site/sphinx/manual-install.md @@ -1,10 +1,12 @@ 手动安装Arthas === -1. 从[这里](http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22)下载最新版本, 以`3.0.0-RC`这个版本为例。 - ``` - wget https://search.maven.org/remotecontent?filepath=com/taobao/arthas/arthas-packaging/3.0.0-RC/arthas-packaging-3.0.0-RC-bin.zip -o arthas-packaging-bin.zip - ``` +1. 下载最新版本 + + 最新版本：[![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22) + + 在`Download`栏下载最新的 `bin.zip` 包。 + 2. 解压缩arthas的压缩包 ``` diff --git a/site/src/site/sphinx/quick-start.md b/site/src/site/sphinx/quick-start.md index 88ecf398a..fc8dbd0c3 100644 --- a/site/src/site/sphinx/quick-start.md +++ b/site/src/site/sphinx/quick-start.md @@ -139,4 +139,10 @@ ts=2018-09-10 17:53:14;result=@Integer[624] ts=2018-09-10 17:53:15;result=@Integer[625] ``` -更多的功能可以查看[进阶使用](advanced-use.md)。 \ No newline at end of file +更多的功能可以查看[进阶使用](advanced-use.md)。 + +## 退出arthas + +如果只是退出当前的连接，可以用`quit`或者`exit`命令。Attach到目标进程上的arthas还会继续运行，端口会保持开放，下次连接时可以直接连接上。 + +如果想完全退出arthas，可以执行`shutdown`命令。 \ No newline at end of file