Skip to content

CLI reference ​

A reference of the yomia commands. Run yomia <command> --help for the full set of flags.

Account ​

sh
yomia login       # approve a code in your browser
yomia logout      # sign out and revoke the token on the server
yomia balance     # account balance
yomia plans       # available plans

Projects & environments ​

sh
yomia init <project>              # create a project (with production) and link this folder
yomia link <project> [--env <e>]  # link this folder to an existing project/environment
yomia status                      # what the current folder is linked to
yomia projects                    # list projects
yomia graph                       # services and the references between them

yomia environment new <name>      # create an empty environment
yomia environment use <name>      # switch the active environment

Deploy & apps ​

sh
yomia deploy <app>                                  # build this folder and deploy it
yomia deploy <app> --image <image> --port <port>    # deploy a prebuilt image
yomia deploy <app> --repo <owner/repo>              # deploy from a Git repo
yomia deploy <app> --repo <url> --branch <b> --path <subdir>
yomia deploy <app> --plan basic                     # update; unset flags keep current values
yomia deploy <app> --private                        # no public URL

yomia apps                        # list apps and status
yomia apps show <app>             # details for one app
yomia apps -e production          # target an environment
yomia apps delete <app>           # delete an app
yomia logs <app> [-f] [--since 30m]

Environment variables ​

sh
yomia env set <app> KEY=value           # set (restarts the app)
echo "$SECRET" | yomia env set <app> KEY=-   # read value from stdin
yomia env set <app> --from-file .env.production
yomia env set <app> 'URL=${{postgres.DATABASE_URL}}'   # reference another service
yomia env list <app>                    # names, versions, who changed them
yomia env history <app>
yomia env unset <app> KEY

Databases & volumes ​

sh
yomia add postgres                      # managed Postgres
yomia volumes add -s <app> -m /data     # attach a volume at a mount path
yomia volumes ls

Domains ​

sh
yomia domain public <app>               # give the app a public URL
yomia domain private <app>              # make it private
yomia domain add <app> shop.example.com # custom domain (prints DNS records)

Global flags ​

Most commands accept:

--project <name>    override the linked project
--env <name>        override the linked environment

Released under the MIT License.