@aigne/example-workflow-reflection 1.5.0 → 1.6.2

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
@@ -24,16 +24,17 @@ class reviewer processing
24
24
  ## Prerequisites
25
25
 
26
26
  - [Node.js](https://nodejs.org) and npm installed on your machine
27
- - [Bun](https://bun.sh) installed on your machine
28
- - [OpenAI API key](https://platform.openai.com/api-keys) used to interact with OpenAI API
29
- - [Pnpm](https://pnpm.io) [Optional] if you want to run the example from source code
27
+ - An [OpenAI API key](https://platform.openai.com/api-keys) for interacting with OpenAI's services
28
+ - Optional dependencies (if running the example from source code):
29
+ - [Bun](https://bun.sh) for running unit tests & examples
30
+ - [Pnpm](https://pnpm.io) for package management
30
31
 
31
- ## Try without Installation
32
+ ## Quick Start (No Installation Required)
32
33
 
33
34
  ```bash
34
- export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # setup your OpenAI API key
35
+ export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key
35
36
 
36
- npx -y @aigne/example-workflow-reflection # run the example
37
+ npx -y @aigne/example-workflow-reflection # Run the example
37
38
  ```
38
39
 
39
40
  ## Installation
@@ -57,7 +58,7 @@ pnpm install
57
58
  Setup your OpenAI API key in the `.env.local` file:
58
59
 
59
60
  ```bash
60
- OPENAI_API_KEY="" # setup your OpenAI API key here
61
+ OPENAI_API_KEY="" # Set your OpenAI API key here
61
62
  ```
62
63
 
63
64
  ### 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, ExecutionEngine, UserAgent, UserInputTopic, UserOutputTopic } from "@aigne/core";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aigne/example-workflow-reflection",
3
- "version": "1.5.0",
3
+ "version": "1.6.2",
4
4
  "description": "A demonstration of using AIGNE Framework to build a reflection 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-reflection",
@@ -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.6.0",
22
+ "@aigne/core": "^1.10.0"
23
23
  },
24
24
  "scripts": {
25
25
  "start": "bun run index.ts",