optimize: optimize makefile target help

[yuluo-yx]

• Fixed optimize: Define the help command of the makefile in a more concise and clear manner #444

$ mk help
Vllm semantic-router: Intelligent Mixture-of-Models Router for Efficient LLM Inference.

Usage:
  make <Target> <Option>

Targets:

Common
  help             Show help info.

Envoy
  prepare-envoy    Install func-e for managing Envoy versions
  run-envoy        Run Envoy proxy with the configured settings

Golang
  go-lint          Run golangci-lint for src/semantic-router
  go-lint-fix      Auto-fix lint issues in src/semantic-router (may need manual fix)
  vet              Run go vet for all Go modules
  check-go-mod-tidy  Check go mod tidy for all Go modules
  install-controller-gen  Install controller-gen for code generation
  generate-crd     Generate CRD manifests using controller-gen
  generate-deepcopy  Generate deepcopy methods using controller-gen
  generate-api     Generate all API artifacts (deepcopy, CRDs)

Rust
  test-binding     Run Go tests with the Rust static library
  test-category-classifier  Test domain classifier with candle-binding
  test-pii-classifier  Test PII classifier with candle-binding
  test-jailbreak-classifier  Test jailbreak classifier with candle-binding
  rust             Ensure Rust is installed and build the Rust library

Build/Test
  build            Build the Rust library and Golang binding
  build-router     Build the router binary
  run-router       Run the router with the specified config
  run-router-e2e   Run the router with e2e config for testing
  test-semantic-router  Run unit tests for semantic-router (set SKIP_MILVUS_TESTS=false to enable Milvus tests)
  test             Run all tests (Go, Rust, binding)
  clean            Clean built artifacts
  test-auto-prompt-reasoning  Test Envoy extproc with a math prompt (curl)
  test-auto-prompt-no-reasoning  Test tools auto-selection no-reasoning
  test-pii         Test prompts that contain PII
  test-prompt-guard  Test prompt guard classifier
  test-tools       Test tools auto-selection
  test-vllm        Test vLLM endpoint with curl
  start-llm-katan  Start LLM Katan servers in foreground mode for e2e testing
  test-e2e-vllm    Run e2e tests with LLM Katan servers (make sure servers are running)

Docs
  docs-install     Install documentation website dependencies
  docs-dev         Start documentation website in dev mode
  docs-build       Build static documentation website
  docs-serve       Serve built documentation website
  docs-clean       Clean documentation build artifacts

Linter
  docs-lint        Lint documentation in website/
  docs-lint-fix    Auto-fix documentation lint issues in website/
  markdown-lint    Lint all markdown files in the project
  markdown-lint-fix  Auto-fix markdown lint issues
  yaml-lint        Lint all YAML files in the project
  codespell        Check for common misspellings in code and docs

Milvus
  start-milvus     Start Milvus container for testing
  stop-milvus      Stop and remove Milvus container
  restart-milvus   Restart Milvus container
  milvus-status    Show status of Milvus container
  clean-milvus     Clean up Milvus data
  start-milvus-ui  Start Attu UI to browse Milvus data

Models
  download-models  Download models (full or minimal set depending on CI_MINIMAL_MODELS)
  download-models-minimal  Pre-download minimal set of models for CI tests
  download-models-full  Download all models used in local development and docs

Pre-commit
  precommit-install  Install pre-commit Python package
  precommit-check  Run pre-commit checks on all relevant files
  precommit-local  Run pre-commit hooks in a Docker/Podman container

Docker
  docker-build-all  Build all Docker images
  docker-build-extproc  Build extproc Docker image
  docker-build-llm-katan  Build llm-katan Docker image
  docker-build-dashboard  Build dashboard Docker image
  docker-build-precommit  Build precommit Docker image
  docker-test-llm-katan  Test llm-katan Docker image locally

Kubernetes
  create-cluster   Create a kind cluster with optimized configuration
  delete-cluster   Delete the kind cluster
  cluster-info     Show cluster information and resource usage
  deploy           Deploy semantic-router to the cluster
  undeploy         Remove semantic-router from the cluster
  load-image       Load Docker image into kind cluster
  test-deployment  Test the deployment
  test-api         Test the Classification API
  port-forward-api  Port forward Classification API (8080)
  port-forward-grpc  Port forward gRPC API (50051)
  port-forward-metrics  Port forward Prometheus metrics (9190)
  logs             Show semantic-router logs
  status           Show deployment status
  setup            Complete setup: create cluster and deploy
  cleanup          Complete cleanup: undeploy and delete cluster

Observability
  o11y-local       Start observability in LOCAL mode (router on host, o11y in Docker)
  o11y-compose     Start observability in COMPOSE mode (all services in Docker)
  stop-observability  Stop and remove observability containers
  o11y-logs        Show logs from observability containers
  o11y-status      Check status of observability containers
  o11y-clean       Remove observability data volumes

OpenShift
  openshift-login  Login to OpenShift cluster
  openshift-logout  Logout from OpenShift cluster
  openshift-deploy  Deploy semantic-router to OpenShift using Kustomize
  openshift-deploy-auto  Deploy using automated script
  openshift-deploy-template  Deploy using OpenShift template
  openshift-undeploy  Remove deployment (keep namespace)
  openshift-cleanup  Remove deployment and namespace
  openshift-status  Show deployment status
  openshift-logs   Show application logs (follow)
  openshift-logs-previous  Show previous pod logs
  openshift-routes  Show route URLs
  openshift-test   Test deployment connectivity
  openshift-port-forward-api  Port forward Classification API
  openshift-port-forward-grpc  Port forward gRPC API
  openshift-port-forward-metrics  Port forward metrics
  openshift-debug  Show debugging information

[netlify]

✅ Deploy Preview for vllm-semantic-router ready!

Name	Link
🔨 Latest commit	d97672c
🔍 Latest deploy log	https://app.netlify.com/projects/vllm-semantic-router/deploys/68f23d1b27f8d5000837545b
😎 Deploy Preview	https://deploy-preview-455--vllm-semantic-router.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[github-actions]

👥 vLLM Semantic Team Notification

The following members have been identified for the changed files in this PR and have been automatically assigned:

📁 tools

Owners: @yuluo-yx, @rootfs, @Xunzhuo
Files changed:

• tools/make/build-run-test.mk
• tools/make/common.mk
• tools/make/docker.mk
• tools/make/docs.mk
• tools/make/envoy.mk
• tools/make/golang.mk
• tools/make/kube.mk
• tools/make/linter.mk
• tools/make/milvus.mk
• tools/make/models.mk
• tools/make/observability.mk
• tools/make/openshift.mk
• tools/make/pre-commit.mk
• tools/make/rust.mk

---

🎉 Thanks for your contributions!

This comment was automatically generated based on the OWNER files in the repository.

[JaredforReal]

Do we miss Docker Compose related commands? like: docker-compose-up, docker-compose-down, docker-compose-up-core etc? @yuluo-yx

[yuluo-yx]

Do we miss Docker Compose related commands? like: docker-compose-up, docker-compose-down, docker-compose-up-core etc? @yuluo-yx

yep, my bad. The makefile contains too many targets, and I forgot them when making the changes.

pls review #467 thx. cc @rootfs