Skip to main content

Install Flatboat

Flatboat only works on Linux based systems, compatible with Docker Engine.

Install the Dependencies​

Install Docker Engine​

The main thing required to run Flatboat is the Docker Engine. Alternative container engines like Podman may work, but are not officially supported.

You can install Docker following the instructions on their documentation.

  • It's not recommended to use a Docker rootless installation.
  • It's recommended to add your $USER to docker group.

Install NodeJS and NPM​

The next thing is NodeJS runtime for javascript applications and NPM for installing packages. You can download these command-line tools from the following sources:

warning

It is possible in the future that NodeJS removes NPM from its default installation, which may require another installation.

Install Devcontainer packages​

Devcontainer is an specification created by Microsoft for development inside containers, which is used by Flatboat. Therefore, is required to install with the following command:

sudo npm i -g @devcontainers/cli

Install Rust and Cargo​

Flatboat is developed in Rust programming language, and published on crates.io. So in order to install it the Cargo package manager is required, and can be installed with the following command:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

When prompted, is recommended to choose the default installation.

Run the Command​

Install Flatboat with cargo

  cargo install flatboat

Usage​

Learn about Flatboat with:

  flatboat -h