vibesketch.server¶
The FastAPI application behind vibe-sketch serve.
The API (/api): version and liveness, the document JSON schema and
validation, the revisioned document store with import, report, render and
export (vibesketch.server.documents), and the input writers. Each
route mirrors an SDK call and a CLI command (AGENTS.md, ground rule 4).
OpenAPI is served at /openapi.json, so a client can read the contract
instead of guessing it. Everything else is the browser shell, served from
its built bundle.
Functions
|
Build the application. |
The built browser shell: |
Classes
|
|
|
Which input to write: a job of the document, or a species and a writer. |
|
|
|
Whether a document is valid, and every problem when it is not. |
|
- vibesketch.server.create_app(store=None, *, web_root=None)¶
Build the application. One instance per server process.
storeholds the documents (a fresh one by default);web_rootis the built browser shell (found withweb_bundle()by default).
- vibesketch.server.web_bundle()¶
The built browser shell:
VIBESKETCH_WEB_DIST, the package, or the checkout.- Return type:
Path | None
Modules