@aigne/example-workflow-handoff 1.5.0 → 1.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +8 -7
  2. package/index.ts +1 -1
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -43,16 +43,17 @@ end
43
43
  ## Prerequisites
44
44
 
45
45
  - [Node.js](https://nodejs.org) and npm installed on your machine
46
- - [Bun](https://bun.sh) installed on your machine
47
- - [OpenAI API key](https://platform.openai.com/api-keys) used to interact with OpenAI API
48
- - [Pnpm](https://pnpm.io) [Optional] if you want to run the example from source code
46
+ - An [OpenAI API key](https://platform.openai.com/api-keys) for interacting with OpenAI's services
47
+ - Optional dependencies (if running the example from source code):
48
+ - [Bun](https://bun.sh) for running unit tests & examples
49
+ - [Pnpm](https://pnpm.io) for package management
49
50
 
50
- ## Try without Installation
51
+ ## Quick Start (No Installation Required)
51
52
 
52
53
  ```bash
53
- export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # setup your OpenAI API key
54
+ export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key
54
55
 
55
- npx -y @aigne/example-workflow-handoff # run the example
56
+ npx -y @aigne/example-workflow-handoff # Run the example
56
57
  ```
57
58
 
58
59
  ## Installation
@@ -76,7 +77,7 @@ pnpm install
76
77
  Setup your OpenAI API key in the `.env.local` file:
77
78
 
78
79
  ```bash
79
- OPENAI_API_KEY="" # setup your OpenAI API key here
80
+ OPENAI_API_KEY="" # Set your OpenAI API key here
80
81
  ```
81
82
 
82
83
  ### Run the Example
package/index.ts CHANGED
@@ -1,4 +1,4 @@
1
- #!/usr/bin/env npx -y bun
1
+ #!/usr/bin/env bunwrapper
2
2
 
3
3
  import { runChatLoopInTerminal } from "@aigne/cli/utils/run-chat-loop.js";
4
4
  import { AIAgent, type Agent, ExecutionEngine, FunctionAgent } from "@aigne/core";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aigne/example-workflow-handoff",
3
- "version": "1.5.0",
3
+ "version": "1.6.1",
4
4
  "description": "A demonstration of using AIGNE Framework to build a handoff workflow",
5
5
  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
6
6
  "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/workflow-handoff",
@@ -18,8 +18,8 @@
18
18
  "dependencies": {
19
19
  "openai": "^4.94.0",
20
20
  "zod": "^3.24.2",
21
- "@aigne/cli": "^1.3.0",
22
- "@aigne/core": "^1.8.0"
21
+ "@aigne/cli": "^1.5.1",
22
+ "@aigne/core": "^1.10.0"
23
23
  },
24
24
  "scripts": {
25
25
  "start": "bun run index.ts",