Module: Ukiryu

Defined in:
lib/ukiryu.rb,
lib/ukiryu/io.rb,
lib/ukiryu/cli.rb,
lib/ukiryu/tool.rb,
lib/ukiryu/type.rb,
lib/ukiryu/cache.rb,
lib/ukiryu/debug.rb,
lib/ukiryu/shell.rb,
lib/ukiryu/tools.rb,
lib/ukiryu/utils.rb,
lib/ukiryu/config.rb,
lib/ukiryu/errors.rb,
lib/ukiryu/logger.rb,
lib/ukiryu/models.rb,
lib/ukiryu/runtime.rb,
lib/ukiryu/version.rb,
lib/ukiryu/executor.rb,
lib/ukiryu/platform.rb,
lib/ukiryu/register.rb,
lib/ukiryu/shell/sh.rb,
lib/ukiryu/thor_ext.rb,
lib/ukiryu/execution.rb,
lib/ukiryu/shell/cmd.rb,
lib/ukiryu/shell/zsh.rb,
lib/ukiryu/definition.rb,
lib/ukiryu/extractors.rb,
lib/ukiryu/shell/base.rb,
lib/ukiryu/shell/bash.rb,
lib/ukiryu/shell/dash.rb,
lib/ukiryu/shell/fish.rb,
lib/ukiryu/shell/tcsh.rb,
lib/ukiryu/tool_cache.rb,
lib/ukiryu/tool_index.rb,
lib/ukiryu/tools/base.rb,
lib/ukiryu/validation.rb,
lib/ukiryu/action/base.rb,
lib/ukiryu/environment.rb,
lib/ukiryu/tool/loader.rb,
lib/ukiryu/tool_finder.rb,
lib/ukiryu/cli_commands.rb,
lib/ukiryu/options/base.rb,
lib/ukiryu/response/base.rb,
lib/ukiryu/cache_registry.rb,
lib/ukiryu/models/routing.rb,
lib/ukiryu/shell/registry.rb,
lib/ukiryu/command_builder.rb,
lib/ukiryu/man_page_parser.rb,
lib/ukiryu/models/argument.rb,
lib/ukiryu/options_builder.rb,
lib/ukiryu/shell/unix_base.rb,
lib/ukiryu/tools/generator.rb,
lib/ukiryu/execution/output.rb,
lib/ukiryu/execution/result.rb,
lib/ukiryu/models/arguments.rb,
lib/ukiryu/models/interface.rb,
lib/ukiryu/schema_validator.rb,
lib/ukiryu/shell/powershell.rb,
lib/ukiryu/version_detector.rb,
lib/ukiryu/config/env_schema.rb,
lib/ukiryu/definition/loader.rb,
lib/ukiryu/definition/source.rb,
lib/ukiryu/execution_context.rb,
lib/ukiryu/models/components.rb,
lib/ukiryu/models/exit_codes.rb,
lib/ukiryu/models/invocation.rb,
lib/ukiryu/executable_locator.rb,
lib/ukiryu/execution/metadata.rb,
lib/ukiryu/models/output_info.rb,
lib/ukiryu/config/env_provider.rb,
lib/ukiryu/definition/metadata.rb,
lib/ukiryu/models/command_info.rb,
lib/ukiryu/models/version_info.rb,
lib/ukiryu/definition/discovery.rb,
lib/ukiryu/extractors/extractor.rb,
lib/ukiryu/models/stage_metrics.rb,
lib/ukiryu/models/tool_metadata.rb,
lib/ukiryu/shell/instance_cache.rb,
lib/ukiryu/validation/validator.rb,
lib/ukiryu/config/type_converter.rb,
lib/ukiryu/definition/lint_issue.rb,
lib/ukiryu/models/error_response.rb,
lib/ukiryu/tools/class_generator.rb,
lib/ukiryu/execution/command_info.rb,
lib/ukiryu/extractors/help_parser.rb,
lib/ukiryu/models/executable_info.rb,
lib/ukiryu/models/flag_definition.rb,
lib/ukiryu/models/run_environment.rb,
lib/ukiryu/models/tool_definition.rb,
lib/ukiryu/tool/version_detection.rb,
lib/ukiryu/validation/constraints.rb,
lib/ukiryu/definition/sources/file.rb,
lib/ukiryu/models/execution_report.rb,
lib/ukiryu/models/platform_profile.rb,
lib/ukiryu/models/semantic_version.rb,
lib/ukiryu/models/success_response.rb,
lib/ukiryu/tool/command_resolution.rb,
lib/ukiryu/tools/executable_finder.rb,
lib/ukiryu/version_scheme_resolver.rb,
lib/ukiryu/cli_commands/run_command.rb,
lib/ukiryu/config/override_resolver.rb,
lib/ukiryu/models/option_definition.rb,
lib/ukiryu/models/validation_result.rb,
lib/ukiryu/models/version_detection.rb,
lib/ukiryu/cli_commands/base_command.rb,
lib/ukiryu/cli_commands/docs_command.rb,
lib/ukiryu/cli_commands/info_command.rb,
lib/ukiryu/cli_commands/lint_command.rb,
lib/ukiryu/cli_commands/list_command.rb,
lib/ukiryu/cli_commands/opts_command.rb,
lib/ukiryu/definition/sources/string.rb,
lib/ukiryu/extractors/base_extractor.rb,
lib/ukiryu/models/command_definition.rb,
lib/ukiryu/models/env_var_definition.rb,
lib/ukiryu/models/execution_metadata.rb,
lib/ukiryu/options_builder/formatter.rb,
lib/ukiryu/options_builder/validator.rb,
lib/ukiryu/tool/executable_discovery.rb,
lib/ukiryu/cli_commands/cache_command.rb,
lib/ukiryu/cli_commands/which_command.rb,
lib/ukiryu/models/argument_definition.rb,
lib/ukiryu/cli_commands/config_command.rb,
lib/ukiryu/cli_commands/system_command.rb,
lib/ukiryu/definition/definition_cache.rb,
lib/ukiryu/definition/version_resolver.rb,
lib/ukiryu/extractors/native_extractor.rb,
lib/ukiryu/models/implementation_index.rb,
lib/ukiryu/cli_commands/extract_command.rb,
lib/ukiryu/cli_commands/resolve_command.rb,
lib/ukiryu/cli_commands/version_command.rb,
lib/ukiryu/definition/definition_linter.rb,
lib/ukiryu/definition/validation_result.rb,
lib/ukiryu/models/version_compatibility.rb,
lib/ukiryu/cli_commands/commands_command.rb,
lib/ukiryu/cli_commands/describe_command.rb,
lib/ukiryu/cli_commands/register_command.rb,
lib/ukiryu/cli_commands/run_file_command.rb,
lib/ukiryu/cli_commands/validate_command.rb,
lib/ukiryu/models/implementation_version.rb,
lib/ukiryu/definition/definition_composer.rb,
lib/ukiryu/cli_commands/response_formatter.rb,
lib/ukiryu/definition/definition_validator.rb,
lib/ukiryu/cli_commands/definitions_command.rb,
lib/ukiryu/definition/documentation_generator.rb

Defined Under Namespace

Modules: Action, CacheRegistry, CliCommands, CommandBuilder, Debug, Definition, Errors, ExecutableLocator, Execution, Executor, Extractors, FriendlyCLI, ManPageParser, Models, Options, OptionsBuilder, Platform, Redirection, Response, Shell, Stream, ToolCache, ToolFinder, Tools, Type, Utils, Validation, VersionDetector Classes: Cache, Cli, Config, Configuration, Environment, ExecutionContext, Logger, Pipe, Register, Runtime, SchemaValidator, StandardError, StandardInput, StandardOutput, Tool, ToolIndex, ToolMetadata, VersionCompatibility, VersionSchemeResolver

Constant Summary collapse

STDIN =

Standard stream marker for stdin

'-'
STDOUT =

Standard stream marker for stdout

'-'
STDIN_MARKER =

Special value for reading from stdin (double dash)

'--'
VERSION = 
'0.3.0'

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object

Get global configuration



66
67
68
 
# File 'lib/ukiryu.rb', line 66

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Configure global Ukiryu settings

Yields:



61
62
63
 
# File 'lib/ukiryu.rb', line 61

def configure
  yield configuration
end

.debug_enabled? ⇒ Boolean

Convenience method for checking if debug is enabled

Returns:

  • (Boolean) —

    true if debug mode is enabled



51
52
53
 
# File 'lib/ukiryu/debug.rb', line 51

def self.debug_enabled?
  Debug.enabled?
end

.reset_configuration ⇒ Object

Reset configuration (mainly for testing)



71
72
73
74
75
76
 
# File 'lib/ukiryu.rb', line 71

def reset_configuration
  @configuration = nil
  Shell.reset
  Runtime.instance.reset!
  ExecutionContext.reset_current!
end