Command line
yeet is a daemon (yeetd) and a CLI that talks to it. The daemon owns every running script; the CLI is how you start them, look at them, and stop them. There are two ways to run a script, and this section has a page for each:
- Running scripts covers
yeet run: start a script from a path, a git repo, a URL, or stdin, with your terminal attached. The script lives as long as the command does, unless you detach it.-pserves its screen or logs over WebSocket and HTTP.yeet ps,yeet attach, andyeet killmanage what is running. - Services covers
yeet service: describe a set of scripts and web servers once, and the daemon keeps them running, restarts them by policy, brings them up on boot, and serves their screens and logs on routes. A service is what you reach for when a script should outlive your terminal and your login.
Running tests covers yeet test, which runs test modules, each in its own isolate.
Run yeet --help or yeet <command> --help for the full option list. The help text is kept current with the binary and is the source of truth when it disagrees with these pages.
Commands
| Command | What it does |
|---|---|
yeet run <script> [options] [-- args...] | Run a script in a fresh isolate. See Running scripts. |
yeet test [options...] [paths...] [-- args...] | Run test modules, each in a fresh isolate. See Running tests. |
yeet ps | List running isolates. |
yeet attach <id> / yeet attach -c <id> | Attach a terminal to a running isolate's tty, or watch its console. |
yeet kill <id> | Kill a running isolate. |
yeet service … | Manage services. See Services. |
yeet status | Check the daemon's status. -w waits until it is ready; -q reports readiness by exit code alone. |
yeet new <name> [-C <dir>] | Scaffold a new project from the template. |
yeet graph dump / yeet graph query | Print the system graph's GraphQL schema, or run a query against it. See Building tools. |
yeet trace / yeet trace bpf | Tail CLI logs, or stream BPF trace output from the kernel's trace pipe. |
yeet login / yeet logout / yeet whoami | Platform authentication for this host. Running scripts needs no account; a service's web server answers only once the host is signed in, as do scripts that reach the platform. whoami -q reports login status by exit code. |
yeet toolchain … | Install, list, update, inspect, and select the BPF toolchain. |
yeet docs | Show where to find the documentation. |
yeet version | Print the build and version. |
Global options
These go before the sub-command and apply to all of them:
| Option | Default | What it does |
|---|---|---|
--socket <path> | /run/yeet/yeetd.sock | The daemon's privileged Unix socket. |
--user-socket <path> | /run/yeet/yeetd.user.sock | The daemon's unprivileged user socket. |
--config <path> | /etc/yeet/yeet.conf | The configuration file. |
--api-url <url> | https://api.yeet.cx | Base URL of the API gateway. |
--ws-url <url> | wss://yeet.ws | Base URL of the WebSocket gateway. |
--no-map-config | Ignore the configuration file and use only command-line arguments. |