Documentation

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

Concepts

Projects, services and environments

How your code maps to StoreEnv.

Concepts 1 min read

If you know Git, you know StoreEnv. A project has its own id, kept in a .storeenv.json committed with your code; remotes are optional hints.

Git and StoreEnv

RepositoryProject (namespace/name, its own id in a committed .storeenv.json)
RemoteOptional link: GitHub, GitLab, Gitea or any host, or none
FolderService (frontend/, backend/, root)
BranchEnvironment, picked by an optional branch rule
CommitSigned version (author, message, changed keys)
Submodule / dependencyImport from a library or another project
push / pull / clonestoreenv push / pull / init

Files, services and environments

Folder with an env fileService. backend/.env belongs to backend. The folder root is called root. Nested folders keep their path, such as apps/web.
.envThe default environment.
.env.<suffix>An environment named after the suffix. prod becomes production, dev becomes development.
.env.example, .env.sample, .env.templateNot pushed. They are compared against the generated template.

Ignored folders

node_modules, .git, dist, build, .next, coverage, vendor and .venv are skipped. Add more under "ignore" in .storeenv.json.