yaze::cli::Cli Class Reference

#include <cli.h>

Collaboration diagram for yaze::cli::Cli:

Classes
struct	Options

Public Types
using	AgentHandler

Public Member Functions
	Cli (CommandRegistry &registry, Options options, std::ostream &out)
absl::Status	Run (absl::Span< const std::string > args) const
void	PrintOverview () const
absl::Status	PrintScopedHelp (absl::Span< const std::string > words) const
void	PrintCategoryHelp (const std::string &category) const
void	PrintCommandSummary () const

Private Member Functions
absl::Status	RunAgent (absl::Span< const std::string > args) const
absl::Status	RunAlias (absl::string_view group, absl::Span< const std::string > args) const
void	PrintAgentHelp () const
void	PrintAliasHelp (absl::string_view group) const

Private Attributes
CommandRegistry &	registry_
Options	options_
std::ostream &	out_

Detailed Description

Definition at line 20 of file cli.h.

Member Typedef Documentation

AgentHandler

using yaze::cli::Cli::AgentHandler

Initial value:

 
      std::function<absl::Status(const std::vector<std::string>& args)>

Definition at line 22 of file cli.h.

Constructor & Destructor Documentation

Cli()

yaze::cli::Cli::Cli	(	CommandRegistry &	registry,
		Options	options,
		std::ostream &	out )

Definition at line 77 of file cli.cc.

Member Function Documentation

Run()

absl::Status yaze::cli::Cli::Run

(

absl::Span< const std::string >

args

)

const

Definition at line 80 of file cli.cc.

References yaze::cli::CommandRegistry::Execute(), yaze::cli::CommandRegistry::GetCommandsInCategory(), yaze::cli::CommandRegistry::HasCommand(), PrintCategoryHelp(), PrintOverview(), PrintScopedHelp(), registry_, RunAgent(), and RunAlias().

PrintOverview()

void yaze::cli::Cli::PrintOverview

(

)

const

Definition at line 148 of file cli.cc.

References yaze::cli::Cli::Options::agent_handler, yaze::cli::util::AnsiStyle::Emphasis(), yaze::cli::CommandRegistry::GetCategories(), yaze::cli::CommandRegistry::GetCommandsInCategory(), yaze::cli::util::AnsiStyle::Heading(), yaze::cli::util::AnsiStyle::Highlight(), yaze::cli::Cli::Options::http_api_available, options_, out_, registry_, yaze::cli::RenderLogo(), yaze::cli::util::AnsiStyle::Reset(), and yaze::cli::Cli::Options::style.

Referenced by PrintScopedHelp(), and Run().

PrintScopedHelp()

absl::Status yaze::cli::Cli::PrintScopedHelp

(

absl::Span< const std::string >

words

)

const

Definition at line 183 of file cli.cc.

References yaze::cli::CommandRegistry::GenerateCompleteHelp(), yaze::cli::CommandRegistry::GenerateHelp(), yaze::cli::CommandRegistry::GetCommandsInCategory(), yaze::cli::CommandRegistry::HasCommand(), options_, out_, PrintAgentHelp(), PrintAliasHelp(), PrintCategoryHelp(), PrintOverview(), registry_, and yaze::cli::Cli::Options::style.

Referenced by Run().

PrintCategoryHelp()

void yaze::cli::Cli::PrintCategoryHelp

(

const std::string &

category

)

const

Definition at line 259 of file cli.cc.

References yaze::cli::CommandRegistry::CommandMetadata::description, yaze::cli::CommandRegistry::GetCommandsInCategory(), yaze::cli::CommandRegistry::GetMetadata(), out_, registry_, yaze::cli::CommandRegistry::CommandMetadata::requires_grpc, yaze::cli::CommandRegistry::CommandMetadata::requires_rom, and yaze::cli::CommandRegistry::CommandMetadata::usage.

Referenced by PrintAgentHelp(), PrintScopedHelp(), and Run().

Here is the call graph for this function:

PrintCommandSummary()

void yaze::cli::Cli::PrintCommandSummary

(

)

const

Definition at line 295 of file cli.cc.

References yaze::cli::CommandRegistry::Count(), yaze::cli::CommandRegistry::GetCategories(), yaze::cli::CommandRegistry::GetCommandsInCategory(), yaze::cli::CommandRegistry::GetMetadata(), out_, and registry_.

Here is the call graph for this function:

RunAgent()

absl::Status yaze::cli::Cli::RunAgent ( absl::Span< const std::string > args ) const

private

Definition at line 113 of file cli.cc.

References yaze::cli::Cli::Options::agent_handler, options_, and PrintAgentHelp().

Referenced by Run().

Here is the call graph for this function:

RunAlias()

absl::Status yaze::cli::Cli::RunAlias ( absl::string_view group, absl::Span< const std::string > args ) const

private

Definition at line 125 of file cli.cc.

References yaze::cli::CommandRegistry::Execute(), yaze::cli::CommandRegistry::HasCommand(), PrintAliasHelp(), and registry_.

Referenced by Run().

Here is the call graph for this function:

PrintAgentHelp()

void yaze::cli::Cli::PrintAgentHelp ( ) const

private

Definition at line 228 of file cli.cc.

References yaze::cli::Cli::Options::agent_handler, yaze::cli::CommandRegistry::GetCommandsInCategory(), yaze::cli::util::AnsiStyle::Heading(), options_, out_, PrintCategoryHelp(), registry_, yaze::cli::util::AnsiStyle::Reset(), and yaze::cli::Cli::Options::style.

Referenced by PrintScopedHelp(), and RunAgent().

Here is the call graph for this function:

PrintAliasHelp()

void yaze::cli::Cli::PrintAliasHelp ( absl::string_view group ) const

private

Definition at line 243 of file cli.cc.

References yaze::cli::CommandRegistry::GenerateCategoryHelp(), yaze::cli::CommandRegistry::GetCommandsInCategory(), yaze::cli::util::AnsiStyle::Heading(), options_, out_, registry_, yaze::cli::util::AnsiStyle::Reset(), and yaze::cli::Cli::Options::style.

Referenced by PrintScopedHelp(), and RunAlias().

Here is the call graph for this function:

Member Data Documentation

registry_

CommandRegistry& yaze::cli::Cli::registry_

private

Definition at line 52 of file cli.h.

Referenced by PrintAgentHelp(), PrintAliasHelp(), PrintCategoryHelp(), PrintCommandSummary(), PrintOverview(), PrintScopedHelp(), Run(), and RunAlias().

options_

Options yaze::cli::Cli::options_

private

Definition at line 53 of file cli.h.

Referenced by PrintAgentHelp(), PrintAliasHelp(), PrintOverview(), PrintScopedHelp(), and RunAgent().

out_

std::ostream& yaze::cli::Cli::out_

private

Definition at line 54 of file cli.h.

Referenced by PrintAgentHelp(), PrintAliasHelp(), PrintCategoryHelp(), PrintCommandSummary(), PrintOverview(), and PrintScopedHelp().

---

The documentation for this class was generated from the following files:

• src/cli/cli.h
• src/cli/cli.cc