Sparki Command Reference - Quick Lookup
Quick Access: Use this document to quickly find the exact command you need.โก Essential Commands (Run These First)
Initial Setup
Start Services
๐งช Testing Commands
Run Tests
View Test Results
๐ Metrics & Monitoring
View Metrics
Health Endpoints
๐ Logs & Debugging
View Logs
Rebuild & Restart
๐๏ธ Database Commands
Database Operations
๐ Redis Commands
Redis Operations
Event Monitoring
๐ Authentication & Tokens
JWT Token Management
๐ ๏ธ Service Management
Service Operations
Service Ports & Endpoints
| Service | Port | Purpose | Health Check |
|---|---|---|---|
| API | 8080 | HTTP REST API | curl localhost:8080/health |
| Relay | 8081 | WebSocket | curl localhost:8081/health |
| Shield | 8000 | Auth/Users | curl localhost:8000/health |
| API Metrics | 9090 | Prometheus | curl localhost:9090/metrics |
| Shield Metrics | 9091 | Prometheus | curl localhost:9091/metrics |
| Relay Metrics | 9092 | Prometheus | curl localhost:9092/metrics |
| PostgreSQL | 5432 | Database | make db-shell |
| Redis | 6379 | Events/Cache | make redis-shell |
๐ CI/CD & Deployment
Testing Pipeline
Deployment
๐ Validation & Quality
Code Quality
Protocol Validation
๐ง Configuration Files
Key Files to Know
Edit Configuration
๐ Troubleshooting Quick Fixes
Port Already in Use
Service Wonโt Start
Tests Failing
Metrics Not Available
๐ Documentation Links
| Document | Purpose | Path |
|---|---|---|
| Setup Guide | Complete initialization | SETUP.md |
| Sparki README | Service definitions | sparki/README.md |
| Monitoring Bridge | Observability setup | monitoring/MONITORING-BRIDGE.md |
| Protocol Rules | API contracts | sparki/protocol-rules.yml |
| Quick Start | Getting started | SPARKI-QUICK-START.md |
| This Document | Quick commands | SPARKI-COMMAND-REFERENCE.md |
๐ก Pro Tips
๐ฏ Common Workflows
โI want to start fresh"
"I want to run tests"
"I want to monitor my services"
"I want to debug a failing serviceโ
Last Updated: 2025-12-16 Status: Ready to use Questions? Check SETUP.md or SPARKI-QUICK-START.md