@aigne/cli 1.16.0 → 1.18.0

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 # Changelog
 
+## [1.18.0](https://github.com/AIGNE-io/aigne-framework/compare/cli-v1.17.0...cli-v1.18.0) (2025-07-01)
+
+
+### Features
+
+* **example:** use AIGNE cli to run chat-bot example ([#198](https://github.com/AIGNE-io/aigne-framework/issues/198)) ([7085541](https://github.com/AIGNE-io/aigne-framework/commit/708554100692f2a557f7329ea78e46c3c870ce10))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/agent-library bumped to 1.17.5
+    * @aigne/anthropic bumped to 0.5.0
+    * @aigne/bedrock bumped to 0.5.0
+    * @aigne/core bumped to 1.28.0
+    * @aigne/deepseek bumped to 0.4.0
+    * @aigne/gemini bumped to 0.4.0
+    * @aigne/ollama bumped to 0.4.0
+    * @aigne/open-router bumped to 0.4.0
+    * @aigne/openai bumped to 0.6.0
+    * @aigne/xai bumped to 0.4.0
+
+## [1.17.0](https://github.com/AIGNE-io/aigne-framework/compare/cli-v1.16.0...cli-v1.17.0) (2025-07-01)
+
+
+### Features
+
+* **cli:** support HTTPS_PROXY and named path param ([#196](https://github.com/AIGNE-io/aigne-framework/issues/196)) ([04e684e](https://github.com/AIGNE-io/aigne-framework/commit/04e684ee26bc2d79924b0e3cb541cd07a7191804))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/agent-library bumped to 1.17.4
+    * @aigne/anthropic bumped to 0.4.0
+    * @aigne/bedrock bumped to 0.4.0
+    * @aigne/core bumped to 1.27.0
+    * @aigne/deepseek bumped to 0.3.11
+    * @aigne/gemini bumped to 0.3.11
+    * @aigne/ollama bumped to 0.3.11
+    * @aigne/open-router bumped to 0.3.11
+    * @aigne/openai bumped to 0.5.0
+    * @aigne/xai bumped to 0.3.11
+
 ## [1.16.0](https://github.com/AIGNE-io/aigne-framework/compare/cli-v1.15.0...cli-v1.16.0) (2025-06-30)
 
 

package/README.md

@@ -16,12 +16,12 @@ Command-line tool for [AIGNE Framework](https://github.com/AIGNE-io/aigne-framew
 
 ## Features
 
-- **Project Creation**: Quickly create new AIGNE projects with predefined file structures and configurations
-- **Agent Running**: Easily run and test AIGNE agents
-- **Testing Support**: Built-in test command for unit testing and integration testing
-- **MCP Services**: Support for launching agents as MCP servers for integration with external systems
-- **Interactive Interface**: Beautiful command-line interface providing an intuitive user experience
-- **Multi-model Support**: Support for OpenAI, Claude, XAI, and other model providers
+* **Project Creation**: Quickly create new AIGNE projects with predefined file structures and configurations
+* **Agent Running**: Easily run and test AIGNE agents
+* **Testing Support**: Built-in test command for unit testing and integration testing
+* **MCP Services**: Support for launching agents as MCP servers for integration with external systems
+* **Interactive Interface**: Beautiful command-line interface providing an intuitive user experience
+* **Multi-model Support**: Support for OpenAI, Claude, XAI, and other model providers
 
 ## Installation
 
@@ -55,13 +55,13 @@ aigne --help
 aigne create [path]
 
 # Run an agent
-aigne run [path]
+aigne run --path xxx
 
 # Run tests
-aigne test [path]
+aigne test --path xxx
 
 # Start MCP server
-aigne serve [path] --mcp
+aigne serve --path xxx --mcp
 
 # Start observability server
 aigne observe [option]
@@ -81,8 +81,8 @@ aigne create my-project
 
 The interactive creation process will ask for:
 
-- Project name
-- Project template (currently supports the default template)
+* Project name
+* Project template (currently supports the default template)
 
 ## Run Command
 
@@ -104,10 +104,10 @@ aigne run --entry-agent myAgent
 
 Available options:
 
-- `--entry-agent <entry-agent>` - Specify the agent name to run (defaults to the first agent found)
-- `--cache-dir <dir>` - Specify the directory to download the package to (used in URL mode)
-- `--model <provider[:model]>` - Specify the AI model in format 'provider\[:model]' where model is optional (e.g., 'openai' or 'openai:gpt-4o-mini')
-- `--verbose` - Enable verbose logging
+* `--entry-agent <entry-agent>` - Specify the agent name to run (defaults to the first agent found)
+* `--cache-dir <dir>` - Specify the directory to download the package to (used in URL mode)
+* `--model <provider[:model]>` - Specify the AI model in format 'provider\[:model]' where model is optional (e.g., 'openai' or 'openai:gpt-4o-mini')
+* `--verbose` - Enable verbose logging
 
 ## Test Command
 
@@ -133,7 +133,7 @@ aigne serve --mcp
 aigne serve --mcp --port 3001
 
 # Start MCP server for agents at specified path
-aigne serve path/to/agents --mcp
+aigne serve --path path/to/agents --mcp
 ```
 
 ## Serve Command (observability)

package/README.zh.md

@@ -16,12 +16,12 @@
 
 ## 特性
 
-- **项目创建**：快速创建新的 AIGNE 项目，包含预设的文件结构和配置
-- **代理运行**：轻松运行和测试 AIGNE 代理
-- **测试支持**：内置测试命令，方便进行单元测试和集成测试
-- **MCP 服务**：支持将代理作为 MCP 服务器启动，与外部系统集成
-- **交互式界面**：美观的命令行界面，提供直观的使用体验
-- **多模型支持**：支持 OpenAI、Claude、XAI 等多种模型提供商
+* **项目创建**：快速创建新的 AIGNE 项目，包含预设的文件结构和配置
+* **代理运行**：轻松运行和测试 AIGNE 代理
+* **测试支持**：内置测试命令，方便进行单元测试和集成测试
+* **MCP 服务**：支持将代理作为 MCP 服务器启动，与外部系统集成
+* **交互式界面**：美观的命令行界面，提供直观的使用体验
+* **多模型支持**：支持 OpenAI、Claude、XAI 等多种模型提供商
 
 ## 安装
 
@@ -55,13 +55,13 @@ aigne --help
 aigne create [path]
 
 # 运行代理
-aigne run [path]
+aigne run --path xxx
 
 # 运行测试
-aigne test [path]
+aigne test --path xxx
 
 # 启动 MCP 服务器
-aigne serve [path] --mcp
+aigne serve --path xxx --mcp
 
 # 启动 observability 服务器
 aigne observe [option]
@@ -81,8 +81,8 @@ aigne create my-project
 
 交互式创建过程会询问：
 
-- 项目名称
-- 项目模板（目前支持 default 模板）
+* 项目名称
+* 项目模板（目前支持 default 模板）
 
 ## 运行命令 (run)
 
@@ -104,10 +104,10 @@ aigne run --entry-agent myAgent
 
 可用选项：
 
-- `--entry-agent <代理>` - 指定要运行的代理名称（默认为找到的第一个代理）
-- `--cache-dir <目录>` - 指定下载包的目录（URL模式下使用）
-- `--model <提供商[:模型]>` - 指定AI模型，格式为'提供商\[:模型]'，其中模型是可选的（如'openai'或'openai:gpt-4o-mini'）
-- `--verbose` - 启用详细日志记录
+* `--entry-agent <代理>` - 指定要运行的代理名称（默认为找到的第一个代理）
+* `--cache-dir <目录>` - 指定下载包的目录（URL模式下使用）
+* `--model <提供商[:模型]>` - 指定AI模型，格式为'提供商\[:模型]'，其中模型是可选的（如'openai'或'openai:gpt-4o-mini'）
+* `--verbose` - 启用详细日志记录
 
 ## 测试命令 (test)
 
@@ -133,7 +133,7 @@ aigne serve --mcp
 aigne serve --mcp --port 3001
 
 # 为指定路径的代理启动 MCP 服务器
-aigne serve path/to/agents --mcp
+aigne serve -- path path/to/agents --mcp
 ```
 
 ## 服务命令 (observability)

package/dist/cli.js

@@ -2,7 +2,7 @@
 import { config } from "dotenv-flow";
 import PrettyError from "pretty-error";
 import { createAIGNECommand } from "./commands/aigne.js";
-config();
+config({ silent: true });
 createAIGNECommand()
     .parseAsync()
     .catch((error) => {

package/dist/commands/aigne.js

@@ -2,7 +2,7 @@ import { Command } from "commander";
 import { AIGNE_CLI_VERSION } from "../constants.js";
 import { asciiLogo } from "../utils/ascii-logo.js";
 import { createCreateCommand } from "./create.js";
-import { createObservabilityCommand } from "./observability.js";
+import { createObservabilityCommand } from "./observe.js";
 import { createRunCommand } from "./run.js";
 import { createServeCommand } from "./serve.js";
 import { createTestCommand } from "./test.js";

package/dist/commands/{observability.js → observe.js}

@@ -1,6 +1,6 @@
 import { tryOrThrow } from "@aigne/core/utils/type-utils.js";
-import { startObservabilityCLIServer } from "@aigne/observability/cli";
-import getObservabilityDbPath from "@aigne/observability/db-path";
+import { startObservabilityCLIServer } from "@aigne/observability-api/cli";
+import getObservabilityDbPath from "@aigne/observability-api/db-path";
 import { Command } from "commander";
 import detectPort from "detect-port";
 const DEFAULT_PORT = () => tryOrThrow(() => {
@@ -20,7 +20,7 @@ export function createObservabilityCommand() {
         .action(async (options) => {
         const port = await detectPort(options.port || DEFAULT_PORT());
         const dbUrl = getObservabilityDbPath();
-        console.log("DB PATH:", dbUrl);
+        console.log("Observability database path:", dbUrl);
         await startObservabilityCLIServer({ port, dbUrl });
     })
         .showHelpAfterError(true)

package/dist/commands/run.js

@@ -7,6 +7,7 @@ import { loadModel } from "@aigne/core/loader/index.js";
 import { logger } from "@aigne/core/utils/logger.js";
 import { isNonNullable } from "@aigne/core/utils/type-utils.js";
 import { Listr, PRESET_TIMER } from "@aigne/listr2";
+import { config } from "dotenv-flow";
 import { availableMemories, availableModels } from "../constants.js";
 import { isV1Package, toAIGNEPackage } from "../utils/agent-v1.js";
 import { downloadAndExtract } from "../utils/download.js";
@@ -43,7 +44,12 @@ export function createRunCommand() {
             {
                 title: "Initialize AIGNE",
                 task: async (ctx) => {
-                    const aigne = await loadAIGNE(dir, options);
+                    // Load env files in the aigne directory
+                    config({ path: dir, silent: true });
+                    const aigne = await loadAIGNE(dir, {
+                        ...options,
+                        model: options.model || process.env.MODEL,
+                    });
                     ctx.aigne = aigne;
                 },
             },
@@ -91,10 +97,11 @@ export function createRunCommand() {
         .showSuggestionAfterError(true);
 }
 async function loadAIGNE(path, options) {
+    const models = availableModels();
     const model = options.model
-        ? await loadModel(availableModels, parseModelOption(options.model))
+        ? await loadModel(models, parseModelOption(options.model))
         : undefined;
-    return await AIGNE.load(path, { models: availableModels, memories: availableMemories, model });
+    return await AIGNE.load(path, { models, memories: availableMemories, model });
 }
 async function downloadPackage(url, cacheDir) {
     await rm(cacheDir, { recursive: true, force: true });

package/dist/commands/serve.js

@@ -16,16 +16,17 @@ const DEFAULT_PORT = () => tryOrThrow(() => {
 export function createServeCommand() {
     return new Command("serve")
         .description("Serve the agents in the specified directory as a MCP server")
-        .argument("[path]", "Path to the agents directory", ".")
+        .option("--url, --path <path_or_url>", "Path to the agents directory or URL to aigne project", ".")
         .option("--mcp", "Serve the agents as a MCP server")
         .option("--host <host>", "Host to run the MCP server on, use 0.0.0.0 to publicly expose the server", "localhost")
         .option("--port <port>", "Port to run the MCP server on", (s) => Number.parseInt(s))
         .option("--pathname <pathname>", "Pathname to the service", "/mcp")
-        .action(async (path, options) => {
+        .action(async (options) => {
+        const { path } = options;
         const absolutePath = isAbsolute(path) ? path : resolve(process.cwd(), path);
         const port = options.port || DEFAULT_PORT();
         const aigne = await AIGNE.load(absolutePath, {
-            models: availableModels,
+            models: availableModels(),
             memories: availableMemories,
         });
         if (options.mcp)

package/dist/commands/test.js

@@ -4,8 +4,9 @@ import { Command } from "commander";
 export function createTestCommand() {
     return new Command("test")
         .description("Run tests in the specified agents directory")
-        .argument("[path]", "Path to the agents directory", ".")
-        .action(async (path) => {
+        .option("--url, --path <path_or_url>", "Path to the agents directory or URL to aigne project", ".")
+        .action(async (options) => {
+        const { path } = options;
         const absolutePath = isAbsolute(path) ? path : resolve(process.cwd(), path);
         spawnSync("node", ["--test"], { cwd: absolutePath, stdio: "inherit" });
     })

package/dist/constants.d.ts

@@ -1,7 +1,5 @@
 import { DefaultMemory } from "@aigne/agent-library/default-memory/index.js";
-import { AnthropicChatModel } from "@aigne/anthropic";
-import { BedrockChatModel } from "@aigne/bedrock";
-import { OpenAIChatModel } from "@aigne/openai";
+import type { LoadableModel } from "@aigne/core/loader/index.js";
 export declare const AIGNE_CLI_VERSION: string;
-export declare const availableModels: (typeof OpenAIChatModel | typeof AnthropicChatModel | typeof BedrockChatModel)[];
+export declare function availableModels(): LoadableModel[];
 export declare const availableMemories: (typeof DefaultMemory)[];

package/dist/constants.js

@@ -7,16 +7,57 @@ import { OllamaChatModel } from "@aigne/ollama";
 import { OpenRouterChatModel } from "@aigne/open-router";
 import { OpenAIChatModel } from "@aigne/openai";
 import { XAIChatModel } from "@aigne/xai";
+import { NodeHttpHandler, streamCollector } from "@smithy/node-http-handler";
+import { HttpsProxyAgent } from "https-proxy-agent";
 import pkg from "../package.json" with { type: "json" };
 export const AIGNE_CLI_VERSION = pkg.version;
-export const availableModels = [
-    OpenAIChatModel,
-    AnthropicChatModel,
-    BedrockChatModel,
-    DeepSeekChatModel,
-    GeminiChatModel,
-    OllamaChatModel,
-    OpenRouterChatModel,
-    XAIChatModel,
-];
+export function availableModels() {
+    const proxy = ["HTTPS_PROXY", "https_proxy", "HTTP_PROXY", "http_proxy", "ALL_PROXY", "all_proxy"]
+        .map((i) => process.env[i])
+        .filter(Boolean)[0];
+    const httpAgent = proxy ? new HttpsProxyAgent(proxy) : undefined;
+    return [
+        {
+            name: OpenAIChatModel.name,
+            create: (params) => new OpenAIChatModel({ ...params, clientOptions: { httpAgent } }),
+        },
+        {
+            name: AnthropicChatModel.name,
+            create: (params) => new AnthropicChatModel({ ...params, clientOptions: { httpAgent } }),
+        },
+        {
+            name: BedrockChatModel.name,
+            create: (params) => new BedrockChatModel({
+                ...params,
+                clientOptions: {
+                    requestHandler: NodeHttpHandler.create({
+                        httpAgent,
+                        httpsAgent: httpAgent,
+                    }),
+                    streamCollector,
+                },
+            }),
+        },
+        {
+            name: DeepSeekChatModel.name,
+            create: (params) => new DeepSeekChatModel({ ...params, clientOptions: { httpAgent } }),
+        },
+        {
+            name: GeminiChatModel.name,
+            create: (params) => new GeminiChatModel({ ...params, clientOptions: { httpAgent } }),
+        },
+        {
+            name: OllamaChatModel.name,
+            create: (params) => new OllamaChatModel({ ...params, clientOptions: { httpAgent } }),
+        },
+        {
+            name: OpenRouterChatModel.name,
+            create: (params) => new OpenRouterChatModel({ ...params, clientOptions: { httpAgent } }),
+        },
+        {
+            name: XAIChatModel.name,
+            create: (params) => new XAIChatModel({ ...params, clientOptions: { httpAgent } }),
+        },
+    ];
+}
 export const availableMemories = [DefaultMemory];

package/dist/tracer/terminal.js

@@ -148,7 +148,7 @@ export class TerminalTracer {
     }
     formatResult(agent, context, m = {}) {
         const { isTTY } = process.stdout;
-        const outputKey = agent instanceof AIAgent ? agent.outputKey : undefined;
+        const outputKey = this.outputKey || (agent instanceof AIAgent ? agent.outputKey : undefined);
         const prefix = logger.enabled(LogLevel.INFO)
             ? `${chalk.grey(figures.tick)} 🤖 ${this.formatTokenUsage(context.usage)}`
             : null;

package/dist/utils/run-chat-loop.d.ts

@@ -6,5 +6,6 @@ export interface ChatLoopOptions {
     defaultQuestion?: string;
     inputKey?: string;
     skipLoop?: boolean;
+    outputKey?: string;
 }
 export declare function runChatLoopInTerminal(userAgent: UserAgent<any, any>, options?: ChatLoopOptions): Promise<void>;

package/dist/utils/run-chat-loop.js

@@ -42,7 +42,7 @@ export async function runChatLoopInTerminal(userAgent, options = {}) {
     }
 }
 async function callAgent(userAgent, input, options) {
-    const tracer = new TerminalTracer(userAgent.context);
+    const tracer = new TerminalTracer(userAgent.context, options);
     await tracer.run(userAgent, typeof input === "string" ? { [options.inputKey || DEFAULT_CHAT_INPUT_KEY]: input } : input);
 }
 const COMMANDS = {

package/dist/utils/run-with-aigne.d.ts

@@ -13,6 +13,7 @@ export interface RunAIGNECommandOptions {
     input?: string[];
     format?: "text" | "json" | "yaml";
     output?: string;
+    outputKey?: string;
     logLevel?: LogLevel;
     force?: boolean;
 }

package/dist/utils/run-with-aigne.js

@@ -21,7 +21,9 @@ export const createRunAIGNECommand = (name = "run") => new Command(name)
     .allowExcessArguments(true)
     .description("Run agent with AIGNE in terminal")
     .option("--chat", "Run chat loop in terminal", false)
-    .option("--model <provider[:model]>", `AI model to use in format 'provider[:model]' where model is optional. Examples: 'openai' or 'openai:gpt-4o-mini'. Available providers: ${availableModels.map((i) => i.name.toLowerCase().replace(/ChatModel$/i, "")).join(", ")} (default: openai)`, process.env.MODEL)
+    .option("--model <provider[:model]>", `AI model to use in format 'provider[:model]' where model is optional. Examples: 'openai' or 'openai:gpt-4o-mini'. Available providers: ${availableModels()
+    .map((i) => i.name.toLowerCase().replace(/ChatModel$/i, ""))
+    .join(", ")} (default: openai)`)
     .option("--temperature <temperature>", "Temperature for the model (controls randomness, higher values produce more random outputs). Range: 0.0-2.0", customZodError("--temperature", (s) => z.coerce.number().min(0).max(2).parse(s)))
     .option("--top-p <top-p>", "Top P (nucleus sampling) parameter for the model (controls diversity). Range: 0.0-1.0", customZodError("--top-p", (s) => z.coerce.number().min(0).max(1).parse(s)))
     .option("--presence-penalty <presence-penalty>", "Presence penalty for the model (penalizes repeating the same tokens). Range: -2.0 to 2.0", customZodError("--presence-penalty", (s) => z.coerce.number().min(-2).max(2).parse(s)))
@@ -89,7 +91,7 @@ export async function parseAgentInputByCommander(agent, options = {}) {
     return input;
 }
 export const parseModelOption = (model) => {
-    const { provider, name } = model?.match(/(?<provider>[^:]+)(:(?<name>(\S+)))?/)?.groups ?? {};
+    const { provider, name } = (model || process.env.MODEL)?.match(/(?<provider>[^:]+)(:(?<name>(\S+)))?/)?.groups ?? {};
     return { provider, name };
 };
 export async function runWithAIGNE(agentCreator, { argv = process.argv, chatLoopOptions, modelOptions, outputKey, } = {}) {
@@ -100,7 +102,7 @@ export async function runWithAIGNE(agentCreator, { argv = process.argv, chatLoop
         if (options.logLevel) {
             logger.level = options.logLevel;
         }
-        const model = await loadModel(availableModels, {
+        const model = await loadModel(availableModels(), {
             ...parseModelOption(options.model),
             temperature: options.temperature,
             topP: options.topP,
@@ -122,7 +124,7 @@ export async function runWithAIGNE(agentCreator, { argv = process.argv, chatLoop
             }
             await runAgentWithAIGNE(aigne, agent, {
                 ...options,
-                outputKey,
+                outputKey: outputKey || options.outputKey,
                 chatLoopOptions,
                 modelOptions,
                 input,
@@ -166,6 +168,7 @@ export async function runAgentWithAIGNE(aigne, agent, { outputKey, chatLoopOptio
         const userAgent = agent instanceof UserAgent ? agent : aigne.invoke(agent);
         await runChatLoopInTerminal(userAgent, {
             ...chatLoopOptions,
+            outputKey,
         });
         return;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/cli",
-  "version": "1.16.0",
+  "version": "1.18.0",
   "description": "cli for AIGNE framework",
   "publishConfig": {
     "access": "public"
@@ -38,6 +38,7 @@
     "@aigne/listr2": "^1.0.10",
     "@aigne/marked-terminal": "^7.3.1",
     "@modelcontextprotocol/sdk": "^1.11.0",
+    "@smithy/node-http-handler": "^4.0.6",
     "chalk": "^5.4.1",
     "commander": "^13.1.0",
     "detect-port": "^2.1.0",
@@ -45,6 +46,7 @@
     "express": "^5.1.0",
     "glob": "^11.0.2",
     "gradient-string": "^3.0.0",
+    "https-proxy-agent": "^7.0.6",
     "inquirer": "^12.6.0",
     "marked": "^15.0.11",
     "prettier": "^3.5.3",
@@ -53,17 +55,17 @@
     "wrap-ansi": "^9.0.0",
     "yaml": "^2.7.1",
     "zod": "^3.24.4",
-    "@aigne/agent-library": "^1.17.3",
-    "@aigne/anthropic": "^0.3.10",
-    "@aigne/bedrock": "^0.3.10",
-    "@aigne/core": "^1.26.0",
-    "@aigne/deepseek": "^0.3.10",
-    "@aigne/observability": "^0.3.0",
-    "@aigne/gemini": "^0.3.10",
-    "@aigne/ollama": "^0.3.10",
-    "@aigne/openai": "^0.4.3",
-    "@aigne/xai": "^0.3.10",
-    "@aigne/open-router": "^0.3.10"
+    "@aigne/agent-library": "^1.17.5",
+    "@aigne/anthropic": "^0.5.0",
+    "@aigne/core": "^1.28.0",
+    "@aigne/deepseek": "^0.4.0",
+    "@aigne/gemini": "^0.4.0",
+    "@aigne/bedrock": "^0.5.0",
+    "@aigne/observability-api": "^0.3.0",
+    "@aigne/open-router": "^0.4.0",
+    "@aigne/ollama": "^0.4.0",
+    "@aigne/openai": "^0.6.0",
+    "@aigne/xai": "^0.4.0"
   },
   "devDependencies": {
     "@types/archiver": "^6.0.3",

package/templates/default/.env.local.example

@@ -0,0 +1,44 @@
+# Change the name of this file to .env.local and fill in the following values
+
+# Uncomment the lines below to enable debug logging
+# DEBUG="aigne:*"
+
+# Use different Models
+
+# OpenAI
+MODEL="openai:gpt-4.1"
+OPENAI_API_KEY="YOUR_OPENAI_API_KEY"
+
+# Anthropic claude
+# MODEL="anthropic:claude-3-7-sonnet-latest"
+# ANTHROPIC_API_KEY=""
+
+# Gemini
+# MODEL="gemini:gemini-2.0-flash"
+# GEMINI_API_KEY=""
+
+# Bedrock nova
+# MODEL=bedrock:us.amazon.nova-premier-v1:0
+# AWS_ACCESS_KEY_ID=""
+# AWS_SECRET_ACCESS_KEY=""
+# AWS_REGION=us-west-2
+
+# DeepSeek
+# MODEL="deepseek:deepseek-chat"
+# DEEPSEEK_API_KEY=""
+
+# OpenRouter
+# MODEL="openrouter:openai/gpt-4o"
+# OPEN_ROUTER_API_KEY=""
+
+# xAI
+# MODEL="xai:grok-2-latest"
+# XAI_API_KEY=""
+
+# Ollama
+# MODEL="ollama:llama3.2"
+# OLLAMA_DEFAULT_BASE_URL="http://localhost:11434/v1";
+
+
+# Setup proxy if needed
+# HTTPS_PROXY=http://localhost:7890

package/templates/default/README.md

@@ -17,6 +17,16 @@ This is the default project template for the AIGNE framework, providing a basic
 npm install -g aigne
 ```
 
+### Setup Environment Variables
+
+Copy the `.env.local.example` file to `.env.local` and set your OpenAI API key:
+
+```shell
+# OpenAI
+MODEL="openai:gpt-4.1"
+OPENAI_API_KEY="YOUR_OPENAI_API_KEY"
+```
+
 ### Start the Project
 
 ```bash