https://github.com/danhper/elixir-git-cli

A simple interface to Git CLI for Elixir
https://github.com/danhper/elixir-git-cli

Last synced: 5 days ago
JSON representation

A simple interface to Git CLI for Elixir

• Host: GitHub
• URL: https://github.com/danhper/elixir-git-cli
• Owner: danhper
• License: mit
• Created: 2015-09-07T08:40:32.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-07-12T15:31:53.000Z (over 2 years ago)
• Last Synced: 2024-04-14T11:08:00.053Z (8 months ago)
• Language: Elixir
• Homepage: https://hex.pm/packages/git_cli
• Size: 24.4 KB
• Stars: 70
• Watchers: 2
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Elixir Git CLI [![Build Status](https://travis-ci.org/danhper/elixir-git-cli.svg?branch=master)](https://travis-ci.org/danhper/elixir-git-cli)

Simple wrapper of git CLI for Elixir.

## Installation

Add the dependency to your `mix.exs` deps:

```elixir

  defp deps do

    [{:git_cli, "~> 0.3"}]

  end

```

## Usage

The usage is basically `Git.COMMAND REPO, ARGS`, where `REPO` is a

`Git.Repository` and `ARGS` is either a string or a list of strings.

So for example, `git pull --rebase origin master` would translate to

`Git.pull repo, ~w(--rebase origin master)`.

The only exceptions are `Git.clone`, `Git.init`, and `Git.new`, which do not take a repository as first argument.

Here are a few examples.

### Git.clone Example

```elixir

{:ok, repo} = Git.clone "https://github.com/danhper/elixir-git-cli"

Git.remote repo, ~w(add upstream https://git.example.com)

Git.pull repo, ~w(--rebase upstream master)

Git.diff repo, "HEAD~1"

Git.add repo, "."

Git.commit repo, ["-m" "my message"]

Git.push repo

IO.puts Git.log!(repo)

```

### Git.new Example

```elixir

repo = Git.new "/path/to/existing/repo"

IO.puts Git.status! repo

Git.commit repo, ["-m" "my message"]

Git.push repo

IO.puts Git.log!(repo)

```

Note that all functions return `:ok` or `{:ok, result}`, and come with their

bang version which only returns `result` when relevant.

On error, the normal version returns `{:error, Git.Error}` and the bang version

simply raises the exception.

## Note

As this is a wrapper for `git`, you need to have the `git` command available on your path.

The commands are generated from [git-commands.txt](./git-commands.txt),

except for `init`, `clone`, and `new` which return a `Git.Repository` struct and not

the git process `stdout`.

The `apply` command is not generated as it conflicts with elixir Kernel function.

The commands with dashes have their function equivalent with dashes replaced by underscores, so for example, `git ls-files` become `Git.ls_files`.

## TODO

* Write more tests

* Parse `git log`, `git diff` etc into `struct`