sapling README

项目的 README,来自 github.com/meta/sapling。合并为一个 markdown 文件: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.

Building EdenFS

EdenFS builds on Linux with CMake 3.28 or newer, Ninja, Rust and GCC 14 or newer. The build fetches folly, fbthrift and the rest of EdenFS's C++ dependencies when they aren't installed. On Ubuntu 24.04, install the libraries it doesn't fetch with:

sudo apt-get install -y libclang-dev libcurl4-openssl-dev libevent-dev libgflags-dev libre2-dev libsodium-dev libssl-dev libxxhash-dev libzstd-dev ninja-build pkg-config zlib1g-dev

For the Python CLI and tests, install the fbthrift-python wheel and the toml, filelock, psutil and parameterized modules in the Python environment CMake uses.

Then, from the repository root:

export CC=gcc-14 CXX=g++-14
cmake -B _build -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_TESTS=ON -DCMAKE_EXE_LINKER_FLAGS=-Wl,--strip-debug
cmake --build _build -j "$(nproc)"
ctest --test-dir _build --output-on-failure -E 'integration_tests\.egg::'

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 (meta/sapling)

正在搜索数据库…

7.3K ·GitHub
这是什么?Sapling 是由 Meta 开发的跨平台、兼容 Git 的源代码管理系统,旨在支持包含数百万个文件和提交的代码仓库,同时保持对用户友好。
这只是一个命令行工具,还是不止于此?它是由三部分组成的生态系统:sl 命令行客户端(及其基于网页的交互式 Smartlog 界面)、Mononoke 服务器,以及用于检出代码的 EdenFS 虚拟文件系统。
我该如何运行 Sapling 命令行工具?在 eden/scm 目录中运行 'make oss' 进行构建,然后运行生成的 sl 可执行文件。另外还有一份入门指南,介绍如何克隆现有的 Git 仓库。
构建它需要安装哪些软件?主命令行工具需要 Python 3.8、Rust、CMake 和 OpenSSL;如果还想构建交互式 Smartlog(ISL)网页界面,则还需要 Node 和 Yarn。
我自己能真正使用 Mononoke 和 EdenFS 吗?在 Meta 之外不适用于生产环境——两者都在 Meta 内部使用,但作为开源版本只能用于不受支持的实验性用途;只有 sl 命令行工具面向外部用户的一般使用。
这个命令行工具能在我所有的机器上运行吗?可以,Sapling 命令行工具可在 Linux、Mac 和 Windows 上构建和运行。
Sapling 与 Git 有什么关系?Sapling 兼容 Git——你可以将现有的 Git 仓库克隆到 Sapling 中,并且为从 Git 转过来的用户提供了一份 Git 速查表。
为什么 EdenFS 能让大型仓库运行得更快?EdenFS 不会在检出时一次性生成所有工作目录文件,而是在访问文件时按需生成,从而加快检出等操作的速度,代价是每个文件首次访问时会有少量延迟。
有图形界面吗,还是只能使用命令行?Sapling 包含交互式 Smartlog(ISL),这是一个用于查看和操作代码仓库的网页界面,同时还提供与 VS Code 集成的版本。
Sapling 的命令行代码来自哪里?sl 命令行工具最初基于 Mercurial 开发,至今仍与其共享大量的界面和功能;代码位于 eden/scm 子目录中。
有哪些类似的项目?git-bug, git, gitoxide, openscion, walgithub, epiq, gitui, git-ai
作者
meta
大小
546.8 MB
星标
7.3K
时长
10年
提交 · 90 天