Grok CLI

How it works

VibeKit runs the Grok CLI in headless mode. This means that the agent will automatically create, edit and delete files if it’s in code mode. The Grok CLI runs in the configured environment and has access to the network, which means it could be used to connect to the outside world. This is a powerful feature that can be used to build powerful applications and should be used with caution. Read more about Grok CLI

Authentication

Grok CLI requires an API key from xAI (X.AI). You can obtain one from the xAI Console.

Environment Variable Authentication

Set your xAI API key as an environment variable:

export GROK_API_KEY="your-xai-api-key-here"
# or alternatively
export XAI_API_KEY="your-xai-api-key-here"

Using in Code

const vibeKit = new VibeKit()
  .withAgent({
    type: "grok",
    provider: "xai",
    apiKey: process.env.GROK_API_KEY,
    model: "grok-beta", // or "grok-2-latest", "grok-2-mini"
  })
  .withSandbox(sandboxProvider);

Configuration Options

Available Models

grok-4 - Grok-4 model (default)
grok-3 - Grok-3 model
grok-code-fast-1 - Grok code model

Custom Base URL

If you’re using a custom xAI API endpoint:

const vibeKit = new VibeKit()
  .withAgent({
    type: "grok",
    provider: "xai",
    apiKey: process.env.GROK_API_KEY,
    model: "grok-beta",
    baseUrl: "https://your-custom-api-url.com", // optional
  })
  .withSandbox(sandboxProvider);

Example Usage

Basic Code Generation

import { VibeKit } from "@vibe-kit/sdk";
import { createE2BProvider } from "@vibe-kit/e2b";

const e2bProvider = createE2BProvider({
  apiKey: process.env.E2B_API_KEY!,
  templateId: "vibekit-grok",
});

const vibeKit = new VibeKit()
  .withAgent({
    type: "grok",
    provider: "xai",
    apiKey: process.env.GROK_API_KEY!,
    model: "grok-beta",
  })
  .withSandbox(e2bProvider);

// Generate code
const result = await vibeKit.generateCode({
  prompt: "Create a simple React component that displays a hello world message",
  mode: "code"
});

console.log(result.stdout);

Ask Mode (Research Only)

// Ask questions without modifying files
const result = await vibeKit.generateCode({
  prompt: "What is the current project structure?",
  mode: "ask"
});

console.log(result.stdout);

Environment Variables

The Grok agent supports the following environment variables:

GROK_API_KEY - Your xAI API key (required)
XAI_API_KEY - Alternative name for your xAI API key
GROK_BASE_URL - Custom API base URL (optional)

Security Considerations

API keys are passed to the sandbox environment and should be treated as sensitive information
The Grok CLI has network access and can make external API calls
Always use proper secrets management in production environments
Consider using environment-specific API keys with appropriate rate limits

Troubleshooting

Common Issues

“grok command not found”: Ensure the Grok CLI is installed in your sandbox template
Authentication errors: Verify your API key is correct and has sufficient credits
Rate limiting: xAI has rate limits; consider implementing retry logic for production use
Model not available: Check that the specified model is available in your xAI account

Debug Mode

To see detailed output from the Grok CLI, you can enable streaming callbacks:

vibeKit.on("update", (message) => {
  console.log("Grok output:", message);
});

vibeKit.on("error", (error) => {
  console.error("Grok error:", error);
});

Get Started

Agents

Supported Sandboxes

SDK Reference

How it works

Authentication

Environment Variable Authentication

Using in Code

Configuration Options

Available Models

Custom Base URL

Example Usage

Basic Code Generation

Ask Mode (Research Only)

Environment Variables

Security Considerations

Troubleshooting

Common Issues

Debug Mode

​How it works

​Authentication

​Environment Variable Authentication

​Using in Code

​Configuration Options

​Available Models

​Custom Base URL

​Example Usage

​Basic Code Generation

​Ask Mode (Research Only)

​Environment Variables

​Security Considerations

​Troubleshooting

​Common Issues

​Debug Mode

How it works

Authentication

Environment Variable Authentication

Using in Code

Configuration Options

Available Models

Custom Base URL

Example Usage

Basic Code Generation

Ask Mode (Research Only)

Environment Variables

Security Considerations

Troubleshooting

Common Issues

Debug Mode