@eko-ai/eko 1.0.7 → 1.0.9

package/README.md

@@ -1,17 +1,31 @@
-# Eko
 
-[![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/badge/version-1.0.5-yellow.svg)](https://eko.fellou.ai/docs/release/versions/)
 
-**Eko** is a revolutionary framework designed to empower developers and users alike to program their browser and operating system using natural language. With seamless integration of browser APIs, OS-level capabilities, and cutting-edge AI tools like Claude 3.5, Eko redefines how we interact with technology, making it intuitive, powerful, and accessible.
 
-## Key Features
+<h1 align="center">
+  <a href="https://github.com/FellouAI/eko" target="_blank">
+    <img src="https://github.com/user-attachments/assets/55dbdd6c-2b08-4e5f-a841-8fea7c2a0b92" alt="eko-logo" width="200" height="200">
+  </a>
+  <br>
+  <small>Eko - Build Production-ready Agentic Workflow with Natural Language</small>
+</h1>
 
-- **Natural Language Programming**: Transform human instructions into e- **Natural Language Programming**: Convert natural language task descriptions into executable workflows, making agent development more intuitive
-- **Two-Layer Execution Model**: Separate offline planning from online execution, making agent decisions more structured and explainable
-- **Comprehensive Tooling**: Rich built-in tools for browser automation, computer control, file operations, and web interactions
-- **Hybrid Drive System:** Combine LLM capabilities with developer control, enabling "human in the loop" and allowing interference at multiple levels of granularity
-- **Event-Driven Automation:** Trigger workflows based on browser or system events
-- **Environment Flexibility**: Work across different environments ( [Browser Extension](/docs/browseruse/browser-extension), [Web](/docs/browseruse/browser-web), [Node.js](/docs/computeruse/computer-node), [Next-Gen AI Browser Fellou](/docs/computeruse/computer-fellou) ) with consistent APIs
+
+
+[![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/)
+
+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**.
+
+# Framework Comparison
+
+| Feature                              | Eko   | Langchain  | Browser-use  | Dify.ai  | Coze   |
+|--------------------------------------|-------|------------|--------------|----------|--------|
+| **Supported Platform**               | **All platform**  | Server side  | Browser  | Web  | Web  |
+| **One sentence to multi-step workflow** | ✅    | ❌          | ✅            | ❌        | ❌      |
+| **Intervenability**                  | ✅    | ✅          | ❌            | ❌        | ❌      | 
+| **Development Efficiency**           | **High**  | Low      | Middle        | Middle    | Low    | 
+| **Task Complexity**           | **High**  | High      | Low        | Middle    | Middle    | Middle       |
+| **Open-source**                      | ✅    | ✅          | ✅            | ✅        | ❌      |
+| **Access to private web resources** | ✅ | ❌          | ❌            | ❌        | ❌      |
 
 ## Quickstart
 
@@ -19,7 +33,7 @@
 npm install @eko-ai/eko
 ```
 
-> The following code is for reference only. For detailed usage, please refer to the [Eko Quickstart guide](https://eko.fellou.ai/docs/getting-started/quickstart/).
+> For detailed usage, please refer to the [Eko Quickstart guide](https://eko.fellou.ai/docs/getting-started/quickstart/).
 
 ```typescript
 import { Eko } from '@eko-ai/eko';
@@ -38,6 +52,46 @@ await eko.execute(sysWorkflow);
 
 ```
 
+## Demos
+
+**Prompt:** `Collect the latest NASDAQ data on Yahoo Finance, including price changes, market capitalization, trading volume of major stocks, analyze the data and generate visualization reports`.
+
+https://github.com/user-attachments/assets/4087b370-8eb8-4346-a549-c4ce4d1efec3
+
+Click [here](https://github.com/FellouAI/eko-demos/tree/main/browser-extension-stock) to get the source code.
+
+---
+
+**Prompt:** `Based on the README of FellouAI/eko on github, search for competitors, highlight the key contributions of Eko, write a blog post advertising Eko, and post it on Write.as.`
+
+https://github.com/user-attachments/assets/6feaea86-2fb9-4e5c-b510-479c2473d810
+
+Click [here](https://github.com/FellouAI/eko-demos/tree/main/browser-extension-blog) to get the source code.
+
+---
+
+**Prompt:** `Clean up all files in the current directory larger than 1MB`
+
+https://github.com/user-attachments/assets/ef7feb58-3ddd-4296-a1de-bb8b6c66e48b
+
+Click [here](https://eko.fellou.ai/docs/computeruse/computer-node/#example-file-cleanup-workflow) to Learn more.
+
+---
+
+**Prompt:** Automatic software testing
+```
+    Current login page automation test:
+    1. Correct account and password are: admin / 666666 
+    2. Please randomly combine usernames and passwords for testing to verify if login validation works properly, such as: username cannot be empty, password cannot be empty, incorrect username, incorrect password
+    3. Finally, try to login with the correct account and password to verify if login is successful
+    4. Generate test report and export
+```
+
+https://github.com/user-attachments/assets/7716300a-c51d-41f1-8d4f-e3f593c1b6d5
+
+
+Click [here](https://eko.fellou.ai/docs/browseruse/browser-web#example-login-automation-testing) to Learn more.
+
 ## Use Cases
 
 - Browser automation and web scraping
@@ -64,24 +118,21 @@ Eko can be used in multiple environments:
 - Browser Extension
 - Web Applications
 - Node.js Applications
-- [Fellou AI Browser](https://fellou.ai)
 
 ## Community and Support
 
 - Report issues on [GitHub Issues](https://github.com/FellouAI/eko/issues)
+- Join our [slack community discussions](https://join.slack.com/t/eko-ai/shared_invite/zt-2xhvkudv9-nHvD1g8Smp227sM51x_Meg)
 - Contribute tools and improvements
 - Share your use cases and feedback
-- Join our community discussions
-
-## Contributing
 
-We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) for details on:
+<h1 align="center">
+  <a href="https://github.com/FellouAI/eko" target="_blank">
+    <img width="699" alt="Screenshot 2025-01-22 at 6 41 57 PM" src="https://github.com/user-attachments/assets/88320cc9-1755-4f21-913b-2bfc909e781d" />
+  </a>
+</h1>
 
-- Setting up the development environment
-- Code style guidelines
-- Submission process
-- Tool development
-- Use case optimization
+[![Star History Chart](https://api.star-history.com/svg?repos=FellouAI/eko&type=Date)](https://star-history.com/#FellouAI/eko&Date)
 
 ## License
 

package/dist/core/eko.d.ts

@@ -1,4 +1,4 @@
-import { EkoConfig, EkoInvokeParam, Tool, Workflow, WorkflowCallback } from '../types';
+import { EkoConfig, EkoInvokeParam, Tool, Workflow, WorkflowCallback, NodeOutput } from '../types';
 /**
  * Eko core
  */
@@ -9,7 +9,8 @@ export declare class Eko {
     private workflowGeneratorMap;
     constructor(config: EkoConfig);
     generate(prompt: string, param?: EkoInvokeParam): Promise<Workflow>;
-    execute(workflow: Workflow, callback?: WorkflowCallback): Promise<void>;
+    execute(workflow: Workflow, callback?: WorkflowCallback): Promise<NodeOutput[]>;
+    cancel(workflow: Workflow): Promise<void>;
     modify(workflow: Workflow, prompt: string): Promise<Workflow>;
     private getTool;
     callTool(toolName: string, input: object, callback?: WorkflowCallback): Promise<any>;

package/dist/extension/content/index.d.ts

@@ -13,3 +13,4 @@ declare function get_dropdown_options(request: any): {
     name: any;
 } | null;
 declare function select_dropdown_option(request: any): any;
+declare function request_user_help(task_id: string, failure_type: string, failure_message: string): void;

package/dist/extension/tools/browser.d.ts

@@ -10,7 +10,8 @@ export declare function right_click(tabId: number, coordinate?: [number, number]
 export declare function right_click_by(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
 export declare function double_click(tabId: number, coordinate?: [number, number]): Promise<any>;
 export declare function double_click_by(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
-export declare function screenshot(windowId: number): Promise<ScreenshotResult>;
+export declare function screenshot(windowId: number, compress?: boolean): Promise<ScreenshotResult>;
+export declare function compress_image(dataUrl: string, scale?: number, quality?: number): Promise<string>;
 export declare function scroll_to(tabId: number, coordinate: [number, number]): Promise<any>;
 export declare function scroll_to_by(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
 export declare function get_dropdown_options(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;

package/dist/extension/tools/get_all_tabs.d.ts

@@ -0,0 +1,9 @@
+import { BrowserTab } from '../../types/tools.types';
+import { Tool, InputSchema, ExecutionContext } from '../../types/action.types';
+export declare class GetAllTabs implements Tool<any, BrowserTab[]> {
+    name: string;
+    description: string;
+    input_schema: InputSchema;
+    constructor();
+    execute(context: ExecutionContext, params: any): Promise<BrowserTab[]>;
+}

package/dist/extension/tools/index.d.ts

@@ -3,8 +3,11 @@ import { ElementClick } from './element_click';
 import { ExportFile } from './export_file';
 import { ExtractContent } from './extract_content';
 import { FindElementPosition } from './find_element_position';
+import { GetAllTabs } from './get_all_tabs';
 import { OpenUrl } from './open_url';
 import { Screenshot } from './screenshot';
 import { TabManagement } from './tab_management';
 import { WebSearch } from './web_search';
-export { BrowserUse, ElementClick, ExportFile, ExtractContent, FindElementPosition, OpenUrl, Screenshot, TabManagement, WebSearch, };
+import { RequestLogin } from './request_login';
+export * from '../../universal_tools';
+export { BrowserUse, ElementClick, ExportFile, ExtractContent, FindElementPosition, OpenUrl, GetAllTabs, Screenshot, TabManagement, WebSearch, RequestLogin, };

package/dist/extension/tools/request_login.d.ts

@@ -0,0 +1,10 @@
+import { Tool, InputSchema, ExecutionContext } from '../../types/action.types';
+export declare class RequestLogin implements Tool<any, any> {
+    name: string;
+    description: string;
+    input_schema: InputSchema;
+    constructor();
+    execute(context: ExecutionContext, params: any): Promise<any>;
+    awaitLogin(tabId: number, task_id: string): Promise<boolean>;
+    isLoginIn(context: ExecutionContext): Promise<boolean>;
+}

package/dist/extension/tools/tab_management.d.ts

@@ -11,7 +11,7 @@ export declare class TabManagement implements Tool<TabManagementParam, TabManage
     /**
      * Tab management
      *
-     * @param {*} params { commond: `new_tab [url]` | 'tab_all' | 'current_tab' | 'go_back' | 'close_tab' | 'switch_tab [tabId]' | `change_url [url]` }
+     * @param {*} params { command: `new_tab [url]` | 'tab_all' | 'current_tab' | 'go_back' | 'close_tab' | 'switch_tab [tabId]' | `change_url [url]` }
      * @returns > { result, success: true }
      */
     execute(context: ExecutionContext, params: TabManagementParam): Promise<TabManagementResult>;

package/dist/extension/utils.d.ts

@@ -1,10 +1,11 @@
 import { ExecutionContext } from '../types/action.types';
 export declare function getWindowId(context: ExecutionContext): Promise<number>;
 export declare function getTabId(context: ExecutionContext): Promise<number>;
-export declare function getCurrentTabId(windowId?: number | undefined): Promise<number | undefined>;
+export declare function getCurrentTabId(windowId?: number): Promise<number>;
 export declare function open_new_tab(url: string, newWindow: boolean, windowId?: number): Promise<chrome.tabs.Tab>;
 export declare function executeScript(tabId: number, func: any, args: any[]): Promise<any>;
 export declare function waitForTabComplete(tabId: number, timeout?: number): Promise<chrome.tabs.Tab>;
+export declare function doesTabExists(tabId: number): Promise<unknown>;
 export declare function getPageSize(tabId?: number): Promise<[number, number]>;
 export declare function sleep(time: number): Promise<void>;
 export declare function injectScript(tabId: number, filename?: string): Promise<void>;