gongreqif

package module
v0.0.0-...-a750ecd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 20, 2025 License: MIT Imports: 1 Imported by: 0

README

GongReqif - ReqIF File Analyzer

Go Version

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.

Datatypes and Spec Types from a loaded ReqIF file 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 specific objects, relations, and specification hierarchies within the file.

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:

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.

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

Documentation

Index

Constants

This section is empty.

Variables

View Source
var NgDistNg embed.FS

NgDistNg is the export of angular distribution. This allows embedding of the pages in the web server

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
go
Package gongreqif gongreqif backend API
Package gongreqif gongreqif backend API
controllers
generated code - do not edit
generated code - do not edit
db
generated code - do not edit
generated code - do not edit
diagrams
generated code - do not edit Package diagrams implements uml diagrams for documenting the gongreqif stack.
generated code - do not edit Package diagrams implements uml diagrams for documenting the gongreqif stack.
fullstack
do not modify, generated file
do not modify, generated file
models
Default generated models package docs (at least one file is necessary in a models package)
Default generated models package docs (at least one file is necessary in a models package)
orm
generated by stacks/gong/go/models/orm_file_per_struct_back_repo.go
generated by stacks/gong/go/models/orm_file_per_struct_back_repo.go
orm/dbgorm
generated code - do not edit
generated code - do not edit
probe
generated code - do not edit
generated code - do not edit
stack
do not modify, generated file
do not modify, generated file
static
generated code - do not edit
generated code - do not edit

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL