Summary#
osy is the local surface: it works on the project in front of you, needs no account and no cloud. Most of it
is offline. It runs against a local platform it starts for you on demand, and the whole area is one loop — write,
run, look, check.
osy launch # create the app if missing, compile this source into it, open it
osy logs --tail # what it said — client and server lines under one correlation id
osy inspect # what actually happened in a run, and where it faulted
osy check # validate + lint + test, one verdict, before you shipDescription#
A compile mints a new app VERSION, and data does not carry across it. This is the fact that surprises people first: a recompile is not an edit in place, so rows you created against the previous version are not what the new one reads. Seed through the app's own functions, or Importing data, after a compile — never by expecting yesterday's data to still be there.
A local platform is a cache, not a store. Instances live under ~/.osy/instances/, each carrying its own
Postgres cluster, and they are reaped: one you have not touched for a day is gone, and that is correct — losing one
costs a rebuild. Listing your local platforms shows every instance on the machine and which are running;
Reclaiming the disk your local platforms use is the deliberate sweep. Stopping the local platform ends the one serving
this project.
Ask the platform rather than reading the compiler. Most questions about your app have a verb: Understanding your app for the resolved model, Explaining your app's security for the declared security in plain English, Reading a capability's source for what a surface offers. A question you answer by reading source is a question the platform has not answered yet.
When something misbehaves, look before you reason. Seeing what happened when your code ran opens the trace and jumps to the fault; Recording a run captures one deliberately; Seeing what a page cost answers the performance question. Faults are captured even with tracing off.
The pages#
Run osy docs local for the full listing.
- The loop itself — The inner loop, Running a local platform, Stopping the local platform, Installing the editor extension
- Getting your app running — Launching your app, Launching the page you're on, Compiling your app, Adding an account, Giving a secret its value
- Getting data in and out — Importing data, Running a function, Reading your data
- Looking at it — Seeing what happened when your code ran, Recording a run, Seeing what a page cost
- Asking about it — Understanding your app, Explaining your app's security, Reading a capability's source
- Before you ship — Checking your app, What a clean check means
- Housekeeping — Listing your local platforms, Reclaiming the disk your local platforms use
See also#
- The inner loop — the loop end to end, for a person and for an agent at the CLI
- Launching your app — create, compile and open in one verb
- What a clean check means — what a green
osy checkdoes and does not prove