Stopping the local platform

Summary#

Stops the local platform for your project — the one Compiling your app, Running tests locally and Launching your app start on demand. The platform's database stops with it, so there is nothing left running after it returns.

Signature#

osy stop [path] [--devname <name>] [--delete] [--test-platform]

Description#

The loop commands start a local platform in the background when one isn't already running, and leave it up so your next command is fast (Running a local platform). osy stop is how you shut that platform down when you're done — it stops the server and the database it manages, and reports plainly when there was nothing running.

You rarely need it during a normal session: leaving the platform running between commands is the point, and it costs little. Reach for it when you want a clean slate, are switching away from a project, or want to be sure nothing is running in the background.

• path selects the project (defaults to the current directory).
• --devname stops a named server instead of this project's, matching osyrin dev --devname (setting OSY_DEVNAME works too).
• --delete also deletes the instance once it is stopped — its database and all — to give the disk back. It deletes only this project's instance: a --devname naming another project's is refused before anything is stopped, and so is one still running after the stop. A later command builds a fresh one. See Reclaiming the disk your local platforms use.
• --test-platform stops the shared test platform instead — the one Running tests locally runs every project's tests on with this build (or the one OSY_TEST_PLATFORM names). With --delete it is deleted too.

The shared test platform is no project's, so a plain osy stop leaves it running — other projects' tests may be on it — and says so, naming --test-platform. Left alone, it stops itself after an idle hour.

It only ever stops a server it can confirm is the one it started: it matches the running process against what the server recorded about itself, and if the recorded server is already gone it simply reports that and stops nothing — it will not signal an unrelated process that has since taken over the same slot.

A platform that has not finished starting is stopped the same way, and osy stop says so, naming the step its start had reached — so you can tell a start that was merely slow from one that was stuck. It has no address yet at that point, but it already holds your project's database, which is why it is found and stopped rather than reported as not running.

Examples#

osy stop            # stop the local platform for this project

osy stop --delete   # stop it and delete its instance, reclaiming the disk

osy stop --test-platform --delete   # stop the shared test platform and delete it

See also#

Listing your local platforms — see every local platform on this machine, and which are still running.

Reclaiming the disk your local platforms use — delete the instances you are no longer using.

Running a local platform — the local platform this stops, and how the loop starts it for you.

Compiling your app — compile your source into your app (starts the platform if needed).

Running tests locally — run your app's tests locally (starts the platform if needed).