serve Command
Start the local fastskill HTTP API server and web UI.Usage
Options
| Option | Description | Default |
|---|---|---|
--host <HOST> | Host to bind the server to | localhost |
--port <PORT> | Port to bind the server to | 8080 |
Examples
Basic Server
Custom Host and Port
Authentication Model
fastskill serve binds an HTTP server on your machine and does not enforce built-in JWT authentication.
- No token endpoint is exposed
- API routes do not require
Authorizationorx-api-keyheaders
API Base Path
All application routes are served under the versioned/api/v1/… namespace. Requests to the
unversioned /api/… prefix are automatically redirected with HTTP 308 to the corresponding
/api/v1/… path, providing a non-breaking migration path for older clients.
Health Probes
The server exposes two standard health endpoints immediately after startup:GET /healthz— Liveness probe. Returns HTTP 200 with a JSON body containing the fastskill crate version, e.g.{"status":"ok","version":"0.9.118"}.GET /readyz— Readiness probe. Returns HTTP 200 when the server is ready to accept traffic. Returns HTTP 503 while graceful shutdown is in progress.
Response Headers
Every/api/v1/… response includes:
X-API-Version: v1— Identifies the API version that served the request.
Graceful Shutdown
SendingSIGINT (Ctrl-C) or SIGTERM causes the server to:
- Flip
/readyzto HTTP 503 so load balancers stop routing new traffic. - Drain in-flight requests to completion.
- Exit cleanly with exit code 0.
Core Endpoints
| Endpoint | Method | Description |
|---|---|---|
/api/v1/status | GET | Service status and uptime |
/api/v1/project | GET | Project view from skill-project.toml |
/api/v1/skills | GET | List installed skills |
/api/v1/skills | POST | Install a skill |
/api/v1/skills/{id} | GET/PUT/DELETE | Get, update, or remove a skill |
/api/v1/skills/upgrade | POST | Upgrade skills |
/api/v1/search | POST | Search skills |
/api/v1/reindex | POST | Reindex all skills |
/api/v1/reindex/{id} | POST | Reindex a specific skill |
/api/v1/registry/sources | GET | List registry sources |
/api/v1/manifest/skills | GET/POST | Manifest skill management |
/index/{*skill_id} | GET | Raw skill index (unchanged) |
/healthz | GET | Liveness probe |
/readyz | GET | Readiness probe |
Redirect Behavior
GET /api/skills → HTTP 308 → GET /api/v1/skills (and similarly for all /api/… paths).