preship 0.1.1

Preship: FastAPI 스테이징 URL을 퍼징해 터지는 입력과 패턴별 AI 수정 프롬프트를 내주는 출시 전 진단 CLI.

Preship

Hammer your FastAPI staging app before launch — find the inputs that crash it, and get a fix for each.

Give it one staging URL. Preship fuzzes every endpoint and tells you:

• What breaks — unhandled 500s (the inputs that crash it), undocumented responses, and schema mismatches, grouped by pattern.
• How to fix it — one copy-paste fix prompt per pattern, ready to drop into whichever AI you use (ChatGPT, Claude, Gemini, anything).

No API key required. Finding the issues and getting the fix prompts works entirely without one.

---

1. Install

Requires Python 3.10+.

pip install preship

This adds the preship command:

preship --help

2. Point it at a staging URL + add an ownership-check route

Preship only scans URLs you own, so it can't be pointed at someone else's server. Before the first scan you prove the URL is yours — once — by adding a single verification route to your app.

Run a scan once and Preship prints your token and the exact route code to paste. Drop the token into the snippet below, add it to your app, and redeploy.

# Add this one route to your FastAPI app (anywhere below app = FastAPI())
from fastapi.responses import PlainTextResponse

@app.get("/.well-known/preflight-verify")
def preflight_verify():
    return PlainTextResponse("paste the token that scan printed here")

The first scan tells you the exact token and prints the route code too — no guessing, just copy what it shows. The token is fixed per URL, so you only add this once.

3. Run the scan

preship scan https://your-staging.example.com

If your staging is behind auth, pass headers along:

preship scan https://your-staging.example.com --header "Authorization: Bearer <token>"

4. Reading the results

The output has two parts.

(1) Findings report — same-kind problems are grouped into patterns and tagged by severity: [HIGH] (the server crashes with a 500) or [LOW] (response-contract mismatch). Each pattern lists the affected endpoints and the actual request → response Preship observed.

(2) AI fix prompts — one prompt block per pattern. Copy a block whole and paste it into whichever AI you use, and you get a likely cause, a FastAPI fix, and an explanation. The prompts contain only what the scanner observed (never your source code) and aren't tied to any specific AI.

Beta: the AI fix prompts are free during beta. Features and policy may change at general availability.

Apply a fix and run preship scan again to confirm the pattern is gone.

---

Advanced (optional): auto-generated patch drafts

Want auto-generated patch drafts too? Put your own Anthropic API key in your own environment and scan. Without it, the fix prompts above still work — the key is entirely optional.

export ANTHROPIC_API_KEY="sk-ant-..."   # your key. The default beta path needs no key — the prompts alone are enough.
preship scan https://your-staging.example.com