Skip to main content

Project Config (.envshed.json)

The project config file stores defaults for the current project so you don't need to pass flags on every command.

Location

The CLI searches for .envshed.json starting from the current directory and walking up to the filesystem root. This means it works from any subdirectory of your project.

Format

{
"org": "my-org",
"project": "my-project",
"defaultEnv": "development",
"apiUrl": "http://localhost:3000"
}
FieldDescriptionRequired
orgOrganization slugYes
projectProject slugYes
defaultEnvDefault environment slugNo
apiUrlAPI URL override (for local development)No

Creating the file

Use envshed init to generate the file:

envshed init -o my-org -p my-project -e development

Or create it manually. The web dashboard also provides a copyable config snippet under the CLI Config button on the project page.

Switching environments

Use envshed env to change the defaultEnv without editing the file:

envshed env staging

Git

Add .envshed.json to your repository so all team members share the same project config. The file does not contain secrets.