blob: 92fd0c0d2d818b1dc09de5d55a79d59a43448696 [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 Newt on Mac - 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 Newt on Mac">
<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.12.0, Apache NimBLE 1.7.0 </a> released (April 4, 2024)
</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_12_0/" >
Version: 1.12.0
</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>
<ul>
<li ><a href="../../../os/get_started/native_install_intro/">Native Install Option</a>
<ul>
<li class="active">
<a href="./">Install Newt on Mac</a>
</li>
<li >
<a href="../newt_linux/">Install Newt on Linux</a>
</li>
<li >
<a href="../newt_windows/">Install Newt on Windows</a>
</li>
<li >
<a href="../../../os/get_started/native_tools/">Install Native Toolchain</a>
</li>
<li >
<a href="../../../os/get_started/cross_tools/">Install Cross Tools for ARM</a>
</li>
</ul>
</li>
<li >
<a href="../../../os/get_started/docker/">Docker Container Option</a>
</li>
<li >
<a href="../../../os/get_started/project_create/">Create Your First Project</a>
</li>
<li >
<a href="../../../os/get_started/serial_access/">Serial Port Setup</a>
</li>
</ul>
</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_intro/">Newt Tool Guide</a>
</li>
<li ><a href="../../../newtmgr/overview/">Newt Manager Guide</a>
</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; <a href="os/get_started/native_install_intro/">Native Install Option</a></li>
<li>&raquo; <a href="os/get_started/get_started/">Basic Setup</a></li>
<li>&raquo; <a href="os/introduction/">Mynewt Documentation</a></li>
<li>&raquo; Install Newt on Mac</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-newt-on-mac-os">Installing Newt on Mac OS</h2>
<p>Newt 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 newt:</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 newt tool, see <a href="/faq/go_env">Setting Up Go Environment to Contribute to Newt and Newtmgr Tools</a>.</p>
<h3 id="installing-homebrew">Installing Homebrew</h3>
<p>If you do not have Homebrew installed, run the following command. You will be prompted for your sudo password.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$ ruby -e &quot;$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)&quot;
</code></pre></div>
<p>You can also extract (or <code>git clone</code>) Homebrew and install it to /usr/local.</p>
<p><br></p>
<h3 id="installing-newt">Installing Newt</h3>
<p>Add the ** runtimeco/homebrew-mynewt ** tap:</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>
<h4 id="installing-the-latest-release-version-of-newt">Installing the Latest Release Version of Newt</h4>
<p>Install the latest stable release version (1.0.0) of newt:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$brew install mynewt-newt
==&gt; Installing mynewt-newt from runtimeco/mynewt
==&gt; Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.0.0/mynewt-newt-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-newt-1.0.0.mavericks.
######################################################################## 100.0%
==&gt; Pouring mynewt-newt-1.0.0.mavericks.bottle.tar.gz
🍺 /usr/local/Cellar/mynewt-newt/1.0.0: 3 files, 10.4MB
</code></pre></div>
<p><br>
<strong>Note:</strong> This installs the newt 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 newt locally.</p>
<p><br>
Check that you are using the installed version of newt:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$which newt
/usr/local/bin/newt
$ls -l /usr/local/bin/newt
lrwxr-xr-x 1 user staff 36 Apr 15 08:18 /usr/local/bin/newt -&gt; ../Cellar/mynewt-newt/1.0.0/bin/newt
$newt version
Apache Newt (incubating) version: 1.0.0
</code></pre></div>
<p><strong>Note:</strong> If you previously built newt from source and the output of <code>which newt</code> shows "$GOPATH/bin/newt", you will need to move "$GOPATH/bin" after "/usr/local/bin" in your $PATH.</p>
<p><br>
Get information about newt: </p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$newt help
Newt allows you to create your own embedded application based on the Mynewt
operating system. Newt provides both build and package management in a single
tool, which allows you to compose an embedded application, and set of
projects, and then build the necessary artifacts from those projects. For more
information on the Mynewt operating system, please visit
https://mynewt.apache.org/.
Please use the newt help command, and specify the name of the command you want
help for, for help on how to use a specific command
Usage:
newt [flags]
newt [command]
Examples:
newt
newt help [&lt;command-name&gt;]
For help on &lt;command-name&gt;. If not specified, print this message.
Available Commands:
build Build one or more targets
clean Delete build artifacts for one or more targets
create-image Add image header to target binary
debug Open debugger session to target
info Show project info
install Install project dependencies
load Load built target to board
mfg Manufacturing flash image commands
new Create a new project
pkg Create and manage packages in the current workspace
run build/create-image/download/debug &lt;target&gt;
size Size of target components
sync Synchronize project dependencies
target Commands to create, delete, configure, and query targets
test Executes unit tests for one or more packages
upgrade Upgrade project dependencies
vals Display valid values for the specified element type(s)
version Display the Newt version number
Flags:
-h, --help Help for newt commands
-j, --jobs int Number of concurrent build jobs (default 8)
-l, --loglevel string Log level (default &quot;WARN&quot;)
-o, --outfile string Filename to tee output to
-q, --quiet Be quiet; only display error output
-s, --silent Be silent; don&#39;t output anything
-v, --verbose Enable verbose output when executing commands
Use &quot;newt [command] --help&quot; for more information about a command.
</code></pre></div>
<p><br></p>
<h4 id="installing-newt-from-the-master-branch">Installing Newt from the Master Branch</h4>
<p>We recommend that you use the latest stable release version (1.0.0) of newt. If you would like to use the master branch with the latest updates, you can install newt 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 newt locally. </li>
</ul>
<p><br>
If you previously installed newt using brew, unlink the current version:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$brew unlink mynewt-newt
</code></pre></div>
<p><br>
Install the latest unstable version of newt from the master branch:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$brew install --HEAD mynewt-newt
==&gt; Installing mynewt-newt from runtimeco/mynewt
==&gt; Cloning https://github.com/apache/incubator-mynewt-newt.git
Cloning into &#39;Users/&lt;username&gt;/Library/Caches/Homebrew/mynewt-newt--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-newt/HEAD-409f7d3: 3 files, 10.4MB, built in 10 seconds
$newt version
Apache Newt (incubating) version: 1.0.0-dev
</code></pre></div>
<p><br>
To switch back to the stable release version (1.0.0) of newt, you can run:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>$brew switch mynewt-newt 1.0.0
Cleaning /usr/local/Cellar/mynewt-newt/1.0.0
Cleaning /usr/local/Cellar/mynewt-newt/HEAD-409f7d3
1 links created for /usr/local/Cellar/mynewt-newt/1.0.0
$newt version
Apache Newt (incubating) version: 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>