VibeKit configuration reference
withAgent()
method to configure which AI model to use.
Property | Type | Required | Description |
---|---|---|---|
type | AgentType | Yes | The type of AI agent to use |
provider | ModelProvider | Yes | The AI provider service |
apiKey | string | Yes | API key for the chosen agent provider |
model | string | Yes | Specific model to use |
"claude"
- Anthropic Claude agent"codex"
- OpenAI Codex agent"opencode"
- Opencode agent"gemini"
- Google Gemini agent"anthropic"
- Anthropic"openai"
- OpenAI"openrouter"
- OpenRouter"azure"
- Azure"gemini"
- Google Gemini"ollama"
- Ollama"mistral"
- Mistral AI"deepseek"
- DeepSeek"xai"
- xAI"groq"
- GroqwithSandbox()
method to configure the sandbox environment where code execution happens. You’ll need to install and import the specific provider package.
withGithub()
method to configure repository integration for pull request creation and code management.
Property | Type | Required | Description |
---|---|---|---|
token | string | Yes | GitHub personal access token with repository permissions |
repository | string | Yes | Repository in the format “owner/repo-name” |
withSession()
method to specify a sandbox session to reuse.
Property | Type | Required | Description |
---|---|---|---|
sandboxId | string | Yes | Existing sandbox ID to reuse |
withWorkingDirectory()
method to specify the directory where the agent should execute commands and work with files.
Property | Type | Required | Default | Description |
---|---|---|---|---|
path | string | Yes | - | The directory path where the agent will execute commands and access files |
withSecrets()
method to provide environment variables and secrets to the sandbox.
Property | Type | Required | Description |
---|---|---|---|
secrets | Record<string, string> | Yes | Key-value pairs of environment variables to set in the sandbox |