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

# BugHerd plugin

> Work with BugHerd website feedback and bug reports. List and triage tasks, move them across the board, comment, attach files, and manage projects, columns and webhooks.

Use **BugHerd** through Corsair: one client, typed API calls, local DB sync.

The [BugHerd API v2](https://docs.bugherd.com/api) authenticates with your organization's API key (Settings > organization > Authentication Token). It is sent as HTTP Basic with the key as the username and `x` as the password, and it can see every project in the organization.

Tasks have two ids: the global `id` that every task route takes, and `local_task_id`, the #number shown in the BugHerd UI. Use `tasks.showByLocalId` to turn a #number into a task, and `tasks.move` takes #numbers. A task's `status` is its column name (`backlog`, `todo`, `doing`, `done`, `closed` or a custom column); a task with no status sits in the Feedback panel.

Lists return up to 100 records per page; pass `page` to get the next one. An empty list means there are no more. BugHerd allows 60 requests a minute.

**Risk.** Deletes (projects, tasks, columns, attachments, webhooks) cannot be undone, and `projects.addGuest` with an email sends that person an invitation, so these are `destructive`. Projects come back without the project's widget `api_key`, which lets anyone post feedback into the project.

**What you get:**

* 39 typed API operations
* 8 synced entities (`attachments`, `columns`, `comments`, `organization`, `projects`, `tasks`, and 2 more) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/bugherd better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/bugherd better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/bugherd better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/bugherd better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { bugherd } from '@corsair-dev/bugherd';

export const corsair = createCorsair({
	plugins: [
		bugherd(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the BugHerd API key before the first call: `pnpm corsair setup --plugin=bugherd --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> bugherd()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'bugherd',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Open tasks in a project**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.bugherd.api.tasks.list({ project_id: 552668, status: 'todo' });
```

**Move a task to Doing and assign it**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.bugherd.api.tasks.update({
	project_id: 552668,
	task_id: 98765,
	status: 'doing',
	assigned_to_id: 4561,
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/bugherd/api.md) page.

## Query synced data

Synced entities support `tenant.bugherd.db.<entity>.search()` and `.list()`: `attachments`, `columns`, `comments`, `organization`, `projects`, `tasks`, `users`, `webhooks`.

See [Database](https://docs.corsair.dev/plugins/bugherd/database.md) for filters and operators.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/bugherd/api.md)
>
> Every `bugherd.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/bugherd/database.md)
>
> Synced entities, search filters, and operators.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


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