> ## 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.

# Overview

> Read and write Excel workbooks in OneDrive for Business or SharePoint through Microsoft Graph.

Use **Excel** through Corsair: one client, typed API calls.

**What you get:**

* 41 typed API operations

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/excel 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 { excel } from '@corsair-dev/excel';

export const corsair = createCorsair({
	plugins: [
		excel(),
	],
	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] OAuth 2.0 (Recommended)
>
> Open [hub.corsair.dev](https://hub.corsair.dev/dashboard), navigate to your project, and enter the **client ID** and **client secret** from your Excel OAuth app.
>
> ```ts theme={null}
> excel()
> ```
>
> More: [OAuth 2.0](https://docs.corsair.dev/concepts/oauth)

> [tab] Managed OAuth
>
> No setup required. Corsair hosts the OAuth app for **Excel** — your tenants connect through Hub when they sign in.
>
> ```ts theme={null}
> excel({
> 	authType: 'managed',
> })
> ```
>
> More: [Managed OAuth](https://docs.corsair.dev/concepts/auth.md#managed)

**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: 'excel',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Read a range**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.excel.api.ranges.get({ itemId: 'item-id', worksheet: 'Sheet1', address: 'A1:C4' });
```

**Write cells**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.excel.api.ranges.update({
	itemId: 'item-id',
	worksheet: 'Sheet1',
	address: 'A1',
	values: [['Hello']],
});
```

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

## What's next

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

> [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.