CLI

genui-sdk-server is a globally installed command-line tool for quickly starting a GenUI SDK chat completion HTTP service. It provides zero-config server startup with automatic environment variable loading and port conflict detection.

Installation

Install globally via npm or yarn:

npm install -g @opentiny/genui-sdk-server
# or
yarn global add @opentiny/genui-sdk-server

After installation, you can use the genui-sdk-server command in your terminal.

Quick Start

1. Create a .env file and configure required environment variables:

BASE_URL=https://api.openai.com/v1
API_KEY=
PORT=3100

2. Run the command to start the service:

genui-sdk-server

On success, the server address is printed, for example:

genui-sdk-server is running on http://localhost:3100

Commands

genui-sdk-server

Starts the GenUI SDK chat HTTP service.

Usage

genui-sdk-server [options]

Options

Option	Short	Type	Description
--envFile <path>	-e	string	Custom environment file path (default: .env in the current directory)
--port <port>	-p	number	Server port (default: 3100 or PORT environment variable)
--help	-h	-	Show help information

Environment Variables

The CLI requires the following environment variables (via .env file or system environment):

Variable	Required	Description	Default
BASE_URL	Yes	API base URL, e.g. https://api.openai.com/v1	-
API_KEY	Yes	API key	-
PORT	No	Server port	3100

Environment variable priority:

1. Command-line option --port (highest priority)
2. Environment variable PORT
3. Default value 3100

Features

• Automatic port detection: If the specified port is in use, tries the next port automatically (up to 10 attempts)
• Environment variable loading: Supports loading configuration from .env files or system environment variables
• CORS support: CORS is enabled automatically for cross-origin requests
• Streaming responses: Supports SSE (Server-Sent Events) streaming format

Examples

Basic usage

Start with default configuration (reads .env in the current directory, port 3100):

genui-sdk-server

Custom environment file

Use a custom environment file:

genui-sdk-server -e /path/to/custom/.env

Specify port

Set the server port via command-line option:

genui-sdk-server -p 3000

Combined usage

Specify both environment file and port:

genui-sdk-server -e /path/to/.env -p 3000

System environment variables

Use system environment variables without a .env file:

# Set system environment variables
export BASE_URL=https://api.openai.com/v1
export API_KEY=
export PORT=3000

# Start the service
genui-sdk-server

Show help

genui-sdk-server --help
# or
genui-sdk-server -h

Server Endpoints

After startup, the service exposes the following endpoint:

• POST /chat/completions - Chat completion endpoint with streaming response (SSE format)

Related Links

• Server API - Component API documentation
• Usage Guide - Detailed usage guide