ORE Studio 0.0.4
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions
ores::cli::config Namespace Reference

Configuration and command-line parsing for the CLI tool. More...

Classes

struct  add_account_options
 Configuration for adding an account entity via command-line arguments. More...
 
struct  add_change_reason_category_options
 Configuration for adding a change reason category entity via command-line arguments. More...
 
struct  add_change_reason_options
 Configuration for adding a change reason entity via command-line arguments. More...
 
struct  add_country_options
 Configuration for adding a country entity via command-line arguments. More...
 
struct  add_currency_options
 Configuration for adding a currency entity via command-line arguments. More...
 
struct  add_feature_flag_options
 Configuration for adding a feature flag entity via command-line arguments. More...
 
struct  add_login_info_options
 Configuration for adding a login_info entity via command-line arguments. More...
 
struct  add_permission_options
 Configuration for adding a permission entity via command-line arguments. More...
 
struct  add_role_options
 Configuration for adding a role entity via command-line arguments. More...
 
struct  delete_options
 Configuration related to deleting entities. More...
 
struct  export_options
 Configuration related to exporting data into a supported export format. More...
 
struct  import_options
 Configuration related to importing data into the system. More...
 
struct  list_options
 Configuration options related to listing entities. More...
 
struct  options
 All of the configuration options required by the command line application. More...
 
class  parser
 Command-line parser implementation using boost program options. More...
 
class  parser_exception
 A fatal error has occurred during option parsing. More...
 

Typedefs

using add_options = std::variant< add_currency_options, add_account_options, add_feature_flag_options, add_login_info_options, add_role_options, add_permission_options, add_country_options, add_change_reason_options, add_change_reason_category_options >
 Variant type holding entity-specific add options.
 

Enumerations

enum class  entity {
  currencies , accounts , feature_flags , login_info ,
  roles , permissions , countries , change_reasons ,
  change_reason_categories
}
 List of available entities to target.
 
enum class  format { json , xml , csv , table }
 List of available formats.
 
enum class  operation {
  import_data , export_data , list_entity , delete_entity ,
  add_entity
}
 List of available operations that can be performed on entities.
 

Functions

std::ostream & operator<< (std::ostream &s, const add_account_options &v)
 
std::ostream & operator<< (std::ostream &s, const add_change_reason_category_options &v)
 
std::ostream & operator<< (std::ostream &s, const add_change_reason_options &v)
 
std::ostream & operator<< (std::ostream &s, const add_country_options &v)
 
std::ostream & operator<< (std::ostream &s, const add_currency_options &v)
 
std::ostream & operator<< (std::ostream &s, const add_feature_flag_options &v)
 
std::ostream & operator<< (std::ostream &s, const add_login_info_options &v)
 
std::ostream & operator<< (std::ostream &s, const add_options &v)
 
std::ostream & operator<< (std::ostream &s, const add_permission_options &v)
 
std::ostream & operator<< (std::ostream &s, const add_role_options &v)
 
std::ostream & operator<< (std::ostream &s, const delete_options &v)
 
std::ostream & operator<< (std::ostream &s, const export_options &v)
 
std::ostream & operator<< (std::ostream &s, const import_options &v)
 
std::ostream & operator<< (std::ostream &s, const list_options &v)
 
std::ostream & operator<< (std::ostream &s, const options &v)
 

Detailed Description

Configuration and command-line parsing for the CLI tool.

Contains command-line option definitions, parsers, and entity-specific parsers for importing data from configuration files (accounts, currencies, feature flags, login info).

Typedef Documentation

◆ add_options

Variant type holding entity-specific add options.

This design allows each entity type to have its own dedicated options struct with strongly-typed required fields, while maintaining a unified interface for the add operation. Use std::visit to dispatch to entity-specific handlers.