workers-research

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #typescript #llm #machine-learning #rust #deep-learning #linux #docker #nodejs #windows #ios

workers-research

(★ 106)

A serverless, AI-powered deep research agent built with Cloudflare Workers and Google Gemini 2.5

workers-research Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# workers-research

**A serverless, Cloudflare Workers-based Deep Research Agent powered by Google Gemini 2.5.**

[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/G4brym/workers-research)

## ✨ Features

- **In-depth Research with Google Gemini 2.5:** Leverages Google's latest models for high-quality research reports.
- **Serverless on Cloudflare:** Built with Workers and Workflows for scalability, reliability, and cost-effectiveness.
- **Intuitive Dashboard:** Manage and view research via a Hono/JSX web interface.
- **Simplified Architecture:** Gemini 2.5's large context window removes the need for prompt compression, enhancing report quality.
- **AutoRAG Integration:** Allows the system to perform research using Cloudflare AI's AutoRAG feature, which queries against a pre-indexed dataset. This can be used as an alternative or in conjunction with standard web browsing research. The AutoRAG feature is invoked when an `autorag_id` is provided with the research request.
- **Inline Q&A:** Ask follow-up questions about completed reports, with answers grounded in the report content and saved for future reference.

## 🚀 Inspiration and Acknowledgements

Inspired by [dzhng's deep-research](https://github.com/dzhng/deep-research). Thank you to dzhng for the original concept. `workers-research` adapts this for the Cloudflare ecosystem.

## 💡 Key Differences from Original Deep-Research

- **Cloudflare Native:** Runs on Cloudflare Workers and Workflows, unlike the Node.js/Docker original.
- **Enhanced Reliability:** Uses Cloudflare Workflows for robust multi-step research.
- **Simplified & Efficient:** Leverages Gemini 2.5's large context window, omitting prompt compression for a streamlined design and potentially better reports.
- **Accessible Crawling:** Utilizes Cloudflare's Browser Rendering (available on the free Workers plan).

## 🔍 Use Cases

- **Academic Research:** Quickly gather information and insights for academic papers, theses, and research projects.
- **Market Analysis:** Research industry trends, competitors, and market dynamics for business decisions.
- **Content Creation:** Generate comprehensive research for blog posts, articles, and educational content.
- **Product Development:** Explore user needs, technical solutions, and industry standards for new products.
- **Educational Projects:** Help students gather information on complex topics for projects and assignments.

## 🛠️ Technology Stack

- **Cloudflare Workers:** Core runtime environment.
- **Cloudflare Workflows:** Manages reliable research execution.
- **Cloudflare D1 Database:** Serverless SQL for research data.
- **Browser Rendering:** Web crawling (free tier available).
- **Google Gemini 2.5:** Advanced language model for reports.
- **Cloudflare AI Gateway (Optional):** Proxy for AI requests (caching, management).
- **Hono:** Lightweight web framework for dashboard and API.
- **workers-qb:** Query builder for Cloudflare D1.

## 🏗️ Architecture Overview

```mermaid
graph TD
    B{Cloudflare Worker} -- API Calls --> D[Cloudflare Workflows];
    B -- Fetches Status/Data --> F[Cloudflare D1 Database];
    D -- Triggers --> E[Gemini 2.5 API];
    D -- Stores/Retrieves Research --> F;
    D -- If Crawling Needed --> G[Browser Rendering API];
    E -- Report Chunks/Results --> D;

subgraph "Cloudflare Ecosystem (Backend)"
        B
        D
        F
        G
    end

subgraph "External Services"
        E
    end

style B fill:#ccf,stroke:#333,stroke-width:2px;
    style D fill:#ccf,stroke:#333,stroke-width:2px;
    style E fill:#fca,stroke:#333,stroke-width:2px;
    style F fill:#ccf,stroke:#333,stroke-width:2px;
    style G fill:#ccf,stroke:#333,stroke-width:2px;
```

### Research Workflow Diagram

The following diagram illustrates the detailed workflow of the research agent when processing a request:

```mermaid
graph TD
    A["User Input: Query, Parameters"] --> B["System: Prepare Full Query & Setup"];
    B --> C["Start Iterative Research Cycle"];
    C --> C1["Generate Search Tasks/Queries based on current goal & learnings"];
    C1 --> C2["Gather Information (Web Search & Content Extraction)"];
    C2 --> C3["Process Information: Extract Key Learnings & Identify Follow-up Needs"];
    C3 --> C4["Further Research Iterations Needed? (based on depth/breadth)"];
    C4 -- Yes --> C1;
    C4 -- No --> D["Compile All Learnings & Generate Final Report"];
    D --> E["Store Report & Update Status in Database"];
    E --> F["Research Complete / Report Available"];
```

## 🚦 Getting Started

Follow these steps to set up and run `workers-research` on your Cloudflare account:

### Setup Steps

1. **Clone the Repository:**
   ```bash
   git clone git@github.com:G4brym/workers-research.git
   ```

2. **Install Dependencies:**
   ```bash
   npm install
   ```

3. **Cloudflare Login:**
   Authenticate with your Cloudflare account using Wrangler:
   ```bash
   wrangler login
   ```

4. **Create a Cloudflare D1 Database:**
   Create a D1 database in your Cloudflare dashboard or using Wrangler:
   ```bash
   wrangler d1 create workers-research
   ```
   **Important:** Replace `"replace-me"` in your `wrangler.toml` file with the `database_id` output from the command above.

Database migrations are applied automatically.

5. **Deploy to Cloudflare Workers:**
   Deploy your worker to Cloudflare:
   ```bash
   wrangler deploy
   ```
   This will deploy your worker to `workers-research.{your-user}.workers.dev` (or your custom domain if configured).

6. **Set up API Keys:**
   - **Google AI Studio API Key:** Obtain from [https://aistudio.google.com](https://aistudio.google.com).
   - Upload API Keys into workers:
     ```bash
     npx wrangler secret put GOOGLE_API_KEY
     ```

7. **(Optional) Configure Cloudflare AI Gateway:**
   - Create an AI Gateway in your Cloudflare account dashboard.
   - Configure the gateway with your preferred settings.
   - Set the required environment variables:
     ```bash
     npx wrangler secret put AI_GATEWAY_NAME
     npx wrangler secret put AI_GATEWAY_ACCOUNT_ID
     ```
   - If your gateway has authentication enabled, also set the API key:
     ```bash
     npx wrangler secret put AI_GATEWAY_API_KEY
     ```

8. **Access the Dashboard:**
   Open your deployed worker URL (e.g., `https://workers-research.{your-user}.workers.dev`) in your browser to access the research dashboard.

## ✍️ Usage

1. **Create a New Research:**
   - On the dashboard homepage, you'll see a "Create New Research" section.
   - Enter your research query, desired depth, and breadth.
   - Click "Continue with creation".

2. **Answer Follow-up Questions:**
   - The application will generate follow-up questions to clarify your research intent.
   - Answer these questions to refine the research direction.
   - Click "Create new Research" to start the research workflow.

3. **Monitor Research Status:**
   - You can track the status of your researches on the dashboard.
   - Researches in progress will be marked as "Running".
   - Completed researches will be marked as "Complete".

4. **Read Research Reports:**
   - Once a research is complete, a "Read" button will appear next to it.
   - Click "Read" to view the generated research report in a nicely formatted HTML page.

5. **Ask Follow-up Questions:**
   - On the research details page of a completed report, scroll to the "Ask a follow-up question" panel.
   - Type a question about the report (e.g. "What are the main risks identified?" or "Which companies were mentioned most?").
   - Answers are grounded in the report content and saved for future reference.

6. **Re-run Researches:**
   - If you want to re-run a previous research, click the "🔄" button next to the research entry. This will create a new research based on the same query and parameters.

## 📊 Performance & Limitations

- **Research Time:** Most researches complete within 5-10 minutes, depending on complexity.
- **Research Depth:** Configure depth from 1-5, with higher values producing more comprehensive reports.
- **API Limits:** Be aware of Cloudflare and Google Gemini API limits when running multiple researches. Browser Rendering on the Workers Free plan is limited to 10 minutes of usage per day, sufficient for most research tasks.

## 💬 Community & Support

- **[GitHub Issues](https://github.com/G4brym/workers-research/issues):** Report bugs or suggest features
- **[Discussions](https://github.com/G4brym/workers-research/discussions):** Ask questions and share ideas

## 🖼️ Screenshots

Home page
![homepage](https://github.com/G4brym/workers-research/raw/main/assets/images/home.png)

New Research
![new-research](https://github.com/G4brym/workers-research/raw/main/assets/images/new-research.png)

Follow up questions
![follow-up-questions](https://github.com/G4brym/workers-research/raw/main/assets/images/follow-up-questions.png)

Reading a report
![research](https://github.com/G4brym/workers-research/raw/main/assets/images/report.png)

## 📜 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

workers-research

workers-research Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

workers-research

workers-research Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README