Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ and generate structured, radiology-style reports — from the CLI, a web UI, or
- **Clinical context input** — attach symptoms, trauma history, and suspected diagnosis to guide the analysis
- **Professional reports** — structured PDF/HTML/JSON with findings tables, impression, and limitations
- **YAML workflow engine** — compose and version-control custom analysis pipelines as code
- **Web UI + CLI + REST API** — 3-step browser wizard, scriptable CLI, and an HTTP API
- **Web UI + CLI + REST API** — scriptable CLI today; the 3-step browser wizard and the HTTP analysis endpoint are a preview — running an analysis from the browser/API is not yet wired up ([#157](https://github.com/Liohtml/MedCheck/issues/157))

---

Expand All @@ -53,7 +53,17 @@ docker run -p 8080:8080 \
ghcr.io/liohtml/medcheck:latest
```

Open [http://localhost:8080](http://localhost:8080) and follow the 3-step wizard.
Open [http://localhost:8080](http://localhost:8080) to browse the web UI (preview). Note that
**running an analysis from the browser is not yet available** — the wizard's Analyze step
returns `501 Not Implemented` until [#157](https://github.com/Liohtml/MedCheck/issues/157)
lands. To run an analysis today, use the CLI inside the container:

```bash
docker run --rm \
-v $(pwd)/scans:/data/scans \
ghcr.io/liohtml/medcheck:latest \
uv run medcheck analyze /data/scans
```

### Option 2 — pip install

Expand Down Expand Up @@ -145,7 +155,7 @@ Run `medcheck analyze --help` for the full list.
| Endpoint | Description |
|---|---|
| `GET /health` | Liveness probe (always public) |
| `POST /api/analyze` | Run an analysis (JSON body: `source`, `anatomy`, `report_format`, `language`, `allow_cloud_llm`, …) |
| `POST /api/analyze` | **Not yet implemented — returns `501`** ([#157](https://github.com/Liohtml/MedCheck/issues/157)). Validates the JSON body (`source`, `anatomy`, `report_format`, `language`, `allow_cloud_llm`, …) and enforces auth/rate limits, but does not run an analysis; use `medcheck analyze` instead |

When `MEDCHECK_API_KEY` is set, `/api/*` requires an `X-API-Key` header. Requests
are rate-limited per client IP (`MEDCHECK_RATE_LIMIT`, default 10/min).
Expand Down
7 changes: 5 additions & 2 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,15 @@ medcheck interactive

---

## Web UI
## Web UI (preview)

Once the server is running (`medcheck serve` or `docker compose up`), open:

```
http://localhost:8080
```

Upload an image, select the anatomy region, and click **Analyze**. Results are displayed as structured JSON and a plain-language summary.
> **Note:** the web wizard is a preview. Running an analysis from the browser is
> not yet available — the Analyze step returns `501 Not Implemented` until
> [#157](https://github.com/Liohtml/MedCheck/issues/157) lands. Use the CLI
> (`medcheck analyze SOURCE`, see above) to run analyses today.
11 changes: 11 additions & 0 deletions src/medcheck/web/templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,17 @@
<main>
<p class="page-subtitle">Upload imaging data and run AI-assisted clinical analysis in three steps.</p>

<!-- Preview notice: remove when the analyze pipeline is wired up (issue #157) -->
<div
role="note"
style="margin: 0 0 1.25rem; padding: 0.75rem 1rem; border: 1px solid #d97706; border-radius: 8px; background: rgba(217, 119, 6, 0.08); font-size: 0.9rem;"
>
<strong>Preview:</strong> running an analysis from the browser is not yet available &mdash;
the Analyze step currently returns <code>501 Not Implemented</code>
(<a href="https://github.com/Liohtml/MedCheck/issues/157" rel="noopener">#157</a>).
Use the CLI instead: <code>medcheck analyze /path/to/scans</code>.
</div>

<!-- Wizard tabs -->
<div class="wizard-tabs">
<button type="button" class="tab-btn active" data-goto="1">
Expand Down
Loading