gem.sh gem.sh
Home Gems Types Docs Community
  • Modules

    • module Clacky
    • module Clacky::AesGcm
    • module Clacky::Agent::CostTracker
    • module Clacky::Agent::LlmCaller
    • module Clacky::Agent::MemoryUpdater
    • module Clacky::Agent::MessageCompressorHelper
    • module Clacky::Agent::SessionSerializer
    • module Clacky::Agent::SkillAutoCreator
    • module Clacky::Agent::SkillEvolution
    • module Clacky::Agent::SkillManager
    • module Clacky::Agent::SkillReflector
    • module Clacky::Agent::SystemPromptBuilder
    • module Clacky::Agent::TimeMachine
    • module Clacky::Agent::ToolExecutor
    • module Clacky::BlockFont
    • module Clacky::Channel
    • module Clacky::Channel::Adapters
    • module Clacky::Channel::Adapters::DingTalk
    • module Clacky::Channel::Adapters::Discord
    • module Clacky::Channel::Adapters::Feishu
    • module Clacky::Channel::Adapters::Feishu::FileProcessor
    • module Clacky::Channel::Adapters::Feishu::WSClient::ProtoFrame
    • module Clacky::Channel::Adapters::Telegram
    • module Clacky::Channel::Adapters::Wecom
    • module Clacky::Channel::Adapters::Wecom::MediaDownloader
    • module Clacky::Channel::Adapters::Weixin
    • module Clacky::ChannelSetup
    • module Clacky::ClackyEnv
    • module Clacky::ClaudeCodeEnv
    • module Clacky::Logger
    • module Clacky::MessageFormat
    • module Clacky::MessageFormat::Anthropic
    • module Clacky::MessageFormat::Bedrock
    • module Clacky::MessageFormat::OpenAI
    • module Clacky::ModelPricing
    • module Clacky::Providers
    • module Clacky::Server
    • module Clacky::Server::Discover
    • module Clacky::Telemetry
    • module Clacky::Tools
    • module Clacky::Tools::Security
    • module Clacky::Tools::Terminal::OutputCleaner
    • module Clacky::UI2
    • module Clacky::UI2::Components
    • module Clacky::UI2::LineEditor
    • module Clacky::UI2::MarkdownRenderer
    • module Clacky::UI2::Themes
    • module Clacky::UIInterface
    • module Clacky::Utils
    • module Clacky::Utils::BrowserDetector
    • module Clacky::Utils::Encoding
    • module Clacky::Utils::EnvironmentDetector
    • module Clacky::Utils::FileIgnoreHelper
    • module Clacky::Utils::FileProcessor
    • module Clacky::Utils::LoginShell
    • module Clacky::Utils::ParserManager
    • module Clacky::Utils::PathHelper
    • module Clacky::Utils::ScriptsManager
    • module Clacky::Utils::StringMatcher
    • module Clacky::Utils::WorkspaceRules
    • module Enumerable
    • module YAMLCompat
  • Classes

    • class BrowserSession
    • class BuiltinSkillsInstaller
    • class Clacky::Agent
    • class Clacky::AgentConfig
    • class Clacky::AgentError
    • class Clacky::AgentInterrupted
    • class Clacky::AgentProfile
    • class Clacky::AnthropicStreamAggregator
    • class Clacky::BadRequestError
    • class Clacky::Banner
    • class Clacky::BedrockStreamAggregator
    • class Clacky::BrandConfig
    • class Clacky::BrowserManager
    • class Clacky::BrowserNotReachableError
    • class Clacky::CLI
    • class Clacky::Channel::Adapters::Base
    • class Clacky::Channel::Adapters::DingTalk::Adapter
    • class Clacky::Channel::Adapters::DingTalk::ApiClient
    • class Clacky::Channel::Adapters::DingTalk::StreamClient
    • class Clacky::Channel::Adapters::Discord::Adapter
    • class Clacky::Channel::Adapters::Discord::ApiClient
    • class Clacky::Channel::Adapters::Discord::ApiClient::ApiError
    • class Clacky::Channel::Adapters::Discord::GatewayClient
    • class Clacky::Channel::Adapters::Discord::GatewayClient::AuthError
    • class Clacky::Channel::Adapters::Feishu::Adapter
    • class Clacky::Channel::Adapters::Feishu::Bot
    • class Clacky::Channel::Adapters::Feishu::FeishuDocPermissionError
    • class Clacky::Channel::Adapters::Feishu::FeishuDocScopeError
    • class Clacky::Channel::Adapters::Feishu::MessageParser
    • class Clacky::Channel::Adapters::Feishu::WSClient
    • class Clacky::Channel::Adapters::Telegram::Adapter
    • class Clacky::Channel::Adapters::Telegram::ApiClient
    • class Clacky::Channel::Adapters::Telegram::ApiClient::ApiError
    • class Clacky::Channel::Adapters::Telegram::ApiClient::TimeoutError
    • class Clacky::Channel::Adapters::Wecom::Adapter
    • class Clacky::Channel::Adapters::Wecom::WSClient
    • class Clacky::Channel::Adapters::Wecom::WSClient::AuthError
    • class Clacky::Channel::Adapters::Weixin::Adapter
    • class Clacky::Channel::Adapters::Weixin::ApiClient
    • class Clacky::Channel::Adapters::Weixin::ApiClient::ApiError
    • class Clacky::Channel::Adapters::Weixin::ApiClient::TimeoutError
    • class Clacky::Channel::Adapters::Weixin::SendQueue
    • class Clacky::Channel::ChannelManager
    • class Clacky::Channel::ChannelUIController
    • class Clacky::ChannelConfig
    • class Clacky::ChannelSetup::LarkSkillsImporter
    • class Clacky::Client
    • class Clacky::GitignoreParser
    • class Clacky::HookManager
    • class Clacky::IdleCompressionTimer
    • class Clacky::JsonUIController
    • class Clacky::MessageCompressor
    • class Clacky::MessageHistory
    • class Clacky::OpenAIStreamAggregator
    • class Clacky::PlainUIController
    • class Clacky::PlatformHttpClient
    • class Clacky::PlatformHttpClient::RetryableNetworkError
    • class Clacky::ProgressIndicator
    • class Clacky::RetryableError
    • class Clacky::Server::EPIPESafeIO
    • class Clacky::Server::HistoryCollector
    • class Clacky::Server::HttpServer
    • class Clacky::Server::HttpServer::WebSocketConnection
    • class Clacky::Server::Master
    • class Clacky::Server::Scheduler
    • class Clacky::Server::SessionRegistry
    • class Clacky::Server::WebUIController
    • class Clacky::SessionManager
    • class Clacky::Skill
    • class Clacky::SkillLoader
    • class Clacky::ToolCallError
    • class Clacky::ToolRegistry
    • class Clacky::Tools::Base
    • class Clacky::Tools::Browser
    • class Clacky::Tools::Edit
    • class Clacky::Tools::FileReader
    • class Clacky::Tools::Glob
    • class Clacky::Tools::Grep
    • class Clacky::Tools::InvokeSkill
    • class Clacky::Tools::ListTasks
    • class Clacky::Tools::RedoTask
    • class Clacky::Tools::RequestUserFeedback
    • class Clacky::Tools::Security::Blocked
    • class Clacky::Tools::Security::Replacer
    • class Clacky::Tools::Terminal
    • class Clacky::Tools::Terminal::PersistentSessionPool
    • class Clacky::Tools::Terminal::SessionManager
    • class Clacky::Tools::Terminal::SpawnFailed
    • class Clacky::Tools::TodoManager
    • class Clacky::Tools::TrashManager
    • class Clacky::Tools::UndoTask
    • class Clacky::Tools::WebFetch
    • class Clacky::Tools::WebSearch
    • class Clacky::Tools::Write
    • class Clacky::TrashDirectory
    • class Clacky::UI2::Components::BaseComponent
    • class Clacky::UI2::Components::CommandSuggestions
    • class Clacky::UI2::Components::CommonComponent
    • class Clacky::UI2::Components::InlineInput
    • class Clacky::UI2::Components::InputArea
    • class Clacky::UI2::Components::MessageComponent
    • class Clacky::UI2::Components::ModalComponent
    • class Clacky::UI2::Components::TodoArea
    • class Clacky::UI2::Components::ToolComponent
    • class Clacky::UI2::Components::WelcomeBanner
    • class Clacky::UI2::LayoutManager
    • class Clacky::UI2::OutputBuffer
    • class Clacky::UI2::ProgressHandle
    • class Clacky::UI2::ScreenBuffer
    • class Clacky::UI2::TerminalDetector
    • class Clacky::UI2::ThemeManager
    • class Clacky::UI2::Themes::BaseTheme
    • class Clacky::UI2::Themes::HackerTheme
    • class Clacky::UI2::Themes::MinimalTheme
    • class Clacky::UI2::UIController
    • class Clacky::UI2::ViewRenderer
    • class Clacky::UIInterface::LegacyProgressHandleAdapter
    • class Clacky::UpstreamTruncatedError
    • class Clacky::Utils::ArgumentsParser
    • class Clacky::Utils::BadArgumentsError
    • class Clacky::Utils::LimitStack
    • class Clacky::Utils::MissingRequiredParamsError
    • class ExternalSkillsImportRunner
    • class ExternalSkillsImporter
    • class FeishuApiClient
    • class FeishuSkillsInstaller
    • class OpenClawImporter
    • class RetryableError
    • class ToolClient
    • class ZipSkillInstaller
    Overview
    H
    Home
    R
    Reference
    T
    Types
    C
    Changelogs
  • Documentation
    • README
    • Agent-first-UI-design
    • Channel-architecture
    • Engineering-article
    • Session-skill-invocation
    • Time machine design
    • Ui2-architecture
  • More
    • Versions
    • Source
    • Playground
    • Stats
    • Metadata
    • Wiki
    • Announcements
    Community
    • Articles
    • Tutorials
    • Videos
    • Community
  1. Gems
  2. openclacky

openclacky

OpenClacky is a Ruby CLI tool for interacting with AI models via OpenAI-compatible APIs. It provides chat functionality and autonomous AI agent capabilities with tool use.

Types
Docs
Guides
Zeitwerk
Namespace
Optimized

Version

1.1.5

Authors

windy

Dependencies

faraday, faraday-multipart, thor, tty-prompt, tty-spinner, diffy, pastel, tty-screen, tty-markdown, base64, logger, websocket, webrick, artii, rubyzip, rouge, chunky_png

Quick Start

bundle add openclacky

Getting Started

Learn more about the Openclacky gem.

Installation

Learn more about how to install and configure the gem

Documentation

Learn more about the details

Guides

Learn more about the gem in the written guides

Reference

Learn more about the classes and modules

Documentation

docs/agent-first-ui-design.md

Read about "Agent-first-UI-design" in openclacky

Read more

docs/channel-architecture.md

Read about "Channel-architecture" in openclacky

Read more

docs/engineering-article.md

Read about "Engineering-article" in openclacky

Read more

docs/session-skill-invocation.md

Read about "Session-skill-invocation" in openclacky

Read more

Playground

Test, play and inspect the gem for yourself

irb(main):001:0>

            

Playground

Run a Ruby playground with the openclacky gem pre-installed

Play

Top-Level Modules

  • Clacky
  • Enumerable
  • YAMLCompat

Top-Level Classes

  • BrowserSession
  • BuiltinSkillsInstaller
  • ExternalSkillsImportRunner
  • ExternalSkillsImporter
  • FeishuApiClient
  • FeishuSkillsInstaller
  • OpenClawImporter
  • RetryableError
  • ToolClient
  • ZipSkillInstaller

Top-Level Instance Methods

  • # api_ok!
  • # api_ok?
  • # build_markdown_table
  • # cmd_delete
  • # cmd_publish
  • # device_fingerprint
  • # discord_get
  • # display_qr
  • # do_http_request
  • # extract_runs
  • # extract_text
  • # fail!
  • # fail!
  • # fail!
  • # fail!
  • # height
  • # hmac_headers
  • # http_request
  • # ilink_get
  • # load_token_data
  • # log
  • # mode_poll
  • # mode_print_qr
  • # ok
  • # ok
  • # ok
  • # ok
  • # parse_failed?
  • # parse_paragraph
  • # parse_row
  • # parse_slide
  • # parse_table
  • # parse_table
  • # poll_until_confirmed
  • # poll_with_ws_wait
  • # post_json
  • # random_wechat_uin
  • # read_document_xml
  • # read_numbering
  • # read_styles
  • # read_zip_entry
  • # run_setup
  • # safe_utf8
  • # save_to_server
  • # save_to_server
  • # save_token_data
  • # saved_bot_token
  • # server_get
  • # server_post
  • # step
  • # step
  • # step
  • # step
  • # to_s
  • # try_antiword
  • # try_ocr
  • # try_pdfplumber
  • # try_pdftotext
  • # try_textutil
  • # visible_lines
  • # warn
  • # warn
  • # warn!
Home
Gems
Docs
Contribute
Monitoring
Twitter GitHub Mastodon

© 2026 gem.sh - Beautiful documentation for any Ruby gem