Manual Installation

Make sure you have the following prerequisites installed:

Node.js + NPM

GNU+Linux & Mac OSX

wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash

Close your shell and open an new one. Now that you can call the nvm program, install Node.js (which comes with NPM):

nvm install --lts

Build Dependencies

GNU+Linux

Debian / Ubuntu / Mint / Trisquel / and Friends

apt install git python build-essential

Red Hat / Fedora / CentOS

yum groupinstall 'Development Tools'

You might also find yourself lacking a C++11 compiler - see this.

Mac OSX

xcode-select --install

Windows

Run as administrator in PowerShell or cmd:

npm install -g windows-build-tools

Daemon + Utilities CLI

This package exposes 3 programs: orc, orcd, and orctool. To install these, use the --global flag.

GRANAX_USE_TOR_ALPHA=1 npm install -g @orcproject/orc

Core Library

This package exposes a module providing a complete implementation of the protocol. To use it in your project, from your project's root directory, install as a dependency.

GRANAX_USE_TOR_ALPHA=1 npm install @orcproject/orc --save

Then you can require the library with:

const orc = require('@orcproject/orc');