免费在 GitHub 公开中文介绍

add-setting-env

本技能指导如何用服务器端环境变量设置用户偏好默认值，涵盖变量校验、服务器配置、写入用户状态，以及更新 `.env.example` 和自托管文档。

原文查看原文说明

Add server-side environment variables that control default values for user settings.

lobehub/lobehub星标 83,509(GitHub 83,509 + cccskills 0)

实测评分未实测

查看安装方法

适用场景

通过环境变量设置用户偏好默认值
将设置接入服务器配置和用户状态
更新环境变量示例及文档

中文介绍

功能

本技能指导如何添加服务器端环境变量，为用户设置提供默认值。内容包括使用 createEnv 和 zod 定义并校验变量；如果新增设置领域，还需更新服务器配置类型、组装全局服务器配置，并将配置合并到用户状态中。最后，还要在 .env.example 中添加示例，并更新自托管环境变量文档。

设置值的优先级依次为：用户自定义设置、服务器环境变量、硬编码默认值。

适用场景

当不同的自托管环境需要为用户设置提供不同初始值，或需要让新的设置项可由环境变量控制时，可以使用本技能。它涵盖从变量校验、配置传递到用户可读文档的完整流程，并建议优先复用已有类型。

使用示例

“请让这个用户设置的默认值可以通过环境变量指定。”
“请将新的设置领域接入服务器配置和用户状态。”
“请同时更新环境变量示例和自托管文档。”

注意事项

本技能适用于涉及服务器设置、状态管理、类型定义和环境变量文档的项目。文档更新范围包括英文版和中文版。

本介绍由 AI（OpenAI Codex）根据公开的 SKILL.md 撰写。准确的规格请查看下方原文。

文档检查

AI 根据 SKILL.md 的内容检查了需要注意的操作和使用前提。评分只依据实际运行的结果（实测对比）。

安全性发送数据、删除文件、执行命令等是否有说明: A良好步骤以增加配置和更新文档为主，未提及发送或删除操作。
安装难易度所需工具和 API 密钥是否少且有说明: B部分不足资料使用 `createEnv` 和 `zod`，但未说明安装步骤或版本。

不计入评分。由 AI（OpenAI Codex）于 2026年10月26日评估。仅供参考，安装前请同时查看原文。

如果您认为评估有误，请申请复核

包含的文件（2）

SKILL.md2.5 KB
agents/openai.yaml43 B

SKILL.md（原文）

安装前可以查看交给 AI 代理的指令内容。

Adding Environment Variable for User Settings

Add server-side environment variables to configure default values for user settings.

Priority: User Custom > Server Env Var > Hardcoded Default

Steps

1. Define Environment Variable

Create packages/env/src/<domain>.ts (import path stays @/envs/<domain> — tsconfig maps to packages/env/src/* first):

import { createEnv } from '@t3-oss/env-core';
import { z } from 'zod';

export const get<Domain>Config = () => {
  return createEnv({
    server: {
      YOUR_ENV_VAR: z.coerce.number().min(MIN).max(MAX).optional(),
    },
    runtimeEnv: {
      YOUR_ENV_VAR: process.env.YOUR_ENV_VAR,
    },
  });
};

export const <domain>Env = get<Domain>Config();

2. Update Type (if new domain)

Add to packages/types/src/serverConfig.ts:

import { User<Domain>Config } from './user/settings';

export interface GlobalServerConfig {
  <domain>?: PartialDeep<User<Domain>Config>;
}

Prefer reusing existing types from packages/types/src/user/settings.

3. Assemble Server Config (if new domain)

In apps/server/src/globalConfig/index.ts:

import { <domain>Env } from '@/envs/<domain>';

export const getServerGlobalConfig = async () => {
  const config: GlobalServerConfig = {
    <domain>: cleanObject({
      <settingName>: <domain>Env.YOUR_ENV_VAR,
    }),
  };
  return config;
};

4. Merge to User Store (if new domain)

In src/store/user/slices/common/action.ts:

const serverSettings: PartialDeep<UserSettings> = {
  <domain>: serverConfig.<domain>,
};

5. Update .env.example

# <Description> (range/options, default: X)
# YOUR_ENV_VAR=<example>

6. Update Documentation

docs/self-hosting/environment-variables/basic.mdx (EN)
docs/self-hosting/environment-variables/basic.zh-CN.mdx (CN)

Example: AI_IMAGE_DEFAULT_IMAGE_NUM

// packages/env/src/image.ts  (import as @/envs/image)
AI_IMAGE_DEFAULT_IMAGE_NUM: z.coerce.number().min(1).max(20).optional(),

// packages/types/src/serverConfig.ts
image?: PartialDeep<UserImageConfig>;

// apps/server/src/globalConfig/index.ts
image: cleanObject({ defaultImageNum: imageEnv.AI_IMAGE_DEFAULT_IMAGE_NUM }),

// src/store/user/slices/common/action.ts
image: serverConfig.image,

// .env.example
# AI_IMAGE_DEFAULT_IMAGE_NUM=4

评价

还没有评价。欢迎分享你的使用感受。

无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

同一仓库的技能