Skip to content

Installing and using Pipefish

tim-hardcastle edited this page Nov 15, 2025 · 13 revisions

Installation

To install Pipefish, download and unzip the Pipefish repository, then install Go, and then in your terminal go into the main pipefish folder and go build. You now have a working copy of Pipefish. Start using it with ./pipefish tui to open up the TUI, the Text User Interface; the first time you do this it will take a second or two to build some auxiliary files.

And then you will see something like this in your terminal:

image

This is a REPL. Even though no service is running yet, it will still evaluate expressions using the built-in features of Pipefish.

image

You can stop it with hub quit, or Ctrl+C. We will discuss what the hub is later on.

How best to use Pipefish

We have supplied Pipefish with a VSCode extension which highlights Pipefish code and takes care of indentation for you. You can add this to VSCode with cp -r <Main folder of the Pipefish distribution>/pipefish-highlighter ~/.vscode/extensions. If VSCode is already running, it may be necessary to restart it.

We intend to add support for other editors, but until then, the best way to code in Pipefish is probably to edit your scripts in VSCode while running the Pipefish TUI in a terminal in the bottom panel, like this. We will use this format to demonstrate Pipefish's features in the rest of this wiki.

image

If you are using VSCode for the first time, note that it ships with autosave turned off. We recommend that you turn it on.

🧿 Pipefish

Clone this wiki locally