Documentation

Install the CLI, learn the model and look up every command.

Reference

.storeenv.json

Every field of the project file.

Reference 1 min read

Safe to commit: it never contains secrets, keys or tokens.

versionWhole number. Missing means version 1 (CLI 0.1). A newer version than the CLI knows is read for the fields it knows and never rewritten.
projectprj_ and 24 hex characters. The project's identity: renames don't change it.
namenamespace/name, for people reading the file. If the project was renamed, the CLI says so and still uses project.
filesPath (relative, inside the folder) to environment name. Mapped files are pushed even if their name isn't .env*.
branchesBranch name, prefix/* or * to environment name. Used only by pull and run.
ignoreExtra paths to skip when looking for env files.
writersPeople whose signed values this repository trusts, as "@login=SE:XXXX-XXXX-XXXX". Reviewed in the repository, out of the server's reach. A listed writer whose key changes is refused until the list is updated.
importsReserved for reviewing imports in code review. The server is the source of truth (storeenv import).

Environment names: lower case letters, digits, - and _, up to 32 characters. Unknown top level fields are kept when the CLI rewrites the file, with a notice.

Upgrading from 0.1

A 0.1 file (localId, ignore, environments) is read as is. The first time a current CLI writes it (init, link, unlink), it becomes version 2: environments is copied to files and kept as a mirror for 0.1 clients. The original is saved once as .storeenv.json.bak.