Installing Newt on Mac OS

Newt is supported on Mac OS X 64 bit platforms and has been tested on Mac OS 10.10 and higher.

This page shows you how to:

  • Upgrade to or install the latest release version of newt.

  • Install the latest newt from the master branch (unstable).

See Installing Previous Releases of Newt to install an earlier version of newt.

Note: If you would like to contribute to the newt tool, see Setting Up Go Environment to Contribute to Newt and Newtmgr Tools.

Installing Homebrew

If you do not have Homebrew installed, run the following command. You will be prompted for your sudo password.

$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

You can also extract (or git clone) Homebrew and install it to /usr/local.

Adding the Mynewt Homebrew Tap

If this is your first time installing newt, add the runtimeco/homebrew-mynewt tap:

$ brew tap runtimeco/homebrew-mynewt
$ brew update

Upgrading to or Installing the Latest Release Version

Perform the following to upgrade or install the latest release version of newt.

Upgrading to the Latest Release Version of Newt

If you previously installed newt using brew, run the following commands to upgrade to newt latest:

$ brew update
$ brew upgrade mynewt-newt
==> Upgrading 1 outdated package, with result:
runtimeco/mynewt/mynewt-newt 1.4.1
==> Upgrading runtimeco/mynewt/mynewt-newt
==> Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.4.1/mynewt-newt-1.4.1.sierra.bottle.tar.gz
==> Downloading from https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.4.1/mynewt-newt-1.4.1.sierra.bottle.tar.gz
######################################################################## 100.0%
==> Pouring mynewt-newt-1.4.1.sierra.bottle.tar.gz
🍺  /usr/local/Cellar/mynewt-newt/1.4.1: 3 files, 7.9MB

Installing the Latest Release Version of Newt

Run the following command to install the latest release version of newt:

$ brew update
$ brew install mynewt-newt
==> Installing mynewt-newt from runtimeco/mynewt
==> Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.4.1/mynewt-newt-1.4.1.sierra.bottle.tar.gz
Already downloaded: /Users/gavin/Library/Caches/Homebrew/mynewt-newt-1.4.1.sierra.bottle.tar.gz
==> Pouring mynewt-newt-1.4.1.sierra.bottle.tar.gz
🍺  /usr/local/Cellar/mynewt-newt/1.4.1: 3 files, 7.9MB

Notes: Homebrew bottles for newt are available for Mac OS Sierra. If you are running an earlier version of Mac OS, the installation will install the latest version of Go and compile newt locally.

Checking the Installed Version

Check that you are using the installed version of newt:

$ which newt
/usr/local/bin/newt
$ newt version
Apache Newt version: 1.4.1

Note: If you previously built newt from source and the output of which newt shows “$GOPATH/bin/newt”, you will need to move “$GOPATH/bin” after “/usr/local/bin” for your PATH in ~/.bash_profile, and source ~/.bash_profile.

Get information about newt:

$ 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 [<command-name>]
    For help on <command-name>.  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
  resign-image Re-sign an image.
  run          build/create-image/download/debug <target>
  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 "WARN")
  -o, --outfile string    Filename to tee output to
  -q, --quiet             Be quiet; only display error output
  -s, --silent            Be silent; don't output anything
  -v, --verbose           Enable verbose output when executing commands

Use "newt [command] --help" for more information about a command.

Installing Newt from the Master Branch

We recommend that you use the latest release version 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.

Notes:

  • The master branch may be unstable.

  • This installation will install the latest version of Go on your computer, if it is not installed, and compile newt locally.

If you previously installed newt using brew, unlink the current version:

$ brew unlink mynewt-newt

Install the latest unstable version of newt from the master branch:

$ brew install mynewt-newt --HEAD

To switch back to the latest stable release version of newt, you can run:

$ brew switch mynewt-newt 1.4.1