sapling README

The project's README from github.com/facebook/sapling. As one markdown file: README.md.

Sapling SCM

Sapling SCM is a cross-platform, highly scalable, Git-compatible source control system.

It aims to provide both user-friendly and powerful interfaces for users, as well as extreme scalability to deal with repositories containing many millions of files and many millions of commits.

Using Sapling

To start using Sapling, see the Getting Started page for how to clone your existing Git repositories. Checkout the Overview for a peek at the various features. Coming from Git? Checkout the Git Cheat Sheet.

Sapling also comes with an Interactive Smartlog (ISL) web UI for seeing and interacting with your repository, as well as a VS Code integrated Interactive Smartlog.

The Sapling Ecosystem

Sapling SCM is comprised of three main components:

Sapling SCM's scalability goals are to ensure that all source control operations scale with the number of files in use by a developer, and not with the size of the repository itself. This enables fast, performant developer experiences even in massive repositories with millions of files and extremely long commit histories.

Sapling CLI

The Sapling CLI, sl, was originally based on Mercurial, and shares various aspects of the UI and features of Mercurial.

The CLI code can be found in the eden/scm subdirectory.

Mononoke

Mononoke is the server-side component of Sapling SCM.

While it is used in production within Meta it is not yet supported for external usage. OSS builds in GitHub Actions are available for unsupported experimentation.

EdenFS

EdenFS is a virtual file system for managing Sapling checkouts.

While it is used in production within Meta it is not yet supported for external usage. OSS builds in GitHub Actions are available for unsupported experimentation.

EdenFS speeds up operations in large repositories by only populating working directory files on demand, as they are accessed. This makes operations like checkout much faster, in exchange for a small performance hit when first accessing new files. This is quite beneficial in large repositories where developers often only work with a small subset of the repository at a time.

More detailed EdenFS design documentation can be found at eden/fs/docs/Overview.md.

Building the Sapling CLI

The Sapling CLI currently builds and runs on Linux, Mac, and Windows. It can be built by running make oss in the eden/scm directory and running the resulting sl executable.

Building the Sapling CLI requires Python 3.8, Rust, CMake, and OpenSSL for the main cli, and Node and Yarn for the ISL web UI.

Getting in Contact

You can Report an Issue on GitHub or Join the Discord

License

The main project is licensed under GPL-2.0.

The website and ISL are licensed under MIT.

Library subprojects, such as minibytes, might have different licenses. Please refer to the LICENSE file and source code headers in each library for detailed information.

sapling (facebook/sapling)

version-control
Searching Database…

7.2K ·GitHub
What is this?Sapling is a cross-platform, Git-compatible source control system built by Meta, designed to scale to repositories with millions of files and commits while staying user-friendly.
Is this just a CLI, or more than that?It is an ecosystem of three parts: the sl command-line client (and its web-based Interactive Smartlog UI), the Mononoke server, and the EdenFS virtual filesystem for checkouts.
How do I get the Sapling CLI running?Build it by running 'make oss' inside the eden/scm directory, then run the resulting sl executable. There is also a Getting Started guide for cloning existing Git repositories.
What do I need installed to build it?You need Python 3.8, Rust, CMake, and OpenSSL for the main CLI, plus Node and Yarn if you also want to build the Interactive Smartlog (ISL) web UI.
Can I actually use Mononoke and EdenFS myself?Not for production use outside Meta — both are used internally at Meta but only buildable as OSS for unsupported experimentation; only the sl CLI is intended for general external use.
Does the CLI work on all my machines?Yes, the Sapling CLI builds and runs on Linux, Mac, and Windows.
How is Sapling related to Git?Sapling is Git-compatible — you clone your existing Git repositories into it, and it offers a Git Cheat Sheet for people switching from Git.
Why does EdenFS make large repos faster?EdenFS populates working directory files on demand as they are accessed instead of checking out everything upfront, which speeds up operations like checkout at the cost of a small first-access penalty per file.
Is there a GUI, or is it command-line only?Sapling includes the Interactive Smartlog (ISL), a web UI for viewing and interacting with your repository, plus a VS Code-integrated version of it.
Where does Sapling's CLI code come from?The sl CLI was originally based on Mercurial and still shares much of its UI and feature set; the code lives in the eden/scm subdirectory.
What are similar projects?git-bug, git, gitoxide, walgithub, gitui, git-ai, epiq, walgit
Creator
facebook
Size
528.7 MB
Stars
7.2K
Age
10y
Commits · 90 Days