Remy Reference/Guide
Guide
17 chapters · mirrored from github.com/mindstudio-ai/remy
The Remy developer guide, mirrored verbatim from the platform repository — the primitives every app is built on, kept current at the source.
00OverviewA Remy app is a code project with a clear structure. You define the logic (data models, business rules, user experiences) and the platform handles…01Project StructureEvery app has two directories:02Spec & MSFMThe spec is a natural language document describing what the app does: the data model, the business rules, the workflows, the edge cases. It lives in…03Manifest ReferenceThe manifest declares everything the platform needs to know about your app: methods, tables, roles, interfaces, scenarios. It's read on every git push to…04Tables & SQL DatabaseEach table is a TypeScript file with a typed interface and a defineTable<T>() call:05MethodsA method is a named async function that runs on the platform. It's the universal unit of backend logic: every interface (web, API, cron, webhook) is a…06Auth & RolesRemy apps can have their own users. Auth is opt-in: configure it in the manifest, define a user table, and build your own login UI. The platform handles…07InterfacesInterfaces are how users interact with your app, and the same methods power all of them: a web frontend, a REST API, and a cron job can all invoke the…08Files & StoragePer-app file storage: user uploads, generated documents, images, marketing assets. A store is a CDN-backed bucket the app talks to, not app-defined state…09Vector DatabasesPer-app searchable document corpora. Upload PDFs, docs and text; ask questions in plain language; get back the passages that answer them, each with a…10Secrets & EnvironmentApps can store encrypted secrets (API keys, database URLs, tokens) that get injected into method execution as process.env variables. Each secret has…11SDK Actions@mindstudio-ai/agent provides access to 200+ AI models and 1,000+ actions through a single API key. No separate provider keys are needed — MindStudio…12Task AgentsA full autonomous agent loop, callable from any method. Give it a prompt, a set of tools, and a JSON Schema for the output you want; the platform runs the…13JewelsA jewel is an optional AI companion for a single app method: foo.jewel.ts beside foo.ts. It proposes the method call a human would otherwise make. The…14AnalyticsEvery app gets a traffic and error dashboard for free, with no setup and no third-party script. The interface SDK reports pageviews, uncaught errors, and…15ScenariosScenarios are seed scripts that put the dev database into a specific state. Instead of manually creating data through the app every time you want to test…16Development & DeploymentDevelopment happens in the hosted sandbox, against a dev release with its own copy of the database. Deployment is a git push that builds a new release and…