Skip to content
Linkworld Docs

Install the CLI

macOS / Linux

Section titled “macOS / Linux”
Terminal window
pip install linkworld

Installs the linkworld command. Verify:

Terminal window
linkworld --version

Windows

Section titled “Windows”
Terminal window
pip install linkworld

Open a fresh PowerShell or Terminal so linkworld is on your PATH.

From source

Section titled “From source”
Terminal window
git clone https://github.com/linkworld/linkworld.git
cd linkworld/packages/cli
pip install -e .

Sign in

Section titled “Sign in”
Terminal window
linkworld login

Opens a browser to GitHub OAuth. After authorizing, the CLI receives a JWT and stores it in ~/.config/linkworld/config.json.

If you already have an admin-issued token:

Terminal window
linkworld login --token eyJhbGc...

What’s next

Section titled “What’s next”

Quickstart →