Skip to content
Eko Docs

Quickstart

Let’s create an eko workflow together in a browser extension to automate the task that Search Sam Altman's information and summarize it into markdown format for export.

With this plugin, you no longer need to manually open multiple web pages; instead, you can run everything with a single click.

Prerequisites

  1. Install npm: Make sure you have Node.js installed. You will also need either npm or pnpm for managing dependencies. If you haven’t installed pnpm yet, follow these steps:

  2. Install pnpm

    Terminal window
    npm install -g pnpm

Note: If you prefer using npm for the setup, you can skip the pnpm installation and use npm commands instead. However, pnpm is faster and more efficient with handling dependencies.

Install Eko

Let’s start by creating a new project and installing Eko:

Terminal window
# Install the Eko CLI globally
pnpm install @eko-ai/eko-cli -g


# Create a new browser extension project
eko-cli init browser-extension-demo


# Install dependencies
cd browser-extension-demo
pnpm install

Creat your first workflow

Write your workflow in the src/background/first_workflow.ts file:

Terminal window
vim src/background/first_workflow.ts

Paste the following content. Press :wq to exit.

src/background/first_workflow.ts
import { Eko } from "@eko-ai/eko";
import { EkoConfig } from "@eko-ai/eko/types";
import { getLLMConfig } from "@eko-ai/eko/extension";


export async function main() {
  // Load LLM model configuration
  // the current browser plugin project provides a page for configuring LLM parameters
  let config = await getLLMConfig();


  // Initialize eko
  let eko = new Eko(config as EkoConfig);


  // Generate a workflow from natural language description
  const workflow = await eko.generate(`
    Search Sam Altman's information and summarize it into markdown format for export
  `);


  // Execute the workflow
  await eko.execute(workflow);
}

Click here to view the sample demo code, or directly download the extension to experience the workflow.

  1. Build: Build the project into browser-loadable extension code:
Terminal window
pnpm run build:dev

Load extension

  • Open the Chrome browser and navigate to chrome://extensions/.
  • Turn on Developer mode (toggle switch in the top right corner).
  • Click Load unpacked button (the blue text in the top-left corner) and select the dist folder of the project (e.g., [root_directory]/Eko/browser-extension-demo/dist).

Configure LLM model API Key

  • Click the Details button on the eko agent card.
  • Scroll down to find the Extension options section.
  • Open it and enter your LLM model API Key.

Let’s run it!

Pin the current extension in the browser’s top-right extensions menu, click the extension to open the popup, and click the RUN button to execute. Run your workflow by clicking the RUN button in the extension popup.

Next Steps

Now that you have run the first workflow, you can: