com.geirolz.git4s
package com.geirolz.git4s
Members list
Packages
package com.geirolz.git4s.cmd
package com.geirolz.git4s.codec
package com.geirolz.git4s.data
package com.geirolz.git4s.log
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 com.geirolz.git4s.Git4s
import com.geirolz.git4s.data.GitVersion
import com.geirolz.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
object Git4s
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
object Git4sConfig
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Git4sConfig.type
object Git4sRepository
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Git4sRepository.type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
object Git4sReset
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Git4sReset.type
object GitInstaller
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
GitInstaller.type
In this article