← Collie

Set up a repo

Collie can keep a project's local service running if the repo tells it two things: how to start it, and how to check it's up. Do these steps and Collie will find the repo on its own and list it under Services, switched off until you turn it on.

1. Add a start script at scripts/launch.sh that starts your service.

2. Make it executable:

   chmod +x scripts/launch.sh

3. Add scripts/launch.json with a health-check address – a URL, a list of ports, or both:

   {
     "healthcheck": {
       "url": "http://myproject.local/"
     },
     "ports": [8081]
   }

   The URL counts as healthy if it answers with a 2xx or 3xx status. Every port listed must be listening.

4. Optional extras in the same file: healthcheck.expected_status (a number or list), healthcheck.timeout_seconds (default 5), healthcheck.retries (default 2), start_grace_seconds (default 120), restart ("never" or "on-failure") and icon ("sf:<symbol>" or a path in the repo).

5. Optional: start README.md with a # Heading – Collie uses it as the service's name. Otherwise it uses the folder name.

6. Open Collie's Settings. The repo appears under Services as “Found on this Mac”. Switch it on.

Collie only reads launch.json; it never changes it. If the file isn't valid JSON, Collie won't take any action on that service.