Magnet CLI

The Magnet CLI lets you work with your Magnet workspace from the terminal: list and create issues and pages, search, link directories to workspaces, and register custom sandbox images.

Installation

The CLI ships as a single native binary — no Node.js or other runtime required.

GitHub Releases (recommended)
npm

Download the binary for your platform from Releases, extract it, and put magnet (or magnet.exe on Windows) in your PATH:

VERSION="v0.1.6"
PLATFORM="darwin-arm64"   # or linux-amd64, windows-amd64
curl -sSL "https://github.com/toolkit-ai/magnet-cli/releases/download/${VERSION}/magnet-cli-${PLATFORM}.tar.gz" | tar xz
sudo mv magnet /usr/local/bin/

npm install -g @magnet-ai/cli

The npm package downloads the matching native binary for your platform at install time.

Verify the installation:

magnet --version

Authentication

There are two ways to authenticate, depending on whether you’re acting as yourself or as a workspace:

Log in as a user (recommended for local development) — magnet login opens your browser and stores a personal CLI token on your machine.

magnet login

Workspace API key (recommended for CI and scripts) — create an API key in your Magnet workspace settings and set it as an environment variable. When MAGNET_API_KEY is set, it takes precedence over a stored login.

export MAGNET_API_KEY="your-uuid-api-key"

Check which identity the CLI is using with magnet whoami.

Environment variables

Variable	Description
`MAGNET_API_KEY`	Workspace API key. Takes precedence over a stored `magnet login` session.
`MAGNET_API_URL`	Base URL for the Magnet API. Defaults to `https://www.magnet.run`.

Commands

Command	Description
`magnet login`	Log in to Magnet via the browser device flow
`magnet logout`	Revoke the stored CLI token and remove it
`magnet whoami`	Show the user or org the CLI is authenticated as
`magnet link`	Link a directory to a Magnet workspace
`magnet issues`	List, get, create, or update issues
`magnet pages`	List, get, create, or update pages
`magnet search`	Search issues and pages
`magnet sandbox-image`	Register custom sandbox images

All commands output JSON, so they compose well with jq and scripts.

Getting Started

Sessions

Integrations

CLI

Installation

Authentication

Environment variables

Commands

​Installation

​Authentication

​Environment variables

​Commands

Installation

Authentication

Environment variables

Commands