peagit
v1.20.0
Published
Incorporate Git into your Electron application
Downloads
73
Readme
peagit
Incorporate Git into your Electron application
This is a skunkworks project to make using Git in your Electron application.
To get started: npm install peagit --save
And than reference it in your application:
import { GitProcess, GitError, IGitResult } from 'peagit'
const pathToRepository = 'C:/path/to/git/repository/'
const result = await GitProcss.exec([ 'status' ], pathToRepository)
if (result.exitCode === 0) {
const version = result.stdout
// TODO: do some things with version
} else {
const error = result.stderr
// TODO: error handling
}
Current features:
- package Git within your application
- make it easy to execute Git commands
- macOS and Windows support
Potential Roadmap:
- an API for common Git operations
- Linux support
- handle authentication and environment setup
- ???
Contributing
After cloning down this repository, run:
npm install
And then you can create the package yourself:
npm pack