bimai
Get started

Join a project

When a colleague already started the project. A few questions, and you have your own team.

Available

Available now. Joining, your seat brief, handoffs, decisions and saving and sharing work today.

A colleague started a bimai project and you'll work in it too, for example as constructeur next to the BIM coordinator. Copy this prompt into Claude Code, in the project folder (or anywhere: Claude asks where the project is):

Paste it into Claude Code; it adds you to the project with your own team.

Show the prompt
Add me to the bimai project (https://bimai.nl) a colleague started. Follow these steps in order.

1. Install bimai with its one-line installer (it needs no Python, git or administrator rights):
   - on Windows: powershell -ExecutionPolicy ByPass -c "irm https://bimai.nl/install.ps1 | iex"
   - on macOS or Linux: curl -LsSf https://bimai.nl/install.sh | sh
   If the bimai command isn't found afterwards, use the full path the installer printed (in the
   .local/bin folder in my user folder). Check it worked with: bimai --version

2. Find the project. It is the folder with a .bimai folder in it. If this folder isn't it, ask me where it
   is. If I give you a link from my colleague, run: bimai join "<link>"
   It puts the project in my Documents/bimai folder and prints where; continue in that folder.

3. Get the joining questions: bimai join --interview
   It prints the questions as JSON, made for your AskUserQuestion tool, and who is already on the project.

4. Ask me step 1 with the AskUserQuestion tool, in one call. Use each question's header, question text
   and options exactly as given, in the given order, and put "(Recommended)" after the recommended
   option. Use multiSelect where multi_select is true. Leave "Other" to me for my own answer.
   - If I answer with Other on a choice, map my words to the closest value in that question's
     "allowed" list. If you're not sure, ask me to confirm the mapping in plain language.
   - For text questions (kind "text"), my own words are the answer.

5. Get step 2 for my role: bimai join --interview --role "<my role>"
   Ask it the same way, in one call. If it asks about a position: a position of my own is for another
   part of the work (a zone or discipline); sharing means doing the same job together with a colleague.

6. Show me what joining would do, without writing anything:
   bimai join --dry-run --json --person "<my name>" --role "<role>" --goals <goals, comma-separated> --tools <tools, comma-separated>
   Add --position <id> if I chose to share one, and --new-to-vscode if I said I'm new to VS Code. Explain in a
   few short lines: my position, my team and why, and who else is on the project.

7. Ask me with AskUserQuestion: "Join this project?" with the options "Yes, add me" and "No, change
   something". Only when I say yes, run the same command without --dry-run and --json, with --yes.

8. Connect my tools. The dry run listed "connections" with a status for each tool I chose:
   - "ready": already connected for the project.
   - "needs-install": ask me with AskUserQuestion: "Install the <label> now?" with the options "Yes,
     install it" and "Not now". Explain its "message" first: Windows may ask permission once, and the program
     it runs in (such as Civil 3D, Revit or OpenRoads) must be closed. Only on yes, run its "command".
   - "needs-app", "other-platform", "unavailable": tell me its "message" in plain words. Don't suggest a
     command for these unless the connection gives one.

9. Run: bimai validate
   Then run: bimai sync  (it saves my setup and shares it with the team; tell me what it says in plain words)
   Then tell me to start a new Claude Code session: my seat brief then tells my team who I am and what's
   new. Give me three example questions, including "What's new for me?" and handing work to a colleague.

If a command fails, show me the error and explain it simply. Don't work around it by editing bimai's
files by hand.

What happens

  1. Claude installs bimai and gets the project: give it the link your colleague sent (bimai join <link> puts it in your Documents/bimai folder).
  2. It asks a few questions as clickable choices: your name, your role, what you want help with and your tools. The project's settings are already there, so there's no project setup.
  3. You get a position: your job on the project, such as constructeur or bim-modeller. If someone already has that job, you choose: a position of your own (another zone or discipline) or sharing theirs.
  4. Claude shows your team and who else is on the project, and only adds you after your yes.

Nothing of your colleagues' setup changes: everyone has their own seat, and the files you share are the same for everybody.

Every session after that

When you open Claude Code, your seat brief tells your team who you are and what's new for you since last time: handoffs from colleagues, new decisions, and (if your project shares it) what the team did. Just ask "What's new for me?" See Working together.

Doing it yourself

bimai join https://github.com/your-org/viaduct   # get the project
bimai join --interview                       # the questions, as JSON
bimai join --person Joris --role constructeur --tools scia --dry-run
bimai join --person Joris --role constructeur --tools scia --yes

On this page