git4s
API
Generated with
git4s/git4s

git4s

package git4s

Members list

Packages

package git4s.cmd
package git4s.codec
package git4s.data
package git4s.log
package git4s.utils

Type members

Classlikes

sealed trait Git4s[F[_]] extends GitInstaller[F], Git4sRepository[F]

Git4s is a pure functional wrapper around the git command line.

Git4s is a pure functional wrapper around the git command line.

It provides a set of methods to interact with a git.

You can create a Git4s instance using the apply method.

Logging is done using the CmdLogger type class implicitly passed to each method. You can provide your own implementation of CmdLogger to log the command output as you like, or use the default one provided by the library. By default, the library uses the Noop logger which doesn't log anything since usually these logs are useful just for debugging purpose.

Example:

import cats.effect.IO
import git4s.Git4s
import git4s.data.GitVersion
import git4s.log.*

given logger: CmdLogger[IO] = CmdLogger.console[IO](LogFilter.all)
val result: IO[GitVersion] = Git4s[IO].version

Type parameters

F

the effect type

Attributes

Companion
object
Supertypes
trait Git4sRepository[F]
trait GitInstaller[F]
class Object
trait Matchable
class Any
object Git4s

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Git4s.type
trait Git4sConfig[F[_]](target: GitConfigTarget)(using x$2: WorkingCtx)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Git4sConfig

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait Git4sRepository[F[_]]

Attributes

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait Git4sReset[F[_]]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Git4sReset

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Git4sReset.type
trait Git4sTag[F[_]](using x$1: WorkingCtx)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Git4sTag

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Git4sTag.type
trait GitInstaller[F[_]]

Attributes

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Generated with