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

# Excel

> Microsoft Excel is a powerful spreadsheet application for data analysis, calculations, and visualization, enabling users to organize and process data with formulas, charts, and piv

Microsoft Excel is a powerful spreadsheet application for data analysis, calculations, and visualization, enabling users to organize and process data with formulas, charts, and pivot tables

`excel` · **54 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth excel
run auth excel --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run excel          # common commands
run excel --all    # every command
```

```ts theme={"theme":"github-dark"}
import { excel } from "@boxd/run";
```

## Common tools

| Tool                      | What it does                                                                                                                             |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `add-table`               | Create a new table in a worksheet using the Microsoft Graph API.                                                                         |
| `add-workbook-permission` | Tool to grant access to a workbook via invite. Use when you need to share a specific workbook file with designated recipients and roles. |
| `get-session`             | Create a session for an Excel workbook using Microsoft Graph API.                                                                        |
| `insert-range`            | Tool to insert a new cell range into a worksheet, shifting existing cells down or right.                                                 |
| `list-table-columns`      | List columns in a table using Microsoft Graph API.                                                                                       |
| `search-files`            | Tool to search OneDrive drive items by query to discover Excel workbook IDs.                                                             |

<Accordion title="All 54 tools" icon="list">
  | Tool                         | What it does                                                                                                                                                               |
  | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `add-chart`                  | Add a chart to a worksheet using Microsoft Graph API.                                                                                                                      |
  | `add-sharepoint-worksheet`   | Add a new worksheet to a SharePoint Excel workbook using Microsoft Graph Sites API.                                                                                        |
  | `add-table`                  | Create a new table in a worksheet using the Microsoft Graph API.                                                                                                           |
  | `add-table-column`           | Add a column to a table using Microsoft Graph API.                                                                                                                         |
  | `add-table-row`              | Add a row to a table using Microsoft Graph API.                                                                                                                            |
  | `add-workbook-permission`    | Tool to grant access to a workbook via invite. Use when you need to share a specific workbook file with designated recipients and roles.                                   |
  | `add-worksheet`              | Add a new worksheet to an Excel workbook using Microsoft Graph API.                                                                                                        |
  | `apply-table-filter`         | Apply a filter to a table column using Microsoft Graph API.                                                                                                                |
  | `apply-table-sort`           | Apply a sort to a table using Microsoft Graph API.                                                                                                                         |
  | `clear-range`                | Tool to clear values, formats, or contents in a specified worksheet range.                                                                                                 |
  | `clear-table-filter`         | Clear a filter from a table column using Microsoft Graph API.                                                                                                              |
  | `close-session`              | Tool to close an existing Excel workbook session. Use when you need to explicitly end a persistent session to release workbook locks.                                      |
  | `convert-table-to-range`     | Convert a table to a range using Microsoft Graph API.                                                                                                                      |
  | `create-workbook`            | Tool to create a new Excel workbook file at a specified drive path.                                                                                                        |
  | `delete-table-column`        | Delete a column from a table using Microsoft Graph API.                                                                                                                    |
  | `delete-table-row`           | Delete a row from a table using Microsoft Graph API.                                                                                                                       |
  | `delete-worksheet`           | Tool to delete a worksheet from the workbook. Use when cleaning up unused or temporary sheets after verifying no dependencies exist.                                       |
  | `export-workbook-to-pdf`     | Tool to export an Excel workbook to PDF via Microsoft Graph's format conversion.                                                                                           |
  | `get-chart-axis`             | Tool to retrieve a specific axis from a chart. Use when you need properties like min, max, interval, and formatting of the chart axis.                                     |
  | `get-chart-data-labels`      | Tool to retrieve the data labels object of a chart. Use when you need to inspect label settings like position, separator, and visibility flags after...                    |
  | `get-chart-legend`           | Tool to retrieve the legend object of a chart. Use after creating or updating a chart when you need to inspect legend visibility and formatting.                           |
  | `get-range`                  | Get a range from a worksheet using Microsoft Graph API.                                                                                                                    |
  | `get-session`                | Create a session for an Excel workbook using Microsoft Graph API.                                                                                                          |
  | `get-sharepoint-range`       | Get a range from a worksheet in SharePoint using Microsoft Graph Sites API.                                                                                                |
  | `get-sharepoint-worksheet`   | Get a worksheet by name or ID from a SharePoint Excel workbook using Microsoft Graph Sites API.                                                                            |
  | `get-table-column`           | Tool to retrieve a specific column from a workbook table. Use when you need to fetch column properties and data by its ID or name.                                         |
  | `get-workbook`               | Tool to retrieve the properties and relationships of a workbook.                                                                                                           |
  | `get-worksheet`              | Get a worksheet by name or ID from an Excel workbook using Microsoft Graph API.                                                                                            |
  | `get-worksheet-used-range`   | Tool to retrieve a worksheet's used range (active data region) without specifying a fixed range address.                                                                   |
  | `insert-range`               | Tool to insert a new cell range into a worksheet, shifting existing cells down or right.                                                                                   |
  | `list-charts`                | List charts in a worksheet using Microsoft Graph API.                                                                                                                      |
  | `list-chart-series`          | Tool to list all data series in a chart. Use when you need to enumerate chart series for further analysis.                                                                 |
  | `list-comments`              | Tool to list comments in an Excel workbook. Use when you need to retrieve all workbook comments via Microsoft Graph API.                                                   |
  | `list-drive-item-children`   | Tool to list immediate children (files/folders) of a folder DriveItem using driveId and itemId.                                                                            |
  | `list-files`                 | List files and folders in a drive root or specified path.                                                                                                                  |
  | `list-named-items`           | List named items in a workbook using Microsoft Graph API.                                                                                                                  |
  | `list-sharepoint-tables`     | List tables in a SharePoint worksheet using Microsoft Graph Sites API.                                                                                                     |
  | `list-sharepoint-worksheets` | List worksheets in an Excel workbook stored in SharePoint using Microsoft Graph Sites API.                                                                                 |
  | `list-table-columns`         | List columns in a table using Microsoft Graph API.                                                                                                                         |
  | `list-table-rows`            | List rows in a table using Microsoft Graph API.                                                                                                                            |
  | `list-tables`                | List tables in a worksheet using Microsoft Graph API. This action retrieves information about all tables present in a specified worksheet of an Excel file.                |
  | `list-workbook-permissions`  | Tool to list permissions set on the workbook file. Use when you need to see which users or links have access to a specific Excel file by supplying its drive and item IDs. |
  | `list-worksheets`            | List worksheets in an Excel workbook using Microsoft Graph API.                                                                                                            |
  | `merge-cells`                | Merge cells in a worksheet range using Microsoft Graph API.                                                                                                                |
  | `protect-worksheet`          | Tool to protect a worksheet using optional protection options.                                                                                                             |
  | `search-files`               | Tool to search OneDrive drive items by query to discover Excel workbook IDs.                                                                                               |
  | `sort-range`                 | Sort a range in a worksheet using Microsoft Graph API.                                                                                                                     |
  | `update-chart`               | Update a chart in a worksheet using Microsoft Graph API.                                                                                                                   |
  | `update-chart-legend`        | Tool to update formatting or position of a chart legend. Use when adjusting legend settings after confirming chart and worksheet exist.                                    |
  | `update-range`               | Update a range in a worksheet using Microsoft Graph API.                                                                                                                   |
  | `update-sharepoint-range`    | Update a range in a SharePoint worksheet using Microsoft Graph Sites API.                                                                                                  |
  | `update-table`               | Update a table in a workbook using Microsoft Graph API.                                                                                                                    |
  | `update-worksheet`           | Update worksheet properties (name, position) in an Excel workbook using Microsoft Graph API.                                                                               |
  | `upload-workbook`            | Tool to upload an external Excel file from a URL into OneDrive/SharePoint.                                                                                                 |
</Accordion>

[Open Excel in the console →](https://app.boxd.sh/integrations/detail/excel)
