Skip to main content

IFC CONSOLE

A terminal interface that connects IFC files to LLMs. ifc-console loads your model with IfcOpenShell and serves it over MCP. Claude, Cursor, VS Code, Codex, and other MCP clients can inspect or edit the model while you keep control from the terminal.

No Blender or host BIM application is required. It runs locally on Windows, macOS, and Linux.

Terminal console AI assistant 3D viewer
The ifc-console terminal with a model loaded Claude Desktop summarising an IFC model The local ifc-console 3D viewer

Why ifc-console

LLMs are good at BIM data work: finding elements, auditing properties, writing IfcOpenShell scripts, and explaining schema quirks. ifc-console is the safe, zero-setup bridge between an LLM client and an IFC file.

  • You stay in control. The ask/edit switch decides whether the LLM may change the in-memory model. AI saving is disabled by default, so only you persist reviewed changes with /save.
  • It runs anywhere. The core Python package runs on Windows, macOS, and Linux. The local 3D viewer is an optional install.
  • It is honest. Errors include useful hints. Mutations are audited, saves are atomic with backups, and the docs state what the sandbox does and does not guarantee.

Install and run

uv tool install ifc-console
# Include the optional 3D viewer and browser chat:
uv tool install "ifc-console[viewer]"

You can use pip instead, or try the core application once with uvx ifc-console.

Start it in the folder containing your models:

cd path/to/your/models
ifc-console

Then:

> /file             choose an IFC model
> /connect codex    copy one-time client setup
> /viewer           open the optional 3D viewer

Paste the copied setup into your AI client and restart that client once. Future sessions are simply: start ifc-console, choose a file, and chat.

Ask or edit

mode what the AI can do
ask (default) inspect and analyze the model
edit also change the model in memory

Use /mode edit only when you want changes. Review them, then /save to keep them or /reload to discard them. The AI cannot change the mode, and AI tools cannot save unless you explicitly enable files.allow_ai_save.

On CPython 3.12+, eligible read-only generated code normally runs in a restricted process without network or subprocess access. Python 3.10 and 3.11 remain supported, but cannot provide that complete audit-hook boundary; auto reports a guarded fallback and strict refuses it. Mutating code runs in the main process because it must reach the live model. Read Safety before editing untrusted files or prompts.

What it includes

  • IFC queries, properties, quantities, validation, clash detection, and CSV export.
  • Multi-model coordination and an offline IFC/IfcOpenShell reference.
  • A Python SDK for scripts, CI, workflows, and agent applications.
  • Optional browser viewer, chat panel, and trusted operation plugins.
from ifc_console import Workbench

with Workbench.open("tower.ifc") as wb:
    walls = wb.query("IfcWall")
    print(len(walls))

Documentation

For development setup and tests, see the contributing guide.

License

The core package is Apache-2.0 and uses IfcOpenShell (LGPL-3.0-or-later). The optional viewer includes Three.js (MIT) and web-ifc (MPL-2.0).

Inspired by Bonsai MCP.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ifc_console-0.1.4.tar.gz (513.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ifc_console-0.1.4-py3-none-any.whl (393.1 kB view details)

Uploaded Python 3

File details

Details for the file ifc_console-0.1.4.tar.gz.

File metadata

  • Download URL: ifc_console-0.1.4.tar.gz
  • Upload date:
  • Size: 513.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ifc_console-0.1.4.tar.gz
Algorithm Hash digest
SHA256 fd1459428ebddf20cc7c7b3ca49ad3ca49d8955816afb9c541794d2894a73504
MD5 4e74c3cf469efdfa7b21dbab28ca0045
BLAKE2b-256 8dfea30cdd9e6ad98b313ade853bba75372e569d4e697601605e2d1e0e031ba3

See more details on using hashes here.

Provenance

The following attestation bundles were made for ifc_console-0.1.4.tar.gz:

Publisher: release.yml on nbharathik/ifc-console

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ifc_console-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: ifc_console-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 393.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ifc_console-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ca80409bcf0bf59a1d1d31e7553df3ec0d177922d4af28edc966c3ad7ebbdae6
MD5 d606ab55e427f8ccd63f398f273a78a9
BLAKE2b-256 6e25e81eaa73e8a30f8665e59ad2e0866639790919453afb1cd6748576bf9751

See more details on using hashes here.

Provenance

The following attestation bundles were made for ifc_console-0.1.4-py3-none-any.whl:

Publisher: release.yml on nbharathik/ifc-console

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page