class Git::Remote

A remote in a Git repository

Remote objects provide access to remote metadata and operations like fetch, merge, and remove. They should be obtained via ‘Git::Repository#remote`, not constructed directly.

@example Getting a remote

git = Git.open('.')
remote = git.remote('origin')
remote.fetch

@api public

Attributes

fetch_opts [RW]

The fetch refspec for this remote

@return [String, nil] the fetch options string

name [RW]

The name of this remote (e.g. ‘’origin’‘)

@return [String] the remote name

url [RW]

The URL of this remote

@return [String, nil] the remote URL

Public Class Methods

new (base, name)

Source

# File lib/git/remote.rb, line 49
def initialize(base, name)
  @base = base
  config = remote_repository.config_remote(name)
  @name = name
  @url = config['url']
  @fetch_opts = config['fetch']
end

Initialize a new Remote object

@param base [Git::Repository] the git repository

@param name [String] the remote name (e.g. ‘’origin’‘)

@note Use ‘Git::Repository#remote` instead of constructing directly

@api private

Public Instance Methods

branch (branch = nil)

Source

# File lib/git/remote.rb, line 122
def branch(branch = nil)
  branch ||= remote_repository.current_branch
  Git::Branch.new(@base, "#{@name}/#{branch}")
end

Returns a {Git::Branch} object for the given branch on this remote

@example Get the remote-tracking branch object

git.remote('origin').branch('main')  #=> #<Git::Branch 'origin/main'>

@param branch [String] the branch name on this remote (defaults to current branch)

@return [Git::Branch] a branch object representing ‘<remote>/<branch>`

fetch (opts = {})

Source

# File lib/git/remote.rb, line 92
def fetch(opts = {})
  remote_repository.fetch(@name, opts)
end

Fetches from this remote

@example Fetch from origin

git.remote('origin').fetch

@param opts [Hash] options for the fetch command

@option opts [Boolean, nil] :tags (nil) fetch all tags from the remote

(`--tags`)

@option opts [Boolean, nil] :prune (nil) remove remote-tracking references

that no longer exist on the remote (`--prune`)

@option opts [Boolean, nil] :prune_tags (nil) remove local tags that no

longer exist on the remote (`--prune-tags`)

@option opts [Boolean, nil] :force (nil) override the fast-forward check

when using explicit refspecs (`--force`)

@option opts [Boolean, nil] :update_head_ok (nil) allow ‘git fetch` to

update the branch pointed to by `HEAD` (`--update-head-ok`)

@option opts [Boolean, nil] :unshallow (nil) convert a shallow clone into a

full repository (`--unshallow`)

@option opts [String, Integer, nil] :depth (nil) limit history to N commits

from each branch tip (`--depth=N`)

@option opts [String, Array<String>, nil] :ref (nil) one or more refspecs to

fetch as positional arguments after the remote name

@return [String] git’s stdout from the fetch

@raise [Git::FailedError] if git exits with a non-zero exit status

merge (branch = nil)

Source

# File lib/git/remote.rb, line 107
def merge(branch = nil)
  branch ||= remote_repository.current_branch
  remote_tracking_branch = "#{@name}/#{branch}"
  remote_repository.merge(remote_tracking_branch)
end

Merges this remote into the given (or current) local branch

@example Merge origin/main into the current branch

git.remote('origin').merge('main')

@param branch [String] the local branch to merge into (defaults to current branch)

@return [String] git’s stdout from the merge

@raise [Git::FailedError] if git exits with a non-zero exit status

remove ()

Source

# File lib/git/remote.rb, line 136
def remove
  remote_repository.remote_remove(@name)
end

Removes this remote from the repository

@example Remove the upstream remote

git.remote('upstream').remove

@return [Git::CommandLine::Result] the result of ‘git remote remove`

@raise [Git::FailedError] if git exits with a non-zero exit status

to_s ()

Source

# File lib/git/remote.rb, line 147
def to_s
  @name
end

Returns the name of this remote as a string

@example Get the remote name as a string

git.remote('origin').to_s  #=> 'origin'

@return [String] the remote name

Private Instance Methods

remote_repository ()

Source

# File lib/git/remote.rb, line 157
def remote_repository
  @base
end

@return [Git::Repository]

@api private