Module: Kward

Defined in:: lib/kward/cli.rb,
lib/kward/ansi.rb,
lib/kward/agent.rb,
lib/kward/ekwsh.rb,
lib/kward/events.rb,
lib/kward/cli/git.rb,
lib/kward/prompts.rb,
lib/kward/version.rb,
lib/kward/cli/tabs.rb,
lib/kward/steering.rb,
lib/kward/auth/file.rb,
lib/kward/cli/stats.rb,
lib/kward/clipboard.rb,
lib/kward/compactor.rb,
lib/kward/tab_store.rb,
lib/kward/workspace.rb,
lib/kward/cli/doctor.rb,
lib/kward/pan/server.rb,
lib/kward/rpc/server.rb,
lib/kward/tools/base.rb,
lib/kward/cli/plugins.rb,
lib/kward/editor_mode.rb,
lib/kward/export_path.rb,
lib/kward/workers/job.rb,
lib/kward/cancellation.rb,
lib/kward/cli/commands.rb,
lib/kward/cli/sessions.rb,
lib/kward/cli/settings.rb,
lib/kward/config_files.rb,
lib/kward/conversation.rb,
lib/kward/message_text.rb,
lib/kward/model/client.rb,
lib/kward/private_file.rb,
lib/kward/rpc/redactor.rb,
lib/kward/session_diff.rb,
lib/kward/cli/rendering.rb,
lib/kward/cli/sysprompt.rb,
lib/kward/project_files.rb,
lib/kward/rpc/transport.rb,
lib/kward/session_store.rb,
lib/kward/session_trash.rb,
lib/kward/terminal_keys.rb,
lib/kward/text_boundary.rb,
lib/kward/workers/store.rb,
lib/kward/cli/compaction.rb,
lib/kward/memory/manager.rb,
lib/kward/message_access.rb,
lib/kward/model/payloads.rb,
lib/kward/prompt_history.rb,
lib/kward/session_naming.rb,
lib/kward/tools/registry.rb,
lib/kward/workers/worker.rb,
lib/kward/plugin_registry.rb,
lib/kward/skills/registry.rb,
lib/kward/telemetry/stats.rb,
lib/kward/tools/edit_file.rb,
lib/kward/tools/fetch_raw.rb,
lib/kward/tools/read_file.rb,
lib/kward/tools/tool_call.rb,
lib/kward/workers/manager.rb,
lib/kward/model/model_info.rb,
lib/kward/prompt_interface.rb,
lib/kward/prompts/commands.rb,
lib/kward/rpc/auth_manager.rb,
lib/kward/rpc/session_tree.rb,
lib/kward/telemetry/logger.rb,
lib/kward/tools/read_skill.rb,
lib/kward/tools/search/web.rb,
lib/kward/tools/web_search.rb,
lib/kward/tools/write_file.rb,
lib/kward/auth/github_oauth.rb,
lib/kward/auth/openai_oauth.rb,
lib/kward/cli/auth_commands.rb,
lib/kward/image_attachments.rb,
lib/kward/prompts/templates.rb,
lib/kward/question_contract.rb,
lib/kward/rpc/prompt_bridge.rb,
lib/kward/rpc/tool_metadata.rb,
lib/kward/scratchpad_runner.rb,
lib/kward/tools/code_search.rb,
lib/kward/tools/search/code.rb,
lib/kward/transcript_export.rb,
lib/kward/workers/git_guard.rb,
lib/kward/workers/live_view.rb,
lib/kward/cli/slash_commands.rb,
lib/kward/cli/tool_summaries.rb,
lib/kward/rpc/config_manager.rb,
lib/kward/rpc/memory_methods.rb,
lib/kward/session_tree_nodes.rb,
lib/kward/terminal_sequences.rb,
lib/kward/workers/write_lock.rb,
lib/kward/cli/memory_commands.rb,
lib/kward/cli/runtime_helpers.rb,
lib/kward/markdown_transcript.rb,
lib/kward/model/context_usage.rb,
lib/kward/model/retry_message.rb,
lib/kward/model/stream_parser.rb,
lib/kward/rpc/session_manager.rb,
lib/kward/rpc/session_metrics.rb,
lib/kward/tools/fetch_content.rb,
lib/kward/workers/queue_store.rb,
lib/kward/workers/tool_policy.rb,
lib/kward/auth/anthropic_oauth.rb,
lib/kward/cli/interactive_turn.rb,
lib/kward/cli/prompt_interface.rb,
lib/kward/context_budget_meter.rb,
lib/kward/local_command_runner.rb,
lib/kward/rpc/runtime_payloads.rb,
lib/kward/tools/list_directory.rb,
lib/kward/workers/queue_runner.rb,
lib/kward/model/chat_invocation.rb,
lib/kward/rpc/session_tree_rows.rb,
lib/kward/session_tree_renderer.rb,
lib/kward/tool_output_compactor.rb,
lib/kward/interactive_pty_runner.rb,
lib/kward/model/context_overflow.rb,
lib/kward/openrouter_model_cache.rb,
lib/kward/starter_pack_installer.rb,
lib/kward/tools/context_for_task.rb,
lib/kward/tools/search/web_fetch.rb,
lib/kward/auth/openrouter_api_key.rb,
lib/kward/cli/openrouter_commands.rb,
lib/kward/prompt_interface/banner.rb,
lib/kward/prompt_interface/layout.rb,
lib/kward/prompt_interface/screen.rb,
lib/kward/tools/ask_user_question.rb,
lib/kward/tools/run_shell_command.rb,
lib/kward/cli_transcript_formatter.rb,
lib/kward/local_pty_command_runner.rb,
lib/kward/rpc/attachment_normalizer.rb,
lib/kward/rpc/tool_event_normalizer.rb,
lib/kward/rpc/transcript_normalizer.rb,
lib/kward/session_tree_tool_display.rb,
lib/kward/tools/context_budget_stats.rb,
lib/kward/tools/retrieve_tool_output.rb,
lib/kward/prompt_interface/git_prompt.rb,
lib/kward/prompt_interface/key_handler.rb,
lib/kward/prompt_interface/editor/state.rb,
lib/kward/prompt_interface/file_overlay.rb,
lib/kward/prompt_interface/stream_state.rb,
lib/kward/prompt_interface/editor/buffer.rb,
lib/kward/prompt_interface/editor/search.rb,
lib/kward/prompt_interface/runtime_state.rb,
lib/kward/prompt_interface/slash_overlay.rb,
lib/kward/tools/summarize_file_structure.rb,
lib/kward/prompt_interface/composer_state.rb,
lib/kward/prompt_interface/editor/endwise.rb,
lib/kward/prompt_interface/editor/renderer.rb,
lib/kward/prompt_interface/project_browser.rb,
lib/kward/prompt_interface/prompt_renderer.rb,
lib/kward/prompt_interface/question_prompt.rb,
lib/kward/compaction/file_operation_tracker.rb,
lib/kward/prompt_interface/editor/kill_ring.rb,
lib/kward/prompt_interface/overlay_renderer.rb,
lib/kward/prompt_interface/selection_prompt.rb,
lib/kward/prompt_interface/composer_renderer.rb,
lib/kward/prompt_interface/editor/controller.rb,
lib/kward/prompt_interface/editor/modes/vibe.rb,
lib/kward/prompt_interface/editor/selections.rb,
lib/kward/prompt_interface/editor/vibe_state.rb,
lib/kward/prompt_interface/interactive/state.rb,
lib/kward/prompt_interface/transcript_buffer.rb,
lib/kward/prompt_interface/editor/auto_indent.rb,
lib/kward/prompt_interface/editor/file_marker.rb,
lib/kward/prompt_interface/editor/modes/emacs.rb,
lib/kward/prompt_interface/editor/status_text.rb,
lib/kward/prompt_interface/composer_controller.rb,
lib/kward/prompt_interface/editor/modes/modern.rb,
lib/kward/prompt_interface/editor/undo_history.rb,
lib/kward/prompt_interface/transcript_renderer.rb,
lib/kward/prompt_interface/interactive/renderer.rb,
lib/kward/prompt_interface/interactive/controller.rb,
lib/kward/prompt_interface/editor/auto_close_pairs.rb,
lib/kward/prompt_interface/editor/indent_navigation.rb,
lib/kward/prompt_interface/editor/syntax_highlighter.rb,
lib/kward/prompt_interface/editor/modes/vibe_insert_readline.rb

Overview

Namespace for the Kward CLI agent runtime.

Defined Under Namespace

Modules: ANSI, AuthFile, CLITranscriptFormatter, ChatInvocation, Compaction, ConfigFiles, ContextOverflow, EditorMode, Events, ImageAttachments, Memory, MessageAccess, MessageText, ModelInfo, ModelPayloads, ModelStreamParser, PrivateFile, ProjectFiles, PromptCommands, Prompts, QuestionContract, RPC, RetryMessage, ScratchpadRunner, SessionNaming, SessionTreeToolDisplay, Skills, TerminalKeys, TerminalSequences, TextBoundary, ToolCall, Tools, Workers Classes: Agent, AnthropicOAuth, CLI, Cancellation, Client, Clipboard, CodeSearch, Compactor, ContextBudgetMeter, ContextUsage, Conversation, Ekwsh, ExportPath, GithubOAuth, InteractivePtyRunner, LocalCommandRunner, LocalPtyCommandRunner, MarkdownTranscript, OpenAIOAuth, OpenRouterAPIKey, OpenRouterModelCache, PanServer, PluginRegistry, PromptHistory, PromptInterface, SessionDiff, SessionStore, SessionTrash, SessionTreeNodes, SessionTreeRenderer, StarterPackInstaller, Steering, TabStore, TelemetryLogger, TelemetryStats, TiktokenTokenCounter, ToolOutputCompactor, ToolRegistry, TranscriptExport, WebFetch, WebSearch, Workspace

Constant Summary collapse

VERSION = Current gem version.

"0.73.1"

Class Method Summary collapse

.plugin {|plugin| ... } ⇒ Object^?
Registers a trusted local plugin.

Class Method Details

.plugin {|plugin| ... } ⇒ `Object`^?

Registers a trusted local plugin.

This method is intended for Ruby files loaded from the user plugin directory. It raises if called outside plugin loading so workspace code cannot silently mutate Kward's runtime by merely being required.

Yield Parameters:

plugin (PluginRegistry::DSL) —
plugin registration DSL

Returns:

(Object, nil) —
the plugin block result

# File 'lib/kward/plugin_registry.rb', line 439

def self.plugin(&block)
  registry = PluginRegistry.loading_registry
  raise "Kward.plugin can only be called while loading a plugin" unless registry

  dsl = PluginRegistry::DSL.new(registry, PluginRegistry.loading_path)
  block.arity == 1 ? block.call(dsl) : dsl.instance_eval(&block)
end