Class: RubynCode::CLI::Commands::Base

Inherits:

Object

• Object
• RubynCode::CLI::Commands::Base

Defined in:

lib/rubyn_code/cli/commands/base.rb

Overview

Abstract base class for all slash commands.

Subclasses must implement:

- self.command_name  

Optionally override:

- self.aliases 

Direct Known Subclasses

Agents, Budget, Chisel, ChiselAudit, ChiselDebt, ChiselGain, ChiselReview, Clear, Compact, ContextInfo, Cost, Diff, Doctor, Goal, Help, InstallSkills, Learning, ListSkills, Loop, Mcp, Megaplan, Model, NewSession, Plan, Provider, Quit, RemoveSkills, Resume, Review, Rewind, Skill, Skills, Spawn, Tasks, Tokens, Undo, Version

Class Method Summary

• .aliases ⇒ Object
• .all_names ⇒ Array<String>

  All names this command responds to (primary + aliases).

• .command_name ⇒ Object
• .description ⇒ Object
• .hidden? ⇒ Boolean

Instance Method Summary

• #execute(args, ctx) ⇒ void

  Execute the command.

Class Method Details

.aliases ⇒ Object

# File 'lib/rubyn_code/cli/commands/base.rb', line 26

def aliases
  [].freeze
end

.all_names ⇒ Array<String>

All names this command responds to (primary + aliases).

Returns:

• (Array<String>)

# File 'lib/rubyn_code/cli/commands/base.rb', line 37

def all_names
  [command_name, *aliases].freeze
end

.command_name ⇒ Object

Raises:

• (NotImplementedError)

# File 'lib/rubyn_code/cli/commands/base.rb', line 18

def command_name
  raise NotImplementedError, "#{name} must define self.command_name"
end

.description ⇒ Object

Raises:

• (NotImplementedError)

# File 'lib/rubyn_code/cli/commands/base.rb', line 22

def description
  raise NotImplementedError, "#{name} must define self.description"
end

.hidden? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/rubyn_code/cli/commands/base.rb', line 30

def hidden?
  false
end

Instance Method Details

#execute(args, ctx) ⇒ void

This method returns an undefined value.

Execute the command.

Parameters:

• args (Array<String>) —

  arguments passed after the command name

• ctx (Commands::Context) —

  shared context with REPL dependencies

Raises:

• (NotImplementedError)

# File 'lib/rubyn_code/cli/commands/base.rb', line 47

def execute(args, ctx)
  raise NotImplementedError, "#{self.class.name}#execute must be implemented"
end