Skip to content

gy.json reference

When you run gy deploy, the CLI writes a .gy.json file to your project root. It records how the app was deployed so subsequent commands can find it automatically.

{
"app": "my-cool-api",
"project": "default",
"port": 3000,
"publicAccess": true,
"tier": "t1",
"env": {
"DATABASE_URL": "postgres://…",
"DEBUG": "false"
}
}
Field Type Description
app string Friendly app name
project string Friendly project name
port number Port the app listens on
publicAccess boolean | object Whether the app is public; may include the assigned domain
tier string Resource tier: t1, t2, or t3
env object Environment variables as key/value pairs

.gy.json contains friendly names only. The CLI resolves internal UUIDs itself, so you never have to look at or copy an identifier.

You can edit .gy.json directly, then push changes with:

Terminal window
gy config sync

However, using gy config set / gy config unset is safer — it validates values and keeps the file in sync with the server.