Skip to main content

Pre-requisites

System Requirements

Review the System Requirements as detailed in Marlin’s documentation.

Install the oyster-cvm CLI tool

The oyster-cvm tool is available as a prebuilt binary for most platforms. Run

# for linux with amd64 architecture
sudo wget https://artifacts.marlin.org/oyster/binaries/oyster-cvm_latest_linux_amd64 -O /usr/local/bin/oyster-cvm

# for linux with arm64 architecture
sudo wget https://artifacts.marlin.org/oyster/binaries/oyster-cvm_latest_linux_arm64 -O /usr/local/bin/oyster-cvm

# for darwin with arm64 architecture (M series Macs)
sudo wget https://artifacts.marlin.org/oyster/binaries/oyster-cvm_latest_darwin_arm64 -O /usr/local/bin/oyster-cvm

Make it executable by running

sudo chmod +x /usr/local/bin/oyster-cvm

You should now be able to run oyster-cvm and see the help output by simply running

oyster-cvm

And that's it! Now that you have set up a development environment, you are ready to go.