Quickstart
To self host Mprove use README.md
Sign Up
After signing up, you will be able to log in and create an organization
Create Organization
Click the org selector in navbar >> New Org
Create Project
To create a new project, first select your organization in navbar
Click the project selector in navbar >> New Project
Add Sandbox Provider (optional)
You can build semantic data models locally, using your own AI agent or without AI.
You can also launch an Editor AI agent session via the Mprove UI on the Builder page.
This will start an OpenCode server in a remote sandbox (a separate sandbox for each session).
To do this, you need to provide an API key from the E2B provider.
Click the project gear icon in navbar >> Sandbox Provider >> Add E2B Api Key
Add LLM Provider and Model
You need to add an LLM model for AI Explorer or Editor (Builder) sessions.
Click the project gear icon in navbar >> LLM Providers >> New Provider
Add LLM Provider details and click Add.
Click Plus icon in Models column.
Add LLM Model details and click Add.
Create SQL Connection
Click the project gear icon in navbar >> Connections >> New Connection
Ask AI to Setup Mprove Project (optional)
Click the Builder in navbar >> Sessions >> New Session.
Ask "Setup Mprove project and use Malloy types" to start Editor Session.
It will create a separate session repository and branch.
As a recommended alternative, you can create semantic models locally and sync your uncommitted changes with Mprove server.
Explore created Semantic Model in UI
On the Models page, click on the model selector and select the model you created.
Click the Schema tab.
Select the measure and dimension from the schema.
Save the draft chart as a new chart file.
Save your drafts as files for later use
All charts, reports, and dashboards in Draft status are deleted during the repository validation process.
If you save a draft as a file, it is no longer a draft and will not be deleted during the repository validation process.
Repository validation process is triggered whenever a user manually edits files in their Dev repository or performs Git-related actions in either the Dev or Production repository.
For example, when a user with the FilesEditor role pushes new changes to the Production repository, this Git-related action deletes all drafts for all users in the Production repository.
Keep this in mind when planning how often to push changes to production.
Commit changes
On the Files page, review the changes that need to be committed.
Click Commit button.
Enter a commit message (optional) and click Commit.
Push changes to Production
On the Files page, review the changes that need to be Pushed to Production.
Click Push to Production button.
Switch to Production Repository
Click the repoName-branchName selector in navbar and select production/main branch.
Check that the chart you created is visible on the Models page in the Charts section.