mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-10-16 04:33:16 +00:00
283eab181f
Invert the docs convention so the Mintlify-published site lives under docs/public/ and internal artifacts (strategy docs, brainstorms, plans, etc.) sit at docs/ root or docs/internal/. Tools that default to writing into docs/ now land in the catch-all instead of leaking into the published tree. - Move Mintlify content (administration/, agents/, api-reference/, changelog/, core-concepts/, examples/, execution/, getting-started/, human-tools/, integrations/, languages/, reference/, tutorials/, workflows/, images/, logo/, docs.json, favicon.svg, dot-highlight.js) into docs/public/. - Collapse docs-internal/ into docs/internal/. - Update Rust path references (fabro-api/build.rs, fabro-server, fabro-dev), TypeScript generator arg, CI path filters, clippy.toml reasons, AGENTS.md/CLAUDE.md, and README.md image refs. Mintlify dashboard project root must be updated to docs/public/ in a follow-up. .mintignore move/trim and .claude/skills/ updates land in a separate commit.
98 lines
2.3 KiB
Text
98 lines
2.3 KiB
Text
---
|
|
title: "Quick Start"
|
|
description: "Get up and running with Fabro"
|
|
---
|
|
|
|
<Note>
|
|
Fabro has two modes:
|
|
|
|
- **Standalone mode** — Run workflows directly from the CLI. This is what the quick start covers below.
|
|
- **Server mode** — An API server with a web UI for launching and managing workflow runs at scale. See [Server Mode](/administration/deploy-server) for details.
|
|
</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>
|
|
Setting up server mode instead? Run `fabro server start` to finish setup in a browser-based wizard. See [Running the Fabro Server](/administration/deploy-server) for the full flow.
|
|
</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>
|