> For the complete documentation index, see [llms.txt](https://docs.kpaas.nsini.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kpaas.nsini.com/start/command.md).

# 启动命令

> 本文主要介绍kplcloud所支持的环境变量的参数解释
>
> kplcloud 启动的各参数的优先级顺序是
>
> cmd args > 环境变量 > 默认值

**支持命令**

```
# Kplcloud平台
可用的配置类型：
[start, install, watch, generate, setting]
有关本系统的相关概述，请参阅 http://github.com/kplcloud/kplcloud

Usage:
  kplcloud [command]

Available Commands:
  completion  generate the autocompletion script for the specified shell
  generate    生成命令 如: 数据库、初始数据等
  help        Help about any command
  reset       重置kplcloud
  setting     调整设置命令，对sys_setting的数据进行操作
  start       启动http、grpc服务
  topic       topic处理命令
  watch       watch命令
```

**全局args**

> 这些args对全局生效

```
Flags:
      --db.drive string                       数据库驱动 (default "mysql")
      --db.mysql.database string              mysql数据库 (default "kplcloud")
      --db.mysql.host string                  mysql数据库地址: mysql (default "mysql")
      --db.mysql.password string              mysql数据库密码 (default "admin")
      --db.mysql.port int                     mysql数据库端口 (default 3306)
      --db.mysql.user string                  mysql数据库用户 (default "kplcloud")
      --email.from string                     邮件发送者
      --email.host string                     邮件服务器地址 (default "smtp.nsini.com")
      --email.password string                 邮件服务器密码
      --email.port int                        邮件服务器端口 (default 465)
      --email.username string                 邮件服务器用户名
  -h, --help                                  help for kplcloud
      --jenkins.host string                   Jenkins服务器地址 (default "http://jenkins:8080")
      --jenkins.password string               Jenkins服务器密码
      --jenkins.username string               Jenkins服务器用户名
      --kubernetes.selector.labels strings    Kubernetes Label 的Key (default [k8s-app,kpl.dev/name,nsini.com/name])
  -n, --namespace string                      命名空间 (default "app")
      --prometheus.host string                Prometheus服务器地址 (default "http://prometheus:9090")
      --queue.drive string                    队列系统驱动 (default "rabbitmq")
      --queue.rabbitmq.exchange string        RabbitMq队列系统交换机 (default "kplcloud-exchange")
      --queue.rabbitmq.host string            RabbitMq队列系统地址 (default "rabbitmq")
      --queue.rabbitmq.password string        RabbitMq队列系统密码 (default "admin")
      --queue.rabbitmq.port int               RabbitMq队列系统端口 (default 5672)
      --queue.rabbitmq.user string            RabbitMq队列系统用户名 (default "kplcloud")
      --queue.rabbitmq.vhost string           RabbitMq队列系统虚拟主机 (default "kplcloud")
      --redis.auth string                     连接Redis密码
      --redis.db int                          连接Redis DB
      --redis.hosts string                    连接Redis地址 (default "redis:6379")
      --redis.prefix string                   Redis写入Cache的前缀 (default "kplcloud")
      --server.debug                          是否开启Debug模式
      --server.default.cluster string         新注册用户默认集群 (default "c1")
      --server.default.namespace string       新注册用户默认命名空间 (default "app")
      --server.default.role string            新注册用户默认角色 (default "develop")
      --server.domain string                  本系统域名 (default "https://kplv2.nsini.com")
      --server.domain.suffix string           生成域名后缀 (default "%s.%s.nsini.com")
      --server.http.proxy string              请求外部服务的Http代理地址
      --server.hub.addr string                生成镜像仓库的域名 (default "hub.nsini.com")
      --server.key string                     本系统服务密钥 (default "6Id96Zhx1eqD")
      --server.log.level string               本系统日志级别 (default "all")
      --server.log.name string                本系统日志名称 (default "kplcloud.log")
      --server.log.path string                本系统日志路径
      --server.name string                    本系统服务名称 (default "kplcloud")
      --server.self.queue                     是否使用http服务启动自动监听队列 (default true)
      --server.session.timeout int            本系统session超时时间 (default 7200)
      --server.terminal.session.timeout int   本系统终端session超时时间 (default 600)
      --server.upload.path string             本系统上传文件路径 (default "/data")
  -v, --version                               version for kplcloud
```

## start

> 启动 http 服务

### args 参数

```
Flags:
      --cors.allow.credentials       是否允许跨域访问的凭证 (default true)
      --cors.allow.headers string    允许跨域访问的头部 (default "Accept, Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization")
      --cors.allow.methods string    允许跨域访问的方法 (default "GET,POST,PUT,DELETE,OPTIONS")
      --cors.allow.origins string    允许跨域访问的域名 (default "*")
      --cors.enable                  是否开启跨域访问
      --cors.expose.headers string   允许跨域访问的头部 (default "Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers, Content-Type")
      --github.client.id string      默认连接的GitHub地址
      --github.secret.key string     默认连接的GitHub地址
  -h, --help                         help for start
  -p, --http.port string             服务启动的http端口 (default ":8080")
      --tracer.drive string          Tracer驱动 (default "jaeger")
      --tracer.enable                是否启用Tracer
      --tracer.jaeger.host string    Tracer Jaeger Host (default "jaeger:6832")
      --tracer.jaeger.log.spans      Tracer Jaeger Log Spans
      --tracer.jaeger.param float    Tracer Jaeger Param (default 1)
      --tracer.jaeger.type string    采样器的类型 const: 固定采样, probabilistic: 随机取样, ratelimiting: 速度限制取样, remote: 基于Jaeger代理的取样 (default "const")
      --tracer.name string           Tracer名称 (default "kplcloud")
      --web.embed                    是否使用embed.FS (default true)
```

## generate

> 生成命令 如: 数据库、初始数据等

## watch

> watch命令
>
> 如：watch pods

## setting

> 调整设置命令，对sys\_setting的数据进行操作

## topic

> topic处理命令

## reset

> 重设置平台


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.kpaas.nsini.com/start/command.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
