@eko-ai/eko 2.0.4 → 2.0.6

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 (2) hide show
  1. package/README.md +123 -0
  2. package/package.json +2 -1
package/README.md ADDED
@@ -0,0 +1,123 @@
1
+
2
+
3
+
4
+ <h1 align="center">
5
+ <a href="https://github.com/FellouAI/eko" target="_blank">
6
+ <img src="https://github.com/user-attachments/assets/55dbdd6c-2b08-4e5f-a841-8fea7c2a0b92" alt="eko-logo" width="200" height="200">
7
+ </a>
8
+ <br>
9
+ <small>Eko - Build Production-ready Agentic Workflow with Natural Language</small>
10
+ </h1>
11
+
12
+
13
+
14
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](https://example.com/build-status) [![Version](https://img.shields.io/github/package-json/v/FellouAI/eko?color=yellow)](https://eko.fellou.ai/docs/release/versions/)
15
+
16
+ Eko (pronounced like ‘echo’) is a production-ready JavaScript framework that enables developers to create reliable agents, **from simple commands to complex workflows**. It provides a unified interface for running agents in both **computer and browser environments**.
17
+
18
+ ## Framework Comparison
19
+
20
+ | Feature | Eko | Langchain | Browser-use | Dify.ai | Coze |
21
+ |--------------------------------------|-------|------------|--------------|----------|--------|
22
+ | **Supported Platform** | **All platform** | Server side | Browser | Web | Web |
23
+ | **One sentence to multi-step workflow** | ✅ | ❌ | ✅ | ❌ | ❌ |
24
+ | **Intervenability** | ✅ | ✅ | ❌ | ❌ | ❌ |
25
+ | **Development Efficiency** | **High** | Low | Middle | Middle | Low |
26
+ | **Task Complexity** | **High** | High | Low | Middle | Middle | Middle |
27
+ | **Open-source** | ✅ | ✅ | ✅ | ✅ | ❌ |
28
+ | **Access to private web resources** | ✅ | ❌ | ❌ | ❌ | ❌ |
29
+
30
+ ## Features
31
+
32
+ - [x] Pure JavaScript: Built for browsers and Node.js.🚀
33
+ - [x] Multi-Agent: Unleash power with multiple Agents in one task.📈
34
+ - [x] Agent/Tool Flexibility: Customize new Agents and Tools in just one line.🎉
35
+ - [x] Native MCP: Connects seamlessly with [Awesome MCP Servers](https://mcpservers.org/).🔗
36
+ - [x] Dynamic LLM: Balance speed and performance with flexible model choices.⚙️
37
+ - [x] Human-in-the-loop: Intervene when it matters most.🤝
38
+ - [x] Stream Planning: Dynamic rendering made easy.🎨
39
+ - [x] Loop & Listener Tasks: Automate any repetitive task.🤖
40
+ - [ ] Observable Chain: *Coming soon*
41
+ - [ ] Native A2A: *Coming soon*
42
+
43
+ ## Quickstart
44
+
45
+ > **Note**: Please refer to the [Eko Quickstart guide](https://eko.fellou.ai/docs/getting-started/quickstart/) guide for full instructions on how to run it.
46
+
47
+ > **Security Warning**
48
+ >
49
+ > DO NOT use API Keys in browser/frontend code!
50
+ >
51
+ > This will expose your credentials and may lead to unauthorized usage.
52
+ >
53
+ > Best Practices: Configure backend API proxy request through baseURL and request headers.
54
+ >
55
+ > Please refer to the link: https://eko.fellou.ai/docs/getting-started/configuration#web-environment
56
+
57
+ ```typescript
58
+ // quickstart.ts
59
+ const llms: LLMs = {
60
+ default: {
61
+ provider: "anthropic",
62
+ model: "claude-3-5-sonnet-20241022",
63
+ apiKey: claudeApiKey || "your-api-key",
64
+ config: { baseURL: claudeBaseURL },
65
+ },
66
+ openai: {
67
+ provider: "openai",
68
+ model: "gpt-4o-mini",
69
+ apiKey: openaiApiKey || "your-api-key",
70
+ config: { baseURL: openaiBaseURL },
71
+ },
72
+ };
73
+ let agents: Agent[] = [new ChatAgent(), new BrowserAgent()];
74
+ let eko = new Eko({ llms, agents });
75
+ let result = await eko.run("Search for the latest news about Musk");
76
+ ```
77
+
78
+ ```bash
79
+ $ pnpm install @eko-ai/eko
80
+ $ npx ts-node quickstart.ts
81
+ ```
82
+
83
+ ## Use Cases
84
+
85
+ - Browser automation and web scraping
86
+ - System file and process management
87
+ - Workflow automation
88
+ - Data processing and organization
89
+ - GUI automation
90
+ - Multi-step task orchestration
91
+
92
+ ## Documentation
93
+
94
+ Visit our [documentation site](https://eko.fellou.ai/docs) for:
95
+
96
+ - Getting started guide
97
+ - API reference
98
+ - Usage examples
99
+ - Best practices
100
+ - Configuration options
101
+
102
+ ## Development Environments
103
+
104
+ Eko can be used in multiple environments:
105
+
106
+ - Browser Extension
107
+ - Web Applications
108
+ - Node.js Applications
109
+
110
+ ## Community and Support
111
+
112
+ - Report issues on [GitHub Issues](https://github.com/FellouAI/eko/issues)
113
+ - Join our [slack community discussions](https://join.slack.com/t/eko-ai/shared_invite/zt-2xhvkudv9-nHvD1g8Smp227sM51x_Meg)
114
+ - Join our [Discard](https://discord.gg/XpFfk2e5):
115
+ ![](discard.png)
116
+ - Contribute tools and improvements
117
+ - Share your use cases and feedback
118
+
119
+ [![Star History Chart](https://api.star-history.com/svg?repos=FellouAI/eko&type=Date)](https://star-history.com/#FellouAI/eko&Date)
120
+
121
+ ## License
122
+
123
+ Eko is released under the MIT License. See the [LICENSE](LICENSE) file for details.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eko-ai/eko",
3
- "version": "2.0.4",
3
+ "version": "2.0.6",
4
4
  "description": "Empowering language to transform human words into action.",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.esm.js",
@@ -56,6 +56,7 @@
56
56
  "dotenv": "^16.5.0",
57
57
  "jest": "^29.7.0",
58
58
  "rollup": "^4.40.0",
59
+ "rollup-plugin-copy": "^3.5.0",
59
60
  "ts-jest": "^29.3.2",
60
61
  "tslib": "^2.8.1",
61
62
  "typedoc": "^0.27.6",