Quick Start

Installation

npm

npm install type-git

pnpm

pnpm add type-git

Deno

import { TypeGit } from 'npm:type-git';
import { denoAdapter } from 'npm:type-git/deno';

Bun

bun add type-git

Basic Usage

Using TypeGit Class (Recommended)

import { TypeGit } from 'type-git';
import { nodeAdapter } from 'type-git/node';

const git = new TypeGit(nodeAdapter);

// Clone a repository
await git.clone('https://github.com/user/repo.git', './my-repo');

// Open existing repository
const repo = await git.open('./my-repo');

// Check status
const status = await repo.status();
console.log('Modified files:', status.files.filter(f => f.isModified));

Using Factory Function

import { createGit } from 'type-git';
import { nodeAdapter } from 'type-git/node';

const git = createGit(nodeAdapter);

Next Steps

• Installation Guide - Detailed installation instructions
• Basic Usage - Learn the core concepts
• API Reference - Complete API documentation