Getting started
Go from "I just signed up" to a green pipeline building your repo. Takes about five minutes; the free tier needs no card.
1. Sign in
Auth is managed by Huudis — one account works across every Forjio product. Sign up at /signup or sign in at /login. You land on your workspace dashboard; everything below happens inside a workspace.
2. Connect a GitHub repo
Go to Dashboard → Projects → New project and enter:
- Repository — the full name, e.g.
your-org/your-repo. - Default branch — usually
mainormaster. - Config path — defaults to
.depllo-ci.yml. - Clone token (optional) — a GitHub token if the repo is private.
When you create the project, Depllo registers a webhook on the repo for
push and pull_request events. If the webhook can't be created (for
example, missing permissions), the project is still created and the
settings page offers a re-create webhook button.
3. Add a .depllo-ci.yml
Commit a config file at the repo root. A minimal one:
stages: [test, build]
variables:
NODE_ENV: test
install:
stage: test
image: node:24-bookworm
script:
- npm ci
- npm test
build:
stage: build
needs: [install]
script:
- npm run build
artifacts:
paths: [dist]
expire_in: 1 week
See the .depllo-ci.yml reference for every supported key. If you're moving off GitHub Actions, run the converter instead of writing this by hand.
4. Push — and watch it run
Push a commit (or open a pull request). The webhook fires, Depllo fetches your config at that exact SHA, creates a pipeline, and queues the jobs. Open the pipeline from the dashboard to see:
- A stage-column graph with
needsedges between jobs. - Live logs streaming as each job runs, with masked secrets.
- Artifacts to download once a job finishes.
The pipeline also posts a commit status back to GitHub under the depllo
context, and updates your status badge.
You can also trigger a run manually from the dashboard or the CLI:
depllo pipeline run your-repo --ref main
Add secrets
Under Project → Settings → Variables, add per-project variables. Mark a variable masked to hide it in logs, protected to expose it only on default-branch pipelines, or file to materialize it as a file and set the variable to its path.
What's next
- The .depllo-ci.yml reference — the full config.
- The API reference — automate everything above.
- The SDKs & CLI — the
deplloCLI and the Node SDK.