Skip to content
MagnetiteMagnetite

Installation

Prerequisites

Section titled “Prerequisites”
  1. A Rust toolchain (rustup): magnet runs cargo to build your models for simulation and deployment.
  2. git, optional but recommended: magnet new initializes a repository, as cargo new does.
  3. A browser, optional for the visual canvas: the editor is bundled with the magnet cli tool and it opens in the browser.

Sign in to your dashboard

Section titled “Sign in to your dashboard”

After your organization’s admin granted you a seat on the dashboard, you get an invitation to sign in to your dashboard, where you’ll find your installation command, for example:

Terminal window
curl --proto '=https' --tlsv1.2 -fsSL https://get.magnetite.rs/install.sh | sh -s -- D1192C-8F543B-DFFE47-A2533B-5B6AD5-V3

Install

Section titled “Install”

The installation command does the following things:

  1. downloads the current release for your platform over TLS and places magnet in ~/.magnet/bin (%USERPROFILE%\.magnet\bin on Windows), on your PATH;
  2. activates the seat on your machine, which writes a license to ~/.magnet;

An installed magnet then verifies the license offline, so the tool works in airplane mode and renews itself when it is next online.

So, you get a key and a license, and a key is used to activate or renew an existing installation, whereas the license is for checking whether you have an active subscription, and you are eligible to use magnet.

Terminal window
magnet license activate <key>

Check what your binary sees at any time:

Terminal window
magnet license status

First project

Section titled “First project”

The quickstart creates a project and builds a feedback loop in it.

Updating

Section titled “Updating”
Terminal window
magnet self-update

replaces the binary with the latest release, and says Unchanged if you already have it.

Uninstalling

Section titled “Uninstalling”
Terminal window
magnet uninstall

removes ~/.magnet/bin/magnet and the installer’s receipt, after asking (--yes skips the prompt).

Three things are kept on your machine:

  • ~/.magnet itself: license.lic and license.key. Reinstalling picks the same seat straight back up, with no new activation.
  • ~/.magnet/bin/env and env.fish: your shell rc files source them, and deleting them makes every new shell print an error.
  • Any project’s .magnet/ and target/: derived state and build output, regenerated on the next command.

To remove everything, do it by hand:

Terminal window
rm -rf ~/.magnet

Then drop the line sourcing ~/.magnet/bin/env from your shell rc.