class Git::Commands::ConfigOptionSyntax::List

List all config entries

Wraps ‘git config –list` to output all config entries visible from the current scope.

@example List all config entries

cmd = Git::Commands::ConfigOptionSyntax::List.new(lib)
cmd.call

@example List global config entries

cmd = Git::Commands::ConfigOptionSyntax::List.new(lib)
cmd.call(global: true)

@example List entries from a specific file

cmd = Git::Commands::ConfigOptionSyntax::List.new(lib)
cmd.call(file: '/path/to/config')

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

@see Git::Commands::ConfigOptionSyntax

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

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/config_option_syntax/list.rb, line 105
def call(*, **)
  super
end

@overload call(**options)

Execute the `git config --list` command

@param options [Hash] command options

@option options [Boolean, nil] :global (nil) list only global config entries

@option options [Boolean, nil] :system (nil) list only system config entries

@option options [Boolean, nil] :local (nil) list only repository config entries

@option options [Boolean, nil] :worktree (nil) list only worktree config entries

@option options [String] :file (nil) list entries from the specified file

  Alias: :f

@option options [String] :blob (nil) list entries from the specified blob

@option options [Boolean, nil] :includes (nil) respect include directives in config files
  (`--includes`)

@option options [Boolean, nil] :no_includes (nil) suppress include directive processing
  (`--no-includes`)

@option options [Boolean, nil] :show_origin (nil) show the origin of each config entry

@option options [Boolean, nil] :show_scope (nil) show the scope of each config entry

@option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline

  Alias: :z

@option options [Boolean, nil] :name_only (nil) output only the names of config keys

@option options [String] :type (nil) ensure values conform to the given type

@return [Git::CommandLine::Result] the result of calling `git config --list`

@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