register

Edit this page

The register command creates a new project in your Upstash Redis database or connects a local directory to an existing project.

Usage#

redenv register <project> [environment]

Arguments#

Name	Required	Description
`project`	Yes	The project name
`environment`	No	Initial environment (default: `development`)

Options#

Flag	Description	Default
`-l, --history-limit <n>`	Number of version history entries to keep	`10`

Examples#

Register a new project#

redenv register my-awesome-app

Register with a specific environment#

redenv register my-app production

Register with custom history limit#

redenv register my-app --history-limit 25

Interactive Flow#

New Project#

$ redenv register my-app

Creating new project "my-app"...
? Create a Master Password for project "my-app": ********
? Confirm Master Password: ********

✔ Project "my-app" registered and encrypted successfully!
  Remember your Master Password. It cannot be recovered.

Existing Project#

$ redenv register my-app

Project "my-app" already exists remotely.
? Enter your Master Password: ********

✔ Successfully connected local directory to project "my-app".

What Gets Created#

After registering, a redenv.config.ts file is created in your project directory:

redenv.config.ts

import { defineConfig } from "@redenv/core";

export default defineConfig({
  name: "my-app",
  environment: "development",
});

Info

This config file is safe to commit to git, it contains no secrets.

Master Password#

Error

CRITICAL: Your Master Password is the only key to decrypt your secrets. If lost, your secrets cannot be recovered. Store it in a password manager.

The Master Password:

Is never stored anywhere (not in Redis, not on disk)
Is used to derive the encryption key for your secrets
Can be temporarily cached in your system keychain during CLI sessions

setup - Configure Upstash credentials first
add - Add secrets after registration
switch - Switch environments
drop - Delete a project