Gitpod SDK

The Gitpod SDK provides powerful tools for developers to interact programmatically with Ona environments. It allows you to automate environment creation, run tasks, manage automations, and scale infrastructure with runners. Available in Python, Node/Typescript, and Go, the SDK gives developers flexibility in their choice of language.

SDKs Available

• Python SDK: For Python developers.
• Node/Typescript SDK: For JavaScript and TypeScript developers.
• Go SDK: For Go developers.

For detailed API references, consult the API Reference.

End-to-End Walkthrough

Watch the video below to see an end-to-end walkthrough of how to use the Gitpod SDK. The steps below are based on the video.

1. Sign Up

• Go to app.gitpod.io and sign up.
• Once logged in, generate a Personal Access Token for SDK authentication under your account settings at Personal Access Tokens.

2. Install the SDK

Install for your preferred language:

• Python SDK:
  pip install gitpod-sdk
  

• Node/Typescript SDK:
  npm install @gitpod/sdk
  

• Go SDK:
  go get github.com/gitpod-io/gitpod-sdk-go
  

3. Authenticate

Authenticate using your personal access token. Set via environment variable or pass in code.

• Option 1: Set the environment variable GITPOD_API_KEY:

  export GITPOD_API_KEY="your_token_here"
  

• Option 2: Authenticate directly in your code:

  • For Python SDK:

    from gitpod_sdk import Gitpod
    
    gitpod = Gitpod(bearer_token="your_token_here")
    

  • For Go SDK:

    package main
    
    import (
        "github.com/gitpod-io/gitpod-sdk-go"
    )
    
    func main() {
        gitpod := gitpod.NewGitpod("your_token_here")
    }
    

  • For Node/Typescript SDK:

    import { Gitpod } from '@gitpod/sdk';
    
    const gitpod = new Gitpod({ bearerToken: 'your_token_here' });
    

4. Run an Example

Create an environment and run a command using the Python SDK:

import asyncio
from gitpod import AsyncGitpod
import gitpod.lib as util

repo_url = "https://github.com/containerd/containerd"
command_to_execute = "go test -v -short ./..."

async def execute_command_in_environment():
    client = AsyncGitpod()

    machine_class_id = (await util.find_most_used_environment_class(client)).id

    create_params = {
        "machine": {"class": machine_class_id},
        "content": {"initializer": {"specs": [{"context_url": {"url": repo_url}}]}}
    }

    environment = (await client.environments.create(spec=create_params)).environment

    await util.wait_for_environment_running(client, environment.id)

    async for line in await util.run_command(client, environment.id, command_to_execute):
        print(line)

    await client.environments.delete(environment_id=environment.id)

if __name__ == "__main__":
    asyncio.run(execute_command_in_environment())

Available Examples

Examples in the SDK repositories:

1. Run a Command in an Environment

• Description: Initialize an environment from a Git repository and run a command inside it.
• Location: Python SDK Example - Run Command

2. Run a Service in an Environment

• Description: Run a long-lived service (such as a database or message queue) inside an environment.
• Location: Python SDK Example - Run Service

3. Access the File System in an Environment

• Description: Access and interact with the file system programmatically.
• Location: Python SDK Example - File System Access

4. Use the Anthropic Tool in an Environment

• Description: Use the Anthropic tool within an environment and interact with Model Context Protocol (MCP).
• Location: Python SDK Example - Anthropic Tool Use

5. MCP Server Example

• Description: Demonstrate MCP integration.
• Location: Go SDK Example - MCP Server