blob: 4238c42c360f8d34d26754127fae788fa4e20685 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installing Newtmgr on Mac OS &mdash; Apache Mynewt latest documentation</title>
<link rel="shortcut icon" href="../../_static/mynewt-logo-only-newt32x32.png"/>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/sphinx_theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/bootstrap-3.0.3.min.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/v2.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/restructuredtext.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/overrides.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="Apache Mynewt latest documentation" href="../../index.html"/>
<link rel="up" title="Install" href="index.html"/>
<link rel="next" title="Installing Newtmgr on Linux" href="install_linux.html"/>
<link rel="prev" title="Install" href="index.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
<script>
(function(i, s, o, g, r, a, m) {
i["GoogleAnalyticsObject"] = r;
(i[r] =
i[r] ||
function() {
(i[r].q = i[r].q || []).push(arguments);
}),
(i[r].l = 1 * new Date());
(a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]);
a.async = 1;
a.src = g;
m.parentNode.insertBefore(a, m);
})(window, document, "script", "//www.google-analytics.com/analytics.js", "ga");
ga("create", "UA-72162311-1", "auto");
ga("send", "pageview");
</script>
</head>
<body class="not-front page-documentation" role="document" >
<div id="wrapper">
<div class="container">
<div id="banner" class="row v2-main-banner">
<a class="logo-cell" href="/">
<img class="logo" src="../../_static/img/logo.png">
</a>
<div class="tagline-cell">
<h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4>
</div>
<div class="news-cell">
<div class="well">
<h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.11.0, Apache NimBLE 1.6.0 </a> released September 7, 2023)
</div>
</div>
</div>
</div>
<header>
<nav id="navbar" class="navbar navbar-inverse" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a>
</li>
<li class="important">
<a href="/quick-start/">Quick Start</a>
</li>
<li>
<a href="/about/">About</a>
</li>
<li>
<a href="/talks/">Talks</a>
</li>
<li class="active">
<a href="/documentation/">Documentation</a>
</li>
<li>
<a href="/download/">Download</a>
</li>
<li>
<a href="/community/">Community</a>
</li>
<li>
<a href="/events/">Events</a>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
</ul>
</div>
</div>
</nav>
</header>
<!-- STARTS MAIN CONTENT -->
<div id="main-content">
<div id="breadcrumb">
<div class="container">
<a href="/documentation/">Docs</a> /
<a href="../index.html">Newt Manager Guide</a> /
<a href="index.html">Install</a> /
Installing Newtmgr on Mac OS
<div class="sourcelink">
<a href="https://github.com/apache/mynewt-newtmgr/edit/master/docs/install/install_mac.rst" class="icon icon-github"
rel="nofollow"> Edit on GitHub</a>
</div>
</div>
</div>
<!-- STARTS CONTAINER -->
<div class="container">
<!-- STARTS .content -->
<div id="content" class="row">
<!-- STARTS .container-sidebar -->
<div class="container-sidebar col-xs-12 col-sm-3">
<div id="docSidebar" class="sticky-container">
<div role="search" class="sphinx-search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search documentation" class="search-documentation" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<!-- Note: only works when deployed -->
<select class="form-control" onchange="if (this.value) window.location.href=this.value">
<option value="/latest" selected>
Version: latest
</option>
<option value="/v1_11_0" >
Version: 1.11.0
</option>
<option value="/v1_10_0" selected="selected" >
Version: 1.10.0
</option>
<option value="/v1_9_0" >
Version: 1.9.0
</option>
<option value="/v1_8_0" >
Version: 1.8.0
</option>
<option value="/v1_7_0" >
Version: 1.7.0
</option>
<option value="/v1_6_0" >
Version: 1.6.0
</option>
<option value="/v1_5_0" >
Version: 1.5.0
</option>
<option value="/v1_4_0" >
Version: 1.4.0
</option>
<option value="/v1_3_0/os/introduction" >
Version: 1.3.0
</option>
<option value="/v1_2_0/os/introduction" >
Version: 1.2.0
</option>
<option value="/v1_1_0/os/introduction" >
Version: 1.1.0
</option>
<option value="/v1_0_0/os/introduction" >
Version: 1.0.0
</option>
<option value="/v0_9_0/os/introduction" >
Version: 0.9.0
</option>
</select>
<div class="region region-sidebar">
<div class="docs-menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../get_started/index.html">Setup &amp; Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../external_links.html">Third-party Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../os/os_user_guide.html">OS User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../network/index.html">BLE User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../newt/index.html">Newt Tool Guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Newt Manager Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../command_list/index.html">Command List</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Install</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Installing Newtmgr on Mac OS</a></li>
<li class="toctree-l3"><a class="reference internal" href="install_linux.html">Installing Newtmgr on Linux</a></li>
<li class="toctree-l3"><a class="reference internal" href="install_windows.html">Installing Newtmgr on Windows</a></li>
<li class="toctree-l3"><a class="reference internal" href="prev_releases.html">Installing Previous Releases of Newtmgr</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../mynewt_faq/index.html">Mynewt FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../misc/index.html">Appendix</a></li>
</ul>
</div>
</div>
</div>
<!-- ENDS STICKY CONTAINER -->
</div>
<!-- ENDS .container-sidebar -->
<div class="col-xs-12 col-sm-9">
<div class="alert alert-warning">
<p>
Version 1.10.0 is not the most recent version of the
Apache Mynewt documentation. Click <a href="/latest">here</a> to
read the latest version.
</p>
</div>
<div class="">
<div class="rst-content">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="installing-newtmgr-on-mac-os">
<h1>Installing Newtmgr on Mac OS<a class="headerlink" href="#installing-newtmgr-on-mac-os" title="Permalink to this headline"></a></h1>
<p>Newtmgr is supported on Mac OS X 64 bit platforms and has been tested on
Mac OS 10.11 and higher.</p>
<p>This page shows you how to install the following versions of newtmgr:</p>
<ul class="simple">
<li><p>Upgrade to or install the latest release version (1.4.1).</p></li>
<li><p>Install the latest from the master branch (unstable).</p></li>
</ul>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#adding-the-mynewt-homebrew-tap" id="id1">Adding the Mynewt Homebrew Tap</a></p></li>
<li><p><a class="reference internal" href="#upgrading-to-or-installing-the-latest-release-version" id="id2">Upgrading to or Installing the Latest Release Version</a></p>
<ul>
<li><p><a class="reference internal" href="#upgrading-to-the-latest-release-version-of-newtmgr" id="id3">Upgrading to the Latest Release Version of Newtmgr</a></p></li>
<li><p><a class="reference internal" href="#installing-the-latest-release-version-of-newtmgr" id="id4">Installing the Latest Release Version of Newtmgr</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#checking-the-installed-version" id="id5">Checking the Installed Version</a></p></li>
<li><p><a class="reference internal" href="#installing-newtmgr-from-the-master-branch" id="id6">Installing Newtmgr from the Master Branch</a></p></li>
</ul>
</div>
<p>See <a class="reference internal" href="prev_releases.html"><span class="doc">Installing Previous Releases of Newtmgr</span></a>
to install an earlier version of newtmgr.</p>
<p><strong>Note:</strong> If you would like to contribute to the newtmgr tool, see
<a class="reference internal" href="../../misc/go_env.html"><span class="doc">Contributing to Newt or Newtmgr Tools</span></a>.</p>
<div class="section" id="adding-the-mynewt-homebrew-tap">
<h2><a class="toc-backref" href="#id1">Adding the Mynewt Homebrew Tap</a><a class="headerlink" href="#adding-the-mynewt-homebrew-tap" title="Permalink to this headline"></a></h2>
<p>You should have added the <strong>runtimeco/homebrew-mynewt</strong> tap when you
installed the <strong>newt</strong> tool. Run the following commands if you have not
done so:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>brew<span class="w"> </span>tap<span class="w"> </span>runtimeco/homebrew-mynewt
<span class="gp">$ </span>brew<span class="w"> </span>update
</pre></div>
</div>
</div>
<div class="section" id="upgrading-to-or-installing-the-latest-release-version">
<h2><a class="toc-backref" href="#id2">Upgrading to or Installing the Latest Release Version</a><a class="headerlink" href="#upgrading-to-or-installing-the-latest-release-version" title="Permalink to this headline"></a></h2>
<p>Perform the following to upgrade or install the latest release version
of newtmgr.</p>
<div class="section" id="upgrading-to-the-latest-release-version-of-newtmgr">
<h3><a class="toc-backref" href="#id3">Upgrading to the Latest Release Version of Newtmgr</a><a class="headerlink" href="#upgrading-to-the-latest-release-version-of-newtmgr" title="Permalink to this headline"></a></h3>
<p>If you have installed an earlier version of newtmgr using brew, run the
following commands to upgrade to the latest version of newtmgr:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>brew<span class="w"> </span>update
<span class="gp">$ </span>brew<span class="w"> </span>upgrade<span class="w"> </span>mynewt-newtmgr
</pre></div>
</div>
</div>
<div class="section" id="installing-the-latest-release-version-of-newtmgr">
<h3><a class="toc-backref" href="#id4">Installing the Latest Release Version of Newtmgr</a><a class="headerlink" href="#installing-the-latest-release-version-of-newtmgr" title="Permalink to this headline"></a></h3>
<p>Run the following command to install the latest release version of
newtmgr:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>brew<span class="w"> </span>update
<span class="gp">$ </span>brew<span class="w"> </span>install<span class="w"> </span>mynewt-newtmgr
<span class="go">==&gt; Installing mynewt-newtmgr from runtimeco/mynewt</span>
<span class="go">==&gt; Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.4.1/mynewt-newtmgr-1.4.1.sierra.bottle.tar.gz</span>
<span class="go">==&gt; Downloading from https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.4.1/mynewt-newtmgr-1.4.1.sierra.bottle.tar.gz</span>
<span class="gp">#</span><span class="c1">####################################################################### 100.0%</span>
<span class="go">==&gt; Pouring mynewt-newtmgr-1.4.1.sierra.bottle.tar.gz</span>
<span class="go">🍺 /usr/local/Cellar/mynewt-newtmgr/1.4.1: 3 files, 17.3MB</span>
</pre></div>
</div>
<p><strong>Notes:</strong> Homebrew bottles for newtmgr 1.4.1 are available for Mac OS
Sierra, El Captian. If you are running an earlier version of Mac OS, the
installation will install the latest version of Go and compile newtmgr
locally.</p>
</div>
</div>
<div class="section" id="checking-the-installed-version">
<h2><a class="toc-backref" href="#id5">Checking the Installed Version</a><a class="headerlink" href="#checking-the-installed-version" title="Permalink to this headline"></a></h2>
<p>Check that you are using the installed version of newtmgr:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>which<span class="w"> </span>newtmgr
<span class="go">/usr/local/bin/newtmgr</span>
<span class="go">ls -l /usr/local/bin/newtmgr</span>
<span class="go">lrwxr-xr-x 1 user staff 42 Jul 1 21:15 /usr/local/bin/newtmgr -&gt; ../Cellar/mynewt-newtmgr/1.4.1/bin/newtmgr</span>
</pre></div>
</div>
<p><strong>Note:</strong> If you previously built newtmgr from source and the output of
<code class="docutils literal notranslate"><span class="pre">which</span> <span class="pre">newtmgr</span></code> shows
“$GOPATH/bin/newtmgr”, you will need to move “$GOPATH/bin” after
“/usr/local/bin” for your PATH in ~/.bash_profile, and source
~/.bash_profile.</p>
<p>Get information about newtmgr:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>newtmgr<span class="w"> </span><span class="nb">help</span>
<span class="go">Usage:</span>
<span class="go"> newtmgr [flags]</span>
<span class="go"> newtmgr [command]</span>
<span class="go">Available Commands:</span>
<span class="go"> config Read or write a config value on a device</span>
<span class="go"> conn Manage newtmgr connection profiles</span>
<span class="go"> crash Send a crash command to a device</span>
<span class="go"> datetime Manage datetime on a device</span>
<span class="go"> echo Send data to a device and display the echoed back data</span>
<span class="go"> fs Access files on a device</span>
<span class="go"> help Help about any command</span>
<span class="go"> image Manage images on a device</span>
<span class="go"> log Manage logs on a device</span>
<span class="go"> mpstat Read mempool statistics from a device</span>
<span class="go"> reset Perform a soft reset of a device</span>
<span class="go"> run Run test procedures on a device</span>
<span class="go"> stat Read statistics from a device</span>
<span class="go"> taskstat Read task statistics from a device</span>
<span class="go">Flags:</span>
<span class="go"> -c, --conn string connection profile to use</span>
<span class="go"> -h, --help help for newtmgr</span>
<span class="go"> -l, --loglevel string log level to use (default &quot;info&quot;)</span>
<span class="go"> --name string name of target BLE device; overrides profile setting</span>
<span class="go"> -t, --timeout float timeout in seconds (partial seconds allowed) (default 10)</span>
<span class="go"> -r, --tries int total number of tries in case of timeout (default 1)</span>
<span class="go">Use &quot;newtmgr [command] --help&quot; for more information about a command.</span>
</pre></div>
</div>
</div>
<div class="section" id="installing-newtmgr-from-the-master-branch">
<h2><a class="toc-backref" href="#id6">Installing Newtmgr from the Master Branch</a><a class="headerlink" href="#installing-newtmgr-from-the-master-branch" title="Permalink to this headline"></a></h2>
<p>We recommend that you use the latest release version of newtmgr. If you
would like to use the master branch with the latest updates, you can
install newtmgr from the HEAD of the master branch.</p>
<p><strong>Notes:</strong></p>
<ul class="simple">
<li><p>The master branch may be unstable.</p></li>
<li><p>This installation will install the latest version of Go on your
computer, if it is not installed, and compile newtmgr locally.</p></li>
</ul>
<p>If you already installed newtgmr, unlink the current version:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>brew<span class="w"> </span>unlink<span class="w"> </span>mynewt-newtmgr
</pre></div>
</div>
<p>Install the latest unstable version of newtmgr from the master branch:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>brew<span class="w"> </span>install<span class="w"> </span>mynewt-newtmgr<span class="w"> </span>--HEAD
<span class="go">==&gt; Installing mynewt-newtmgr from runtimeco/mynewt</span>
<span class="go">==&gt; Cloning https://github.com/apache/mynewt-newtmgr.git</span>
<span class="go">Cloning into &#39;/Users/wanda/Library/Caches/Homebrew/mynewt-newtmgr--git&#39;...</span>
<span class="go">remote: Counting objects: 2169, done.</span>
<span class="go">remote: Compressing objects: 100% (1752/1752), done.</span>
<span class="go">remote: Total 2169 (delta 379), reused 2042 (delta 342), pack-reused 0</span>
<span class="go">Receiving objects: 100% (2169/2169), 8.13 MiB | 5.47 MiB/s, done.</span>
<span class="go">Resolving deltas: 100% (379/379), done.</span>
<span class="go">==&gt; Checking out branch master</span>
<span class="go">==&gt; go get github.com/currantlabs/ble</span>
<span class="go">==&gt; go get github.com/raff/goble</span>
<span class="go">==&gt; go get github.com/mgutz/logxi/v1</span>
<span class="go">==&gt; go install</span>
<span class="go">🍺 /usr/local/Cellar/mynewt-newtmgr/HEAD-2d5217f: 3 files, 17.3MB, built in 1 minute 10 seconds</span>
</pre></div>
</div>
<p>To switch back to the latest stable release version of newtmgr, you can
run:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>brew<span class="w"> </span>switch<span class="w"> </span>mynewt-newtmgr<span class="w"> </span><span class="m">1</span>.4.1
<span class="go">Cleaning /usr/local/Cellar/mynewt-newtmgr/1.4.1</span>
<span class="go">Cleaning /usr/local/Cellar/mynewt-newtmgr/HEAD-2d5217f</span>
<span class="go">1 links created for /usr/local/Cellar/mynewt-newtmgr/1.4.1</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="rst-footer-buttons row" role="navigation" aria-label="footer navigation">
<a href="install_linux.html" class="btn btn-neutral float-right" title="Installing Newtmgr on Linux" accesskey="n">Next: Installing Newtmgr on Linux <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Install" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous: Install</a>
</div>
</div>
</div>
</div>
<!-- ENDS CONTENT SECTION -->
</div>
<!-- ENDS .content -->
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-12">
<p class="copyright">Apache Mynewt is available under Apache License, version 2.0.</p>
</div>
<div class="col-xs-12">
<div class="logos">
<img src="../../_static/img/asf_logo_wide_small.png" alt="Apache" title="Apache">
<small class="footnote">
Apache Mynewt, Mynewt, Apache, the Apache feather logo, and the Apache Mynewt project logo are either
registered trademarks or trademarks of the Apache Software Foundation in the United States and other countries.
</small>
<a href="">
<img src="../../_static/img/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" />
</a>
</div>
</div>
</div>
</div>
</footer>
</div>
<!-- ENDS #wrapper -->
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'latest',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
LINK_SUFFIX: '.html'
};
</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/js/bootstrap-3.0.3.min.js"></script>
<script type="text/javascript" src="../../_static/js/affix.js"></script>
<script type="text/javascript" src="../../_static/js/main.js"></script>
</body>
</html>