Mach5 One Quickstart

This quickstart starts Mach5 One, opens the API reference, and connects to the SQL and MCP endpoints.

This page covers the Mach5 One local runtime path. The features reached through these endpoints are common Mach5 features shared across editions.


1. Initialize config

mach5-one init

2. Start Mach5 One

mach5-one start

The server prints its resolved configuration and endpoints:

mach5-one ready at http://127.0.0.1:8080
  config:       ~/.mach5-one/mach5-one.toml
  data:         ~/.mach5-one/data
  HTTP + MCP:   127.0.0.1:8080
  PostgreSQL:   127.0.0.1:5432
  msearch:      127.0.0.1:8081 (unnested)
  body limit:   209715200 bytes
  memory budget: <derived from host/cgroup>
  WARNING: authentication is disabled; every client is granted administrator access

The banner shows the REAL bind addresses and active config/data paths. All listeners bind before the banner prints; a port conflict fails startup with the conflicting address instead of printing ready. See the network exposure section for the authentication warning and remote-access opt-in.


3. Check the server

curl http://localhost:8080/version.txt
curl http://localhost:8080/session

Open the API reference:

http://localhost:8080/apis/rapidoc

Open the OpenAPI document:

http://localhost:8080/apis/openapi.json

4. Open Data Explorer

If Data Explorer assets are configured, open:

http://localhost:8080/

See configuration.md for ui.dex_dist_path.


5. Connect with SQL

Mach5 One exposes a PostgreSQL-compatible endpoint on the configured pg_port.

Example:

psql -h localhost -p 5432 -U local -d default

Run SQL from your PostgreSQL-compatible client after creating or loading data through Data Explorer or the Mach5 APIs.


6. Connect an agent through MCP

MCP endpoint:

http://localhost:8080/mcp

See mcp.md and agent-quickstart.md.


7. Stop Mach5 One

Press Ctrl-C in the terminal running mach5-one start, or send SIGTERM to the process.


What to do next

Analytics Cookies

Help us understand website usage.

Necessary storage remembers your choice. With your consent, Mach5 also uses PostHog analytics to measure website traffic and interactions.

Change this anytime from Cookie Settings in the footer. Privacy Notice.