Install Arthas¶

Linux/Unix/Mac¶

You can install Arthas with one single line command on Linux, Unix, and Mac. Pls. copy the following command and paste it into the command line, then press Enter to run:

curl -L https://alibaba.github.io/arthas/install.sh | sh

The command above will download the bootstrap script as.sh to the current directory. You can move it the any other place you want, or put its location in $PATH.

You can enter its interactive interface by executing as.sh, or execute as.sh -h for more help information.

Windows¶

Latest Version:

Download the latest bin.zip, unzip the package, and find as.bat from ‘bin’ directory. For now this script will only take one argument pid, which means you can only diagnose the local Java process. (Welcome any bat script expert to make it better :heart:)

as.bat <pid>

To have a better experience, you can start the Arthas Server locally by executing as.bat <pid>, then run ./as.sh <pid>@<ip>:<por> in another Linux/Unix/Mac machine.

If the color is not working as expect on windows, you can use conemu to get it to work.

Manual Installation¶

Manual Installation

If you fail to boot Arthas with the provided batch file, you could try to assemble the bootstrap command in the following way.

Locate java in the target JVM:
- Linux/Unix/Mac: ps aux | grep java
- Windows: open the Process Monitor to search java
Assemble bootstrap command:

Let’s suppose we are using /opt/jdk1.8/bin/java, then the command should be:
```
/opt/jdk1.8/bin/java -Xbootclasspath/a:/opt/jdk1.8/lib/tools.jar \
    -jar /tmp/arthas-packaging/arthas-core.jar \
    -pid 15146 \
    -target-ip 127.0.0.1 -telnet-port 3658 -http-port 8563 \
    -core /tmp/arthas-packaging/arthas-core.jar \
    -agent /tmp/arthas-packaging/arthas/arthas-agent.jar
```
Note:
- -Xbootclasspath adds tools.jar
- -jar /tmp/arthas-packaging/arthas-core.jar specifies main entry
- -pid 15146 specifies the target java process PID
- -target-ip 127.0.0.1 specifies the IP
- -telnet-port 3658 -http-port 8563 specifies telnet and HTTP ports for remote access
- -core /tmp/arthas-packaging/arthas-core.jar -agent /tmp/arthas-packaging/arthas/arthas-agent.jar specifies core/agent jar package
If you are running on JDK 1.9 or above，then it’s unncessary to add tools.jar in option -Xbootclasspath.

You can find the logs from ~/logs/arthas/arthas.log.
Use telnet to connect once attaching to the target JVM (in step 2) succeeds
```
telnet localhost 3658
```

Offline Help Documentation¶

Latest Version:

Download the latest doc.zip.

Uninstall¶

On Linux/Unix/Mac, delete the files with the following command:
```
rm -rf ~/.arthas/ ~/.arthas_history
```
On Windows, simply delete the zip file and unzipped files.