fprime

(★ 11,681)

F´ - A flight software and embedded systems framework

File Explorer

Showing a partial file list — download the zip above to see everything.

  • .clang-format
  • .clang-tidy
  • .gitignore
  • .gitmodules
  • .nav.yml
  • .pre-commit-config.yaml
  • AGENTS.md
  • AI_POLICY.md
  • CITATION.cff
  • CLAUDE.md
  • CMakeLists.txt
  • CMakePresets.json
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • GOVERNANCE.md
  • LICENSE.txt
  • NOTICE.txt
  • README.md
  • SECURITY.md

# Installation Guide

python
Prerequisites

Setup Steps

pip install fprime-bootstrap

Install the F' bootstrapping tool.

fprime-bootstrap project

Create a new F' project.

Key Commands

pip install fprime-bootstrap

Install the fprime-bootstrap package.

fprime-bootstrap project

Create a new F' project using the bootstrap wizard.

Using a Python virtual environment on Linux, Windows WSL, or macOS is recommended.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Showing a partial file list.

Release Timeline

Actively Maintained

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

git

View Details ▼

Distributed version control system.
Some subcommands such as `commit`, `add`, `branch`, `switch`, `push`, etc. have their own usage documentation.

git init

Create an empty Git repository:

git clone {{https://example.com/repo.git}}

Clone a remote Git repository from the internet:

git status

View the status of the local repository:

🔍

pip install

View Details ▼

Install Python packages.

pip install {{package1 package2 ...}}

Install one or more packages:

pip install {{package1 package2 ...}} {{[-U|--upgrade]}}

Upgrade all specified packages to the latest version, installing any that are not already present:

pip install {{package}}=={{version}}

Install a specific version of a package:

🔍

pip

View Details ▼

Python package manager.
Some subcommands such as `install` have their own usage documentation.

pip install {{package}}

Install a package (see `pip install` for more install examples):

pip install --user {{package}}

Install a package to the user's directory instead of the system-wide default location:

pip install {{[-U|--upgrade]}} {{package}}

Upgrade a package:

🔍

pip3

View Details ▼

This command is an alias of `pip`.

tldr pip

View documentation for the original command:

🔍

pipx

View Details ▼

Install and run Python applications in isolated environments.

pipx run {{pycowsay}} {{moo}}

Run an app in a temporary virtual environment:

pipx install {{package}}

Install a package in a virtual environment and add entry points to path:

pipx uninstall {{package}}

Uninstall a package:

🔍

python

View Details ▼

Python language interpreter.

python

Start a REPL (interactive shell):

python {{path/to/file.py}}

Execute a specific Python file:

python -i {{path/to/file.py}}

Execute a specific Python file and start a REPL:

🔍

python3

View Details ▼

This command is an alias of `python`.

tldr python

View documentation for the original command:

🔍

then

View Details ▼

This shell keyword is used in combination with `if` and `elif` to separate branches and branch conditions.

tldr if

View documentation for `if` command:

// repository documentation