Getting Started

This guide will go through everything you'll need to set up your development environment for using Freestyle.

Installing Freestyle SDK

If you're using TypeScript, JavaScript, or Python, you should install the Freestyle SDK into your project.

npm i freestyle-sandboxes

pnpm i freestyle-sandboxes

bun i freestyle-sandboxes

yarn add freestyle-sandboxes

pip install freestyle

Otherwise, you'll want to be aware of the Freestyle API Reference and how to use it with your preferred HTTP client.

Get an API Key

You can get your API key from the Freestyle Dashboard. This key is used to authenticate your requests to the Freestyle APIs. We recommend storing it in an environment variable named FREESTYLE_API_KEY, this way our SDKs can automatically detect it.

Adding to your Vibe Coding Setup

Add to Cursor

Click this link to add Freestyle documentation to your Cursor setup. This will allow you to easily reference our API documentation while coding.

Add to VSCode

Click this link to add Freestyle documentation to your VSCode setup. This will allow you to access our API documentation directly within your code editor.

Add to Claude Code

You can add Freestyle documentation to Claude Code by running the following command:

claude mcp add --transport http freestyle-docs https://docs.freestyle.sh/api/mcp/mcp

Add to Claude Desktop

For adding to Claude Desktop, you'll need to create or edit the claude_desktop_config.json file in your Claude Desktop configuration directory. Add the following configuration:

{
  "mcpServers": {
    "freestyle-docs": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://docs.freestyle.sh/api/mcp/mcp"]
    }
  }
}

Talk to Us!

If you have any questions or need help, you can reach out to us on our Discord server

Where to go now?

• Building an AI App Builder on Freestyle: Learn how to build an AI app builder using Freestyle.
• Web Deployments: Explore how to deploy websites using Freestyle.
• Git: Understand how to manage Git repositories with Freestyle.
• Dev Servers: Learn about running development servers for live previews of code.
• Code Execution: Discover how to run code serverlessly with Freestyle.