Google Git
Sign in
apache / mynewt-site / 8528acea806ecedcedbaec90568a1524b3ae623d / . / v1_0_0 / newtmgr / install_mac / index.html
blob: d4f3a6a343e59927902243c141a1054b0239b12f [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">
<!-- This is broken by doc revisioning.
-->
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>Install Newtmgr On Mac OS - Apache Mynewt</title>
<link href="../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
<link rel="stylesheet" href="../../css/highlight.css">
<link href="../../css/base.css" rel="stylesheet">
<link href="../../css/custom.css" rel="stylesheet">
<link href="../../css/v2.css" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Lato" rel="stylesheet">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<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="Install Newtmgr On Mac OS">
<div class="container">
<div class="row v2-main-banner">
<a class="logo-cell" href="/">
<img class="logo" src="/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>
<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" 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
class=""
>
<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
class=""
>
<a href="/about/">About</a>
</li>
<li
class=""
>
<a href="/talks/">Talks</a>
</li>
<li
class="active"
>
<a href="/documentation/">Documentation</a>
</li>
<li
class=""
>
<a href="/download/">Download</a>
</li>
<li
class=""
>
<a href="/community/">Community</a>
</li>
<li
class=""
>
<a href="/events/">Events</a>
</li>
</ul>
</div>
</div>
</nav>
<div class="container">
<div class="row">
<div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
<ul class="toc-nav">
<li class="doc-version"><select class="form-control" onchange="if (this.value) window.location.href=this.value">
<option value="/latest">
Version: master
</option>
<option value="/v1_11_0/" >
Version: 1.11.0
</option>
<option value="/v1_10_0/" >
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" selected="selected" >
Version: 1.0.0
</option>
<option value="/v0_9_0/os/introduction" >
Version: 0.9.0
</option>
</select></li>
<li ><a href="../../os/introduction/">Mynewt Documentation</a>
<ul>
<li ><a href="../../os/get_started/get_started/">Basic Setup</a>
</li>
<li >
<a href="../../os/get_started/vocabulary/">Concepts</a>
</li>
<li ><a href="../../os/tutorials/tutorials/">Tutorials</a>
</li>
<li ><a href="../../os/os_user_guide/">OS User Guide</a>
</li>
<li><a href="
../../network/ble/ble_intro/
">BLE User Guide</a>
</li>
<li ><a href="../../newt/newt_intro/">Newt Tool Guide</a>
</li>
<li ><a href="../overview/">Newt Manager Guide</a>
<ul>
<li><a href="
../command_list/newtmgr_config/
">Command Guide</a>
</li>
<li><a href="
./
">Install</a>
<ul>
<li class="active">
<a href="./">Install Newtmgr On Mac OS</a>
</li>
<li >
<a href="../install_linux/">Install Newtmgr On Linux</a>
</li>
<li >
<a href="../install_windows/">Install Newtmgr On Windows</a>
</li>
</ul>
</li>
</ul>
</li>
<li >
<a href="../../known_issues/">Known Issues</a>
</li>
</ul>
</li>
<li><a href="
../../faq/go_env/
">Appendix</a>
</li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<div class="doc-header">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/documentation/">Docs</a></li>
<li>&raquo; Install</li>
<li>&raquo; <a href="newtmgr/overview/">Newt Manager Guide</a></li>
<li>&raquo; <a href="os/introduction/">Mynewt Documentation</a></li>
<li>&raquo; Install Newtmgr On Mac OS</li>
</ul>
</div>
</div>
<div class="alert alert-warning">
<p>
Version 1.0.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>
<h2 id="installing-newtmgr-on-mac-os">Installing Newtmgr on Mac OS</h2>
<p>Newtmgr is supported on Mac OS X 64 bit platforms and has been tested on Mac OS 10.9 and higher.</p>
<p>This page shows you how to install the following versions of newtmgr:</p>
<ul>
<li>The latest stable release version (1.0.0)</li>
<li>The latest from the master branch (unstable)</li>
</ul>
<p><strong>Note:</strong> If you would like to contribute to the newtmgr tool, see <a href="/faq/go_env">Setting Up Go Environment to Contribute to Newt and Newtmgr Tools</a>.</p>
<h3 id="adding-the-runtimecohomebrew-mynewt-tap">Adding the runtimeco/homebrew-mynewt Tap:</h3>
<p>You should have added the runtimeco/homebrew-mynewt tap when you installed the <em>newt</em> tool. Run the following commands if you have not done so:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$brew tap runtimeco/homebrew-mynewt
$brew update
</code></pre></div>
<p><br></p>
<h3 id="installing-the-latest-release-version-of-newtmgr">Installing the Latest Release Version of Newtmgr</h3>
<p>Install the latest stable release version (1.0.0) of newtmgr:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>brew install mynewt-newtmgr
==&gt; Installing mynewt-newtmgr from runtimeco/mynewt
==&gt; Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.0.0/mynewt-newtmgr-1.0.0.mavericks.bottle.tar.gz
==&gt; Downloading from https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.0.0/mynewt-newtmgr-1.0.0.maveric
######################################################################## 100.0%
==&gt; Pouring mynewt-newtmgr-1.0.0.mavericks.bottle.tar.gz
🍺 /usr/local/Cellar/mynewt-newtmgr/1.0.0: 3 files, 15.2MB
</code></pre></div>
<p><br>
<strong>Note:</strong> This installs the newtmgr 1.0.0 binary that has been tested on Mac OS 10.9 and higher. If you are running an earlier version of Mac OS, the installation will install the latest version of Go and compile newtmgr locally.</p>
<p><br>
Check that you are using the installed version of newtmgr:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$which newtmgr
/usr/local/bin/newtmgr
ls -l /usr/local/bin/newtmgr
lrwxr-xr-x 1 user staff 42 Apr 15 09:14 /usr/local/bin/newtmgr -&gt; ../Cellar/mynewt-newtmgr/1.0.0/bin/newtmgr
</code></pre></div>
<p><strong>Note:</strong> If you previously built newtmgr from source and the output of <code>which newtmgr</code> shows "$GOPATH/bin/newtmgr", you will need to move "$GOPATH/bin" after "/usr/local/bin" in your $PATH.</p>
<p><br>
Get information about newtmgr:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$newtmgr help
Newtmgr helps you manage remote devices running the Mynewt OS
Usage:
newtmgr [flags]
newtmgr [command]
Available Commands:
config Read or write a config value on a device
conn Manage newtmgr connection profiles
crash Send a crash command to a device
datetime Manage datetime on a device
echo Send data to a device and display the echoed back data
fs Access files on a device
image Manage images on a device
log Manage logs on a device
mpstats Read memory pool statistics from a device
reset Send reset request to a device
run Run test procedures on a device
stat Read statistics from a device
taskstats Read task statistics from a device
Flags:
-c, --conn string connection profile to use
-h, --help Help for newtmgr commands
-l, --loglevel string log level to use (default &quot;info&quot;)
-t, --trace print all bytes transmitted and received
Use &quot;newtmgr [command] --help&quot; for more information about a command.
</code></pre></div>
<p><br></p>
<h4 id="installing-newtmgr-from-the-master-branch">Installing Newtmgr from the Master Branch</h4>
<p>We recommend that you use the latest stable release version (1.0.0) 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>** Notes: **</p>
<ul>
<li>The master branch may be unstable.</li>
<li>This installation will install the latest version of Go on your computer, if it is not installed, and compile newtmgr locally. </li>
</ul>
<p><br>
If you already installed newtgmr, unlink the current version:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$brew unlink mynewt-newtmgr
</code></pre></div>
<p><br>
Install the latest unstable version of newtmgr from the master branch:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$brew install --HEAD mynewt-newtmgr
==&gt; Installing mynewt-newtmgr from runtimeco/mynewt
==&gt; Cloning https://github.com/apache/incubator-mynewt-newt.git
Cloning into &#39;/Users/&lt;user&gt;/Library/Caches/Homebrew/mynewt-newtmgr--git&#39;...
remote: Counting objects: 623, done.
remote: Compressing objects: 100% (501/501), done.
remote: Total 623 (delta 154), reused 323 (delta 84), pack-reused 0
Receiving objects: 100% (623/623), 1.10 MiB | 0 bytes/s, done.
Resolving deltas: 100% (154/154), done.
==&gt; Checking out branch master
==&gt; go install
🍺 /usr/local/Cellar/mynewt-newtmgr/HEAD-409f7d3: 3 files, 15.1MB, built in 14 seconds
</code></pre></div>
<p><br>
To switch back to the stable release version (1.0.0) of newtmgr, you can run:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$brew switch mynewt-newtmgr 1.0.0
Cleaning /usr/local/Cellar/mynewt-newtmgr/1.0.0
Cleaning /usr/local/Cellar/mynewt-newtmgr/HEAD-409f7d3
1 links created for /usr/local/Cellar/mynewt-newtmgr/1.0.0
</code></pre></div>
<p><br></p>
<div class="row">
<ul class="nav nav-pills" style="margin-bottom: 10px">
<li>
</li>
<li class="pull-right">
</li>
</ul>
</div>
<footer class="row">
<div class="col-xs-12">
<p class="copyright">Apache Mynewt (incubating) is available under Apache License, version 2.0.</p>
</div>
<div class="col-xs-12">
<div class="logos">
<a href="https://www.apache.org/">
<img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache">
</a>
<p>
Copyright © 2015-2021 The Apache Software Foundation.<br>
<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>
</p>
<a href="">
<img src="https://www.countit.com/images/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" />
</a>
</div>
</div>
<a href="https://www.apache.org/licenses/">
<button class="button-footer-asf">
License
</button>
</a>
<a href="https://www.apache.org/foundation/sponsorship.html">
<button class="button-footer-asf">
Sponsorship
</button>
</a>
<a href="https://www.apache.org/foundation/thanks.html">
<button class="button-footer-asf">
Thanks
</button>
</a>
<a href="https://www.apache.org/security/">
<button class="button-footer-asf">
Security
</button>
</a>
<a href="https://apache.org/events/current-event">
<button class="button-footer-asf">
ASF Events
</button>
</a>
</footer>
</div>
</div>
</div>
<script src="../../js/jquery-1.10.2.min.js"></script>
<script src="../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../js/highlight.pack.js"></script>
<script src="../../js/base.js"></script>
<script src="../../js/custom.js"></script>
<script src="search/main.js"></script>
</body>
</html>