pithyx dev
pithyx dev startet einen Mock-Desktop auf deinem Rechner: dein gebautes Frontend in derselben Sandbox wie auf der Box, die Host-Seite des SDK und einen Proxy zum Backend, der sich wie der der Box verhält. Das Backend läuft mit docker compose. Auf der Box gibt es keinen Entwicklungsmodus; mit Vite nutzt du stattdessen das Plugin @pithyx/cli/vite und startest vite (@pithyx/cli).
pithyx dev [project folder] [--frontend <folder>] [--port <port>] [--host <host>] [--endpoint <n=url>]... [--no-docker]Optionen
Abschnitt betitelt „Optionen“| Option | Wert | Typ | Standard | Beschreibung |
|---|---|---|---|---|
--frontend |
<folder> |
string | dist |
The built frontend |
--port |
<port> |
string | 7400 |
The port |
--host |
<host> |
string | 127.0.0.1 |
The address to listen on |
--endpoint |
<n=url> |
string, wiederholbar | – | Reach the endpoint n at url instead of through Docker, for example –endpoint api=http://localhost:8080 (repeatable) |
--no-docker |
– | boolean | aus | Do not start the backend; endpoints without –endpoint answer 503 |
--port muss eine ganze Zahl von 1 bis 65535 sein. Ein IPv6---host wird in eckigen Klammern ausgegeben. --endpoint nennt einen Endpunkt, den das Manifest deklariert, und eine URL, zum Beispiel api=http://localhost:8080; ein nicht deklarierter Name scheitert.
Was läuft
Abschnitt betitelt „Was läuft“- Die Seite liegt unter
http://<host>:<port>/, das Frontend als/apps/<id>/mit den Headern der Box. Dateien werden bei jeder Anfrage gelesen: Baue neu und lade neu, um eine Änderung zu sehen. - Das Backend startet, wenn das Manifest eines hat, ein Endpunkt kein
--endpointhat und--no-dockerfehlt:docker compose --project-name pithyx-dev-<id mit _ statt Punkten> --file <compose> --file <override> up --detach --wait --build.<compose>istbackend/compose.dev.yaml, wenn sie existiert, sonst die Datei ausbackend.compose. Der Override veröffentlicht den Port jedes Endpunkts auf127.0.0.1unter einem Port, den Docker wählt; der Proxy erreicht ihn dort. - Mit
--no-dockerantworten Endpunkte ohne--endpointmit 503. - Strg+C oder SIGTERM stoppt den Server, führt
docker compose downaus (Volumes bleiben) und endet mit 0.
Dateien
Abschnitt betitelt „Dateien“| Datei | Zugriff |
|---|---|
pithyx.json |
gelesen; muss existieren und gültig sein |
icon.svg, der Frontend-Ordner |
bei jeder Anfrage gelesen |
backend/compose.dev.yaml oder die Datei aus backend.compose |
von docker compose gelesen |
ein temporärer Ordner pithyx-dev-* mit compose.ports.yaml |
beim Start geschrieben, nach down entfernt |
Exit-Codes
Abschnitt betitelt „Exit-Codes“| Code | Wann |
|---|---|
| 0 | Mit Strg+C oder SIGTERM gestoppt. |
| 1 | pithyx.json fehlt oder ist ungültig, --endpoint ist falsch geschrieben oder nennt einen nicht deklarierten Endpunkt, Docker scheitert, oder der Port lässt sich nicht öffnen. |
| 2 | --port ist kein Port, oder mehr als ein Projektordner. |
Befunde
Abschnitt betitelt „Befunde“dev gibt keine Befunde aus. Starte pithyx validate, um zu sehen, warum ein Manifest ungültig ist.
Beispiele
Abschnitt betitelt „Beispiele“pithyx dev # http://127.0.0.1:7400/pithyx dev --port 8000 --host 0.0.0.0 # von anderen Rechnern erreichbarpithyx dev --endpoint api=http://localhost:8080 # dein eigener Server für den Endpunkt apipithyx dev --no-docker # nur das Frontend