Get Started

Yeet lets you write JavaScript scripts that subscribe to a live system graph — processes, CPU, memory, network, Docker, and more — and render or act on the data in real time.

First steps

• Installation — install the daemon and log in
• What is Yeet? — understand what the system graph exposes and how scripts work
• Examples — see working scripts you can run and modify today
• Running with Docker — macOS and Windows users start here

Installation

yeet currently supports Linux natively. macOS and Windows users can run yeet via Docker — see Running with Docker (macOS/Windows).

Run the following command to install yeet:

curl -fsSL https://yeet.cx | sh

Login

Once installed, authenticate with your yeet account:

yeet login

This will give you a link to authenticate in your browser. Once authenticated, you're ready to go.