grgit-remote

Name

grgit-remote - Manage set of tracked repositories

Synopsis

grgit.remote.list()
grgit.remote.add(name: <name>, url: <url>, pushUrl: <url>,
  fetchRefSpecs: [<refspec>, ...], pushRefSpecs: [<refspecs>, ...],
  mirror: <boolean>)
grgit.remote.add {
  name = <name>
  url = <url>
  pushUrl = <url>
  fetchRefSpecs = [<refspec>, ...]
  pushRefSpecs = [<refspecs>, ...]
  mirror = <boolean>
}

Description

Manage the set of repositories ("remotes") whose branches you track.

list() returns a List<Remote> (Remote) of all remotes configured for the repo. add() returns the newly configured Remote

Options

add

name

(String, default null) Name of the new remote

url

(String, default null) URL to fetch the remote repository from.

pushUrl

(String, default null) URL to push to for this remote. If omitted, url is used for push.

fetchRefSpecs

(List<String>, default [+refs/heads/:refs/remotes/<name>/]) default refspecs to use when fetching from this remote.

pushRefSpecs

(List<String>, default []) default refspecs to use when pushing to this remote.

mirror

(boolean, default false) If true makes grgit-push always behave as if mirror is specified.

Examples

See Also