Esta página aún no está traducida; se muestra la versión en inglés.

Beta Próximamente. Esta función aún está en desarrollo; los nombres y detalles pueden cambiar antes del lanzamiento.

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" }
  ]
}
FieldMeaning
installruns first and must succeed, for example npm ci
starta background service to start, for example a database
terminalslong-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:

  1. install runs in the project root. Ingot waits for it, up to 15 minutes.
  2. If it fails, nothing else starts: .ingot/environment.json: install failed (npm ci). Start and terminals were not run.
  3. Otherwise start and 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.

These commands run with your permissions, like any script in the repository. Read environment.json in projects you didn't write before running it.