Git4sRepository

com.geirolz.git4s.Git4sRepository
See theGit4sRepository companion object
trait Git4sRepository[F[_]]

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Git4s[F]

Members list

Value members

Abstract methods

def add(pattern: String)(using CmdLogger[F]): F[GitAddResult]

Add file contents to the index.

Add file contents to the index.

Interactive commands not supported yet.

https://git-scm.com/docs/git-add

Attributes

def checkout(branchName: BranchName, createIfNotExists: Boolean): F[Unit]

Select the branch with the specified name

Select the branch with the specified name

Attributes

def clean(force: Boolean, recursive: Boolean, dontUseStdIgnoreRules: Boolean)(using CmdLogger[F]): F[Unit]

Remove untracked files from the working tree.

Remove untracked files from the working tree.

https://git-scm.com/docs/git-clean

Attributes

def commit(message: String, fixup: Option[FixupCommit])(using CmdLogger[F]): F[GitCommitResult]

Record changes to the repository.

Record changes to the repository.

https://git-scm.com/docs/git-commit

Attributes

def currentBranch(using CmdLogger[F]): F[BranchName]

Show the current branch.

Show the current branch.

https://git-scm.com/docs/git-rev-parse

Attributes

def deleteLocalBranch(branchName: BranchName): F[Unit]

Delete a branch.

Attributes

def deleteRemoteBranch(branchName: BranchName, remote: Remote): F[Unit]

Delete a branch on the remote.

Delete a branch on the remote.

https://git-scm.com/docs/git-push

Attributes

def diff(pattern: Option[String], added: Boolean, copied: Boolean, deleted: Boolean, modified: Boolean, renamed: Boolean, typeChanged: Boolean, unmerged: Boolean, unknown: Boolean, broken: Boolean, allOrNone: Boolean)(using CmdLogger[F]): Stream[F, FileDiff]

Show changes between commits, commit and working tree, etc

Show changes between commits, commit and working tree, etc

https://git-scm.com/docs/git-diff

Attributes

def fetch(remote: Remote): F[Unit]

Download objects and refs from another repository.

Download objects and refs from another repository.

https://git-scm.com/docs/git-fetch

Attributes

def init(using CmdLogger[F]): F[GitInitResult]

Create an empty Git repository or reinitialize an existing one.

Create an empty Git repository or reinitialize an existing one.

https://git-scm.com/docs/git-init

Attributes

def pull(remote: Remote, targetBranch: Option[BranchName], rebase: Boolean, fastForwardOnly: Boolean, noFastForward: Boolean, squash: Boolean, noCommit: Boolean, noVerify: Boolean)(using CmdLogger[F]): F[Unit]

Fetch from and integrate with another repository or a local branch.

Fetch from and integrate with another repository or a local branch.

https://git-scm.com/docs/git-pull

Attributes

def push(remote: Remote, sourceBranch: Option[BranchName], remoteTargetBranch: Option[BranchName], force: Boolean)(using CmdLogger[F]): F[Unit]

Update remote refs along with associated objects.

Update remote refs along with associated objects.

https://git-scm.com/docs/git-push

Attributes

def reset: Git4sReset[F]

Return a Git4sReset type to perform resets

Return a Git4sReset type to perform resets

Attributes

def status(using CmdLogger[F]): F[GitStatus]

Show the working tree status.

Show the working tree status.

https://git-scm.com/docs/git-status

Attributes