class Git::Commands::SymbolicRef::Read

Reads the target of a symbolic ref via ‘git symbolic-ref`

Given one argument, reads which branch head the given symbolic ref refers to and outputs its path, relative to the ‘.git/` directory.

Exits with status 0 if the contents were printed correctly, or status 1 if the requested name is not a symbolic ref (e.g. a detached HEAD). When ‘quiet: true`, exit status 1 is silent (no error message on stderr).

@example Read current HEAD

cmd = Git::Commands::SymbolicRef::Read.new(execution_context)
result = cmd.call('HEAD')
result.stdout  # => "refs/heads/main"

@example Read HEAD with shortened output

cmd = Git::Commands::SymbolicRef::Read.new(execution_context)
result = cmd.call('HEAD', short: true)
result.stdout  # => "main"

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

@see Git::Commands::SymbolicRef

@see git-scm.com/docs/git-symbolic-ref git-symbolic-ref documentation

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/symbolic_ref/read.rb, line 93
def call(*, **)
  super
end

Executes the git symbolic-ref command to read a symbolic ref

@overload call(name, **options)

@param name [String] the symbolic ref name to read
  (e.g. `HEAD`)

@param options [Hash] command options

@option options [Boolean, nil] :quiet (nil) suppress error message
  when the name is not a symbolic ref

  Alias: :q

@option options [Boolean, nil] :short (nil) shorten the ref output
  (e.g. `refs/heads/main` → `main`)

@option options [Boolean, nil] :recurse (nil) follow chain of symbolic refs
  until result no longer points at a symbolic ref (`--recurse`)

@option options [Boolean, nil] :no_recurse (nil) stop after a single level
  of dereferencing (`--no-recurse`)

@return [Git::CommandLine::Result] the result of calling
  `git symbolic-ref`

@raise [ArgumentError] if unsupported options are provided

@raise [ArgumentError] if the name operand is missing

@raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)

@api public

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