Skip to main content

Bonsai

Bonsai is an assistant that reads your model and talks about it. It fills the area below the canvas on its own; open it with the Bonsai button in the status bar.

Edition

Enterprise, and there is a second condition. The tab appears only when the signed bonsai capability reaches the client and the backend has Bonsai configured and enabled. No button means one of the two is missing — the capability is signed, so its absence cannot be worked around from the browser.

Three modes​

The mode decides what Bonsai is allowed to do, and it is switched in the chat itself (/mode review, /mode alter, /mode generate) or with the buttons above the input.

ModeWhat it may do
Reviewread only: inspect the model, run quality rules, query it with SQL
Alterchange model records — every write is put to you first
Generaterun the template engine and talk about what came out

Nothing is written without your approval​

In Alter mode a proposed change arrives as Apply this change? with Apply and Reject. What was applied in the current exchange is listed as Changes applied this turn, and Undo turn takes all of it back at once. So a conversation that went the wrong way costs one click, not a manual repair of every record.

What it can look at​

Bonsai does not guess about your model — it has read-only tools for it, in every mode:

  • run the quality rules and report the violations
  • query the model with SQL, and read the schema of that projection
  • find groups in the entity tree
  • read the modelling guides a template pack ships for each object type

With a template pack installed, the last one is what lets it answer how should this be modelled here rather than in general. Together with Alter mode, that means it can find a violation and fix the offending records in one conversation — with each fix approved by you.

Commands​

CommandWhat it does
/helplist the commands
/mode <review | alter | generate>switch mode
/undoundo this turn's changes
/clearstart a new conversation