Quickstart

From nothing to a deployed change.

1. Install the CLI

   curl -fsSL https://docs.polymesa.com/install.sh | sh

   polymesa --version

   Other platforms and manual downloads: Install.

2. Authenticate

   polymesa auth login --url https://api.polymesa.com

   Opens a browser, then stores the token under the default alias. Confirm:

   polymesa auth whoami

3. Pull your configuration

   polymesa retrieve ./my-workspace
   cd my-workspace

   You now have entities/, guest_files/, automations/, groups/, share_rules/, and email_senders/. This is a good moment to git init — configuration is code, and deploys are much less frightening with history.

4. Generate types

   polymesa types .

   Writes entity definitions into .polymesa/ so your editor can autocomplete against your actual schema.

5. Write a trigger

   Create automations/Issue/ApplyDefaults.ts:

   import { BeforeInsert, BeforeResult } from "platform:triggers";
   import { Issue } from "platform:entities";
   
   export default class ApplyDefaults implements BeforeInsert<Issue> {
     beforeInsert(newRecords: Issue[]): BeforeResult<Issue> {
       for (const issue of newRecords) {
         issue.priority ??= "P3";
         issue.status ??= issue.assignee_id ? "assigned" : "new";
       }
       return newRecords;
     }
   }

   Note the array. Triggers are always bulk.

6. Preview the deploy

   polymesa deploy . --dry-run

   Reports what would change per folder, without writing anything. Read it before every real deploy — this is where an unintended delete shows up.

7. Deploy

   polymesa deploy .

   Create an issue in the app and confirm the defaults applied.

Try it without installing anything

The in-browser sandbox runs the full editor against a live runtime, so you can write a query or a trigger and hit run before setting any of this up.

Next

• Command reference — every command and flag
• Triggers — validation, rejection, bulk patterns
• Querying with SQL — reads, writes, and injection safety