installation.md

description
Follow the steps below to install Mailchain...

Installation

Quick Install (Mac)

To install Mailchain for the first time, we recommend using Homebrew to download, install and manage the application on your local machine.

First we need to tap mailchain repository to the list of formulae that brew tracks using

brew tap mailchain/tap

Once you have done this, you can install mailchain using

brew install mailchain

Quick Install (Linux)

To install Mailchain for the first time, run the following command to download and install the application on your local machine.

curl -sL https://run.mailchain.xyz/install.sh | sh

Quick Install (Windows)

Prerequisites:

To install Mailchain for the first time, you need to install Scoop.sh. To do this, open Powershell and run:

Set-ExecutionPolicy RemoteSigned -scope CurrentUser
iwr -useb get.scoop.sh | iex

Install:

Once Scoop is installed, run the following command to download and install the application on your local machine.

scoop install git
scoop bucket add mailchain https://github.com/mailchain/scoop-bucket.git
scoop install mailchain

$path = "$home\.mailchain\.mailchain.yaml"; If(!(test-path $path)) { New-Item -ItemType "file" -Force -Path $path }

Manual Install

To choose where to store the application, you can install mailchain manually.

1. Download the application

Download the application directly via the Mailchain releases page. We recommend you save it in your home directory: ~/.mailchain/bin

2. Export the application path

Next, add mailchain to your environmental variable path with:

export PATH=$PATH:$HOME/.mailchain/bin

{% hint style="info" %} Note: if you changed the location of the mailchain executable, you should update the path as appropriate:

export PATH=$PATH:$HOME/{mailchain_executable_location}

{% endhint %}

Verify the application is installed and running correctly with: mailchain version. For example:`

$ mailchain version
Version: v0.0.11

Next, if the application is working as expected, you’ll want to add the path to ~/.profile, .zshrc, or ~/.bash_profile, depending on which shell you use.

To determine the shell you use, run echo $SHELL. For example, if using zsh, as shown below:

$ echo $SHELL

Shell output	Command to export the path to the shell profile
/bin/zsh	echo 'export PATH=$PATH:$HOME/.mailchain/bin' >> ~/.zshrc
/bin/bash	echo 'export PATH=$PATH:$HOME/.mailchain/bin' >> ~/.bashrc
/bin/ksh	echo 'export PATH=$PATH:$HOME/.mailchain/bin' >> ~/.kshrc

You are now ready to initialise the application, following the appropriate instructions for Ethereum or Substrate.