Documentation

Build with your secrets in reach.

Use the guides and examples below to understand the Top Secrete workflow and get started with an SDK for your language.

Quick start

The basic integration pattern

1. Create a project. Open the Top Secrete console and create a project for your application.
2. Choose an environment. Use the environment that matches the application instance you are setting up.
3. Add a named secret. For example, add a value named DATABASE_URL.
4. Initialize the SDK. Select the example for your language and retrieve the secret by name.

retrieve-secret

import { TopSecrete } from "@topsecrete/sdk";

const secrets = new TopSecrete({
  project: "edgipay-api",
  environment: "production",
});

const databaseUrl = await secrets.get("DATABASE_URL");

Illustrative SDK usage · see the documentation for package setup.

SDK languages

Choose the SDK that matches your application language. The code selector above includes an illustrative retrieval example for each supported language.

TypeScript

Typed JavaScript projects

JavaScript

JavaScript applications

Go services and APIs

Python

Python applications

Core concepts

Project

A named workspace for an application or service.

Environment

A context such as development, staging, or production.

Secret name

The key used by your application to request a value.

SDK

A language-specific library that provides a developer interface for retrieving secrets.

Need help getting started?

Contact Top Secrete