---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [docs](../index.md) / downloadDocs

# Function: downloadDocs()

> **downloadDocs**(`instance`, `options`): `Promise`\<[`DownloadDocsResult`](../interfaces/DownloadDocsResult.md)\>

Defined in: [packages/b2c-tooling-sdk/src/docs/download.ts:59](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/docs/download.ts#L59)

Downloads documentation archive from a B2C instance.

The archive is available at a special URL:
`https://{hostname}:443/on/demandware.servlet/WFS/Studio/Sites/mock/demandware-mock.zip`

The outer zip contains `DWAPP-*.API-doc.zip` which contains `sfdocs/script-api/` with markdown docs.

## Parameters

### instance

[`B2CInstance`](../../instance/classes/B2CInstance.md)

B2C instance to download from

### options

[`DownloadDocsOptions`](../interfaces/DownloadDocsOptions.md)

Download options

## Returns

`Promise`\<[`DownloadDocsResult`](../interfaces/DownloadDocsResult.md)\>

Download result with extraction details

## Throws

Error if download fails or credentials are missing

## Example

```typescript
const instance = B2CInstance.fromEnvironment();
const result = await downloadDocs(instance, {
  outputDir: './docs',
  keepArchive: true,
});
console.log(`Downloaded ${result.fileCount} files`);
```
