Skip to main content

local-preview

Test status Deploy Status Docs Go Reference PyPI

A local-first preview-deployment orchestrator: every commit of a registered git repository becomes a servable preview at its own subdomain (<sha>-<repo>.preview.localhost:8080), built once, deduplicated by content, and served from a single binary.

local-preview resolves each commit into a (frontend artifact, backend artifact) pair by content-addressing the relevant subtrees. Commits that don't touch the frontend (or backend) reuse the existing artifact — and the already-running backend process. Backend state follows git lineage: a new backend version forks its data from the nearest deployed ancestor, so previews feel continuous on a straight line of commits while divergent branches can never corrupt each other.

Install

uv tool install local-preview

This installs the binary to ~/.local/bin/preview. Make sure to have that on your PATH.

Run

preview serve

The server listens on :8080. Open http://localhost:8080/ for the dashboard.

Or with Docker Compose:

docker compose up -d

📖 Documentation

Full documentation lives at https://jmelahman.github.io/local-preview/:

  • Quickstart — register a repo, deploy a commit, open the preview.
  • Configuration — flags and env vars.
  • REST API — endpoints exposed by the running server.
  • CLIserve, repo, deploy, install-hook.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

local_preview-0.10.1-py3-none-manylinux_2_17_x86_64.whl (7.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

local_preview-0.10.1-py3-none-manylinux_2_17_aarch64.whl (6.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

local_preview-0.10.1-py3-none-macosx_11_0_arm64.whl (6.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

local_preview-0.10.1-py3-none-macosx_10_12_x86_64.whl (7.3 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

local_preview-0.10.1-py3-none-any.whl (7.2 MB view details)

Uploaded Python 3

File details

Details for the file local_preview-0.10.1-py3-none-manylinux_2_17_x86_64.whl.

File metadata

  • Download URL: local_preview-0.10.1-py3-none-manylinux_2_17_x86_64.whl
  • Upload date:
  • Size: 7.2 MB
  • Tags: Python 3, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for local_preview-0.10.1-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 0014223a090491636b16aff1cfb59b654c61e72fa11eb08fc4ff328c3adbf9f5
MD5 41b5957361e6f39bd5a4473102aad030
BLAKE2b-256 c81f8b219d572b3737d94933bf4f84de7aecca0bfc96377cbada71a0a04b9754

See more details on using hashes here.

File details

Details for the file local_preview-0.10.1-py3-none-manylinux_2_17_aarch64.whl.

File metadata

  • Download URL: local_preview-0.10.1-py3-none-manylinux_2_17_aarch64.whl
  • Upload date:
  • Size: 6.7 MB
  • Tags: Python 3, manylinux: glibc 2.17+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for local_preview-0.10.1-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 d90b699c5eda9a60c7fdefee8b3bd5778d11b1cb157feefb6b3935b6d8844c43
MD5 4a45bd164161f302190c3f076ef96d3a
BLAKE2b-256 62a5f3c7a1095da12553041bd4a63ea5dd02dee51b595f8fa972bdb4239fe61f

See more details on using hashes here.

File details

Details for the file local_preview-0.10.1-py3-none-macosx_11_0_arm64.whl.

File metadata

  • Download URL: local_preview-0.10.1-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 6.9 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for local_preview-0.10.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a0d8694fac9ef6252f80e26a02bbcdd444da5b77ac86ae9aa4b86f37105a68a8
MD5 cc61b6aedebbfdc1451d33d82d63e6e1
BLAKE2b-256 245b6d2c26da68a32cb0768161a7060773c8bc3ead0f8e5d3c7d933202b94d7e

See more details on using hashes here.

File details

Details for the file local_preview-0.10.1-py3-none-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: local_preview-0.10.1-py3-none-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 7.3 MB
  • Tags: Python 3, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for local_preview-0.10.1-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 e3efee1273d17d8fd26f4ac41295f114cfd6496bf7e81b4a351f3054e9c1fa61
MD5 10402ccf79874dcfe1badb15cd5fedf5
BLAKE2b-256 4d98514c0fe72cc25d1b6f042512e38911dbdb35c328975105b5decfb921df4f

See more details on using hashes here.

File details

Details for the file local_preview-0.10.1-py3-none-any.whl.

File metadata

  • Download URL: local_preview-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 7.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for local_preview-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d86ecdee9b6480969d68421cef6a6d1c7464605e0419a6a91357cbc90a6616b8
MD5 ed23e652df2b2c5494423838466c5ebc
BLAKE2b-256 e5f48cebfc577c0a638a28d68936846e2180df71915a5aabbc97225f637521c0

See more details on using hashes here.

Release history Release notifications | RSS feed

0.23.0

5 files

0.22.0

5 files

0.21.0

5 files

0.20.0

5 files

0.19.0

5 files

0.18.2

5 files

0.18.1

5 files

0.18.0

5 files

0.17.1

5 files

0.17.0

5 files

0.16.0

5 files

0.15.0

5 files

0.14.3

5 files

0.14.2

5 files

0.14.1

5 files

0.14.0

5 files

0.13.2

5 files

0.13.1

5 files

0.13.0

5 files

0.12.0

5 files

0.11.1

5 files

0.11.0

5 files

0.10.2

5 files

This release

0.10.1 This release

5 files

0.10.0

5 files

0.9.0

5 files

0.8.2

5 files

0.8.1

5 files

0.8.0

5 files

0.7.0

5 files

0.6.0

5 files

0.5.0

5 files

0.4.0

5 files

0.3.0

5 files

0.2.2

5 files

0.2.0

5 files

0.1.8

5 files

0.1.7

5 files

0.1.4

5 files

0.1.3

5 files

0.1.2

5 files

0.1.1

5 files

0.1.0

5 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page