Client-GitHub for Eliza Framework

Overview

The client-github module is a component of the Eliza framework designed to interact with GitHub repositories. It provides functionalities to clone repositories, manage branches, create pull requests, and maintain file-based knowledge for Eliza agents.

This client leverages GitHub's REST API via the @octokit/rest library and includes robust error handling and configuration validation.

Features

• Repository Management: Clone, pull, and switch branches
• File Processing: Generate agent memories from repository files
• Pull Request Management: Create and manage pull requests programmatically
• Commit Operations: Stage, commit, and push files with ease
• Knowledge Base Integration: Convert repository content into agent memories
• Branch Management: Flexible branch switching and creation

Installation

Install the package as part of the Eliza framework: bash bun add @elizaos/client-github

Configuration

The GitHub client requires the following environment variables:

Variable	Description	Required
GITHUB_OWNER	Owner of the GitHub repository	Yes
GITHUB_REPO	Repository name	Yes
GITHUB_BRANCH	Target branch (default: main)	Yes
GITHUB_PATH	Path to focus on within the repo	Yes
GITHUB_API_TOKEN	GitHub API token for authentication	Yes

Usage

Initialization

typescript:packages/client-github/README.md

import { GitHubClientInterface } from '@elizaos/client-github';
// Initialize the client
const client = await GitHubClientInterface.start(runtime);

Creating Memories

// Convert repository files to agent memories
await client.createMemoriesFromFiles();

// Convert repository files to agent memories
await client.createMemoriesFromFiles();

Creating Pull Requests

await client.createPullRequest(
  'Feature: Add new functionality',
  'feature/new-feature',
  [
    {
      path: 'src/feature.ts',
      content: '// New feature implementation',
    },
  ],
  'Implements new functionality with tests'
);

await client.createPullRequest(
  'Feature: Add new functionality',
  'feature/new-feature',
  [
    {
      path: 'src/feature.ts',
      content: '// New feature implementation',
    },
  ],
  'Implements new functionality with tests'
);

Direct Commits

await client.createCommit('Update configuration', [
  {
    path: 'config.json',
    content: JSON.stringify(config, null, 2),
  },
]);

API Reference

GitHubClientInterface

• start(runtime: IAgentRuntime): Initialize the client
• stop(runtime: IAgentRuntime): Clean up resources

GitHubClient

• initialize(): Set up repository and configuration
• createMemoriesFromFiles(): Generate agent memories
• createPullRequest(title: string, branch: string, files: Array<{path: string, content: string}>, description?: string): Create PR
• createCommit(message: string, files: Array<{path: string, content: string}>): Direct commit

Scripts

# Build the project
bun run build

# Development with watch mode
bun run dev

# Lint the codebase
bun run lint

Dependencies

• @elizaos/core: ^0.1.7-alpha.2
• @octokit/rest: ^20.1.1
• @octokit/types: ^12.6.0
• glob: ^10.4.5
• simple-git: ^3.27.0

Development Dependencies

• @types/glob: ^8.1.0
• tsup: ^8.3.5

Contribution

Contributions are welcome! Please ensure all code adheres to the framework's standards and passes linting checks.

License

This project is licensed under the MIT License. See the LICENSE file for details.