Skip to main content

Quickstart

Connect your application and reach its first execution with team secrets.

Before you start

An Envshed account (the first sign-in creates it: Start free) and Node.js 18 or later.

1. Install the CLI​

terminal
npm install -g envshed

Just trying it? Run any command with npx envshed@latest instead, no install needed. See Install the CLI.

From your application folder, run:

terminal
cd ~/my-app
npx envshed@latest init

Init signs in when needed and resumes after device authorization. Reuse or create an organization/project, choose an environment and review the plan. If you started in the dashboard, copy its init command to reuse the context already chosen.

Init writes shared metadata to .envshed.json; tokens remain in your personal credential store. A monorepo or parent folder containing several applications can configure selected apps in one plan. Existing setup is reused. See init for options and recovery.

3. Prepare values and run​

Follow the guide to add values in the dashboard or explicitly import an existing file. Existing team projects can go straight to execution. Init suggests your actual application command and offers to run it with injected variables. For example:

terminal
npx envshed@latest run -- npm run dev

Replace the example with your application's command. No env file is required or created by run. The process and authorized children can still read their injected variables; avoiding an env file reduces exposure on disk without isolating those processes.

The guide can optionally integrate an existing development script after previewing the change. Starting a process and confirming the application worked are separate steps. Repeat init to resume the guide.

4. Select another environment​

terminal
npx envshed@latest env staging
npx envshed@latest branch

This saves a personal selection for the checkout, outside Git. Shared project defaults and local env files stay unchanged. For one command only, use run -e staging. Flags and ENVSHED_ENV take precedence over the saved selection. Reset it with env checkout --reset. CI ignores personal selections.

Optional file compatibility​

For tools that require files, export explicitly:

terminal
npx envshed@latest pull

The file contains plaintext values. Review overwrite prompts and keep it out of Git. See pull and the checkout migration.

Next steps​