Project environment
Describe how to set up and start your project once, in .ingot/environment.json. Ingot runs it for you with one command, and agents read it so they know how to install, start and run the project.
environment.json
{
"install": "npm ci",
"start": "docker compose up -d",
"terminals": [
{ "name": "web", "command": "npm run dev", "description": "Vite dev server" },
{ "name": "worker", "command": "npm run worker" }
]
}
| Field | Meaning |
|---|---|
install | runs first and must succeed, for example npm ci |
start | a background service to start, for example a database |
terminals | long-running processes, each with a command and an optional name and description |
All fields are optional, but each terminal needs a command. Commit the file so the whole team sets up the same way.
Install and start
Run Project Environment: Install and Start from the command palette:
installruns in the project root. Ingot waits for it, up to 15 minutes.- If it fails, nothing else starts:
.ingot/environment.json: install failed (npm ci). Start and terminals were not run. - Otherwise
startand every terminal command start together as background processes, listed under Processes.
.ingot/environment.json: installed, started 3 process(es).
What agents see
Every agent turn includes a short note, so the agent runs the right commands instead of guessing:
Project environment (.ingot/environment.json):
- install: `npm ci`
- start: `docker compose up -d`
- web: `npm run dev` (Vite dev server)
Existing .cursor/environment.json
If the project has no .ingot/environment.json, Ingot reads .cursor/environment.json when the project keeps its .cursor setup (Import an existing setup). Its snapshot and build fields are ignored.
environment.json in projects you didn't write before running it.