@aigne/cli 1.6.0 → 1.7.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.7.0](https://github.com/AIGNE-io/aigne-framework/compare/cli-v1.6.0...cli-v1.7.0) (2025-04-23)
+
+
+### Features
+
+* **core:** enhance ClaudeChatModel to support streaming responses ([#85](https://github.com/AIGNE-io/aigne-framework/issues/85)) ([5433240](https://github.com/AIGNE-io/aigne-framework/commit/5433240e7b663ec9e9f4a79dffa05038088d54fc))
+* support set memory in agent yaml ([#90](https://github.com/AIGNE-io/aigne-framework/issues/90)) ([215118f](https://github.com/AIGNE-io/aigne-framework/commit/215118f1dc55f02322d59a3f18395a459198e031))
+* **tests:** add example tests and update the ci configuration ([#81](https://github.com/AIGNE-io/aigne-framework/issues/81)) ([777bb8d](https://github.com/AIGNE-io/aigne-framework/commit/777bb8d184c21e74b3eb9bbb4a1003708409a338))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.11.0
+
 ## [1.6.0](https://github.com/AIGNE-io/aigne-framework/compare/cli-v1.5.1...cli-v1.6.0) (2025-04-22)
 
 

package/LICENSE

@@ -0,0 +1,93 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+*As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.*
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,135 @@
+# @aigne/cli
+
+[![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-framework?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-framework)
+[![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-framework?style=flat-square)](https://github.com/AIGNE-io/aigne-framework/issues)
+[![codecov](https://codecov.io/gh/AIGNE-io/aigne-framework/graph/badge.svg?token=DO07834RQL)](https://codecov.io/gh/AIGNE-io/aigne-framework)
+[![NPM Version](https://img.shields.io/npm/v/@aigne/cli)](https://www.npmjs.com/package/@aigne/cli)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/cli)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE)
+
+**English** | [中文](README.zh.md)
+
+Command-line tool for [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), providing convenient development and management capabilities.
+
+## Introduction
+
+`@aigne/cli` is the official command-line tool for [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework), designed to simplify the development, testing, and deployment processes for AIGNE applications. It provides a series of useful commands to help developers quickly create projects, run agents, test code, and deploy applications.
+
+## 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
+
+## Installation
+
+```bash
+# Using npm
+npm install -g @aigne/cli
+
+# Using yarn
+yarn global add @aigne/cli
+
+# Using pnpm
+pnpm add -g @aigne/cli
+```
+
+## Basic Commands
+
+AIGNE CLI provides the following main commands:
+
+```bash
+# Display help information
+aigne --help
+
+# Create a new project
+aigne create [path]
+
+# Run an agent
+aigne run [path]
+
+# Run tests
+aigne test [path]
+
+# Start MCP server
+aigne serve [path] --mcp
+```
+
+## Create Command
+
+Create a new AIGNE project with agent configuration files.
+
+```bash
+# Create a project in the current directory (will prompt for project name)
+aigne create
+
+# Create a project at the specified path
+aigne create my-project
+```
+
+The interactive creation process will ask for:
+- Project name
+- Project template (currently supports the default template)
+
+## Run Command
+
+Launch a chat loop with the specified agent.
+
+```bash
+# Run the agent in the current directory
+aigne run
+
+# Run the agent at the specified path
+aigne run path/to/agents
+
+# Run the agent from a remote URL
+aigne run https://example.com/aigne-project
+```
+
+Available options:
+- `--agent <agent>` - Specify the agent name to use (defaults to the first agent found)
+- `--download-dir <dir>` - Specify the directory to download the package to (used in URL mode)
+- `--model-provider <provider>` - Specify the model provider (openai, claude, xai)
+- `--model-name <model>` - Specify the model name
+- `--verbose` - Enable verbose logging
+
+## Test Command
+
+Run tests in the specified agents directory.
+
+```bash
+# Test the agents in the current directory
+aigne test
+
+# Test the agents at the specified path
+aigne test path/to/agents
+```
+
+## Serve Command
+
+Serve the agents in the specified directory as a MCP server.
+
+```bash
+# Start MCP server on default port 3000
+aigne serve --mcp
+
+# Start MCP server on specified port
+aigne serve --mcp --port 3001
+
+# Start MCP server for agents at specified path
+aigne serve path/to/agents --mcp
+```
+
+## Documentation
+
+For more detailed CLI usage guides, please refer to:
+
+- [CLI Guide](../../docs/cli.md)
+- [Agent Development Guide](../../docs/agent-development.md)
+- [Cookbook](../../docs/cookbook.md)
+
+## License
+
+Elastic-2.0

package/README.zh.md

@@ -0,0 +1,135 @@
+# @aigne/cli
+
+[![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-framework?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-framework)
+[![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-framework?style=flat-square)](https://github.com/AIGNE-io/aigne-framework/issues)
+[![codecov](https://codecov.io/gh/AIGNE-io/aigne-framework/graph/badge.svg?token=DO07834RQL)](https://codecov.io/gh/AIGNE-io/aigne-framework)
+[![NPM Version](https://img.shields.io/npm/v/@aigne/cli)](https://www.npmjs.com/package/@aigne/cli)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/cli)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE)
+
+[English](README.md) | **中文**
+
+[AIGNE 框架](https://github.com/AIGNE-io/aigne-framework)的命令行工具，提供便捷的开发和管理功能。
+
+## 简介
+
+`@aigne/cli` 是 [AIGNE 框架](https://github.com/AIGNE-io/aigne-framework)的官方命令行工具，旨在简化 AIGNE 应用的开发、测试和部署流程。它提供了一系列实用命令，帮助开发者快速创建项目、运行代理、测试代码，以及部署应用等。
+
+## 特性
+
+- **项目创建**：快速创建新的 AIGNE 项目，包含预设的文件结构和配置
+- **代理运行**：轻松运行和测试 AIGNE 代理
+- **测试支持**：内置测试命令，方便进行单元测试和集成测试
+- **MCP 服务**：支持将代理作为 MCP 服务器启动，与外部系统集成
+- **交互式界面**：美观的命令行界面，提供直观的使用体验
+- **多模型支持**：支持 OpenAI、Claude、XAI 等多种模型提供商
+
+## 安装
+
+```bash
+# 使用 npm
+npm install -g @aigne/cli
+
+# 使用 yarn
+yarn global add @aigne/cli
+
+# 使用 pnpm
+pnpm add -g @aigne/cli
+```
+
+## 基本命令
+
+AIGNE CLI 提供了以下主要命令：
+
+```bash
+# 显示帮助信息
+aigne --help
+
+# 创建新项目
+aigne create [path]
+
+# 运行代理
+aigne run [path]
+
+# 运行测试
+aigne test [path]
+
+# 启动 MCP 服务器
+aigne serve [path] --mcp
+```
+
+## 创建命令 (create)
+
+创建一个带有代理配置文件的新 AIGNE 项目。
+
+```bash
+# 在当前目录创建项目（会提示输入项目名称）
+aigne create
+
+# 在指定路径创建项目
+aigne create my-project
+```
+
+交互式创建过程会询问：
+- 项目名称
+- 项目模板（目前支持 default 模板）
+
+## 运行命令 (run)
+
+启动与指定代理的聊天循环。
+
+```bash
+# 运行当前目录中的代理
+aigne run
+
+# 运行指定路径中的代理
+aigne run path/to/agents
+
+# 运行远程 URL 中的代理
+aigne run https://example.com/aigne-project
+```
+
+可用选项：
+- `--agent <agent>` - 指定要使用的代理名称（默认为找到的第一个代理）
+- `--download-dir <dir>` - 指定下载包的目录（URL模式下使用）
+- `--model-provider <provider>` - 指定模型提供商（openai、claude、xai）
+- `--model-name <model>` - 指定模型名称
+- `--verbose` - 启用详细日志记录
+
+## 测试命令 (test)
+
+在指定的代理目录中运行测试。
+
+```bash
+# 测试当前目录中的代理
+aigne test
+
+# 测试指定路径中的代理
+aigne test path/to/agents
+```
+
+## 服务命令 (serve)
+
+将指定目录中的代理作为 MCP 服务器提供服务。
+
+```bash
+# 在默认端口 3000 启动 MCP 服务器
+aigne serve --mcp
+
+# 在指定端口启动 MCP 服务器
+aigne serve --mcp --port 3001
+
+# 为指定路径的代理启动 MCP 服务器
+aigne serve path/to/agents --mcp
+```
+
+## 文档
+
+更多详细的 CLI 使用指南，请参考：
+
+- [CLI 指南](../../docs/cli.zh.md)
+- [代理开发指南](../../docs/agent-development.zh.md)
+- [Cookbook](../../docs/cookbook.zh.md)
+
+## 协议
+
+Elastic-2.0

package/dist/tracer/terminal.js

@@ -28,7 +28,6 @@ export class TerminalTracer {
             },
         }, [], {
             concurrent: true,
-            forceTTY: true,
             rendererOptions: {
                 collapseSubtasks: false,
                 writeBottomBarDirectly: true,

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@aigne/cli",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "cli for AIGNE framework",
   "publishConfig": {
     "access": "public"
   },
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "homepage": "https://github.com/AIGNE-io/aigne-framework",
-  "license": "ISC",
+  "license": "Elastic-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AIGNE-io/aigne-framework"
@@ -50,7 +50,7 @@
     "pretty-error": "^4.0.0",
     "tar": "^7.4.3",
     "zod": "^3.24.2",
-    "@aigne/core": "^1.10.0"
+    "@aigne/core": "^1.11.0"
   },
   "devDependencies": {
     "@types/archiver": "^6.0.3",

package/templates/default/chat.yaml

@@ -3,5 +3,8 @@ description: Chat agent
 instructions: |
   You are a helpful assistant that can answer questions and provide information on a wide range of topics.
   Your goal is to assist users in finding the information they need and to engage in friendly conversation.
+memory:
+  subscribeTopic:
+    - chat
 tools:
   - sandbox.js