class Git::Commands::Remote::Show

‘git remote show` command

Shows information about one or more remotes, including fetch and push URLs and branch tracking information.

@example Show information about a remote

show = Git::Commands::Remote::Show.new(execution_context)
show.call('origin')

@example Show cached information without contacting the remote

show = Git::Commands::Remote::Show.new(execution_context)
show.call('origin', n: true)

@example Show verbose output for multiple remotes

show = Git::Commands::Remote::Show.new(execution_context)
show.call('origin', 'upstream', verbose: true)

@note ‘arguments` block audited against git-scm.com/docs/git-remote/2.53.0

@see Git::Commands::Remote

@see git-scm.com/docs/git-remote git-remote

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/remote/show.rb, line 71
def call(*, **)
  super
end

@overload call(*name, **options)

Execute the `git remote show` command

@param name [Array<String>] one or more remote names to inspect

@param options [Hash] command options

@option options [Boolean, nil] :verbose (nil) show the remote URL after
  the remote name

  Alias: :v

@option options [Boolean, nil] :n (nil) do not query remote heads with
  `git ls-remote`

  Uses cached information instead of contacting the remote server.

@return [Git::CommandLine::Result] the result of calling `git remote show`

@raise [ArgumentError] if unsupported options are provided

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

@api public

Calls superclass method Git::Commands::Base::call