Skip to content

Prerequisites

Before using and developing flowcean, ensure you have the necessary tools and environments set up. This page outlines the requirements and how to install them.

Git

Git is a widely used version control system that will help you manage the source code and dependencies. Follow the steps below to download and install Git or consult the official documentation.

Most Linux distributions have Git available in their package managers. You can install it by running one of the following commands, depending on your distribution:

# Debian-based distributions like Ubuntu
sudo apt-get install git
# Fedora
sudo dnf install git
# Arch Linux
sudo pacman -S git

You can install Git using a package manager like Homebrew. If you have Homebrew installed, simply run:

brew install git

Visit the official Git website and download the appropriate version of Git for your operating system. Run the downloaded .exe file and follow the installation instructions. You might want to select the default options unless you have specific needs.

Verify the installation by checking the version:

git --version

This command should display the installed version of Git.

uv

uv is a package manager and environment management tool that eases the handling of Python projects. Install uv if you don't already have it:

curl -LsSf https://astral.sh/uv/install.sh | sh

curl -LsSf https://astral.sh/uv/install.sh | sh

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

See the installation documentation for details and alternative installation methods.

Python

While uv manages the necessary Python interpreters for you, you might want to install Python manually if you don't intend to use uv.

Manual Python Installation

Most Linux distributions come with Python pre-installed. However, you can also install or update Python using your package manager:

  • For Debian-based distributions (like Ubuntu):
sudo apt-get update
sudo apt-get install python3
  • For Fedora:
sudo dnf install python3
  • For Arch Linux:
sudo pacman -S python
  • Install Python using Homebrew by running:
brew install python
  • Alternatively, download the installer from the official Python website and follow the instructions.
  1. Download the latest version of Python from the official Python website.
  2. Run the downloaded installer. Be sure to check the "Add Python to PATH" option before installing.
  3. Follow the installation prompts to complete the process.

Verify the installation by checking the Python version:

python3 --version

or, if python3 is unavailable, try:

python --version

This command should display the installed version of Python.

Just

just is a handy way to save and run project-specific commands. Follow the steps below to download and install just as a pre-built binary or consult the official installation guide.

You can use the following command on Linux, MacOS, or Windows to download the latest release, just replace <DEST> with the directory where you'd like to put just:

curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to <DEST>

For example, to install just to ~/.local/bin:

# create ~/.local/bin
mkdir -p ~/.local/bin

# download and extract just to ~/.local/bin/just
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to ~/.local/bin

# add `~/.local/bin` to the paths that your shell searches for executables
# this line should be added to your shells initialization file,
# e.g. `~/.bashrc` or `~/.zshrc`
export PATH="$PATH:$HOME/.local/bin"

# just should now be executable
just --help