[pull] main from lobehub:main #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

pull wants to merge 2,127 commits into XMethues:main from lobehub:main

+999,349 −382,318

The diff you're trying to view is too large. We only load the first 3000 changed files.

.agents/skills/add-provider-doc/SKILL.md

-Original file line number
+Diff line change
@@ -0,0 +1,90 @@
+    ---
+    name: add-provider-doc
+    description: Guide for adding new AI provider documentation. Use when adding documentation for a new AI provider (like OpenAI, Anthropic, etc.), including usage docs, environment variables, Docker config, and image resources. Triggers on provider documentation tasks.
+    ---
+    # Adding New AI Provider Documentation
+    Complete workflow for adding documentation for a new AI provider.
+    ## Overview
+. Create usage documentation (EN + CN)
+. Add environment variable documentation (EN + CN)
+. Update Docker configuration files
+. Update .env.example
+. Prepare image resources
+    ## Step 1: Create Provider Usage Documentation
+    ### Required Files
+    - `docs/usage/providers/{provider-name}.mdx` (English)
+    - `docs/usage/providers/{provider-name}.zh-CN.mdx` (Chinese)
+    ### Key Requirements
+    - 5-6 screenshots showing the process
+    - Cover image for the provider
+    - Real registration and dashboard URLs
+    - Pricing information callout
+    - **Never include real API keys** - use placeholders
+    Reference: `docs/usage/providers/fal.mdx`
+    ## Step 2: Update Environment Variables Documentation
+    ### Files to Update
+    - `docs/self-hosting/environment-variables/model-provider.mdx` (EN)
+    - `docs/self-hosting/environment-variables/model-provider.zh-CN.mdx` (CN)
+    ### Content Format
+    ```markdown
+    ### `{PROVIDER}_API_KEY`
+    - Type: Required
+    - Description: API key from {Provider Name}
+    - Example: `{api-key-format}`
+    ### `{PROVIDER}_MODEL_LIST`
+    - Type: Optional
+    - Description: Control model list. Use `+` to add, `-` to hide
+    - Example: `-all,+model-1,+model-2=Display Name`
+    ```
+    ## Step 3: Update Docker Files
+    Update all Dockerfiles at the **end** of ENV section:
+    - `Dockerfile`
+    - `Dockerfile.database`
+    - `Dockerfile.pglite`
+    ```dockerfile
+    # {New Provider}
+    {PROVIDER}_API_KEY="" {PROVIDER}_MODEL_LIST=""
+    ```
+    ## Step 4: Update .env.example
+    ```bash
+    ### {Provider Name} ###
+    # {PROVIDER}_API_KEY={prefix}-xxxxxxxx
+    ```
+    ## Step 5: Image Resources
+    - Cover image
+    - 3-4 API dashboard screenshots
+    - 2-3 LobeChat configuration screenshots
+    - Host on LobeHub CDN: `hub-apac-1.lobeobjects.space`
+    ## Checklist
+    - [ ] EN + CN usage docs
+    - [ ] EN + CN env var docs
+    - [ ] All 3 Dockerfiles updated
+    - [ ] .env.example updated
+    - [ ] All images prepared
+    - [ ] No real API keys in docs

.agents/skills/add-setting-env/SKILL.md

-Original file line number
+Diff line change
@@ -0,0 +1,106 @@
+    ---
+    name: add-setting-env
+    description: Guide for adding environment variables to configure user settings. Use when implementing server-side environment variables that control default values for user settings. Triggers on env var configuration or setting default value tasks.
+    ---
+    # 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 `src/envs/<domain>.ts`:
+    ```typescript
+    import { createEnv } from '@t3-oss/env-nextjs';
+    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`:
+    ```typescript
+    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 `src/server/globalConfig/index.ts`:
+    ```typescript
+    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`:
+    ```typescript
+    const serverSettings: PartialDeep<UserSettings> = {
+      <domain>: serverConfig.<domain>,
+    };
+    ```
+    ### 5. Update .env.example
+    ```bash
+    # <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
+    ```typescript
+    // src/envs/image.ts
+    AI_IMAGE_DEFAULT_IMAGE_NUM: z.coerce.number().min(1).max(20).optional(),
+    // packages/types/src/serverConfig.ts
+    image?: PartialDeep<UserImageConfig>;
+    // src/server/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
+    ```

.agents/skills/debug/SKILL.md

-Original file line number
+Diff line change
@@ -0,0 +1,66 @@
+    ---
+    name: debug
+    description: Debug package usage guide. Use when adding debug logging, understanding log namespaces, or implementing debugging features. Triggers on debug logging requests or logging implementation.
+    user-invocable: false
+    ---
+    # Debug Package Usage Guide
+    ## Basic Usage
+    ```typescript
+    import debug from 'debug';
+    // Format: lobe-[module]:[submodule]
+    const log = debug('lobe-server:market');
+    log('Simple message');
+    log('With variable: %O', object);
+    log('Formatted number: %d', number);
+    ```
+    ## Namespace Conventions
+    - Desktop: `lobe-desktop:[module]`
+    - Server: `lobe-server:[module]`
+    - Client: `lobe-client:[module]`
+    - Router: `lobe-[type]-router:[module]`
+    ## Format Specifiers
+    - `%O` - Object expanded (recommended for complex objects)
+    - `%o` - Object
+    - `%s` - String
+    - `%d` - Number
+    ## Enable Debug Output
+    ### Browser
+    ```javascript
+    localStorage.debug = 'lobe-*';
+    ```
+    ### Node.js
+    ```bash
+    DEBUG=lobe-* npm run dev
+    DEBUG=lobe-* pnpm dev
+    ```
+    ### Electron
+    ```typescript
+    process.env.DEBUG = 'lobe-*';
+    ```
+    ## Example
+    ```typescript
+    // src/server/routers/edge/market/index.ts
+    import debug from 'debug';
+    const log = debug('lobe-edge-router:market');
+    log('getAgent input: %O', input);
+    ```

.agents/skills/desktop/SKILL.md

-Original file line number
+Diff line change
@@ -0,0 +1,78 @@
+    ---
+    name: desktop
+    description: Electron desktop development guide. Use when implementing desktop features, IPC handlers, controllers, preload scripts, window management, menu configuration, or Electron-specific functionality. Triggers on desktop app development, Electron IPC, or desktop local tools implementation.
+    disable-model-invocation: true
+    ---
+    # Desktop Development Guide
+    ## Architecture Overview
+    LobeChat desktop is built on Electron with main-renderer architecture:
+. **Main Process** (`apps/desktop/src/main`): App lifecycle, system APIs, window management
+. **Renderer Process**: Reuses web code from `src/`
+. **Preload Scripts** (`apps/desktop/src/preload`): Securely expose main process to renderer
+    ## Adding New Desktop Features
+    ### 1. Create Controller
+    Location: `apps/desktop/src/main/controllers/`
+    ```typescript
+    import { ControllerModule, IpcMethod } from '@/controllers';
+    export default class NewFeatureCtr extends ControllerModule {
+      static override readonly groupName = 'newFeature';
+      @IpcMethod()
+      async doSomething(params: SomeParams): Promise<SomeResult> {
+        // Implementation
+        return { success: true };
+      }
+    }
+    ```
+    Register in `apps/desktop/src/main/controllers/registry.ts`.
+    ### 2. Define IPC Types
+    Location: `packages/electron-client-ipc/src/types.ts`
+    ```typescript
+    export interface SomeParams { /* ... */ }
+    export interface SomeResult { success: boolean; error?: string }
+    ```
+    ### 3. Create Renderer Service
+    Location: `src/services/electron/`
+    ```typescript
+    import { ensureElectronIpc } from '@/utils/electron/ipc';
+    const ipc = ensureElectronIpc();
+    export const newFeatureService = async (params: SomeParams) => {
+      return ipc.newFeature.doSomething(params);
+    };
+    ```
+    ### 4. Implement Store Action
+    Location: `src/store/`
+    ### 5. Add Tests
+    Location: `apps/desktop/src/main/controllers/__tests__/`
+    ## Detailed Guides
+    See `references/` for specific topics:
+    - **Feature implementation**: `references/feature-implementation.md`
+    - **Local tools workflow**: `references/local-tools.md`
+    - **Menu configuration**: `references/menu-config.md`
+    - **Window management**: `references/window-management.md`
+    ## Best Practices
+. **Security**: Validate inputs, limit exposed APIs
+. **Performance**: Use async methods, batch data transfers
+. **UX**: Add progress indicators, provide error feedback
+. **Code organization**: Follow existing patterns, add documentation

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[pull] main from lobehub:main #105

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

[pull] main from lobehub:main #105

Are you sure you want to change the base?

[pull] main from lobehub:main #105

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!