Cli

Gateway CLI

This document provides information about the available CLI commands and their parameters for the Gateway application.

Starts the Gateway with the specified configuration.

Usage:

gateway start [flags]

Flags:

--config - Path to YAML file with gateway configuration (default: ”./gateway.yaml”)
--addr - Address for gateway server (default: “:9090”)
--servers - Comma-separated list of additional server URLs for Swagger UI (e.g., “https://dev1.example.com,https://dev2.example.com”)

Starts the REST Gateway service.

Usage:

gateway start rest [flags]

Flags:

Starts the MCP (Message-Coupling Protocol) Gateway service.

Usage:

gateway start mcp

Starts the MCP Gateway service using stdin/stdout for communication.

Usage:

gateway start mcp-stdio [flags]

Flags:

Discovers and generates a gateway configuration based on database schema.

Usage:

gateway discover [flags]

Flags:

--database-type - Type of database to connect to
--tables - Specific tables to include in the discovery, you can specify comma-separated list eg “sales,orders,customers”
--ai-api-key - API key for AI service, for instance OpenAI key
--ai-endpoint - Endpoint for AI service, compatible with OpenAI api schema
--ai-model - Model name for AI service, eg o3-mini
--output - Output file path for generated configuration
--extra-prompt - Additional instructions for the AI model

Lists all available database connectors.

Usage:

gateway connectors [connector_name]

If a connector name is provided, displays detailed documentation for that connector.

Lists all available plugins.

Usage:

gateway plugins [plugin_name]

If a plugin name is provided, displays detailed documentation for that plugin.

The gateway.yaml configuration file defines:

Example configuration:

# Example gateway.yaml
api:
  # API configuration
database:
  # Database connection settings
plugins:
  # Plugin configurations

For detailed configuration options, please refer to the main documentation.