# API Reference

> API reference for @anymux/github.

Source: https://anymux-docs.n.yatsyk.com/docs/github/api

# API Reference

## `GitHubFileSystem`

Implements `IFileSystem` using the GitHub Contents API.

### Constructor

```ts
new GitHubFileSystem(options: GitHubFileSystemOptions)
```

### Options

| Option  | Type      | Description                                    |
| ------- | --------- | ---------------------------------------------- |
| `owner` | `string`  | Repository owner                               |
| `repo`  | `string`  | Repository name                                |
| `token` | `string`  | GitHub personal access token                   |
| `ref`   | `string?` | Branch or commit ref (default: default branch) |

## `GitHubGitRepo`

Implements `IGitRepo` for branch, commit, and tree operations.

## `GitHubGitHost`

Implements `IGitHost` for issues, pull requests, and releases.