bimai 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. bimai-0.1.0/LICENSE +21 -0
  2. bimai-0.1.0/PKG-INFO +280 -0
  3. bimai-0.1.0/README.md +246 -0
  4. bimai-0.1.0/cli/bimai/__init__.py +3 -0
  5. bimai-0.1.0/cli/bimai/__main__.py +5 -0
  6. bimai-0.1.0/cli/bimai/bridges.py +277 -0
  7. bimai-0.1.0/cli/bimai/catalogue/presets/bim-coordinator.yaml +5 -0
  8. bimai-0.1.0/cli/bimai/catalogue/presets/bim-modeller.yaml +5 -0
  9. bimai-0.1.0/cli/bimai/catalogue/presets/design-coordinator.yaml +5 -0
  10. bimai-0.1.0/cli/bimai/catalogue/presets/information-manager.yaml +5 -0
  11. bimai-0.1.0/cli/bimai/catalogue/roles/coordinator.md +30 -0
  12. bimai-0.1.0/cli/bimai/catalogue/roles/information-manager.md +28 -0
  13. bimai-0.1.0/cli/bimai/catalogue/roles/issue-manager.md +26 -0
  14. bimai-0.1.0/cli/bimai/catalogue/roles/mentor.md +30 -0
  15. bimai-0.1.0/cli/bimai/catalogue/roles/model-checker.md +28 -0
  16. bimai-0.1.0/cli/bimai/catalogue/roles/planning-analyst.md +28 -0
  17. bimai-0.1.0/cli/bimai/catalogue/roles/requirements-risk-manager.md +30 -0
  18. bimai-0.1.0/cli/bimai/catalogue/roles/scribe.md +28 -0
  19. bimai-0.1.0/cli/bimai/catalogue/servers.yaml +121 -0
  20. bimai-0.1.0/cli/bimai/catalogue/tools.yaml +56 -0
  21. bimai-0.1.0/cli/bimai/claude.py +223 -0
  22. bimai-0.1.0/cli/bimai/cli.py +630 -0
  23. bimai-0.1.0/cli/bimai/connections.py +286 -0
  24. bimai-0.1.0/cli/bimai/files.py +68 -0
  25. bimai-0.1.0/cli/bimai/init.py +162 -0
  26. bimai-0.1.0/cli/bimai/scan.py +119 -0
  27. bimai-0.1.0/cli/bimai/schemas/automation.schema.json +37 -0
  28. bimai-0.1.0/cli/bimai/schemas/ownership.schema.json +80 -0
  29. bimai-0.1.0/cli/bimai/schemas/people.schema.json +52 -0
  30. bimai-0.1.0/cli/bimai/schemas/project.schema.json +80 -0
  31. bimai-0.1.0/cli/bimai/schemas/seat.schema.json +61 -0
  32. bimai-0.1.0/cli/bimai/schemas/workflow.schema.json +130 -0
  33. bimai-0.1.0/cli/bimai/team.py +157 -0
  34. bimai-0.1.0/cli/bimai/update.py +78 -0
  35. bimai-0.1.0/cli/bimai/validate.py +261 -0
  36. bimai-0.1.0/cli/bimai.egg-info/PKG-INFO +280 -0
  37. bimai-0.1.0/cli/bimai.egg-info/SOURCES.txt +41 -0
  38. bimai-0.1.0/cli/bimai.egg-info/dependency_links.txt +1 -0
  39. bimai-0.1.0/cli/bimai.egg-info/entry_points.txt +2 -0
  40. bimai-0.1.0/cli/bimai.egg-info/requires.txt +7 -0
  41. bimai-0.1.0/cli/bimai.egg-info/top_level.txt +1 -0
  42. bimai-0.1.0/pyproject.toml +57 -0
  43. bimai-0.1.0/setup.cfg +4 -0
bimai-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 bimai contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
bimai-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,280 @@
1
+ Metadata-Version: 2.4
2
+ Name: bimai
3
+ Version: 0.1.0
4
+ Summary: An open-source BIM team that lives in your editor: AI agents for BIM coordination, built on Claude Code
5
+ Author: bimai contributors
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://docs.bimai.nl
8
+ Project-URL: Documentation, https://docs.bimai.nl
9
+ Project-URL: Source, https://github.com/StefanDaniels1/BIMAI
10
+ Project-URL: Issues, https://github.com/StefanDaniels1/BIMAI/issues
11
+ Keywords: bim,aec,revit,civil-3d,ifc,claude-code,mcp,ai-agents
12
+ Classifier: Development Status :: 2 - Pre-Alpha
13
+ Classifier: Environment :: Console
14
+ Classifier: Intended Audience :: End Users/Desktop
15
+ Classifier: Intended Audience :: Other Audience
16
+ Classifier: Operating System :: Microsoft :: Windows
17
+ Classifier: Operating System :: MacOS
18
+ Classifier: Operating System :: POSIX :: Linux
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Topic :: Scientific/Engineering
24
+ Requires-Python: >=3.11
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Requires-Dist: pyyaml>=6
28
+ Requires-Dist: jsonschema>=4.18
29
+ Requires-Dist: keyring>=24
30
+ Provides-Extra: dev
31
+ Requires-Dist: pytest; extra == "dev"
32
+ Requires-Dist: python-docx; extra == "dev"
33
+ Dynamic: license-file
34
+
35
+ <p align="center">
36
+ <img src="https://raw.githubusercontent.com/StefanDaniels1/BIMAI/main/assets/logo.svg" alt="bimai — a BIM team at your command" width="720">
37
+ </p>
38
+
39
+ <p align="center">
40
+ <strong>An open-source BIM team that lives in your editor.</strong><br>
41
+ Coordinate models, track requirements and risks, triage issues, write the minutes and plan your week,<br>
42
+ with AI agents that follow your BIM process and show their evidence.
43
+ </p>
44
+
45
+ <p align="center">
46
+ <a href="https://docs.bimai.nl"><strong>Documentation</strong></a> ·
47
+ <a href="https://docs.bimai.nl/docs/why">For managers and directors</a> ·
48
+ <a href="https://docs.bimai.nl/docs/example-project">Example project</a>
49
+ </p>
50
+
51
+ <p align="center">
52
+ <img alt="Status: pre-alpha" src="https://img.shields.io/badge/status-pre--alpha-FFB000?style=flat-square">
53
+ <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-FFB000?style=flat-square">
54
+ <img alt="Harness: Claude Code" src="https://img.shields.io/badge/harness-Claude%20Code-FFB000?style=flat-square">
55
+ <img alt="Open BIM ready" src="https://img.shields.io/badge/open%20BIM-IFC%20%C2%B7%20IDS%20%C2%B7%20BCF%20%C2%B7%20USD-FFB000?style=flat-square">
56
+ </p>
57
+
58
+ ---
59
+
60
+ > **⚠️ Pre-alpha.** bimai is being designed in the open. The architecture is written; the code is starting now.
61
+ > Commands below show the target experience for v0.1. Working so far: the [meeting-intake pack](packs/meeting-intake/), the [project-site generator](packs/project-site/) and the [documentation site](docs/). Star or watch the repo to follow along, and see [Contributing](#contributing) to help shape it.
62
+
63
+ ## What is bimai?
64
+
65
+ AI can now read your Revit model and your ACC issues. What's missing is someone who knows **what a BIM professional actually does with them**: run the coordination round, check a delivery, chase the open issues, write it up, and remember what was decided.
66
+
67
+ bimai is that someone. It turns an AI coding harness (Claude Code first) into a **BIM team**:
68
+
69
+ ```
70
+ You: "Prepare Thursday's coordination meeting."
71
+
72
+ 🧭 Coordinator workflow: weekly-coordination → 6 steps, 2 parallel lanes
73
+ 📋 Issue Manager 47 open ACC issues · 9 overdue · 3 clusters found ⎤ in
74
+ 🔍 Model Checker delivery check on 3 models: 2 findings ⎦ parallel
75
+ ✋ You review the findings → approve
76
+ ✍️ Scribe agenda written · 4 open decisions · evidence cited
77
+ ```
78
+
79
+ Every agent works from files in your project repo, follows a workflow you define, cites the tool calls behind every claim, and **asks before it changes anything**.
80
+
81
+ ## Why bimai?
82
+
83
+ | Today | With bimai |
84
+ |---|---|
85
+ | Plenty of Revit and ACC MCP servers, but each is a single tool with no BIM workflow | A team with BIM roles that knows what a clash round or a delivery check involves |
86
+ | Coding agents built for developers (frontend, backend, tester) | Roles BIM people recognise: coordinator, information manager, model checker, scribe |
87
+ | Vendor assistants that stay inside one product | One place that works across ACC, Revit, open formats and Microsoft 365 |
88
+ | AI answers you can't trace | Every output cites its evidence; every decision is logged in git |
89
+ | Chat that forgets | A project memory the whole team shares by cloning the repo |
90
+
91
+ ## What you get
92
+
93
+ - **🧑‍🤝‍🧑 A team that fits your role:** a short interview at `bimai init` picks a small team from a catalogue (Coordinator, Requirements & Risk Manager, Planning Analyst, Information Manager, Model Checker, Issue Manager, Scribe, and more). A design coordinator gets a different team than a BIM modeller, and no one gets members they don't need.
94
+ - **📄 Your BEP becomes the configuration:** drop the BIM execution plan (Word or PDF) at onboarding. bimai extracts naming rules, tools and versions, responsibilities, coordination rhythm and milestones, each with its page reference, and sets up the project from what was actually agreed after you review it.
95
+ - **🌐 A site for every project:** a private website, generated from the project files, that explains the people, their AI teams, the BEP agreements, decisions, meetings and this week's work. Made for new colleagues, managers, directors and clients who never open VS Code. [See the example](https://docs.bimai.nl/docs/example-project).
96
+ - **👀 Open by default, so no context is lost:** each session leaves a short journal entry in the project, and project tasks are shared, so anyone can ask "what did the team do this week?" and a colleague covering for you knows where you left off. Your desk (plans, preferences, other clients' projects) stays private.
97
+ - **🤝 Work together, each with your own team:** a modeller, a coordinator and a design manager share one project: the same rules, context and decisions, but each with their own team. Every responsibility has one owner, and agents hand work to each other instead of getting in each other's way. Add more modellers or coordinators per discipline or zone, and hand over or cover a job when someone leaves or is ill; the agents' knowledge stays with the job.
98
+ - **🙈 No git or programming needed:** bimai saves, shares, updates and restores your work automatically, in plain language. Git runs underneath for history and safety; you never see it.
99
+ - **🎙️ Meeting transcripts to tasks:** drop the Teams or Zoom transcript of a coordination session. bimai writes the minutes, logs the decisions, gives each person their tasks and hands role-level work to the right position. Whenever it isn't sure (which Jan? decided or just discussed? project matter or personal?), it asks the person who uploaded it before anything is applied.
100
+ - **📐 Design coordination from your exports:** drop in a Relatics JSON export and a Primavera or MS Project XML planning, and get requirements status, risk reviews, schedule health and a weekly design progress report, with trends from every snapshot.
101
+ - **🗺️ Workflows, not improvisation:** chain small steps (scripts, tool calls, agents, other workflows, human approvals) in YAML, sequentially or in parallel. The engine decides the order; agents only do the thinking, so simple steps cost no tokens.
102
+ - **📅 A personal planner:** all your tasks and deadlines across projects, with a morning plan, a Friday review and deadline warnings.
103
+ - **🔌 Standard connectors:** ACC/Forma, the Autodesk AEC Data Model, Microsoft Graph, desktop apps like Revit, Civil 3D, Bentley OpenRoads and Blender/Bonsai, and open formats like IFC, all behind one gateway with the same safety rules.
104
+ - **⏰ Daily automations:** any workflow on a schedule (Windows Task Scheduler, cron or GitHub Actions). Unattended runs *propose* changes; you approve them later.
105
+ - **🧾 Evidence and memory in git:** decisions, history and a full audit trail, versioned alongside your project.
106
+ - **📊 See your setup:** `bimai graph` draws your team, workflows, connectors and projects as diagrams that render in GitHub and VS Code.
107
+ - **🪟 Windows, macOS and Linux:** cross-platform core; Windows-only BIM apps are clearly marked.
108
+ - **💶 Low token cost by default:** most roles run on smaller models; scripts do the counting and checking.
109
+
110
+ ## How it works
111
+
112
+ bimai doesn't build its own agent runtime. It **configures** one, the way a Linux distribution configures a kernel.
113
+
114
+ ```mermaid
115
+ flowchart LR
116
+ U[You in VS Code] --> CC[Claude Code]
117
+ CC --> P[bimai plugin<br/>roles · packs · hooks]
118
+ P --> W[.bimai/ in your repo<br/>workflows · decisions · evidence]
119
+ P --> G[bimai gateway]
120
+ G --> A[ACC / Forma · AEC Data Model]
121
+ G --> R[Revit · Civil 3D · OpenRoads · Bonsai]
122
+ G --> O[IFC · IDS · BCF · USD]
123
+ G --> M[Microsoft 365]
124
+ ```
125
+
126
+ Everything is one of five building blocks:
127
+
128
+ | Block | What it is |
129
+ |---|---|
130
+ | **Team** | Agent roles as markdown charters |
131
+ | **Workflow** | YAML that chains steps (scripts, tools, agents, other workflows, human gates) sequentially or in parallel |
132
+ | **Pack** | A reusable BIM procedure: a skill plus its scripts, templates and tests |
133
+ | **Connector** | A standard bridge to one tool: an API, a desktop app, a file format, or an existing MCP server |
134
+ | **Automation** | A workflow on a schedule |
135
+
136
+ A workflow reads like a checklist. Steps without `needs` run in parallel:
137
+
138
+ ```yaml
139
+ id: weekly-coordination
140
+ steps:
141
+ fetch-issues: { tool: issues.list, with: { status: open } }
142
+ fetch-models: { tool: model.list_published }
143
+ cluster: { needs: [fetch-issues], script: acc-issue-triage/cluster.py }
144
+ check-models: { needs: [fetch-models], foreach: "${{ steps.fetch-models.output }}", workflow: delivery-check }
145
+ review: { needs: [cluster, check-models], gate: approval }
146
+ agenda: { needs: [review], agent: scribe, pack: coordination-meeting }
147
+ ```
148
+
149
+ The full design is in **[ARCHITECTURE.md](ARCHITECTURE.md)**.
150
+
151
+ ## Install
152
+
153
+ One line, no Python, git or administrator rights needed:
154
+
155
+ ```powershell
156
+ # Windows
157
+ powershell -ExecutionPolicy ByPass -c "irm https://docs.bimai.nl/install.ps1 | iex"
158
+ ```
159
+
160
+ ```bash
161
+ # macOS and Linux
162
+ curl -LsSf https://docs.bimai.nl/install.sh | sh
163
+ ```
164
+
165
+ Then run `bimai init` in your project folder. Update any time with `bimai update`.
166
+ More: [Install bimai](https://docs.bimai.nl/docs/start/install).
167
+
168
+ ## Quick start (target for v0.1)
169
+
170
+ ```bash
171
+ # 1. once per computer (planned): checks git and Claude Code, signs you in, creates your desk
172
+ bimai setup
173
+
174
+ # try everything first with sample data, no accounts needed
175
+ bimai new --demo
176
+
177
+ # 2a. start a new project (usually the BIM coordinator or information manager)
178
+ bimai new a2-knooppunt # creates the shared project, runs the interview, gives a join link
179
+
180
+ # 2b. or join a project a colleague already started
181
+ bimai join https://github.com/your-org/a2-knooppunt
182
+ ```
183
+
184
+ Everything lands in one folder on your computer:
185
+
186
+ ```
187
+ ~/bimai/
188
+ ├── desk/ private to you: your projects, plans, preferences
189
+ └── projects/
190
+ └── a2-knooppunt/ shared with the project team: rules, decisions, everyone's tasks and journal
191
+ ```
192
+
193
+
194
+ ```
195
+ ? What's your role on this project? design coordinator
196
+ ? Drop your BEP (Word or PDF): BEP-A2-knooppunt-v3.pdf
197
+ ✓ 38 agreements found · 2 open questions · Revit 2025, OpenRoads 2023, ACC
198
+ ? What do you want help with? requirements, risks, planning, progress reporting
199
+ ? Which data do you have? Relatics export, Primavera planning
200
+
201
+ Proposed team (4 of max 5):
202
+ 🧭 Coordinator always
203
+ 📐 Requirements & Risk Manager goals: requirements, risks · data: Relatics
204
+ 📅 Planning Analyst goal: planning · data: Primavera XML
205
+ ✍️ Scribe goal: progress reporting
206
+ ? Confirm team? yes
207
+ ```
208
+
209
+ ```bash
210
+ # add your exports (or drop them in .bimai/data/inbox/)
211
+ bimai data import exports/relatics.json
212
+ bimai data import planning/DO-planning.xml
213
+ ```
214
+
215
+ Then `bimai open a2-knooppunt` opens the project in VS Code with Claude Code ready. Try:
216
+
217
+ ```
218
+ /bimai:meeting process a meeting transcript into minutes and tasks
219
+ /bimai:report weekly design progress report
220
+ /bimai:triage triage open ACC issues
221
+ /bimai:meeting-prep agenda from issues + open decisions
222
+ /bimai:delivery-check check a model against your delivery checklist
223
+ /bimai:plan plan my day across all projects
224
+ ```
225
+
226
+ ## Principles
227
+
228
+ 1. **Configure the harness, don't rebuild it.** Improvements to Claude Code make bimai better for free.
229
+ 2. **Files are the source of truth.** Team, workflows, decisions and history live in git.
230
+ 3. **Agents reason, scripts decide.** Anything checkable is computed by deterministic code.
231
+ 4. **Read by default.** Every write goes through a human approval gate.
232
+ 5. **Every claim has evidence.**
233
+ 6. **One contract for every extension.** A community connector behaves exactly like a built-in one.
234
+ 7. **Open formats first.** IFC, IDS, BCF and OpenUSD are the long-term backbone.
235
+ 8. **Proven by evals.** Nothing ships without passing realistic BIM scenarios.
236
+
237
+ ## Extend bimai
238
+
239
+ bimai is built to be built on. The **Builder** role walks you through a fixed recipe for any tool:
240
+
241
+ ```
242
+ /bimai:new-connector scaffold a connector (api · desktop-bridge · file · upstream MCP)
243
+ /bimai:new-pack scaffold a skill + scripts + tests
244
+ /bimai:certify run conformance tests and evals → experimental / beta / stable
245
+ /bimai:register add it to your project's gateway, read-only first
246
+ ```
247
+
248
+ Want a custom Revit API server, a Blender/Bonsai bridge or a Solibri connector? Follow the same contract and it gets the approval gate, the evidence trail, the test harness and the scheduler for free. See [§9 of the architecture](ARCHITECTURE.md#9-building-on-top-how-the-system-extends-itself).
249
+
250
+ Packs depend on **capabilities** (`issues.read`, `model.query`), not on vendors. A pack written for ACC today runs on BCF tomorrow, and one written for Revit runs on Bonsai and IfcOpenShell.
251
+
252
+ ## Roadmap
253
+
254
+ - [ ] **v0.1: the core.** CLI and workflow engine, the plugin with its roles and hooks, onboarding with role presets, Relatics and planning XML imports, the connector kit, the ACC issues connector, the gateway, workflows for design coordination and BIM coordination, the Planner, daily automations, and a 10-scenario eval suite
255
+ - [ ] **v0.2: extend.** Desktop-bridge and file connector templates, the Builder role, the registry, and a contributor guide ("add a BIM tool in an afternoon")
256
+ - [ ] **v0.3: open BIM.** IFC, IDS and BCF connectors, and IFC/USD enrichment with assertion provenance
257
+ - [ ] **Later:** adapters for other harnesses (GitHub Copilot, AGENTS.md), and organization profiles with company standards, templates and workflows in one install
258
+
259
+ ## Contributing
260
+
261
+ bimai is for the BIM community, and it's being shaped right now. The most useful contributions at this stage:
262
+
263
+ - **BIM professionals:** your real workflows. What does your coordination round, delivery check or handover look like? Open a discussion with the steps.
264
+ - **Developers:** the CLI core, the connector kit and the first connectors (see the build order in [ARCHITECTURE.md](ARCHITECTURE.md#14-mvp-and-build-order)).
265
+ - **Writers:** documentation is part of done. Every change ships with its page in [`docs/`](docs/); CI fails when a command or pack has no page.
266
+ - **Everyone:** eval scenarios. A realistic task with an expected result is the best way to make the agents trustworthy.
267
+
268
+ Please open an issue before starting larger work, so we can agree on the approach.
269
+
270
+ ## Acknowledgements
271
+
272
+ - [Squad](https://github.com/bradygaster/squad) by Brady Gaster, for the idea of an AI team that lives in your repo as files
273
+ - [Claude Code](https://www.anthropic.com/claude-code), the harness bimai runs on first
274
+ - [IfcOpenShell](https://ifcopenshell.org), [Bonsai](https://bonsaibim.org) and [buildingSMART](https://www.buildingsmart.org), for the open BIM foundations
275
+
276
+ bimai is an independent open-source project. It is not affiliated with or endorsed by Autodesk, Microsoft, Anthropic or buildingSMART. Product names are trademarks of their respective owners.
277
+
278
+ ## License
279
+
280
+ [MIT](LICENSE). Free to use, change and share, including commercially.
bimai-0.1.0/README.md ADDED
@@ -0,0 +1,246 @@
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/StefanDaniels1/BIMAI/main/assets/logo.svg" alt="bimai — a BIM team at your command" width="720">
3
+ </p>
4
+
5
+ <p align="center">
6
+ <strong>An open-source BIM team that lives in your editor.</strong><br>
7
+ Coordinate models, track requirements and risks, triage issues, write the minutes and plan your week,<br>
8
+ with AI agents that follow your BIM process and show their evidence.
9
+ </p>
10
+
11
+ <p align="center">
12
+ <a href="https://docs.bimai.nl"><strong>Documentation</strong></a> ·
13
+ <a href="https://docs.bimai.nl/docs/why">For managers and directors</a> ·
14
+ <a href="https://docs.bimai.nl/docs/example-project">Example project</a>
15
+ </p>
16
+
17
+ <p align="center">
18
+ <img alt="Status: pre-alpha" src="https://img.shields.io/badge/status-pre--alpha-FFB000?style=flat-square">
19
+ <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-FFB000?style=flat-square">
20
+ <img alt="Harness: Claude Code" src="https://img.shields.io/badge/harness-Claude%20Code-FFB000?style=flat-square">
21
+ <img alt="Open BIM ready" src="https://img.shields.io/badge/open%20BIM-IFC%20%C2%B7%20IDS%20%C2%B7%20BCF%20%C2%B7%20USD-FFB000?style=flat-square">
22
+ </p>
23
+
24
+ ---
25
+
26
+ > **⚠️ Pre-alpha.** bimai is being designed in the open. The architecture is written; the code is starting now.
27
+ > Commands below show the target experience for v0.1. Working so far: the [meeting-intake pack](packs/meeting-intake/), the [project-site generator](packs/project-site/) and the [documentation site](docs/). Star or watch the repo to follow along, and see [Contributing](#contributing) to help shape it.
28
+
29
+ ## What is bimai?
30
+
31
+ AI can now read your Revit model and your ACC issues. What's missing is someone who knows **what a BIM professional actually does with them**: run the coordination round, check a delivery, chase the open issues, write it up, and remember what was decided.
32
+
33
+ bimai is that someone. It turns an AI coding harness (Claude Code first) into a **BIM team**:
34
+
35
+ ```
36
+ You: "Prepare Thursday's coordination meeting."
37
+
38
+ 🧭 Coordinator workflow: weekly-coordination → 6 steps, 2 parallel lanes
39
+ 📋 Issue Manager 47 open ACC issues · 9 overdue · 3 clusters found ⎤ in
40
+ 🔍 Model Checker delivery check on 3 models: 2 findings ⎦ parallel
41
+ ✋ You review the findings → approve
42
+ ✍️ Scribe agenda written · 4 open decisions · evidence cited
43
+ ```
44
+
45
+ Every agent works from files in your project repo, follows a workflow you define, cites the tool calls behind every claim, and **asks before it changes anything**.
46
+
47
+ ## Why bimai?
48
+
49
+ | Today | With bimai |
50
+ |---|---|
51
+ | Plenty of Revit and ACC MCP servers, but each is a single tool with no BIM workflow | A team with BIM roles that knows what a clash round or a delivery check involves |
52
+ | Coding agents built for developers (frontend, backend, tester) | Roles BIM people recognise: coordinator, information manager, model checker, scribe |
53
+ | Vendor assistants that stay inside one product | One place that works across ACC, Revit, open formats and Microsoft 365 |
54
+ | AI answers you can't trace | Every output cites its evidence; every decision is logged in git |
55
+ | Chat that forgets | A project memory the whole team shares by cloning the repo |
56
+
57
+ ## What you get
58
+
59
+ - **🧑‍🤝‍🧑 A team that fits your role:** a short interview at `bimai init` picks a small team from a catalogue (Coordinator, Requirements & Risk Manager, Planning Analyst, Information Manager, Model Checker, Issue Manager, Scribe, and more). A design coordinator gets a different team than a BIM modeller, and no one gets members they don't need.
60
+ - **📄 Your BEP becomes the configuration:** drop the BIM execution plan (Word or PDF) at onboarding. bimai extracts naming rules, tools and versions, responsibilities, coordination rhythm and milestones, each with its page reference, and sets up the project from what was actually agreed after you review it.
61
+ - **🌐 A site for every project:** a private website, generated from the project files, that explains the people, their AI teams, the BEP agreements, decisions, meetings and this week's work. Made for new colleagues, managers, directors and clients who never open VS Code. [See the example](https://docs.bimai.nl/docs/example-project).
62
+ - **👀 Open by default, so no context is lost:** each session leaves a short journal entry in the project, and project tasks are shared, so anyone can ask "what did the team do this week?" and a colleague covering for you knows where you left off. Your desk (plans, preferences, other clients' projects) stays private.
63
+ - **🤝 Work together, each with your own team:** a modeller, a coordinator and a design manager share one project: the same rules, context and decisions, but each with their own team. Every responsibility has one owner, and agents hand work to each other instead of getting in each other's way. Add more modellers or coordinators per discipline or zone, and hand over or cover a job when someone leaves or is ill; the agents' knowledge stays with the job.
64
+ - **🙈 No git or programming needed:** bimai saves, shares, updates and restores your work automatically, in plain language. Git runs underneath for history and safety; you never see it.
65
+ - **🎙️ Meeting transcripts to tasks:** drop the Teams or Zoom transcript of a coordination session. bimai writes the minutes, logs the decisions, gives each person their tasks and hands role-level work to the right position. Whenever it isn't sure (which Jan? decided or just discussed? project matter or personal?), it asks the person who uploaded it before anything is applied.
66
+ - **📐 Design coordination from your exports:** drop in a Relatics JSON export and a Primavera or MS Project XML planning, and get requirements status, risk reviews, schedule health and a weekly design progress report, with trends from every snapshot.
67
+ - **🗺️ Workflows, not improvisation:** chain small steps (scripts, tool calls, agents, other workflows, human approvals) in YAML, sequentially or in parallel. The engine decides the order; agents only do the thinking, so simple steps cost no tokens.
68
+ - **📅 A personal planner:** all your tasks and deadlines across projects, with a morning plan, a Friday review and deadline warnings.
69
+ - **🔌 Standard connectors:** ACC/Forma, the Autodesk AEC Data Model, Microsoft Graph, desktop apps like Revit, Civil 3D, Bentley OpenRoads and Blender/Bonsai, and open formats like IFC, all behind one gateway with the same safety rules.
70
+ - **⏰ Daily automations:** any workflow on a schedule (Windows Task Scheduler, cron or GitHub Actions). Unattended runs *propose* changes; you approve them later.
71
+ - **🧾 Evidence and memory in git:** decisions, history and a full audit trail, versioned alongside your project.
72
+ - **📊 See your setup:** `bimai graph` draws your team, workflows, connectors and projects as diagrams that render in GitHub and VS Code.
73
+ - **🪟 Windows, macOS and Linux:** cross-platform core; Windows-only BIM apps are clearly marked.
74
+ - **💶 Low token cost by default:** most roles run on smaller models; scripts do the counting and checking.
75
+
76
+ ## How it works
77
+
78
+ bimai doesn't build its own agent runtime. It **configures** one, the way a Linux distribution configures a kernel.
79
+
80
+ ```mermaid
81
+ flowchart LR
82
+ U[You in VS Code] --> CC[Claude Code]
83
+ CC --> P[bimai plugin<br/>roles · packs · hooks]
84
+ P --> W[.bimai/ in your repo<br/>workflows · decisions · evidence]
85
+ P --> G[bimai gateway]
86
+ G --> A[ACC / Forma · AEC Data Model]
87
+ G --> R[Revit · Civil 3D · OpenRoads · Bonsai]
88
+ G --> O[IFC · IDS · BCF · USD]
89
+ G --> M[Microsoft 365]
90
+ ```
91
+
92
+ Everything is one of five building blocks:
93
+
94
+ | Block | What it is |
95
+ |---|---|
96
+ | **Team** | Agent roles as markdown charters |
97
+ | **Workflow** | YAML that chains steps (scripts, tools, agents, other workflows, human gates) sequentially or in parallel |
98
+ | **Pack** | A reusable BIM procedure: a skill plus its scripts, templates and tests |
99
+ | **Connector** | A standard bridge to one tool: an API, a desktop app, a file format, or an existing MCP server |
100
+ | **Automation** | A workflow on a schedule |
101
+
102
+ A workflow reads like a checklist. Steps without `needs` run in parallel:
103
+
104
+ ```yaml
105
+ id: weekly-coordination
106
+ steps:
107
+ fetch-issues: { tool: issues.list, with: { status: open } }
108
+ fetch-models: { tool: model.list_published }
109
+ cluster: { needs: [fetch-issues], script: acc-issue-triage/cluster.py }
110
+ check-models: { needs: [fetch-models], foreach: "${{ steps.fetch-models.output }}", workflow: delivery-check }
111
+ review: { needs: [cluster, check-models], gate: approval }
112
+ agenda: { needs: [review], agent: scribe, pack: coordination-meeting }
113
+ ```
114
+
115
+ The full design is in **[ARCHITECTURE.md](ARCHITECTURE.md)**.
116
+
117
+ ## Install
118
+
119
+ One line, no Python, git or administrator rights needed:
120
+
121
+ ```powershell
122
+ # Windows
123
+ powershell -ExecutionPolicy ByPass -c "irm https://docs.bimai.nl/install.ps1 | iex"
124
+ ```
125
+
126
+ ```bash
127
+ # macOS and Linux
128
+ curl -LsSf https://docs.bimai.nl/install.sh | sh
129
+ ```
130
+
131
+ Then run `bimai init` in your project folder. Update any time with `bimai update`.
132
+ More: [Install bimai](https://docs.bimai.nl/docs/start/install).
133
+
134
+ ## Quick start (target for v0.1)
135
+
136
+ ```bash
137
+ # 1. once per computer (planned): checks git and Claude Code, signs you in, creates your desk
138
+ bimai setup
139
+
140
+ # try everything first with sample data, no accounts needed
141
+ bimai new --demo
142
+
143
+ # 2a. start a new project (usually the BIM coordinator or information manager)
144
+ bimai new a2-knooppunt # creates the shared project, runs the interview, gives a join link
145
+
146
+ # 2b. or join a project a colleague already started
147
+ bimai join https://github.com/your-org/a2-knooppunt
148
+ ```
149
+
150
+ Everything lands in one folder on your computer:
151
+
152
+ ```
153
+ ~/bimai/
154
+ ├── desk/ private to you: your projects, plans, preferences
155
+ └── projects/
156
+ └── a2-knooppunt/ shared with the project team: rules, decisions, everyone's tasks and journal
157
+ ```
158
+
159
+
160
+ ```
161
+ ? What's your role on this project? design coordinator
162
+ ? Drop your BEP (Word or PDF): BEP-A2-knooppunt-v3.pdf
163
+ ✓ 38 agreements found · 2 open questions · Revit 2025, OpenRoads 2023, ACC
164
+ ? What do you want help with? requirements, risks, planning, progress reporting
165
+ ? Which data do you have? Relatics export, Primavera planning
166
+
167
+ Proposed team (4 of max 5):
168
+ 🧭 Coordinator always
169
+ 📐 Requirements & Risk Manager goals: requirements, risks · data: Relatics
170
+ 📅 Planning Analyst goal: planning · data: Primavera XML
171
+ ✍️ Scribe goal: progress reporting
172
+ ? Confirm team? yes
173
+ ```
174
+
175
+ ```bash
176
+ # add your exports (or drop them in .bimai/data/inbox/)
177
+ bimai data import exports/relatics.json
178
+ bimai data import planning/DO-planning.xml
179
+ ```
180
+
181
+ Then `bimai open a2-knooppunt` opens the project in VS Code with Claude Code ready. Try:
182
+
183
+ ```
184
+ /bimai:meeting process a meeting transcript into minutes and tasks
185
+ /bimai:report weekly design progress report
186
+ /bimai:triage triage open ACC issues
187
+ /bimai:meeting-prep agenda from issues + open decisions
188
+ /bimai:delivery-check check a model against your delivery checklist
189
+ /bimai:plan plan my day across all projects
190
+ ```
191
+
192
+ ## Principles
193
+
194
+ 1. **Configure the harness, don't rebuild it.** Improvements to Claude Code make bimai better for free.
195
+ 2. **Files are the source of truth.** Team, workflows, decisions and history live in git.
196
+ 3. **Agents reason, scripts decide.** Anything checkable is computed by deterministic code.
197
+ 4. **Read by default.** Every write goes through a human approval gate.
198
+ 5. **Every claim has evidence.**
199
+ 6. **One contract for every extension.** A community connector behaves exactly like a built-in one.
200
+ 7. **Open formats first.** IFC, IDS, BCF and OpenUSD are the long-term backbone.
201
+ 8. **Proven by evals.** Nothing ships without passing realistic BIM scenarios.
202
+
203
+ ## Extend bimai
204
+
205
+ bimai is built to be built on. The **Builder** role walks you through a fixed recipe for any tool:
206
+
207
+ ```
208
+ /bimai:new-connector scaffold a connector (api · desktop-bridge · file · upstream MCP)
209
+ /bimai:new-pack scaffold a skill + scripts + tests
210
+ /bimai:certify run conformance tests and evals → experimental / beta / stable
211
+ /bimai:register add it to your project's gateway, read-only first
212
+ ```
213
+
214
+ Want a custom Revit API server, a Blender/Bonsai bridge or a Solibri connector? Follow the same contract and it gets the approval gate, the evidence trail, the test harness and the scheduler for free. See [§9 of the architecture](ARCHITECTURE.md#9-building-on-top-how-the-system-extends-itself).
215
+
216
+ Packs depend on **capabilities** (`issues.read`, `model.query`), not on vendors. A pack written for ACC today runs on BCF tomorrow, and one written for Revit runs on Bonsai and IfcOpenShell.
217
+
218
+ ## Roadmap
219
+
220
+ - [ ] **v0.1: the core.** CLI and workflow engine, the plugin with its roles and hooks, onboarding with role presets, Relatics and planning XML imports, the connector kit, the ACC issues connector, the gateway, workflows for design coordination and BIM coordination, the Planner, daily automations, and a 10-scenario eval suite
221
+ - [ ] **v0.2: extend.** Desktop-bridge and file connector templates, the Builder role, the registry, and a contributor guide ("add a BIM tool in an afternoon")
222
+ - [ ] **v0.3: open BIM.** IFC, IDS and BCF connectors, and IFC/USD enrichment with assertion provenance
223
+ - [ ] **Later:** adapters for other harnesses (GitHub Copilot, AGENTS.md), and organization profiles with company standards, templates and workflows in one install
224
+
225
+ ## Contributing
226
+
227
+ bimai is for the BIM community, and it's being shaped right now. The most useful contributions at this stage:
228
+
229
+ - **BIM professionals:** your real workflows. What does your coordination round, delivery check or handover look like? Open a discussion with the steps.
230
+ - **Developers:** the CLI core, the connector kit and the first connectors (see the build order in [ARCHITECTURE.md](ARCHITECTURE.md#14-mvp-and-build-order)).
231
+ - **Writers:** documentation is part of done. Every change ships with its page in [`docs/`](docs/); CI fails when a command or pack has no page.
232
+ - **Everyone:** eval scenarios. A realistic task with an expected result is the best way to make the agents trustworthy.
233
+
234
+ Please open an issue before starting larger work, so we can agree on the approach.
235
+
236
+ ## Acknowledgements
237
+
238
+ - [Squad](https://github.com/bradygaster/squad) by Brady Gaster, for the idea of an AI team that lives in your repo as files
239
+ - [Claude Code](https://www.anthropic.com/claude-code), the harness bimai runs on first
240
+ - [IfcOpenShell](https://ifcopenshell.org), [Bonsai](https://bonsaibim.org) and [buildingSMART](https://www.buildingsmart.org), for the open BIM foundations
241
+
242
+ bimai is an independent open-source project. It is not affiliated with or endorsed by Autodesk, Microsoft, Anthropic or buildingSMART. Product names are trademarks of their respective owners.
243
+
244
+ ## License
245
+
246
+ [MIT](LICENSE). Free to use, change and share, including commercially.
@@ -0,0 +1,3 @@
1
+ """bimai: an open-source BIM team that lives in your editor."""
2
+
3
+ __version__ = "0.1.0"
@@ -0,0 +1,5 @@
1
+ import sys
2
+
3
+ from bimai.cli import main
4
+
5
+ sys.exit(main())