Skip to content

Search

Documentation

Your first Forge build

Register a repository with Forge, pick the platforms, build it, and download the result — about five minutes, most of it the build.

Ezen az oldalon

Before you start

  • An account. Register, or Log in with GitHub.
  • A Balaur project at the root of a repository. Forge exports the repository's root, so project.toml has to be there, not in a subfolder.
  • The project exports on your machine. If balaur export . --target linux-x64 fails locally, it fails on Forge for the same reason, and it is quicker to find out at your desk.

1. Register the repository

Open Projects and press New project. It asks for the repository and nothing else, two ways:

  • From GitHub, the default: for a private repository, or any repository you want built on every push. It needs the Forge App installed; the page walks you through it, and Connecting GitHub explains what the App can see.
  • By URL: a public https:// repository, cloned anonymously. Builds start when you ask, not on push.

The project is named after the repository, builds its default branch (main for a URL), and has every target on. Registering opens its Settings tab, where all three change, and the next build uses them. A target with no signing set up yet builds unsigned and says so.

The eight targets are linux-x64, linux-arm64, macos-universal, windows-x64, windows-arm64, ios, android and web. Builds and artifacts says what each one produces. For a first build, turning every target off but linux-x64 in Settings is the fastest way to see everything work.

2. Build it

On Projects, press Build now on the project's card, or on its dashboard. You land on the build's page: one card per target, and the build's output underneath, streaming as it runs — the clone first, then the export.

A target goes queued → running → succeeded or failed. Targets build independently, so a failed ios does not stop linux-x64.

3. Download

A succeeded target has a Download button. Its badge says whether it was signed; the first build almost certainly was not, and says what it would need. Downloads are kept for 30 days.

Next