@aigne/example-chat-bot 1.15.89 → 1.15.90-beta.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [1.15.90-beta.1](https://github.com/AIGNE-io/aigne-framework/compare/example-chat-bot-v1.15.90-beta...example-chat-bot-v1.15.90-beta.1) (2025-12-08)
+
+
+### Bug Fixes
+
+* correct run example & doc improvements ([#707](https://github.com/AIGNE-io/aigne-framework/issues/707)) ([f98fc5d](https://github.com/AIGNE-io/aigne-framework/commit/f98fc5df28fd6ce6134128c2f0e5395c1554b740))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/cli bumped to 1.58.0-beta.1
+
+## [1.15.90-beta](https://github.com/AIGNE-io/aigne-framework/compare/example-chat-bot-v1.15.89...example-chat-bot-v1.15.90-beta) (2025-12-07)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/cli bumped to 1.58.0-beta
+
 ## [1.15.89](https://github.com/AIGNE-io/aigne-framework/compare/example-chat-bot-v1.15.89-beta...example-chat-bot-v1.15.89) (2025-12-06)
 
 

package/README.md

@@ -17,9 +17,9 @@ This example demonstrates how to create and run an agent-based chatbot using the
 
 ## Quick Start (No Installation Required)
 
-```bash
-export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key
+### Run the Example
 
+```bash
 # Run in one-shot mode (default)
 npx -y @aigne/example-chat-bot
 
@@ -30,55 +30,73 @@ npx -y @aigne/example-chat-bot --chat
 echo "Tell me about AIGNE Framework" | npx -y @aigne/example-chat-bot
 ```
 
-## Installation
+### Connect to an AI Model
 
-### Install AIGNE CLI
+As an example, running `npx -y @aigne/example-chat-bot --chat` requires an AI model. If this is your first run, you need to connect one.
+
+![run example](./run-example.png)
+
+- Connect via the official AIGNE Hub
+
+Choose the first option and your browser will open the official AIGNE Hub page. Follow the prompts to complete the connection. If you're a new user, the system automatically grants 400,000 tokens for you to use.
+
+![connect to official aigne hub](../images/connect-to-aigne-hub.png)
+
+- Connect via a self-hosted AIGNE Hub
+
+Choose the second option, enter the URL of your self-hosted AIGNE Hub, and follow the prompts to complete the connection. If you need to set up a self-hosted AIGNE Hub, visit the Blocklet Store to install and deploy it: [Blocklet Store](https://store.blocklet.dev/blocklets/z8ia3xzq2tMq8CRHfaXj1BTYJyYnEcHbqP8cJ?utm_source=www.arcblock.io&utm_medium=blog_link&utm_campaign=default&utm_content=store.blocklet.dev#:~:text=%F0%9F%9A%80%20Get%20Started%20in%20Minutes).
+
+![connect to self hosted aigne hub](../images/connect-to-self-hosted-aigne-hub.png)
+
+- Connect via a third-party model provider
+
+Using OpenAI as an example, you can configure the provider's API key via environment variables. After configuration, run the example again:
 
 ```bash
-npm install -g @aigne/cli
+export OPENAI_API_KEY="" # Set your OpenAI API key here
 ```
+For more details on third-party model configuration (e.g., OpenAI, DeepSeek, Google Gemini), see [.env.local.example](./.env.local.example).
 
-### Clone the Repository
+After configuration, run the example again.
 
-```bash
-git clone https://github.com/AIGNE-io/aigne-framework
+### Debugging
 
-cd aigne-framework/examples/chat-bot
-```
+The `aigne observe` command starts a local web server to monitor and analyze agent execution data. It provides a user-friendly interface to inspect traces, view detailed call information, and understand your agent’s behavior during runtime. This tool is essential for debugging, performance tuning, and gaining insight into how your agent processes information and interacts with tools and models.
+
+Start the observation server.
 
-### Setup Environment Variables
+![aigne-observe-execute](../images/aigne-observe-execute.png)
+
+View a list of recent executions.
+
+![aigne-observe-list](../images/aigne-observe-list.png)
+
+## Installation
 
-Setup your OpenAI API key in the `.env.local` file (you can rename `.env.local.example` to `.env.local`):
+### Install AIGNE CLI
 
 ```bash
-OPENAI_API_KEY="" # Set your OpenAI API key here
+npm install -g @aigne/cli
 ```
 
-#### Using Different Models
-
-You can use different AI models by setting the `MODEL` environment variable along with the corresponding API key. The framework supports multiple providers:
+### Clone the Repository
 
-* **OpenAI**: `MODEL="openai:gpt-4.1"` with `OPENAI_API_KEY`
-* **Anthropic**: `MODEL="anthropic:claude-3-7-sonnet-latest"` with `ANTHROPIC_API_KEY`
-* **Google Gemini**: `MODEL="gemini:gemini-2.0-flash"` with `GEMINI_API_KEY`
-* **AWS Bedrock**: `MODEL="bedrock:us.amazon.nova-premier-v1:0"` with AWS credentials
-* **DeepSeek**: `MODEL="deepseek:deepseek-chat"` with `DEEPSEEK_API_KEY`
-* **OpenRouter**: `MODEL="openrouter:openai/gpt-4o"` with `OPEN_ROUTER_API_KEY`
-* **xAI**: `MODEL="xai:grok-2-latest"` with `XAI_API_KEY`
-* **Ollama**: `MODEL="ollama:llama3.2"` with `OLLAMA_DEFAULT_BASE_URL`
+```bash
+git clone https://github.com/AIGNE-io/aigne-framework
 
-For detailed configuration examples, please refer to the `.env.local.example` file in this directory.
+cd aigne-framework/examples/chat-bot
+```
 
 ### Run the Example
 
 ```bash
-aigne run # Run in one-shot mode (default)
+pnpm start # Run in one-shot mode (default)
 
 # Run in interactive chat mode
-aigne run --chat
+pnpm start --chat
 
 # Use pipeline input
-echo "Tell me about AIGNE Framework" | aigne run
+echo "Tell me about AIGNE Framework" | pnpm start
 ```
 
 ### Run Options

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/example-chat-bot",
-  "version": "1.15.89",
+  "version": "1.15.90-beta.1",
   "description": "A demonstration of using AIGNE Framework to build a chat bot",
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/chat-bot",
@@ -12,9 +12,10 @@
   "type": "module",
   "bin": "aigne.yaml",
   "dependencies": {
-    "@aigne/cli": "^1.57.3"
+    "@aigne/cli": "^1.58.0-beta.1"
   },
   "scripts": {
+    "start": "aigne run",
     "test": "aigne test",
     "test:llm": "aigne run --input 'What can AIGNE do?'"
   }