gitrepo

Create Git repository object

Since R2023b

Syntax

repo = gitrepo

repo = gitrepo(folder)

Description

repo = gitrepo creates a matlab.git.GitRepository object repo for the Git™ repository in the current working folder. You can use repo to manipulate the repository programmatically.

repo = gitrepo(folder) creates a matlab.git.GitRepository object repo for the Git repository in the specified folder.

Examples

Create Repository Object for Current Folder

Open the Times Table App project repository and create a repository object.

openExample("matlab/TimesTableProjectExample")
repo = gitrepo

repo = 

  GitRepository with properties:

    WorkingFolder: "C:\myWorkSpace\examples\TimesTableProjectExample"
        GitFolder: "C:\myWorkSpace\examples\TimesTableProjectExample\.git"
    CurrentBranch: [1×1 GitBranch]  (main)
       LastCommit: [1×1 GitCommit]  (566d916)
          Remotes: [1×1 GitRemote]
    ModifiedFiles: [0×1 string]
   UntrackedFiles: [1×1 string]
           IsBare: 0
        IsShallow: 0
       IsDetached: 0
       IsWorktree: 0 

Create Repository Object for Specified Folder

Create a repository object for a specified folder.

repo = gitrepo("newrepo\")

repo = 

  GitRepository with properties:

     WorkingFolder: "C:\workSpace\newrepo"
         GitFolder: "C:\workSpace\newrepo\.git"
     CurrentBranch: [0×0 GitBranch]
        LastCommit: [0×0 GitCommit]
           Remotes: [1×1 GitRemote] (origin https://github.com/my/repo
     ModifiedFiles: [0×1 string]
    UntrackedFiles: [2×1 string]
            IsBare: 0
         IsShallow: 0
        IsDetached: 0
        IsWorktree: 0

Input Arguments

folder — Path of folder

character vector | string scalar

Path of the repository folder for which the function creates a matlab.git.GitRepository object, specified as a character vector or string scalar.

Output Arguments

repo — Git repository

matlab.git.GitRepository object

Git repository, returned as a matlab.git.GitRepository object.

Version History

Introduced in R2023b