mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-09-06 08:18:58 +00:00
b96647314c
Reframe the deployment docs around the actual product story: Fabro runs as a server, and the only deployment question is where that server runs (laptop vs self-hosted Docker). Drop the Render, Fly.io, and DigitalOcean guides and their config files; keep Railway as the managed shortcut. - New: administration/deployment.mdx (overview, two-mode framing) - New: administration/self-host-docker.mdx (compose-first how-to) - Move: administration/deploy-server.mdx -> reference/server-operations.mdx (it was operational reference, not deploy guidance) - Delete: deploy-render.mdx, deploy-fly-io.mdx, deploy-digital-ocean.mdx - Delete: render.yaml, fly.toml, railway.toml, Dockerfile.deploy - docker-compose.yaml: load .env if present so users can drive the stack from a single env file end-to-end - Update internal links and the docs-test that pinned the old path
95 lines
2.3 KiB
Text
95 lines
2.3 KiB
Text
---
|
|
title: "Quick Start"
|
|
description: "Get up and running with Fabro"
|
|
---
|
|
|
|
<Note>
|
|
Fabro runs as a server. This quickstart runs everything locally on your laptop — no deployment required. To self-host the server for a team or 24/7 workflows, see [Deployment](/administration/deployment).
|
|
</Note>
|
|
|
|
## Supported platforms
|
|
|
|
| OS | Architecture | Supported |
|
|
| --- | --- | --- |
|
|
| Linux | x86_64 | Yes |
|
|
| Linux | arm64 (aarch64) | Yes |
|
|
| macOS | arm64 (Apple Silicon) | Yes |
|
|
| macOS | x86_64 (Intel) | No |
|
|
| Windows | any | No |
|
|
|
|
<Note>
|
|
On Intel Macs, run Fabro in a Linux x86_64 container or VM. Native Windows isn't supported; use WSL2 with a supported Linux architecture.
|
|
</Note>
|
|
|
|
## Install
|
|
|
|
<Tabs>
|
|
<Tab title="Claude Code">
|
|
```bash
|
|
curl -fsSL https://fabro.sh/install.md | claude
|
|
```
|
|
</Tab>
|
|
<Tab title="Codex">
|
|
```bash
|
|
codex "$(curl -fsSL https://fabro.sh/install.md)"
|
|
```
|
|
</Tab>
|
|
<Tab title="Homebrew">
|
|
```bash
|
|
brew install fabro-sh/tap/fabro-nightly
|
|
```
|
|
</Tab>
|
|
<Tab title="Bash">
|
|
```bash
|
|
curl -fsSL https://fabro.sh/install.sh | bash
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<Tip>
|
|
Release binaries and the multi-arch Docker image ship with [SLSA Build Provenance](/reference/verifying-releases) attestations you can verify with `gh attestation verify`.
|
|
</Tip>
|
|
|
|
<Note>
|
|
Self-hosting the server? See [Self-host with Docker](/administration/self-host-docker) and [Server Operations](/reference/server-operations) for the install wizard, auth, and CLI-pointing.
|
|
</Note>
|
|
|
|
## Initialize your project
|
|
|
|
```bash
|
|
cd my-repo/
|
|
fabro repo init
|
|
```
|
|
|
|
This creates `.fabro/project.toml` and a starter workflow under `.fabro/workflows/hello/`.
|
|
|
|
## Configure API keys
|
|
|
|
Add at least one LLM provider key:
|
|
|
|
```bash
|
|
ANTHROPIC_API_KEY=sk-ant-...
|
|
OPENAI_API_KEY=sk-...
|
|
GEMINI_API_KEY=AI...
|
|
```
|
|
|
|
<Note>
|
|
You only need one provider key to get started. Add more to enable multi-model workflows.
|
|
</Note>
|
|
|
|
## Run your first workflow
|
|
|
|
```bash
|
|
fabro run hello
|
|
```
|
|
|
|
## Next steps
|
|
|
|
<Columns cols={2}>
|
|
<Card title="Why Fabro?" icon="lightbulb" href="/getting-started/why-fabro">
|
|
Understand the problems Fabro solves.
|
|
</Card>
|
|
<Card title="Workflows" icon="diagram-project" href="/core-concepts/workflows">
|
|
Learn how to define workflow graphs in Graphviz.
|
|
</Card>
|
|
</Columns>
|