Skip to content

Commit 94c45bb

Browse files
committed
docs: update getting-started guide for new mantle init flow (#7)
1 parent 8a2eba1 commit 94c45bb

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

  • site/src/content/docs/getting-started

site/src/content/docs/getting-started/index.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,50 +11,50 @@ Mantle is a headless AI workflow automation platform. You define workflows as YA
1111
You need the following installed on your machine:
1212

1313
- **Go 1.25+** -- [install instructions](https://go.dev/doc/install)
14-
- **Docker and Docker Compose** -- [install instructions](https://docs.docker.com/get-docker/)
15-
- **Make** -- included on macOS and most Linux distributions
14+
15+
Optional (for automatic local Postgres provisioning):
16+
17+
- **Docker** -- [install instructions](https://docs.docker.com/get-docker/)
1618

1719
Verify your setup:
1820

1921
```bash
2022
go version # go1.25 or later
21-
docker --version
2223
```
2324

2425
## Install and Start (< 2 minutes)
2526

26-
Clone the repository, start Postgres, build the binary, and run migrations:
27+
Install the binary and initialize:
2728

2829
```bash
29-
git clone https://github.com/dvflw/mantle.git && cd mantle
30-
docker compose up -d
31-
make build
32-
./mantle init
30+
go install github.com/dvflw/mantle/cmd/mantle@latest
31+
mantle init
3332
```
3433

35-
The `docker compose up -d` command starts Postgres 16 on `localhost:5432` with user `mantle`, password `mantle`, and database `mantle`. The `make build` command produces a single `mantle` binary in the project root. The `mantle init` command creates all required database tables.
36-
37-
By default, Mantle uses `sslmode=prefer` in the database URL. This works for local development with the provided Docker Compose setup (it will connect without TLS if the server does not offer TLS). For production, always configure TLS explicitly with `sslmode=require` or `sslmode=verify-full`:
34+
`mantle init` connects to Postgres and runs migrations. If no database is reachable on localhost, it offers to start one automatically via Docker. For remote databases, set the URL before running init:
3835

3936
```bash
4037
export MANTLE_DATABASE_URL="postgres://mantle:secret@db.example.com:5432/mantle?sslmode=require"
38+
mantle init
4139
```
4240

43-
See [Configuration](/docs/configuration) for all database options.
44-
4541
You should see:
4642

4743
```
4844
Running migrations...
4945
Migrations complete.
5046
```
5147

52-
Optionally, move the binary onto your PATH:
48+
**Development setup:** If you want to build from source, clone the repository and use `make build` instead of `go install`:
5349

5450
```bash
55-
sudo mv mantle /usr/local/bin/
51+
git clone https://github.com/dvflw/mantle.git && cd mantle
52+
make build
53+
./mantle init
5654
```
5755

56+
See [Configuration](/docs/configuration) for all database options.
57+
5858
Verify it works:
5959

6060
```bash

0 commit comments

Comments
 (0)