gongreqif

README

GongReqif - ReqIF File Analyzer

GongReqif is a command-line tool for analyzing and inspecting OMG ReqIF (Requirements Interchange Format) files. You can easily browse or drop your .reqif or .reqifz files to get a structured view of the requirements data.

GongReqif displaying the Data Types and Specification Types from a loaded ReqIF file.

A view of the specific objects, relations, and specification hierarchies within the file.

A view of the rendering of a specification.

About the Project

The Requirements Interchange Format (ReqIF) is an open, XML-based standard used to exchange requirements between different software tools, particularly in the automotive, aerospace, and defense industries. A .reqif file is a single XML file, while a .reqifz is a compressed archive containing the .reqif file and associated attachments, such as images.

GongReqif provides a simple interface to parse and visualize the hierarchical structure, attributes, and relationships within these requirement files, facilitating a quick and clear analysis without needing complex enterprise software.

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

You need to have Go version 1.24 or higher installed on your system. You can find the installation instructions on the official Go website:

• Go Installation Guide

Installation & Running the Application

You can run the application directly from the source using the go run command. This command will fetch the package and its dependencies and execute the main command.

go run github.com/fullstack-lang/gongreqif/go/cmd/gongreqif@main

Usage

Once the application is running, launch a browser on http://localhost:8080/ where you can interact with your ReqIF files.

1. Open a file: You can either drag and drop a .reqif or .reqifz file directly onto the application window.
2. Browse for a file: Alternatively, you can click the "Browse" button to open a file dialog and select your desired ReqIF file.

The application will then process the file and display its contents for analysis.

You can download the "reqif" sample file, ReqIF for Wheeled Tennis Ball Drone.reqif, directly using the link below.

• Download the ReqIF Sample File

Once downloaded, you can open it in the application using the drag-and-drop or browse method described above.

If you want to see images, you can download the "reqifz" sample file, ReqIF for Wheeled Tennis Ball Drone.reqifz, directly using the link below.

• Download the ReqIF Sample File (ReqIF file zipped with images)

Once downloaded, you can open it in the application using the drag-and-drop or browse method described above.

You then configure the rendering configuration for each of the 3 specifications or you can all download the rendering configuration for the sample file, directly using the ling below.

• Download Rendering Conf of Sample File

Once downloaded, go to the "ReqIF render" and you can open it in the application using the drag-and-drop or browse method described above.

Distributed under the MIT License. See LICENSE for more information.