syntaxis/scripts/syntaxis-api-lib.nu
Jesús Pérez 9cef9b8d57 refactor: consolidate configuration directories
Merge _configs/ into config/ for single configuration directory.
Update all path references.

Changes:
- Move _configs/* to config/
- Update .gitignore for new patterns
- No code references to _configs/ found

Impact: -1 root directory (layout_conventions.md compliance)
2025-12-26 18:36:23 +00:00

43 lines
2.2 KiB
Plaintext

def api_usage [] {
print "USAGE:"
print " syntaxis-api start [OPTIONS] Start the API server with auto-discovered config"
print " syntaxis-api stop Stop the running API server"
print " syntaxis-api restart [OPTIONS] Restart the API server"
print ""
print "COMMANDS:"
print " start Start the API server with auto-discovered config"
print " stop Stop any running syntaxis-api process (SIGTERM)"
print " restart Stop and start the server (useful for reloading config)"
print ""
print "OPTIONS:"
print " --config <PATH> Configuration file path (overrides auto-discovery)"
print " --host <HOST> Server host to bind to (default: 127.0.0.1)"
print " --port <PORT> Server port number (default: 3001)"
print ""
print "EXAMPLES:"
print " syntaxis-api start # Start with default config"
print " syntaxis-api start --port 8080 # Start with custom port"
print " syntaxis-api start --config /custom.toml # Start with custom config file"
print " syntaxis-api stop # Stop running server"
print " syntaxis-api restart # Restart with default config"
print " syntaxis-api restart --port 3001 # Restart with custom port"
print " syntaxis-api --help # Show this help message"
print ""
print "ENDPOINTS:"
print " GET /health Health check endpoint"
print " GET /api/projects List projects"
print " POST /api/projects Create new project"
print " GET /api/projects/{id} Get project details"
print ""
print "FEATURES:"
print " - REST API for project management"
print " - Task tracking and management"
print " - Phase lifecycle management"
print " - Audit trail and change tracking"
print ""
print "CONFIG DISCOVERY:"
print " 1. --config flag (if provided)"
print " 2. ~/.config/syntaxis/config.toml"
print " 3. ~/.config/syntaxis/syntaxis-api.toml"
}