Installation with asdf

asdf is a version manager that allows you to install and manage multiple versions of voyager-verifier (and many other tools) on your system.

Prerequisites

First, you’ll need to install asdf if you haven’t already. Follow the official asdf installation guide.

Installation Steps

1. Add the Voyager Plugin

Add the voyager-verifier plugin to asdf:

asdf plugin add voyager https://github.com/NethermindEth/asdf-voyager-verifier.git

2. Install the Latest Version

Install the latest version of voyager-verifier:

asdf install voyager latest

This will download and install the most recent version available.

3. Set Global Version

Set the installed version as your global default:

asdf global voyager latest

Alternatively, set it for the current directory only:

asdf local voyager latest

4. Verify Installation

Confirm the installation was successful:

voyager --version

You should see output like:

voyager-verifier 2.0.1

Managing Versions

List Available Versions

See all available versions:

asdf list all voyager

Install Specific Version

Install a specific version:

asdf install voyager 1.3.0

Switch Versions

Switch to a different installed version globally:

asdf global voyager 1.3.0

Or for the current directory:

asdf local voyager 1.3.0

List Installed Versions

See which versions you have installed:

asdf list voyager

Updating

Update to Latest Version

To update to the latest version:

asdf install voyager latest
asdf global voyager latest

Update the Plugin

To get access to newly released versions, update the plugin:

asdf plugin update voyager

Uninstalling

Remove a Specific Version

asdf uninstall voyager 1.3.0

Remove the Plugin

To completely remove voyager-verifier from asdf:

asdf plugin remove voyager

Project-Specific Versions

For project-specific version management, create a .tool-versions file in your project directory:

echo "voyager 2.0.1" > .tool-versions

When you cd into this directory, asdf will automatically use the specified version.

Troubleshooting

Command Not Found

If voyager command is not found after installation:

1. Make sure asdf is properly configured in your shell profile (.bashrc, .zshrc, etc.)
2. Restart your terminal or run source ~/.bashrc (or your shell’s config file)
3. Verify asdf is working: asdf --version

Plugin Installation Fails

If adding the plugin fails:

1. Ensure you have git installed
2. Check your network connection
3. Verify the plugin URL is correct

Version Not Available

If a specific version isn’t available:

# Update the plugin to fetch latest versions
asdf plugin update voyager

# List available versions again
asdf list all voyager

Next Steps

Now that voyager-verifier is installed, proceed to the Quickstart Guide to verify your first contract!