Documentation

cli

init

Generate a runix.yaml configuration template in your project.

runix init#

Creates a runix.yaml file in the current directory with a starter template. This file defines your services, databases, and configuration.

bash
$ runix init
Created runix.yaml
Edit it to define your services, then run `runix deploy`.

The generated template looks like this:

runix.yaml
yaml
name: my-app
services:
  - name: api
    type: web-service
    repo: https://github.com/user/api
    branch: main
    env:
      PORT: "8080"
      NODE_ENV: production

  - name: db
    type: postgresql

Edit the template to match your project. Change the repo URL, service name, and environment variables before deploying.

If a runix.yaml already exists in the directory, the command will not overwrite it.

If the file already exists

bash
$ runix init
runix.yaml already exists in this directory.