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

Was this helpful?

Edit on GitHub
  1. Getting Started

Running your app

Use keyshade CLI to run your app

PreviousAdd keyshade to your projectNextIntroduction

Last updated 13 days ago

Was this helpful?

In te previous section, we added keyshade to our project. Now, let's run our app.

Generally we run NextJS apps using the npm run dev command. But to make keyshade work, we will need to run it using this command:

keyshade run "npm run dev"

Note: In case you have used something else in place of NextJS, use the same command to run your app. For example, if you have used a simple NodeJS app, you could use keyshade run "node index.js"

Once you run this, you would see the following output:

As you can see, there are some additional logs stating that keyshade was successfully set up.

You can also see the following line:

[INFO] 2025-04-27 17:25:03 - Fetched 2 configurations (1 secrets, 1 variables)

This states that keyshade was able to fetch 2 configurations - 1 secret and 1 variable.

Seeing the results

We have successfully added keyshade to our project. Now, let's see the results.

Head over to http://localhost:3000 and you should see the following:

The app has fetched the secret and variable from keyshade and injected them into the app.

That's it! You have successfully added keyshade to your project.

output
output