Git extension: Makes git-diff and git-merge work for Excel workbooks (xls* file types)
Clone or download
Latest commit 19edefa Jun 21, 2018

README.md

xltrail client - A Git Extension for Excel

Windows macOS
Windows build status not yet available

Git xltrail is an open-source Git command line extension for managing Excel workbook files in Git.

The extension makes git diff and git merge work for Excel workbooks (xls, xlt, xla, xlam, xlsx, xlsm, xlsb, xltx, xltm). Git xltrail does not require Excel as it works directly on the workbook file.

With Git xltrail installed, Git can diff and merge Excel workbook files just like any other source code file.

It is written in Python, with pre-compiled binaries available for Windows.

Installation instructions and docs are available at https://www.xltrail.com/client.

Getting Started

Installation

You can install the Git xltrail client on Windows, using the pre-complied binary installer.

This repository can also be built-from-source using Python and PyInstaller.

Git xltrail requires a global installation once per-machine. This can be done by running:

C:\Developer>git xltrail install

Alternatively, initialise Git xltrail locally (per repository), using the --local option, inside the root folder of your repository’s local working copy:

C:\Developer>git xltrail install --local

Usage

Diff workbooks

Get meaningful git diff output when comparing Excel workbook files containing VBA code.

C:\Developer>git diff dev..master
diff --xltrail a/Book1.xlsb b/Book1.xlsb
--- a/Book1.xlsb/VBA/Module/Module1
+++ b/Book1.xlsb/VBA/Module/Module1
@@ -1,4 +1,4 @@
 Option Explicit
 Public Function Version() As String
-   Version = "v1.0"
+   Version = "v1.1"
 End Function

Merge branches

C:\Developer>git merge dev
--- a/Book1.xlsb/VBA/Module/Module1
+++ b/Book1.xlsb/VBA/Module/Module1
Auto-merging Book1.xlsb
Merge made by the 'recursive' strategy.
 Book1.xlsb | Bin 8021 -> 7910 bytes
 1 file changed, 0 insertions(+), 0 deletions(-)

List workbooks

List all workbooks in your repository and get meta data on workbook content.

C:\Developer>git xltrail ls-files
./Book1.xlsb
    VBA/Document/ThisWorkbook
    VBA/Document/Sheet1
    VBA/Module/Module1
    VBA/Module/Module2
    VBA/Module/Module3

List all workbooks and content in your repository.

C:\Developer>git xltrail ls-files -v
./Book1.xlsb
    VBA/Document/ThisWorkbook
        Option Explicit

    VBA/Document/Sheet1
        Option Explicit

    VBA/Module/Module1
        Option Explicit
        Public Function Version() As String
            Version = "v1.0"
        End Function

    VBA/Module/Module2
        Option Explicit
        Public Function GetVersion() As String
            GetVersion = "v0.0.1"
        End Function
        Public Sub test()
            Debug.Print "hello"
            'asdasdsad
        End Sub
    VBA/Module/Module3
        Option Explicit

        Public Function GetVersion() As String
            GetVersion = "v0.0.1"
        End Function

Docs

Docs are available at https://www.xltrail.com/client.

Contributing

Please open a new issue to report bugs or create a pull request to send patches.