Installation

npm

npm install @keydown-app/ts-git

pnpm

pnpm add @keydown-app/ts-git

yarn

yarn add @keydown-app/ts-git

Optional Dependencies

CLI Support

The package also exports an optional embedded terminal command surface:

npm install @keydown-app/ts-git

Then import the CLI components:

import { CommandParser } from '@keydown-app/ts-git/cli';

Diff Algorithm

For diff functionality, you’ll need a line diff algorithm:

npm install @keydown-app/ts-git-diff-myers

Usage:

import { myersLineDiff } from '@keydown-app/ts-git-diff-myers';
import { GitClient, MemoryFSAdapter } from '@keydown-app/ts-git';

const git = new GitClient({
  fs: new MemoryFSAdapter(),
  dir: '/my-repo',
  lineDiffAlgorithm: myersLineDiff,
});

TypeScript Configuration

TS-Git is written in TypeScript and includes type definitions. No additional @types package is needed.

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

Next Steps

• Quick Start - Create your first repository