module Gitlab::CI::CLI::Helpers
Defines methods related to CLI
output and formatting.
Public Instance Methods
actions()
click to toggle source
Returns actions available to CLI
& Shell
@return [Array]
# File lib/gitlab/ci/cli_helpers.rb, line 16 def actions @actions ||= Gitlab::CI.actions end
client()
click to toggle source
Returns Gitlab::Client instance
@return [Gitlab::Client]
# File lib/gitlab/ci/cli_helpers.rb, line 23 def client @client ||= Gitlab::CI::Client.new(endpoint: (Gitlab.endpoint || '')) end
help(cmd=nil, &block)
click to toggle source
Gets defined help for a specific command/action.
@return [String]
# File lib/gitlab/ci/cli_helpers.rb, line 38 def help(cmd=nil, &block) if cmd.nil? || Gitlab::CI::Help.help_map.key?(cmd) Gitlab::CI::Help.actions_table(cmd) else Gitlab::CI::Help.get_help(cmd, &block) end end
valid_command?(cmd)
click to toggle source
Confirms command is valid.
@return [Boolean]
# File lib/gitlab/ci/cli_helpers.rb, line 30 def valid_command?(cmd) command = cmd.is_a?(Symbol) ? cmd : cmd.to_sym Gitlab::CI.actions.include?(command) end