Bombastic is in early stages of development. Until a major version is released, incompatibility changes may occur. If you have a feature proposal, found incorrect behavior or any suggestion, please consider filing an issue.

Bombastic creates Bill of Materials (BoM) documents from Industry Foundation Classes (IFC) files.

Features

• Compatible with the IFC2x3 TC1 specification.
• Shipped both as a command line tool and as a dependency.
• Supported BoM formats: HTML.
• Project is 100% TypeScript.
• Native support for Bun.sh.

Bombastic also has the following features in its near-term roadmap:

• PDF BoM format support.
• Improved UX for bombastic-cli.
• Documentation website.
• Improved, configurable UI BoM templates.
• Support for IFC4 ADD2 TC1 and IFC 4.3 ADD2 specifications.

Getting started

Installation

Installing the command line tool

Currently, the command-line tool is only supported in Linux-x86_64. Support for more systems and architectures will arrive gradually, based on ease of integration and community demand.

The command-line tool is available for download in the latest bombastic-cli release.

Installing the npm dependency

Adding the npm dependency to your package is performed differently depending on your package manager.

Popular choices are:

# npm
npm install bombastic-ifc

# Yarn
yarn add bombastic-ifc

# pnpm
yarn add bombastic-ifc

# Bun
bun add bombastic-ifc

Generating BoM documents

The following examples feature how to use an IFC file, example.ifc to generate an HTML BoM report, example_bom.html.

Using the command line tool

bombastic -i example.ifc -f html -o example_bom.html

Using the npm dependency

import { BOMGenerator } from "bombastic-ifc";

// Instantiate the BoM generator
const generator = BOMGenerator();

// Generate BoM document file
generator.generate("example.ifc", "html", "example_bom.html");