> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oqoqo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# oqoqo acp and oqoqo github

> Serve Ask Oqo to Agent Client Protocol editors, and manage the GitHub accounts and repositories where Ask Oqo answers.

Chat with [Ask Oqo](https://docs.oqoqo.ai/operate/ask-oqo.md) outside the dashboard over the Agent Client Protocol (ACP), the open standard editors use to talk to AI agents.

## oqoqo acp

Serve an Oqoqo agent as an ACP agent on standard input and output. An ACP editor, such as Zed or a JetBrains IDE, or an automated tool starts it.

```bash theme={null}
oqoqo acp <agent-id> [flags]
```

No Plugin (MCP) tool: this is a way to reach Ask Oqo, not a product operation.

**Arguments**

| Argument | Description |
| - | - |
| `<agent-id>` | Required. The agent to serve: `ask-oqo`. |

**Flags**

| Flag | Type | Default | Description |
| - | - | - | - |
| `--project-id` | string | The saved project | The project every chat uses. The saved project doesn't change. |
| `--model` | string | The organization's **Ask Oqo model** | The model that new chats start on. |

Also takes the [global flags](https://docs.oqoqo.ai/cli/overview.md#global-flags).

**Examples**

The command an editor runs to chat with Ask Oqo:

```bash theme={null}
oqoqo acp ask-oqo
```

Pin every chat to one project:

```bash theme={null}
oqoqo acp ask-oqo --project-id prj_2d7c90ab
```

Run unattended, such as in a run or a CI job, with a personal API key:

```bash theme={null}
OQOQO_API_KEY=<your personal API key> oqoqo acp ask-oqo --project-id prj_2d7c90ab
```

**Notes**

Standard output carries only the protocol; errors go to standard error.

* **Sign in.** The editor's **Sign in** action opens Oqoqo sign-in in your browser. Unattended tools set `OQOQO_API_KEY` to a [personal API key](https://docs.oqoqo.ai/setup/profile.md#api-keys) instead. The key acts as you: anything that uses it can read and change your projects, as Ask Oqo can.
* **Chats.** Chats use your Oqoqo project and show in your Ask Oqo history in the dashboard.
* **First use.** If you never opened Ask Oqo in the dashboard, the chat shows a link named **Open Ask Oqo in Oqoqo once**. Open it, then send your message again.
* **Models.** Ask Oqo needs a model under **Organization settings → Oqoqo AI defaults**. See [Ask Oqo](https://docs.oqoqo.ai/operate/ask-oqo.md#prerequisites) for which models it can use.

To measure Ask Oqo in experiments, add this command as a custom agent from a download: see [Run Ask Oqo as a custom agent](https://docs.oqoqo.ai/guides/ask-oqo-custom-agent.md).

> [!NOTE]
>
> Custom agents are in private beta. Email [support@oqoqo.ai](mailto:support@oqoqo.ai) to enable them for your organization.

## Ask Oqo in GitHub (CI/CD)

> [!NOTE]
>
> Ask Oqo in GitHub is in private beta. Email [support@oqoqo.ai](mailto:support@oqoqo.ai) to enable it for your organization.

These commands manage where [Ask Oqo answers in GitHub](https://docs.oqoqo.ai/operate/ask-oqo-in-github.md): the GitHub accounts your organization connected, each account's default project, and a repository's own project. You install the app and choose its repositories on GitHub, and you connect GitHub to your profile in the dashboard. The commands return the links to those pages.

Every command returns the same result, and a refused command returns one of the same codes.

**Result fields**

| Field | Description |
| - | - |
| `accounts` | The GitHub accounts you can access that have the app: `installationId`, `accountLogin`, `accountType` (`organization`, `user`, or null), `accountUrl`, `avatarUrl`, `state` (`connected`, `available`, or `not_installed`), `defaultProject` (`projectId` and `projectName`, or null), and `settingsUrl`, GitHub's page for the app's repositories. |
| `repositories` | With no account selected, every repository that has a project of its own. For one account, one page of its repositories. Each has `repositoryId`, `fullName`, `repositoryUrl`, `installationId`, `private`, `project` (`projectId` and `projectName`, or null), and `projectSource`. |
| `projectSource` | `repository` when the project was chosen for the repository, `account` when it is the account's default project, and null when the repository has no project. |
| `private` | True or false in an account's page. It is null in the list of repositories with their own project. |
| `nextPage` | The next page of an account's repositories, or null. |
| `appName`, `appSlug`, `appUrl`, `installUrl` | The app's name, the name to mention after `@`, its page on GitHub, and GitHub's page to install it on an account. |

| Code | When |
| - | - |
| `github_unavailable` | Ask Oqo in GitHub isn't enabled for your organization. |
| `github_connection_required` | You haven't connected GitHub. `details.connectUrl` is the dashboard page where you connect it. |
| `github_account_not_found` | The app isn't installed on the account, or you can't access the account on GitHub. |
| `github_account_not_connected` | The account isn't connected to your organization. |
| `github_account_in_use` | The account is connected to another Oqoqo organization. |
| `github_repository_not_found` | You can't access the repository on GitHub, or the app can't read it from a connected account. |
| `project_not_found` | The project doesn't exist or you can't open it. |

## oqoqo github repos list

List the GitHub accounts you can access, each with its default project, and every repository that has a project of its own.

```bash theme={null}
oqoqo github repos list [flags]
```

**Plugin (MCP) tool:** [`list_github_repositories`](https://docs.oqoqo.ai/mcp-server/agents-and-setup#list_github_repositories)

**Flags**

| Flag | Type | Default | Description |
| - | - | - | - |
| `--installation-id` | integer | | A connected account's `installationId`. Lists that account's repositories from GitHub, one page at a time, each with its project and `projectSource`. |
| `--page` | integer | 1 | The page of the account's repositories, from `nextPage`. |

Also takes the [global flags](https://docs.oqoqo.ai/cli/overview.md#global-flags).

**Examples**

```bash theme={null}
oqoqo github repos list --output json
oqoqo github repos list --installation-id 4242 --output json
```

**Notes**

In text output, the last line is the name to mention in a comment. The command only reads.

## oqoqo github repos link

Choose the project Ask Oqo uses in one repository, or switch the repository to another project. A repository's own project wins over its account's default project.

```bash theme={null}
oqoqo github repos link <repository-id> --project-id <id>
```

**Plugin (MCP) tool:** [`manage_github_repository`](https://docs.oqoqo.ai/mcp-server/agents-and-setup#manage_github_repository) with `action: "link"`

**Arguments**

| Argument | Description |
| - | - |
| `<repository-id>` | Required. The repository's `repositoryId` from `oqoqo github repos list`. |

**Flags**

| Flag | Type | Default | Description |
| - | - | - | - |
| `--project-id` | string | | Required. The `prj_` project to use for this repository. |

Also takes the [global flags](https://docs.oqoqo.ai/cli/overview.md#global-flags).

**Examples**

```bash theme={null}
oqoqo github repos link 1296269 --project-id prj_2d7c90ab --output json
```

**Notes**

You need access to the repository on GitHub, and the app must be able to read it from a connected account. Running it again with the same project changes nothing.

## oqoqo github repos unlink

Remove a repository's project, so Ask Oqo stops answering there. In an account with a default project, this turns Ask Oqo off for that repository only.

```bash theme={null}
oqoqo github repos unlink <repository-id>
```

**Plugin (MCP) tool:** [`manage_github_repository`](https://docs.oqoqo.ai/mcp-server/agents-and-setup#manage_github_repository) with `action: "unlink"`

**Arguments**

| Argument | Description |
| - | - |
| `<repository-id>` | Required. The repository's `repositoryId` from `oqoqo github repos list`. |

Also takes the [global flags](https://docs.oqoqo.ai/cli/overview.md#global-flags).

**Examples**

```bash theme={null}
oqoqo github repos unlink 1296269 --output json
```

**Notes**

The app keeps its access on GitHub. Choose a project again with `oqoqo github repos link`. Running it again changes nothing.

## oqoqo github accounts connect

Connect a GitHub account that has the app installed to your organization.

```bash theme={null}
oqoqo github accounts connect <installation-id> [flags]
```

**Plugin (MCP) tool:** [`manage_github_repository`](https://docs.oqoqo.ai/mcp-server/agents-and-setup#manage_github_repository) with `action: "connect_account"`

**Arguments**

| Argument | Description |
| - | - |
| `<installation-id>` | Required. The account's `installationId` from `oqoqo github repos list`. |

**Flags**

| Flag | Type | Default | Description |
| - | - | - | - |
| `--project-id` | string | | The account's default project. With it, Ask Oqo answers in all of the account's repositories at once. Without it, you choose a project for each repository. |

Also takes the [global flags](https://docs.oqoqo.ai/cli/overview.md#global-flags).

**Examples**

```bash theme={null}
oqoqo github accounts connect 4242 --project-id prj_2d7c90ab --output json
```

**Notes**

You need access to the account on GitHub, and an account can be connected to only one Oqoqo organization. To install the app first, open `installUrl` from `oqoqo github repos list`. An account that is already connected keeps its default project.

## oqoqo github accounts default-project

Set, change, or remove a connected account's default project. Ask Oqo answers for it in every repository of the account that has no project of its own and isn't turned off, including repositories added later.

```bash theme={null}
oqoqo github accounts default-project <installation-id> --project-id <id>
oqoqo github accounts default-project <installation-id> --none
```

**Plugin (MCP) tool:** [`manage_github_repository`](https://docs.oqoqo.ai/mcp-server/agents-and-setup#manage_github_repository) with `action: "set_default_project"`

**Arguments**

| Argument | Description |
| - | - |
| `<installation-id>` | Required. The account's `installationId` from `oqoqo github repos list`. |

**Flags**

| Flag | Type | Default | Description |
| - | - | - | - |
| `--project-id` | string | | The `prj_` project to use as the default. Pass this or `--none`. |
| `--none` | boolean | | Remove the account's default project. |

Also takes the [global flags](https://docs.oqoqo.ai/cli/overview.md#global-flags).

**Examples**

```bash theme={null}
oqoqo github accounts default-project 4242 --project-id prj_2d7c90ab --output json
```

## oqoqo github accounts disconnect

Disconnect a GitHub account from your organization. Ask Oqo stops answering in all of its repositories, and its default project and their project choices are removed.

```bash theme={null}
oqoqo github accounts disconnect <installation-id> [flags]
```

**Plugin (MCP) tool:** [`disconnect_github_account`](https://docs.oqoqo.ai/mcp-server/agents-and-setup#disconnect_github_account)

**Arguments**

| Argument | Description |
| - | - |
| `<installation-id>` | Required. The account's `installationId` from `oqoqo github repos list`. |

**Flags**

| Flag | Type | Default | Description |
| - | - | - | - |
| `--yes` | boolean | | Confirm without a prompt. Required with `--output json` or without a terminal. |

Also takes the [global flags](https://docs.oqoqo.ai/cli/overview.md#global-flags).

**Examples**

```bash theme={null}
oqoqo github accounts disconnect 4242 --yes --output json
```

**Notes**

The app stays installed on GitHub. Connecting the account again doesn't bring its projects back.

## oqoqo github accounts link-me

Tell Oqoqo which GitHub account is yours, so Ask Oqo answers when you mention it. The other `github repos` and `github accounts` commands that change something do this too, so you need this one only if you don't manage repositories.

```bash theme={null}
oqoqo github accounts link-me
```

**Plugin (MCP) tool:** [`manage_github_repository`](https://docs.oqoqo.ai/mcp-server/agents-and-setup#manage_github_repository) with `action: "link_person"`

Also takes the [global flags](https://docs.oqoqo.ai/cli/overview.md#global-flags).

**Examples**

```bash theme={null}
oqoqo github accounts link-me --output json
```

## Related

> [card] [Ask Oqo](https://docs.oqoqo.ai/operate/ask-oqo.md)
>
> Models, approvals, and Slack.

> [card] [Run Ask Oqo as a custom agent](https://docs.oqoqo.ai/guides/ask-oqo-custom-agent.md)
>
> Measure Ask Oqo with tasks and rubrics.

> [card] [Profile and API keys](https://docs.oqoqo.ai/setup/profile.md)
>
> Create a personal API key for OQOQO\_API\_KEY.

> [card] [CLI reference](https://docs.oqoqo.ai/cli/overview.md)
>
> Install, sign in, and global flags.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.