Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions content/llms-full-root.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Keploy offers three core products:
Record-replay engine using eBPF to capture API calls and generate test suites with deterministic replay. The open-source core captures HTTP/HTTPS, gRPC, WebSocket, and GraphQL traffic at the kernel level and automatically creates replayable test cases with mocked dependencies (databases, external APIs, message queues). Tests are stored as YAML files in the project directory.

### 2. Test Agent (AI Unit Test Generation)
AI-powered unit test generation from PR diffs and source code. The Test Agent analyzes code semantics using LLMs (Gemini 2.5 Pro, GPT-4) and generates unit tests that are validated by actually running them against the codebase. Only tests that build, pass, and increase coverage are kept. Available via VS Code extension, JetBrains plugins, CLI, and GitHub PR Agent. Currently supports Go with Java and JavaScript coming soon.
AI-powered unit test generation from PR diffs and source code. The Test Agent analyzes code semantics using LLMs (Gemini 2.5 Pro, GPT-4) and generates unit tests that are validated by actually running them against the codebase. Only tests that build, pass, and increase coverage are kept. Available through the GitHub PR Agent. Currently supports Go with Java and JavaScript coming soon.

### 3. API Test Generation
Generate API tests from OpenAPI specs, Postman collections, cURL commands, or real user traffic. Supports functional tests, edge case tests, performance tests, security tests, and dependency tests. AI models route tasks to the best-suited model and validate results to ensure high-quality output.
Expand Down Expand Up @@ -465,9 +465,8 @@ For current, publicly substantiated security, privacy, and compliance informatio
## Integrations

### IDE Integrations
- VS Code Extension: inline test generation and execution (see Marketplace for current installs)
- JetBrains Plugin: IntelliJ IDEA, PyCharm, WebStorm, GoLand support
- URL: https://keploy.io/docs/keploy-explained/integrations-vscode/
- VS Code Extension (Keploy: API & DB Mocks): records the API and database calls your tests make and replays them offline with `keploy mock`, from a panel in VS Code. It also sets up AI coding agents and adds a CI job that replays the recording. It does not generate unit tests. See the Marketplace for current installs.
- URL: https://keploy.io/docs/running-keploy/utg-vscode-extension/

### PR Agent Integration
Automated test suggestions on GitHub pull requests. Analyzes PR diffs and generates targeted tests for changed code paths.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,16 +100,15 @@ There are many unit testing tools available for a wide range of languages and en

### Keploy

Keploy offers a one-click unit test generation tool that streamlines the testing process for developers. Instead of spending time writing test cases from scratch, you can generate them instantly, allowing you to focus on coding and delivering new features.
Keploy's PR Agent generates unit tests for the code you change in a pull request. Instead of spending time writing test cases from scratch, you get them on the pull request itself, allowing you to focus on coding and delivering new features.

**Benefits of Using Keploy:**

- **Efficiency**: Quickly create unit tests to save time and effort.
- **Enhanced Coverage**: Automatically generate tests for various scenarios, improving code reliability.
- **Focus on Quality**: Spend more time writing high-quality code while ensuring thorough validation.
<img src="https://keploy-devrel.s3.us-west-2.amazonaws.com/docs/webp-s3/img/glossary/keploy_VS.webp" alt="Keploy" width="816" height="1788" style={{maxWidth:'100%',height:'auto'}} />

Get started by downloading the tool from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Keploy.keployio) and boost your development workflow today!
Get started with the [PR Agent](/docs/running-keploy/utg-pr-agent/) and boost your development workflow today!

### pytest (Python)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
---
id: integrations-vscode
title: IDE Integrations — VS Code
sidebar_label: Integrations & Connected Tools
description: Learn about IDE integrations for Keploy’s AI-powered unit testing.
title: IDE integrations — VS Code
sidebar_label: VS Code
description: Keploy's VS Code extension records the API and database calls your tests make and replays them with those dependencies switched off, from inside the editor.
tags:
- integrations
- vscode
- unit testing
- mocks
keywords:
- keploy vs code extension
- vscode mocks
- api mocks
- database mocks
---

# 🔌 IDE Integrations — VS Code
# IDE integrations — VS Code

Keploy aims to make AI-powered unit testing as seamless as possible—right inside your favorite tools.
Keploy's VS Code extension, **Keploy: API & DB Mocks**, brings the [`keploy mock`](/docs/running-keploy/mock-your-tests/) loop into the editor. It records the real calls your tests make to APIs and databases, then replays your tests with those dependencies switched off. It installs the Keploy CLI for you, can set up your AI coding agent to record and replay, and can add a CI job that replays the recording on every pull request.

## ✅ Currently Supported
Install it from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=keploy.keployio), then follow the [VS Code extension guide](/docs/running-keploy/utg-vscode-extension/).

**Visual Studio Code (VS Code):**
We offer smooth integration with VS Code, so you can generate, view, and manage AI-generated unit tests without leaving your IDE.
The extension no longer generates unit tests. To generate unit tests, use Keploy's [PR Agent](/docs/running-keploy/utg-pr-agent/).

## 💡 Want Support for Another IDE?
## Request another editor

Need Keploy in JetBrains, Neovim, or another editor?

[Reach out to our team!](mailto:support@keploy.io)

Your feedback shapes our roadmap!

More IDE integrations are coming soon—stay tuned.
If you need Keploy in JetBrains, Neovim, or another editor, [tell our team](mailto:support@keploy.io).

## Related

- [Keploy VS Code extension](/docs/running-keploy/utg-vscode-extension/) — install, record, replay, and troubleshoot.
- [Mock your tests](/docs/running-keploy/mock-your-tests/) — the `keploy mock` commands the extension runs.
- [SCM Integrations — PR Agent](/docs/keploy-explained/integrations-pr-agent/) — the pull-request integration.
- [Keploy Troubleshooting Guide](/docs/keploy-explained/common-errors/) — fix common setup issues.
- [What is Keploy?](/docs/keploy-explained/introduction/) — project overview.
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,11 @@ Yes! Keploy is built to handle large, complex projects. Processing time may vary

### 10. Which method should I use to generate tests?

- **PR Agent**: Best for automated test generation on GitHub pull requests.
- **VS Code Extension**: Ideal for developers who prefer working in their IDE.
- **CLI Tool**: For those who want more control or integrate into scripts.
Use the [PR Agent](/docs/running-keploy/utg-pr-agent/), which generates unit tests on your GitHub pull requests.

### 11. Do I need an API key?

Only for the CLI method. Other tools like PR Agent and VS Code Extension use their own secure auth flows.
No. The PR Agent uses its own secure auth flow.

### 12. How does Keploy ensure the quality of generated tests?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tags:

> **Master the art of automated testing with proven strategies, expert insights, and advanced techniques for maximizing your testing ROI.**

This comprehensive guide outlines battle-tested best practices for writing exceptional unit tests, leveraging automation effectively, and extracting maximum value from Keploy's Unit Test Generation ecosystem — including the PR Agent and VS Code extension.
This comprehensive guide outlines battle-tested best practices for writing exceptional unit tests, leveraging automation effectively, and extracting maximum value from Keploy's Unit Test Generation ecosystem — including the PR Agent.

## **Foundational Unit Testing Principles**

Expand Down Expand Up @@ -210,49 +210,6 @@ Combine automated generation with manual expertise:
- **Domain Expert Review**: Have domain experts validate test logic
- **Continuous Refinement**: Iteratively improve generated test quality

## **VS Code Extension Power User Techniques**

### **1. Real-Time Development Integration** ⚡

Maximize productivity by generating tests during active development:

- **Function-Level Testing**: Generate tests immediately after writing functions
- **Refactoring Safety**: Create tests before refactoring existing code
- **Bug Reproduction**: Generate tests to reproduce and fix reported bugs
- **API Exploration**: Use generated tests to understand third-party APIs

### **2. Advanced Configuration Management**

Customize the VS Code extension for optimal team workflows:

```json
{
"keploy.utg.outputDirectory": "./tests",
"keploy.utg.testFramework": "jest",
"keploy.utg.mockingStrategy": "auto",
"keploy.utg.coverageTarget": "branches",
"keploy.utg.namingConvention": "descriptive"
}
```

### **3. Incremental Test Development**

Build comprehensive test suites incrementally:

- **Start Small**: Begin with core utility functions
- **Expand Gradually**: Add tests for more complex business logic
- **Maintain Quality**: Regularly review and refactor generated tests
- **Document Patterns**: Create team guidelines for test generation

### **4. Integration with Development Workflow**

Seamlessly blend test generation with existing development practices:

- **Code Review Integration**: Generate tests before requesting code reviews
- **Pair Programming**: Use generated tests as conversation starters
- **Knowledge Sharing**: Use tests to document expected behavior
- **Onboarding Tool**: Help new team members understand codebase behavior

## **Advanced Metrics & Monitoring**

### **Test Quality Indicators**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ so your test code needs **no SDK and no changes**.

Keploy propagates your test runner's **exit code**, so it drops straight into CI.

Using VS Code? The [Keploy VS Code extension](/docs/running-keploy/utg-vscode-extension/)
runs these commands for you from a panel, and its
[troubleshooting table](/docs/running-keploy/utg-vscode-extension/#troubleshoot)
explains the messages the panel shows when a run fails.

## Quick start

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,19 @@ keywords:

Keploy's Unit Test Generator (UTG) simplifies testing by generating high-quality, maintainable unit tests with minimal manual effort. Inspired by Meta’s LLM research, it uses code semantics and Large Language Models (LLMs) to produce meaningful test cases.

To fit into modern development workflows, Keploy now supports multiple methods for unit test generation - ranging from automated pull request comments to a one-click VS Code extension
To fit into modern development workflows, Keploy generates unit tests on your pull requests.

Keploy's UTG aims to:

- **Automate unit test generation:** Reduce manual effort by generating tests automatically.
- **Improve edge case coverage:** Catch complex scenarios often missed manually.
- **Boost test coverage:** Make comprehensive coverage achievable as your codebase grows.

### Try the Unit Test Generator in two ways:
### Try the Unit Test Generator

1. **PR Agent**: Install a GitHub App on your repo to automatically generate tests when you create a pull request.

2. **VS Code Extension**: Generate test files with a single click directly from your IDE.
Install the [PR Agent](/docs/running-keploy/utg-pr-agent/), a GitHub App, on your repository to automatically generate tests when you create a pull request.

## Related

- [Unit Test Architecture](/docs/running-keploy/unit-test-architecture/) — how the generator is structured.
- [Keploy's PR Agent](/docs/running-keploy/utg-pr-agent/) — generate unit tests on pull requests.
- [Keploy's VS Code Extension](/docs/running-keploy/utg-vscode-extension/) — generate unit tests in your editor.
Original file line number Diff line number Diff line change
Expand Up @@ -93,5 +93,4 @@ _Elevate your development workflow. Make every pull request a quality checkpoint
## Related

- [Keploy Unit Test Generator](/docs/running-keploy/unit-test-generator/) — the engine behind the PR agent.
- [Keploy's VS Code Extension](/docs/running-keploy/utg-vscode-extension/) — the same generator in your IDE.
- [Unit Test Architecture](/docs/running-keploy/unit-test-architecture/) — how generated unit tests are built.
Loading
Loading