GitHub Codespaces quickstart

GitHub Codespaces provides a cloud-based development environment for TEN Agent. It enables you to develop directly in your browser wit the following benefits:

• No local environment setup required
• Consistent development environment across devices
• Works on any computer with a browser
• Pre-configured with all dependencies

This guide shows you how to get started with TEN Agent in Codespaces.

1. Navigate to the TEN-framework repository

2. Click the Code button and select Create codespace on main

   

3. GitHub creates your Codespace in a new browser tab

   

   First-time setup may take a few minutes as GitHub provisions your environment.

Once your Codespace loads with VSCode in the browser:

1. Open the integrated terminal

2. Create your environment file:

   
   

   _1

   cp .env.example .env

   
   

3. Edit .env and add your API keys

4. Build the agent:

   
   

   _1

   task use

   
   

5. Start the server:

   
   

   _1

   task run

   
   

Since Codespaces doesn't use Docker Compose, start the frontend separately:

1. Open a new terminal

2. Navigate to the playground directory:

   
   

   _1

   cd playground

   
   

3. Install dependencies:

   
   

   _1

   pnpm install

   
   

4. Start the development server:

   
   

   _1

   pnpm dev

   
   

   The frontend runs on port 3000.

Codespaces automatically creates URLs for exposed ports:

1. Click the Ports tab in the bottom panel

   

2. Find port 3000 and right-click its visibility setting

3. Select Public to make it accessible

   

4. Click the forwarded address for port 3000

   

   Your browser opens the frontend in a new tab.

You have successfully set up a development environment for TEN Agent using GitHub Codespaces. Start developing your agent directly in the cloud. Your Codespace provides the same development experience as local VSCode. You can:

• Set breakpoints and debug code
• Use extensions and terminal commands
• Commit and push changes to Git