Skip to Content
FontegoDocs

Quick start

A Fontego on your machine in Docker, a first workspace, and a synced copy of it.

This runs a Fontego in Docker on your machine, with a first workspace filled from the sample template, and syncs it into a local folder. It takes a few minutes.

You need Docker with Compose, git, and Bun 1.3.14 or newer for the CLI.

1. Get the code

The server's repository builds on the CLI's (it holds @fontego/core), so clone both side by side:

git clone https://github.com/fontego-ai/fontego-app.git
git clone https://github.com/fontego-ai/fontego-cli.git

2. Start the server

cd fontego-app
docker compose up -d --wait

It listens on http://localhost:8740, only on this machine. The data lives in a Docker volume.

3. Set it up

fontego-server init creates the server admin, the first workspace and, with --token, a token for the CLI:

docker compose exec server fontego-server init you@example.org --workspace notes --template demo --token

It prints a link to choose your password (open it to use the web app) and the token, which is shown only once. Running it again changes nothing that is already there.

4. Install the CLI

There are no packaged releases yet: run fontego from its repository.

cd ../fontego-cli && bun install
alias fontego="bun $PWD/cli/src/main.ts"
fontego version

5. Sign in and sync

fontego login http://localhost:8740 --token <the token>
fontego clone notes
cd notes

notes is now an ordinary folder. Change a file, then:

fontego status   # what you changed
fontego sync     # send it up and bring down everyone else's changes

Or leave fontego watch running, and it syncs seconds after every edit.

Instead of a token you can sign in through the browser: fontego login http://localhost:8740 opens it and waits.

Next

To take the test install down, with its data: docker compose down -v.

On this page