Keyshade Alpha is launching April 30th 5:00 PM IST
Join our Launch Party
keyshade docs
GithubDiscordReddit
  • 👋What is keyshade?
  • Getting Started
    • Introduction
    • Adding your first secret and variable
    • Installing the CLI
    • Setting up your profile
    • Add keyshade to your project
    • Running your app
  • CLI
    • Introduction
    • Profile
    • Init
    • Workspace
    • Project
    • Environment
    • Run
    • Scan
  • 🥰CONTRIBUTING TO KEYSHADE
    • Summary
    • Design of our code
      • Organization of code
      • API
      • CLI
      • Web
      • Integrations
    • Prerequisites
    • Environment Variables
    • Setting things up
    • Running things locally
      • Running the API
      • Running the Web
      • Running the Platform
      • Running the CLI
      • API Testing
      • Docker Support
  • Internals
    • Architecture of keyshade
    • How the CLI works
Powered by GitBook
On this page
  • Creating a new project
  • Creating a secret
  • Creating a variable
  • That's it!

Was this helpful?

Edit on GitHub
  1. Getting Started

Adding your first secret and variable

Get to know about our platform

PreviousIntroductionNextInstalling the CLI

Last updated 13 days ago

Was this helpful?

Our app is the place where you manage all of your secrets and variables. This can also be done using the CLI, but we want to keep it as simple as possible for now. Here's a list of things that we will be doing in this tutorial:

  • Creating a new project

  • Creating a secret in your project

  • Creating a variable in your project

So, let's get started!

Creating a new project

Head over to . This is where you get to access our platform. Log in with your email, or your favourite OAuth provider. Once inside, you should be greeted with a similar page like this:

Now, we can start creating our project.

  • Click on Create Project

  • Enter your project name

  • Optionally, you can store the private key in the project (not recommended in production projects)

  • Edit or add environments if your want to

  • Finally, click on Create Project

Your project should now show up in your dashboard:

Creating a secret

Now, let's create our first secret.

  • Select the newly created My App project.

  • Head over to the Secrets tab.

  • Enter the name of the secret. We will use NEXT_PUBLIC_API_KEY. You can also add a note if you want to.

  • Specify a value for the dev environment we created. We would use ks_1234.

  • Hit on Add Secret.

If created successfully, you secret should look like this:

Creating a variable

Lastly, let's create our first variable.

  • Head over to the Variables tab.

  • Enter the name of the variable. We will use NEXT_PUBLIC_PORT. You can also add a note if you want to.

  • Specify a value for the dev environment we created. We would use 3000.

  • Hit on Add Variable.

If created successfully, you variable should look like this:

That's it!

We are now in a pretty good shape. We have added our first secret and variable. Now, lets get the CLI installed and set up locally.

If the creation was successful, you should be greeted with a dialog like this: You can download the private and public key then hit on Close.

https://app.keyshade.xyz
Dashboard
Dashboard
Success
Success