Skip to main content
Work in Progress: This SDK is currently under active development. The API is subject to change and may introduce breaking changes in future releases.

Getting Started

@upstash/context7-sdk is a TypeScript SDK for Context7, enabling easier access to library documentation with full type coverage. Using @upstash/context7-sdk you can:
  • Search across available libraries
  • Get documentation context for any library
  • Access library metadata including trust scores and versions
You can find the Github Repository here.

Install

Usage

Initializing the Client

To use the Context7 SDK, you need an API key. You can get your API key from the Context7 Dashboard.

Using environment variables

The SDK automatically reads from environment variables if no API key is provided in the config:
When an environment variable is set, you can initialize the client without any parameters:

Using a configuration object

If you prefer to pass configuration in code, the constructor accepts a config object containing the apiKey value. This could be useful if your application needs to interact with multiple projects, each with a different configuration.
The SDK checks for API keys in this order: 1. config.apiKey (if provided) 2. process.env.CONTEXT7_API_KEY

Quick Start Example

Error Handling

The SDK throws Context7Error for API errors:

Next Steps

Explore the SDK commands: