OFT logo OpenFastTrace

What is OpenFastTrace?

OpenFastTrace (short OFT) is a requirement tracing suite. Requirement tracing keeps track of whether you actually implemented everything you planned to in your specifications. It also identifies obsolete parts of your product and helps you to get rid of them.

You can learn more about requirement tracing and how to use OpenFastTrace in the user guide.

Below you see a screenshot of an HTML tracing report where OFT traces itself. You see a summary followed by a detail view of the traced requirements.

Project Information

Build Maven Central

Sonarcloud status:

Quality Gate Bugs Code smells Coverage Duplicated Lines Lines of Code Maintainability Rating Reliability Rating Security Rating Technical Dept Vulnerabilities

User Guides and Tools

• 📖 User Guide
• 🔌 Extending OpenFastTrace With Plugins
• 💲 Command Line Usage
• 🛠 IntelliJ Plugin (PyCharm, Clion, etc.)

News and Discussions

• 📢 Blog
• ➕ Changelog
• 📅 Upcoming Milestones
• 🗨️ Discussion Board
• 🐘 OpenFastTrace@mastodon.social
• ✨ OpenFastTrace Stories
• i️ About us

Information for Contributors

• 🎟️ Project Board
• 🦮 Developer Guide
• 🔌 Plugin Developer Guide
• 🎁 Contributing Guide
• 🤝 Code of Conduct
• 🤖 AI Agent Guide
• 💡 System Requirements
• 👜 Design

Demos and Presentations

• 📹 Introduction Video (YouTube, 3:30 minutes)
• 🛗 Elevator pitch
• 📽️ OpenFastTrace Presentation (LibreOffice, 20 minutes)
• 🎬 OpenFastTrace Live Demo Script (Markdown, 1 hour)

Using OpenFastTrace

If you want to use OFT, you have the choice between using it as part of your build process — typically with Maven or Gradle. Or you can run OFT from the command line.

Check the user guide for detailed information on how to use OpenFastTrack.

Getting OpenFastTrace

OpenFastTrace at it's core is a Java Archive (short "JAR"). This file contains the OpenFastTrace Library and an entry point for running OFT from the command line.

Getting Pre-Built Packages

Pre-Built JAR files (called openfasttrace-4.2.0.jar) are available from the following places:

• Maven Central
• GitHub

Check our developer guide to learn how to use the OFT JAR as dependency in your own code with popular build tools.

Installation

Runtime Dependencies

OpenFastTrace 4.0.0 and above only needs a Java 17 (or later) runtime environment to run. OpenFastTrace until version 3.x.x supported Java 11. Versions prior to that ran with Java 8. Note that only the latest version of OFT is actively supported.

Installation of Runtime Dependencies on Linux

Ubuntu or Debian

If you just want to run OFT:

apt-get install openjdk-17-jre

Running OpenFastTrace

Run JAR File

The most basic variant to run OpenFastTrace is directly from the JAR file via the command line:

java -jar product/target/openfasttrace-4.2.0.jar trace /path/to/directory/being/traced

If you want to run OFT automatically as part of a continuous build, we recommend using our plugins for Gradle and Maven.

For more details about how to run OFT please consult the user guide.

Download and Execute in Continuous Integration

If you want to run OFT in a CI build, you can use the OFT wrapper script oftw.sh. The script only requires Java 17 and Maven and downloads the OFT JAR from Maven Central if it is not yet available in the local Maven repository $HOME/.m2/repository.

Development

If you want to learn how to build OpenFastTrace, please check our Developer Guide.

You would like to contribute to OFT? Please check out our Contributor Guide to get started.