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

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

# docs

Documentation search for B2C Commerce Script API.

Provides functions for downloading documentation from B2C instances
and searching bundled documentation locally.

## Download Documentation

Use [downloadDocs](functions/downloadDocs.md) to download documentation from a B2C instance:

```typescript
import { downloadDocs } from '@salesforce/b2c-tooling-sdk/docs';
import { B2CInstance } from '@salesforce/b2c-tooling-sdk';

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

## Search Bundled Docs

Use [searchDocs](functions/searchDocs.md) and [readDocByQuery](functions/readDocByQuery.md) to search and read bundled documentation:

```typescript
import { searchDocs, readDocByQuery } from '@salesforce/b2c-tooling-sdk/docs';

// Search for documentation
const results = searchDocs('ProductMgr');
results.forEach(r => console.log(r.entry.id, r.score));

// Read a specific doc by fuzzy query
const doc = readDocByQuery('dw.catalog.ProductMgr');
if (doc) {
  console.log(doc.content);
}
```

## Interfaces

- [DocEntry](interfaces/DocEntry.md)
- [DownloadDocsOptions](interfaces/DownloadDocsOptions.md)
- [DownloadDocsResult](interfaces/DownloadDocsResult.md)
- [SchemaEntry](interfaces/SchemaEntry.md)
- [SchemaIndex](interfaces/SchemaIndex.md)
- [SchemaSearchResult](interfaces/SchemaSearchResult.md)
- [SearchIndex](interfaces/SearchIndex.md)
- [SearchResult](interfaces/SearchResult.md)

## Functions

- [downloadDocs](functions/downloadDocs.md)
- [listDocs](functions/listDocs.md)
- [listSchemas](functions/listSchemas.md)
- [loadSearchIndex](functions/loadSearchIndex.md)
- [readDoc](functions/readDoc.md)
- [readDocByQuery](functions/readDocByQuery.md)
- [readSchema](functions/readSchema.md)
- [readSchemaByQuery](functions/readSchemaByQuery.md)
- [searchDocs](functions/searchDocs.md)
- [searchSchemas](functions/searchSchemas.md)