Home

Git Subprocess Client Methods Overview

• Create Client Object Instance
• String Responses
• Methods
  • Git Init
  • Git Remote Add
  • Git Add File
  • Git Add All
  • Git Commit
  • Git Push
  • Git Status
  • Git Log
  • Git Log One Line
  • Git Log All
  • Git Log All One Line
  • Switch Branch
  • Create Branch (No Checkout)
  • Create and Checkout to Branch
  • Delete Branch
  • List Branches
  • Get Current Branch Name
  • Git Pull
  • Fetch Branch
  • Fetch All
  • Git Stash
  • Git Stash Apply
  • Git Clone
  • Any Other Git Command

Create Client Object Instance

GitSubprocessClient gitSubprocessClient = new GitSubprocessClient(repoPath);

String Responses

All GitSubprocessClient responses are Strings, and will be the exact output you would normally see from the terminal. For that reason, they are a bit tricky to parse, but nothing that can’t be done with a little extra String manipulation code. String methods split and substring are your friends!

Methods

These are literally identical to the Git terminal commands, just being run in a Java program.

Git Init

String gitInit = gitSubprocessClient.gitInit();

Git Remote Add

Remote name and url must be supplied. Below will add a remote named “origin” with the url “https://github.com/CSC109/GitSubprocessClient.git”

String gitRemoteAdd = gitSubprocessClient.gitRemoteAdd("origin", "https://github.com/CSC109/GitSubprocessClient.git");

Git Add File

Stage a changed file – git add <filePath> command. A file path must be supplied.

String gitAddFile = gitSubprocessClient.gitAddFile("GitSubprocessClient.java");

Git Add All

Stage all changed file – git add . command.

String gitAddAll = gitSubprocessClient.gitAddAll();

Git Commit

Create a commit. A commit message must be supplied.

String commitMessage = "This is a commit message";

String commit = gitSubprocessClient.gitCommit(commitMessage);

Git Push

Push all recent commits to the remote branch. A branch name must be specified.

String push = gitSubprocessClient.gitPush("master");

Git Status

Gets the status of the repo.

String status = gitSubprocessClient.gitStatus();

Git Log

Equivalent to running a git log to get commit information. The number of commits to log (starting from most recent) must be supplied.

Below will get the most recent 5 commits.

String log = gitSubprocessClient.gitLog(5);

Git Log One Line

Same as Git Log, but will condense the commit output text. Equivalent to running git log –oneline. The number of commits to log (starting from most recent) must be supplied.

Below will get the most recent 5 commits.

String log = gitSubprocessClient.gitLogOneLine(5);

Git Log All

Get all commit information.

String log = gitSubprocessClient.gitLogAll();

Git Log All One Line

Same as Git Log All, but will condense the commit output text. Equivalent to running git log –oneline.

String log = gitSubprocessClient.gitLogAllOneLine();

Switch Branch

Checkout to a new branch. Branch name to checkout to must be supplied.

String checkout = gitSubprocessClient.switchBranch("master");

Create Branch (No Checkout)

Creates a branch. Does NOT checkout to branch. New branch name must be supplied.

String createBranch = gitSubprocessClient.createBranch("new-branch");

Create and Checkout to Branch

Creates a branch and performs a checkout to branch. This is the git checkout -b / command. New branch name must be supplied.

String createBranch = gitSubprocessClient.createAndSwitchBranch("new-branch");

Delete Branch

Deletes a branch. Branch name to delete must be supplied.

String deleteBranch = gitSubprocessClient.deleteBranch("new-branch");

List Branches

Lists all branch names in repo.

String branches = gitSubprocessClient.listBranches();

Get Current Branch Name

Gets the name of the current branch the repo has checked out.

String branchName = gitSubprocessClient.getCurrentBranchName();

Git Pull

Performs a pull. Branch name to pull must be supplied.

String pull = gitSubprocessClient.gitPull("master");

Fetch Branch

Performs a fetch on a specific branch. Branch name to fetch must be supplied.

String fetch = gitSubprocessClient.gitFetch("master");

Fetch All

Performs a general fetch on all branches.

String fetch = gitSubprocessClient.gitFetchAll();

Git Stash

Stashes away all current changes that have not been committed yet. They will be “removed” temporarily, but can be reapplied later with Git Stash Apply.

String stash = gitSubprocessClient.gitStash();

Git Stash Apply

Applies current stashed changes.

String stashApply = gitSubprocessClient.gitStashApply();

Git Clone

Clones remote repo to local machine. Url to clone must be supplied.

String clone = gitSubprocessClient.gitClone();

Any Other Git Command

There is a method called runGitCommand that can be used as a “catch all” to run any other Git command not already provided by the client.

For example, to run a git push origin master using the runGitCommit method, it would look like this:

String commit = gitSubprocessClient.runGitCommand("push origin master");