Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,16 @@ Fawx is a local-first agentic engine. It runs on your machine, calls LLMs for re
## Quick Start

```bash
# Build
git clone https://github.com/fawxai/fawx.git
cd fawx && cargo build --release
cd fawx
./scripts/install.sh

# Configure (interactive wizard)
./target/release/fawx setup

# Run
./target/release/fawx serve
fawx setup
fawx serve
```

This builds from source, installs the `fawx` binary to `~/.local/bin/`, and walks you through configuration. Set `INSTALL_DIR` to change the install location.

Bring your own API key (Anthropic, OpenAI, or local models). Fawx never sends data anywhere except the LLM provider you choose.

---
Expand Down
31 changes: 31 additions & 0 deletions scripts/install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#!/usr/bin/env bash
set -euo pipefail

REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
INSTALL_DIR="${INSTALL_DIR:-$HOME/.local/bin}"

main() {
echo "Building Fawx..."
cd "$REPO_ROOT"
cargo build --release -p fx-cli

echo "Installing to $INSTALL_DIR..."
mkdir -p "$INSTALL_DIR"
cp "target/release/fawx" "$INSTALL_DIR/fawx"
chmod +x "$INSTALL_DIR/fawx"

if ! echo "$PATH" | tr ':' '\n' | grep -qx "$INSTALL_DIR"; then
echo ""
echo "⚠ $INSTALL_DIR is not in your PATH."
echo " Add it to your shell profile:"
echo ""
echo " export PATH=\"$INSTALL_DIR:\$PATH\""
echo ""
echo " Then restart your shell or run: source ~/.bashrc"
fi

echo ""
echo "✓ Fawx installed. Run: fawx setup"
}

main "$@"
Loading