Installation

Install @catmint-fs/git and its peer dependency @catmint-fs/core.

Requirements

  • TypeScript 5.0 or later
  • @catmint-fs/core — provides the storage layer abstraction

No native dependencies are required. The package works in Node.js, Deno, Bun, and modern browsers.

Install

npm install @catmint-fs/git @catmint-fs/core
pnpm add @catmint-fs/git @catmint-fs/core
yarn add @catmint-fs/git @catmint-fs/core

Optional Packages

Depending on your use case, you may also want these companion packages:

PackagePurposeInstall
@catmint-fs/sqlite-adapterPersistent storage via SQLitenpm install @catmint-fs/sqlite-adapter
@catmint-fs/git-auth-nodeCredential helpers for Node.js (SSH keys, tokens)npm install @catmint-fs/git-auth-node

Verify Installation

import { createMemoryLayer } from "@catmint-fs/core";
import { initRepository } from "@catmint-fs/git";

const layer = createMemoryLayer();
const repo = await initRepository(layer);
console.log(await repo.currentBranch()); // "main"

If this runs without errors, you're ready to go.

TypeScript Configuration

@catmint-fs/git ships with full type declarations. No additional @types packages are needed. Make sure your tsconfig.json includes:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler"
  }
}

Next Steps