This package follows the push.rocks Rust-backed package pattern: TypeScript owns the public package API and lifecycle, while Rust owns the Git/storage/protocol engine. TypeScript controls the Rust binary through @push.rocks/smartrust, and builds use @git.zone/tsrust.

The current implementation provides lifecycle IPC plus initial local bare repository management and read APIs. Git protocol serving, mirror refresh, authorization, and write/admin features are planned in ../readme.plan.md.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Install

pnpm add @foss.global/gitmanager

Usage

import { GitManager } from '@foss.global/gitmanager';

const gitManager = new GitManager({
  dataDir: '/var/lib/foss-global/gitmanager',
});

await gitManager.start();
const status = await gitManager.getStatus();
console.log(status.running, status.dataDir);

await gitManager.importMirror({
  org: 'foss.global',
  repo: 'interfaces',
  remoteUrl: 'ssh://git@code.foss.global:29419/foss.global/interfaces.git',
});

const refs = await gitManager.listRefs({ org: 'foss.global', repo: 'interfaces' });
const tree = await gitManager.listTree({ org: 'foss.global', repo: 'interfaces', ref: 'main' });
const readme = await gitManager.readFile({
  org: 'foss.global',
  repo: 'interfaces',
  ref: 'main',
  path: 'readme.md',
});

await gitManager.stop();

Public API

GitManager: TypeScript facade for the Rust engine lifecycle.
GitManager.start(): spawns the Rust binary through smartrust and starts the engine.
GitManager.stop(): asks the engine to stop and always kills the bridge process in cleanup.
GitManager.getStatus(): returns { running, dataDir, uptimeMs }.
GitManager.initBareRepository(): creates an empty local bare repository.
GitManager.importMirror(): imports a remote repository with git clone --mirror. Supported remote forms are https://, http://, ssh://, git://, file://, and SCP-like git@host:org/repo.git URLs.
GitManager.listRepositories(): lists local repositories managed below the configured data directory.
GitManager.listRefs(): lists branch and tag refs.
GitManager.listTree(): lists tree entries at a ref and optional path.
GitManager.readFile(): reads a blob as base64 after checking the blob size limit.
GitManager.listCommits(): lists commit summaries for a ref.
GitManager.getCommit(): reads commit detail metadata, parents, author/committer data, and diff stats for a ref.
GitManager.getDiff(): returns a structured unified diff between a head ref and its first parent or an explicit base ref.
GitManager.listTags(): lists lightweight and annotated tags with target object metadata.
GitManager.getTag(): reads one tag by exact name.
GitManager.running: local facade running state.
RustGitManagerBridge: lower-level typed bridge around @push.rocks/smartrust.
IGitManagerOptions, IGitManagerStatus, IRustGitManagerConfig: exported option/status contracts.

Repository/read DTO contracts are re-exported from the published @foss.global/interfaces package.

Read/list APIs go through JSON IPC. Git packfile streaming for clone/fetch/push must not go through JSON IPC; future Git HTTP/SSH transport work belongs in the Rust engine or controlled Git subprocesses.

The initial read APIs use the system git CLI with explicit arguments, non-interactive environment variables, command timeouts, ref-to-object-id resolution, path validation, bounded stdout/stderr capture, ref/tree result caps, and a 1 MiB file read cap.

Rust Build

The package builds a Rust binary named rustgitmanager from rust/ using @git.zone/tsrust.

Configured targets:

linux_amd64
linux_arm64

The ARM64 target uses rust/.cargo/config.toml with aarch64-linux-gnu-gcc as linker.

Testing

pnpm test
pnpm run test:rust
pnpm run build

pnpm test runs the pretest hook first, which builds the Rust binaries with tsrust, and then runs lifecycle plus local mirror import/read API tests through smartrust.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the repository license file.

Bundled Rust binaries include third-party Rust crates under their respective licenses. See thirdparty.md for the packaged notice list.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

readme.md

@foss.global/gitmanager