Shoal

Documentation

Install Shoal, moor a model, and find any command. Written against version 0.21.0.

Pick your Shoal

Shoal is one engine with three ways in. The concepts, the commands, and the models are the same in all of them, so choosing here only changes which install steps, which keys, and which menu these pages show you. You can change it any time from the top of the contents.

Shoal in any shell

Terminal

One binary in any shell. Output goes to your terminal's own scrollback, and you can steer a turn while it runs.

Install it

Shoal as an editor panel

VS Code

A panel in the editor, speaking to the same engine. Ask about a selection from the context menu.

Install it

Shoal as its own window

Desktop

Its own window, no terminal needed once installed. The Start Menu entry points straight at it.

Install it

What is here

How to read these pages

Everything in the reference is generated from the program. Commands, flags, defaults, the slash menus, the keys, and the editor's settings are read out of the binary and its clients at version 0.21.0 rather than written down beside them, so the reference cannot drift from what runs on your machine.

The guides are written by hand, and they say what is built. Where something is designed but not working yet, they say that instead of describing it as though it were finished. Shoal is pre-alpha, and the capabilities section on the home page states what is verified, what is built but unused, and what is absent.