<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< title > Install Arthas — Arthas 3.3.7 documentation< / title >
< link rel = "shortcut icon" href = "_static/favicon.ico" / >
< script type = "text/javascript" src = "_static/js/modernizr.min.js" > < / script >
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/language_data.js" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/overrides.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "Download" href = "download.html" / >
< link rel = "prev" title = "Arthas Documentation" href = "index.html" / >
< script src = "_static/center_page.js" > < / script >
< link rel = "stylesheet" href = "https://g.alicdn.com/code/lib/highlight.js/9.13.1/styles/github.min.css" >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "index.html" class = "icon icon-home" > Arthas
< / a >
< div class = "version" >
3.3.7
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul class = "current" >
< li class = "toctree-l1" > < a class = "reference external" href = "https://alibaba.github.io/arthas/arthas-tutorials?language=en" > Online tutorials(Recommend)< / a > < / li >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > Installation< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#quick-installation" > Quick installation< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "#use-arthas-boot-recommended" > Use < code class = "docutils literal notranslate" > < span class = "pre" > arthas-boot< / span > < / code > (Recommended)< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#use-as-sh" > Use < code class = "docutils literal notranslate" > < span class = "pre" > as.sh< / span > < / code > < / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#full-installation" > Full installation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#manual-installation" > Manual Installation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#installation-via-packages" > Installation via Packages< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "#instruction-for-debian-based-systems" > Instruction for Debian based systems< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#instruction-for-fedora-based-systems" > Instruction for Fedora based systems< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#usage" > Usage< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#offline-help-documentation" > Offline Help Documentation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#uninstall" > Uninstall< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "download.html" > Download< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "quick-start.html" > Quick start< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "advanced-use.html" > Advanced usage< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "commands.html" > Commands< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "web-console.html" > WebConsole< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "docker.html" > Docker< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "spring-boot-starter.html" > Arthas Spring Boot Starter< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/alibaba/arthas/issues?q=label%3Auser-case" > User cases< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/alibaba/arthas/issues?q=label%3Aquestion-answered" > Questions and answers< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/alibaba/arthas" > Fork me at GitHub< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md#" > Compile and debug/CONTRIBUTING< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/alibaba/arthas/releases" > Release Notes< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "contact-us.html" > Contact us< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "index.html" > Arthas< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > Install Arthas< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/en/install-detail.md" class = "fa fa-github" > Edit on GitHub< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "install-arthas" >
< h1 > Install Arthas< a class = "headerlink" href = "#install-arthas" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "quick-installation" >
< h2 > Quick installation< a class = "headerlink" href = "#quick-installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "section" id = "use-arthas-boot-recommended" >
< h3 > Use < code class = "docutils literal notranslate" > < span class = "pre" > arthas-boot< / span > < / code > (Recommended)< a class = "headerlink" href = "#use-arthas-boot-recommended" title = "Permalink to this headline" > ¶< / a > < / h3 >
< p > Download< code class = "docutils literal notranslate" > < span class = "pre" > arthas-boot.jar< / span > < / code > , Start with < code class = "docutils literal notranslate" > < span class = "pre" > java< / span > < / code > command:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > curl -O https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar< / pre > < / div >
< / div >
< p > Print usage:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > java -jar arthas-boot.jar -h< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "use-as-sh" >
< h3 > Use < code class = "docutils literal notranslate" > < span class = "pre" > as.sh< / span > < / code > < a class = "headerlink" href = "#use-as-sh" title = "Permalink to this headline" > ¶< / a > < / h3 >
< p > 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 < em > Enter< / em > to run:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > curl -L https://alibaba.github.io/arthas/install.sh | sh< / pre > < / div >
< / div >
< p > The command above will download the bootstrap script < code class = "docutils literal notranslate" > < span class = "pre" > as.sh< / span > < / code > to the current directory. You can move it to any other place you want, or put its location in < code class = "docutils literal notranslate" > < span class = "pre" > $PATH< / span > < / code > .< / p >
< p > You can enter its interactive interface by executing < code class = "docutils literal notranslate" > < span class = "pre" > as.sh< / span > < / code > , or execute < code class = "docutils literal notranslate" > < span class = "pre" > as.sh< / span > < span class = "pre" > -h< / span > < / code > for more help information.< / p >
< / div >
< / div >
< div class = "section" id = "full-installation" >
< h2 > Full installation< a class = "headerlink" href = "#full-installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Latest Version, Click To Download: < a class = "reference external" href = "http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=doc&v=LATEST" > < img alt = "https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" src = "https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" / > < / a > < / p >
< p > Download and unzip, find < code class = "docutils literal notranslate" > < span class = "pre" > arthas-boot.jar< / span > < / code > in the directory. Start with < code class = "docutils literal notranslate" > < span class = "pre" > java< / span > < / code > command:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > java -jar arthas-boot.jar< / pre > < / div >
< / div >
< p > Print usage:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > java -jar arthas-boot.jar -h< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "manual-installation" >
< h2 > Manual Installation< a class = "headerlink" href = "#manual-installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > < a class = "reference internal" href = "manual-install.html" > < span class = "doc" > Manual Installation< / span > < / a > < / p >
< / div >
< div class = "section" id = "installation-via-packages" >
< h2 > Installation via Packages< a class = "headerlink" href = "#installation-via-packages" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Arthas has packages for Debian and Fedora based systems.
you can get them from the github releases page https://github.com/alibaba/arthas/releases.< / p >
< div class = "section" id = "instruction-for-debian-based-systems" >
< h3 > Instruction for Debian based systems< a class = "headerlink" href = "#instruction-for-debian-based-systems" title = "Permalink to this headline" > ¶< / a > < / h3 >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > sudo dpkg -i arthas*.deb< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "instruction-for-fedora-based-systems" >
< h3 > Instruction for Fedora based systems< a class = "headerlink" href = "#instruction-for-fedora-based-systems" title = "Permalink to this headline" > ¶< / a > < / h3 >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > sudo rpm -i arthas*.rpm< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "usage" >
< h3 > Usage< a class = "headerlink" href = "#usage" title = "Permalink to this headline" > ¶< / a > < / h3 >
< p > After the installation of packages, execute< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > as.sh< / pre > < / div >
< / div >
< / div >
< / div >
< div class = "section" id = "offline-help-documentation" >
< h2 > Offline Help Documentation< a class = "headerlink" href = "#offline-help-documentation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Latest Version Documentation, Click To Download:< a class = "reference external" href = "http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=doc&v=LATEST" > < img alt = "https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" src = "https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" / > < / a > < / p >
< / div >
< div class = "section" id = "uninstall" >
< h2 > Uninstall< a class = "headerlink" href = "#uninstall" title = "Permalink to this headline" > ¶< / a > < / h2 >
< ul >
< li > < p > On Linux/Unix/Mac, delete the files with the following command:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > rm -rf ~/.arthas/
rm -rf ~/logs/arthas/< / pre > < / div >
< / div >
< / li >
< li > < p > On Windows, delete < code class = "docutils literal notranslate" > < span class = "pre" > .arthas< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > logs/arthas< / span > < / code > directory under user home.< / p > < / li >
< / ul >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "download.html" class = "btn btn-neutral float-right" title = "Download" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
< a href = "index.html" class = "btn btn-neutral float-left" title = "Arthas Documentation" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2018-2020, Alibaba Middleware Group, and contributors
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< div class = "github-fork-ribbon-wrapper right" >
< div class = "github-fork-ribbon" >
< a href = "https://github.com/alibaba/arthas" target = "_blank" > Fork me at GitHub< / a >
< / div >
< / div >
< script type = "text/javascript" src = "_static/add_badges.js" > < / script >
< script src = "https://g.alicdn.com/code/lib/highlight.js/9.13.1/highlight.min.js" > < / script >
< script src = "https://g.alicdn.com/code/lib/highlightjs-line-numbers.js/2.5.0/highlightjs-line-numbers.min.js" > < / script >
< script >
document.querySelectorAll('div.hljs > pre').forEach(function(block) {
hljs.highlightBlock(block);
hljs.lineNumbersBlock(block);
});
< / script >
< script >
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
if (window.location.hostname == "arthas.gitee.io") {
hm.src = "https://hm.baidu.com/hm.js?ecc1b0d9aeb73da1671876133211d4d3";
} else { // https://alibaba.github.io/arthas/
hm.src = "https://hm.baidu.com/hm.js?d5c5e25b100f0eb51a4c35c8a86ea9b4";
}
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
< / script >
< / body >
< / html >