Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gateways.app/llms.txt

Use this file to discover all available pages before exploring further.

Initialize a local app or static site directory before you push it with the Gateways CLI. The init command writes .gateways.yaml in the current directory.

​
Steps

Run these commands from the app or site folder you want to deploy.
1

Open your working project directory

cd my-repo
2

Initialize the Gateways project file

Pass the Gateways project slug and environment slug as project/environment.
gateways init my-app/production
To upload from a subdirectory by default, pass it as the optional second argument:
gateways init my-app/production dist
3

Sign in if needed

init checks that the project and environment exist and that your account has access.
gateways login
4

Check the generated file

gateways status
If .gateways.yaml already exists, init updates project, environment, and optional path while preserving fields like email, push_resource, start_commands, and ignore.
5

Push or pick a target

The first push can open a picker for upload apps or static sites. The chosen target is saved so future pushes can reuse it.
gateways push

​
What gets written

A minimal project file looks like this: 
project: my-app
environment: production
path: dist
See Project file for all supported .gateways.yaml fields and a fuller example.