Class: Git::Commands::Remote::List Private

Inherits:

Base

• Object
• Base
• Git::Commands::Remote::List

Defined in:

lib/git/commands/remote/list.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Note:

arguments block audited against https://git-scm.com/docs/git-remote/2.53.0

git remote command (list remotes)

Lists all configured remote connections.

Examples:

List all remotes

list = Git::Commands::Remote::List.new(execution_context)
list.call

List remotes with URLs

list = Git::Commands::Remote::List.new(execution_context)
list.call(verbose: true)

See Also:

• Git::Commands::Remote
• git-remote

Instance Method Summary

• #call(**options) ⇒ Git::CommandLineResult

  Execute the git remote command.

Methods inherited from Base

allow_exit_status, arguments, #initialize, requires_git_version, skip_version_validation

Constructor Details

This class inherits a constructor from Git::Commands::Base

Instance Method Details

#call(**options) ⇒ Git::CommandLineResult

Execute the git remote command

Parameters:

• options (Hash) —

  command options

Options Hash (**options):

• :verbose (Boolean, nil) — default: nil —

  show remote URLs alongside remote names

  Alias: :v

Returns:

• (Git::CommandLineResult) —

  the result of calling git remote

Raises:

• (ArgumentError) —

  if unsupported options are provided

• (Git::FailedError) —

  if git exits with a non-zero exit status

# File 'lib/git/commands/remote/list.rb', line 34