tigerfs

(β˜… 686)

Mount PostgreSQL as a filesystem. Build apps with files, explore databases with ls and cat. Every write is logged and undoable.

  • .gitignore
  • .goreleaser.yaml
  • CHANGELOG.md
  • CLAUDE.md
  • Dockerfile
  • go.mod
  • go.sum
  • LICENSE
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/timescale/tigerfs

Downloads the entire project code from GitHub to your computer.

cd tigerfs

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
curl -fsSL https://install.tigerfs.io | sh

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
./demo.sh start # auto-detects platform (--docker or --mac)

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build -o bin/tigerfs-stress ./test/stress

Compiles the Go program into an executable.

go build -o bin/tigerfs ./cmd/tigerfs

Compiles the Go program into an executable.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

// repository documentation