# VibeKit

## Docs

- [Introduction](https://docs.vibekit.sh/sdk/index.md): The VibeKit SDK makes it easy to embed powerful AI coding agents into your web applications. With support for multiple AI providers and secure sandboxed execution, you can add intelligent code generation, editing, and execution capabilities to any application.
- [Quickstart](https://docs.vibekit.sh/sdk/quickstart.md): Below is an example on how to get started with VibeKit
- [Ask Mode](https://docs.vibekit.sh/sdk/ask-mode.md): Ask mode allows you to run RAG over codebase and disables changes to the file system.
- [GitHub Integration](https://docs.vibekit.sh/sdk/github-integration.md): Clone repositories, create branches, open pull requests, and more.
- [Streaming](https://docs.vibekit.sh/sdk/streaming.md): VibeKit supports streaming responses, allowing you to receive data from the API in real-time as it is generated.
- [Session Management](https://docs.vibekit.sh/sdk/session-management.md): Learn how to manage sessions in VibeKit for multi-turn conversations
- [Git Worktrees](https://docs.vibekit.sh/sdk/worktrees.md): Use isolated workspace environments for different branches with automatic worktree management
- [Secrets Management](https://docs.vibekit.sh/sdk/secrets.md): Learn how to configure secrets and environment variables in VibeKit
- [OpenAI Codex](https://docs.vibekit.sh/agents/codex.md): Run OpenAI Codex in a secure and private sandbox
- [Claude Code](https://docs.vibekit.sh/agents/claude-code.md): Run Claude Code in a secure and private sandbox
- [Google Gemini](https://docs.vibekit.sh/agents/gemini.md): Run Google Gemini CLI in a secure and private sandbox
- [Grok CLI](https://docs.vibekit.sh/agents/grok.md): Run Grok CLI in a secure and private sandbox
- [Opencode](https://docs.vibekit.sh/agents/opencode.md): Run Opencode in a secure and private sandbox
- [Beam](https://docs.vibekit.sh/supported-sandboxes/beam.md): Configure VibeKit with Beam sandboxes for scalable cloud execution
- [Blaxel](https://docs.vibekit.sh/supported-sandboxes/blaxel.md): Configure VibeKit with Blaxel sandboxes for lightning-fast cloud execution
- [Dagger (Local)](https://docs.vibekit.sh/supported-sandboxes/dagger.md): Configure VibeKit with local Dagger sandboxes for fast, offline development
- [Cloudflare](https://docs.vibekit.sh/supported-sandboxes/cloudflare.md): Configure VibeKit with Cloudflare Sandboxes
- [Daytona](https://docs.vibekit.sh/supported-sandboxes/daytona.md): Configure VibeKit with a Daytona Sandbox
- [E2B](https://docs.vibekit.sh/supported-sandboxes/e2b.md): Configure VibeKit with an E2B sandbox
- [Fly.io](https://docs.vibekit.sh/supported-sandboxes/flyio.md): Configure VibeKit with Fly.io
- [Modal](https://docs.vibekit.sh/supported-sandboxes/modal.md): Configure VibeKit with Modal
- [Northflank](https://docs.vibekit.sh/supported-sandboxes/northflank.md): Configure VibeKit with Northflank persistent sandboxes
- [Configuration](https://docs.vibekit.sh/api-reference/configuration.md): VibeKit configuration reference
- [generateCode (Deprecated)](https://docs.vibekit.sh/api-reference/generate-code.md): Generates code using the configured AI agent (Codex or Claude) with optional streaming callbacks and conversation history.
- [executeCommand](https://docs.vibekit.sh/api-reference/execute-command.md): Run arbitrary shell commands in the sandbox environment.
- [createPullRequest](https://docs.vibekit.sh/api-reference/create-pull-request.md): Create a pull request after generating code changes.
- [mergePullRequest](https://docs.vibekit.sh/api-reference/merge-pull-request.md): Merge an existing pull request on GitHub
- [pushToBranch](https://docs.vibekit.sh/api-reference/push-to-branch.md): Push code changes to a branch.
- [runTests](https://docs.vibekit.sh/api-reference/run-tests.md): Execute tests in the sandbox environment with automatic test runner detection
- [kill](https://docs.vibekit.sh/api-reference/kill-sandbox.md): Terminates the active sandbox.
- [getHost](https://docs.vibekit.sh/api-reference/get-host.md): Get the host URL for a specific port in the sandbox environment.
- [pause](https://docs.vibekit.sh/api-reference/pause-sandbox.md): Pauses the active sandbox.
- [resume](https://docs.vibekit.sh/api-reference/resume-sandbox.md): Resumes the paused sandbox.
- [getSession](https://docs.vibekit.sh/api-reference/get-session.md): Retrieves the current session ID for the sandbox environment.
- [setSession](https://docs.vibekit.sh/api-reference/set-session.md): Sets the session ID for the sandbox environment. This method allows you to restore or switch between existing sandbox sessions.
- [Introduction](https://docs.vibekit.sh/cli/index.md): VibeKit is a safety layer for your coding agent. Run Claude Code, Gemini, Codex — or any coding agent — in a clean, isolated sandbox with sensitive data redaction and observability baked in.
- [Installation](https://docs.vibekit.sh/cli/installation.md): How to install and set up the VibeKit CLI on your system
- [Quick Reference](https://docs.vibekit.sh/cli/quick-reference.md): Quick reference card for common VibeKit CLI commands
- [Local Sandbox](https://docs.vibekit.sh/cli/local-sandbox.md): Optional Docker container isolation for running AI coding agents with filesystem protection.
- [Built-in Redaction](https://docs.vibekit.sh/cli/redaction.md): Automatically detect and remove sensitive data like API keys, secrets, and PII from AI agent completions through the proxy server.
- [Observability](https://docs.vibekit.sh/cli/observability.md): Complete visibility into agent operations with logs, analytics, and dashboard to understand what your coding agents are doing.
- [Universal Agent Support](https://docs.vibekit.sh/cli/agent-support.md): Works with Claude Code, Gemini, Codex, Cursor Agent, and OpenCode - providing consistent security and observability across all coding agents.
- [Configuration Files](https://docs.vibekit.sh/cli/configuration-files.md): Understanding and managing VibeKit CLI configuration files
- [Environment Variables](https://docs.vibekit.sh/cli/environment-variables.md): Complete reference for environment variables used by the VibeKit CLI
- [Introduction](https://docs.vibekit.sh/auth/index.md): Universal OAuth authentication library for AI providers' MAX subscriptions. Currently supports Claude AI with Gemini, Grok, and ChatGPT Max coming soon.
- [Overview](https://docs.vibekit.sh/auth/overview.md)
- [Node](https://docs.vibekit.sh/auth/node.md)
- [Browser](https://docs.vibekit.sh/auth/browser.md)
- [Types](https://docs.vibekit.sh/auth/types.md)

## OpenAPI Specs

- [openapi](https://docs.vibekit.sh/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/superagent-ai/vibekit)
- [Community](https://discord.gg/spZ7MnqFT4)
- [Website](https://vibekit.sh)