Skip to content

Latest commit

 

History

History
116 lines (79 loc) · 2.08 KB

README.md

File metadata and controls

116 lines (79 loc) · 2.08 KB
Raw

noirup

Update or revert to a specific Nargo branch with ease.

Installing

curl -L https://raw.githubusercontent.com/noir-lang/noirup/main/install | bash

Usage

To install the nightly version:

noirup

To install a specific version (in this case the nightly version):

noirup --version nightly

To install a specific branch (in this case the release/0.1.0 branch's latest commit):

noirup --branch release/0.1.0

To install a fork's main branch (in this case tomafrench/noir's main branch):

noirup --repo tomafrench/noir

To install a specific branch in a fork (in this case the patch-10 branch's latest commit in tomafrench/noir):

noirup --repo tomafrench/noir --branch patch-10

To install from a specific Pull Request:

noirup --pr 367

To install from a specific commit:

noirup -C 20048e7

To install a local directory or repository (e.g. one located at ~/git/noir, assuming you're in the home directory)

Note: --branch, --repo, and --version flags are ignored during local installations.
noirup --path ./git/noir

Tip: All flags have a single character shorthand equivalent! You can use -v instead of --version, etc.

Github Action

This action is in early development and so will likely experience breaking changes. It's recommended to pin to a particular tagged version.

Noirup is also available as a GitHub action to allow easy installation of the Noir toolchain using noirup.


Example workflow

name: test suite
on: [push, pull_request]

jobs:
  test:
    name: nargo test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: noir-lang/[email protected]
        with:
          toolchain: 0.6.0
      - run: nargo test

Inputs

All inputs are optional.

Name Description
version Noirup toolchain version e.g. 0.3.2. Defaults to the latest stable release.