Skip to content

QUICKSTART_GUIDE.md

Latest commit

 

History

History
76 lines (48 loc) · 1.71 KB

QUICKSTART_GUIDE.md

File metadata and controls

76 lines (48 loc) · 1.71 KB

Cyber Ware Server - Quickstart Guide

Start Cyber Ware example server and verify it works. For project overview, see README.md.

Start the Server

# With example modules (tenant-resolver, users-info)
make example

# Or minimal (no example modules)
make quickstart

Server runs on http://127.0.0.1:8087.

Verify It's Running

curl -s http://127.0.0.1:8087/health
# {"status": "healthy", "timestamp": "..."}

API Documentation

Interactive Documentation

Open http://127.0.0.1:8087/docs in your browser for the full API reference with interactive testing.

OpenAPI Spec

curl -s http://127.0.0.1:8087/openapi.json > openapi.json

Module Examples

Each module has a QUICKSTART.md with minimal curl examples:

Note: Module quickstarts show basic usage only. Use /docs for complete API documentation.

Stop the Server

pkill -f cyberware-server

Troubleshooting

Issue Solution
Port 8087 in use pkill -f cyberware-server
Empty tenant-resolver Use make example instead of make quickstart
Connection refused Server not running - check logs

Further Reading