Class: Clacky::CLI

Inherits:
Thor
  • Object
show all
Defined in:
lib/clacky/cli.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.exit_on_failure? ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/clacky/cli.rb', line 13

def self.exit_on_failure?
  true
end

Instance Method Details

#agent ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/clacky/cli.rb', line 64

def agent
  # Handle help option
  if options[:help]
    invoke :help, ["agent"]
    return
  end

  # ── Telemetry (anonymous, opt-out via CLACKY_TELEMETRY=0) ──────────
  # Fire-and-forget background thread; never blocks startup.
  Clacky::Telemetry.startup!

  # ── Sibling server discovery ───────────────────────────────────────
  # Bare-CLI mode does NOT boot an HTTP server, so skills that call
  # back into /api/* (channels, browser, scheduler) normally can't work.
  # If the user happens to have a Clacky server running on this machine
  # (in another terminal or via `clacky server`), auto-wire CLACKY_SERVER_HOST
  # / CLACKY_SERVER_PORT so those skills can reach it transparently.
  discover_sibling_server!

  agent_config = Clacky::AgentConfig.load

  # Override model if --model option is specified
  if options[:model]
    unless agent_config.switch_model_by_name(options[:model])
      # During early startup @ui may not be ready; use simple error output
      $stderr.puts "Error: model '#{options[:model]}' not found. Available: #{agent_config.model_names.join(', ')}"
      exit 1
    end
  end

  # Handle session listing
  if options[:list]
    list_sessions
    return
  end

  # Handle Ctrl+C gracefully - raise exception to be caught in the loop
  Signal.trap("INT") do
    Thread.main.raise(Clacky::AgentInterrupted, "Interrupted by user")
  end

  # Validate and get working directory
  working_dir = validate_working_directory(options[:path], agent_config)

  # Update agent config with CLI options
  agent_config.permission_mode = options[:mode].to_sym if options[:mode]
  agent_config.verbose = options[:verbose] if options[:verbose]

  # Client factory: produces a fresh Client reflecting the *current*
  # state of agent_config each time it's called. The CLI never holds a
  # long-lived `client` variable — instead, anyone who needs a client
  # (initial agent construction, /clear, etc.) calls the factory.
  #
  # This mirrors the server-side design (HTTPServer#client_factory) and
  # avoids the class of bugs where a shared client is ivar_set'd field by
  # field (easy to miss @model / @use_bedrock) and then reused for a
  # later Agent.new, serving stale credentials.
  client_factory = lambda do
    Clacky::Client.new(
      agent_config.api_key,
      base_url: agent_config.base_url,
      model: agent_config.model_name,
      anthropic_format: agent_config.anthropic_format?
    )
  end

  # Resolve agent profile name from --agent option
  agent_profile = options[:agent] || "coding"

  # Handle session loading/continuation
  session_manager = Clacky::SessionManager.new
  agent = nil
  is_session_load = false

  if options[:continue]
    agent = load_latest_session(client_factory.call, agent_config, session_manager, working_dir, profile: agent_profile)
    is_session_load = !agent.nil?
  elsif options[:attach]
    agent = load_session_by_number(client_factory.call, agent_config, session_manager, working_dir, options[:attach], profile: agent_profile)
    is_session_load = !agent.nil?
  elsif options[:fork]
    agent = fork_session(client_factory.call, agent_config, session_manager, working_dir, options[:fork], profile: agent_profile)
    is_session_load = !agent.nil?
  end

  # Create new agent if no session loaded
  if agent.nil?
    agent = Clacky::Agent.new(client_factory.call, agent_config, working_dir: working_dir, ui: nil, profile: agent_profile,
                              session_id: Clacky::SessionManager.generate_id, source: :manual)
    agent.rename("CLI Session")
  end

  # Change to working directory
  original_dir = Dir.pwd
  should_chdir = File.realpath(working_dir) != File.realpath(original_dir)
  Dir.chdir(working_dir) if should_chdir
  begin
    if options[:message]
      file_paths = Array(options[:file]) + Array(options[:image])
      run_non_interactive(agent, options[:message], file_paths, agent_config, session_manager)
    elsif options[:json]
      run_agent_with_json(agent, working_dir, agent_config, session_manager, client_factory, profile: agent_profile)
    else
      run_agent_with_ui2(agent, working_dir, agent_config, session_manager, client_factory, is_session_load: is_session_load)
    end
  ensure
    Dir.chdir(original_dir)
    Clacky::BrowserManager.instance.stop rescue nil
  end
end

#api_ext_list ⇒ Object 



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
 
# File 'lib/clacky/cli.rb', line 1255

def api_ext_list
  Clacky::ApiExtensionLoader.load_all if Clacky::ApiExtension.registry.empty?

  if Clacky::ApiExtension.registry.empty?
    puts "No api extensions loaded."
    return
  end

  Clacky::ApiExtension.registry.each do |id, klass|
    public_tag = klass.public_paths.any? ? " (public)" : ""
    puts "#{id}#{public_tag}"
    klass.routes.each do |route|
      full_path = "/api/ext/#{id}#{route.pattern}".chomp("/")
      full_path = "/api/ext/#{id}/" if full_path == "/api/ext/#{id}"
      puts "  #{route.method.to_s.upcase.ljust(6)} #{full_path}"
    end
  end
end

#api_ext_new(name) ⇒ Object 



1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/clacky/cli.rb', line 1226

def api_ext_new(name)
  path = Clacky::ApiExtensionLoader.scaffold(name)
  puts "Created api extension: #{path}"
  puts "Edit the routes, then run: clacky api_ext_verify"
rescue ArgumentError => e
  warn "Error: #{e.message}"
  exit 1
end

#api_ext_verify ⇒ Object 



1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'lib/clacky/cli.rb', line 1236

def api_ext_verify
  result = Clacky::ApiExtensionLoader.load_all

  if result.loaded.empty? && result.skipped.empty?
    puts "No api extensions found in ~/.clacky/api_ext/"
    return
  end

  result.loaded.each do |id|
    klass = Clacky::ApiExtension.registry[id]
    public_count = klass.public_paths.size
    suffix = public_count > 0 ? " (#{public_count} public)" : ""
    puts "[OK]   #{id} — #{klass.routes.size} route(s)#{suffix}"
  end
  result.skipped.each { |(n, reason)| puts "[SKIP] #{n} — #{reason}" }
  exit 1 if result.skipped.any?
end

#billing ⇒ Object 



1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
 
# File 'lib/clacky/cli.rb', line 1297

def billing
  if options[:help]
    invoke :help, ["billing"]
    return
  end

  require_relative "billing/billing_store"

  store = Clacky::Billing::BillingStore.new
  period = options[:period].to_sym
  summary = store.summary(period: period)

  if options[:json]
    require "json"
    puts JSON.pretty_generate(summary)
    return
  end

  # Display formatted billing summary
  puts ""
  puts "📊 Billing Summary (#{period})"
  puts "─" * 50
  puts ""

  # Total cost
  cost_str = summary[:total_cost] > 0 ? "$#{format('%.4f', summary[:total_cost])}" : "$0.0000"
  puts "  💰 Total Cost:       #{cost_str}"
  puts "  📝 Total Tokens:     #{format_number(summary[:total_tokens])}"
  puts "  📥 Prompt Tokens:    #{format_number(summary[:prompt_tokens])}"
  puts "  📤 Completion:       #{format_number(summary[:completion_tokens])}"
  puts "  🗄️  Cache Read:       #{format_number(summary[:cache_read_tokens])}"
  puts "  📝 Cache Write:      #{format_number(summary[:cache_write_tokens])}"
  puts "  🔢 API Requests:     #{summary[:record_count]}"
  puts ""

  # By model breakdown
  if summary[:by_model] && !summary[:by_model].empty?
    puts "📈 By Model:"
    puts "─" * 50
    summary[:by_model].each do |model, data|
      cost = data.is_a?(Hash) ? data[:cost] : data
      requests = data.is_a?(Hash) ? data[:requests] : "?"
      puts "  #{model}"
      puts "    Cost: $#{format('%.4f', cost)}  |  Requests: #{requests}"
    end
    puts ""
  end

  # Daily breakdown (last N days)
  daily = store.daily_breakdown(days: [options[:days], 14].min)
  recent_days = daily.select { |d| d[:cost] > 0 }.last(7)

  if recent_days.any?
    puts "📅 Recent Daily Usage:"
    puts "─" * 50
    recent_days.each do |day|
      bar_len = [(day[:cost] * 100).to_i, 30].min
      bar = "█" * bar_len
      puts "  #{day[:date]}  $#{format('%.4f', day[:cost])}  #{bar}"
    end
    puts ""
  end

  puts "─" * 50
  puts "  Data stored in: ~/.clacky/billing/"
  puts ""
end

#channel_new(name) ⇒ Object 



1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'lib/clacky/cli.rb', line 1192

def channel_new(name)
  require_relative "server/channel"
  path = Clacky::Channel::Adapters::UserAdapterLoader.scaffold(name)
  puts "Created channel adapter: #{path}"
  puts "Edit the TODO sections, then run: clacky channel_verify"
rescue ArgumentError => e
  warn "Error: #{e.message}"
  exit 1
end

#channel_verify ⇒ Object 



1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
 
# File 'lib/clacky/cli.rb', line 1203

def channel_verify
  require_relative "server/channel"
  result = Clacky::Channel::Adapters::UserAdapterLoader.last_result

  if result.loaded.empty? && result.skipped.empty?
    puts "No custom channel adapters found in ~/.clacky/channels/"
    return
  end

  result.loaded.each { |n| puts "[OK]   #{n}" }
  result.skipped.each { |(n, reason)| puts "[SKIP] #{n} — #{reason}" }
  exit 1 if result.skipped.any?
end

#hook_new ⇒ Object 



1156
1157
1158
1159
1160
1161
1162
1163
1164
 
# File 'lib/clacky/cli.rb', line 1156

def hook_new
  require_relative "shell_hook_loader"
  path = Clacky::ShellHookLoader.scaffold
  puts "Created hooks config: #{path}"
  puts "Edit it, then run: clacky hook_verify"
rescue ArgumentError => e
  warn "Error: #{e.message}"
  exit 1
end

#hook_verify ⇒ Object 



1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
 
# File 'lib/clacky/cli.rb', line 1167

def hook_verify
  require_relative "agent/hook_manager"
  require_relative "shell_hook_loader"
  hm = Clacky::HookManager.new
  result = Clacky::ShellHookLoader.load_into(hm)

  if result.registered.empty? && result.skipped.empty?
    puts "No hooks found in ~/.clacky/hooks.yml"
    return
  end

  result.registered.each { |(event, name)| puts "[OK]   #{event} → #{name}" }
  result.skipped.each { |(name, reason)| puts "[SKIP] #{name} — #{reason}" }
  exit 1 if result.skipped.any?
end

#patch_list ⇒ Object 



1151
1152
1153
 
# File 'lib/clacky/cli.rb', line 1151

def patch_list
  invoke :patch_verify, []
end

#patch_new(id, target) ⇒ Object 



1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'lib/clacky/cli.rb', line 1124

def patch_new(id, target)
  require_relative "patch_loader"
  path = Clacky::PatchLoader.scaffold(id, target, description: options[:desc])
  puts "Created patch: #{path}"
  puts "Edit patch.rb, then run: clacky patch_verify"
rescue ArgumentError, StandardError => e
  warn "Error: #{e.message}"
  exit 1
end

#patch_verify ⇒ Object 



1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/clacky/cli.rb', line 1135

def patch_verify
  require "clacky"
  result = Clacky::PatchLoader.last_result

  if result.applied.empty? && result.disabled.empty? && result.skipped.empty?
    puts "No patches found in ~/.clacky/patches/"
    return
  end

  result.applied.each  { |id| puts "[OK]       #{id}" }
  result.disabled.each { |(id, reason)| puts "[DISABLED] #{id} — #{reason}" }
  result.skipped.each  { |(id, reason)| puts "[SKIP]     #{id} — #{reason}" }
  exit 1 if result.skipped.any?
end

#server ⇒ Object 



1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/clacky/cli.rb', line 1390

def server
  if options[:help]
    invoke :help, ["server"]
    return
  end

  # ── Security gate ──────────────────────────────────────────────────────
  # Binding to 0.0.0.0 exposes the server to the public network.
  # Refuse to start unless CLACKY_ACCESS_KEY env var is set.
  if options[:host] == "0.0.0.0" && !ENV.key?("CLACKY_ACCESS_KEY")
    puts <<~MSG
      ╔══════════════════════════════════════════════════════════════╗
      ║  ⚠️  Security Warning: Refusing to start                      ║
      ╠══════════════════════════════════════════════════════════════╣
      ║                                                              ║
      ║  Binding to 0.0.0.0 exposes Clacky to the public network.    ║
      ║  You must set CLACKY_ACCESS_KEY before starting the server.  ║
      ║                                                              ║
      ║  Generate a secure key:                                      ║
      ║    openssl rand -hex 32                                      ║
      ║                                                              ║
      ║  Then export it:                                             ║
      ║    export CLACKY_ACCESS_KEY=<your-generated-key>             ║
      ║                                                              ║
      ╚══════════════════════════════════════════════════════════════╝
    MSG
    exit(1)
  end
  # ─────────────────────────────────────────────────────────────────────

  if ENV["CLACKY_WORKER"] == "1"
    # ── Worker mode ───────────────────────────────────────────────────────
    # Spawned by Master. Inherit the listen socket from the file descriptor
    # passed via CLACKY_INHERIT_FD, and report back to master via CLACKY_MASTER_PID.
    require_relative "server/http_server"
    require_relative "server/epipe_safe_io"

    # Protect $stdout / $stderr from Errno::EPIPE.
    #
    # The worker inherits fd 1/2 from the Master process. If the Master's
    # stdout pipe ever breaks (e.g. it was launched by an installer or GUI
    # that has since exited), the next `puts` would raise Errno::EPIPE and
    # crash the worker — destroying all in-memory sessions, agent loops,
    # and SSE connections, and looping forever because the respawned
    # worker inherits the same broken fd.
    #
    # In healthy state these wrappers are transparent — output goes to
    # the user's terminal as usual. On first broken-pipe failure they
    # silently fall back to /dev/null and the worker stays alive.
    $stdout = Clacky::Server::EPIPESafeIO.new($stdout)
    $stderr = Clacky::Server::EPIPESafeIO.new($stderr)

    fd              = ENV["CLACKY_INHERIT_FD"].to_i
    master_pid      = ENV["CLACKY_MASTER_PID"].to_i
    # Must use TCPServer.for_fd (not Socket.for_fd) so that accept_nonblock
    # returns a single Socket, not [Socket, Addrinfo] — WEBrick expects the former.
    socket     = TCPServer.for_fd(fd)

    Clacky::Logger.console = true
    Clacky::Logger.info("[cli worker PID=#{Process.pid}] CLACKY_INHERIT_FD=#{fd} CLACKY_MASTER_PID=#{master_pid} socket=#{socket.class} fd=#{socket.fileno}")

    agent_config = Clacky::AgentConfig.load
    agent_config.permission_mode = :confirm_all

    # Apply CLI overrides to agent config (--no-compression etc.)
    # These override whatever is stored in config.yml.
    agent_config.enable_compression = false if options[:no_compression]
    agent_config.memory_update_enabled = false if options[:no_memory]
    agent_config.enable_prompt_caching = false if options[:no_caching]
    if options[:no_skill_evolution]
      agent_config.skill_evolution[:enabled] = false
    end

    client_factory = lambda do
      Clacky::Client.new(
        agent_config.api_key,
        base_url: agent_config.base_url,
        model: agent_config.model_name,
        anthropic_format: agent_config.anthropic_format?
      )
    end

    Clacky::Server::HttpServer.new(
      host:           options[:host],
      port:           options[:port],
      agent_config:   agent_config,
      client_factory: client_factory,
      brand_test:     options[:brand_test],
      socket:         socket,
      master_pid:     master_pid
    ).start
  else
    # ── Master mode ───────────────────────────────────────────────────────
    # First invocation by the user. Start the Master process which holds the
    # socket and supervises worker processes.
    require_relative "server/server_master"

    if options[:brand_test]
      say "⚡ Brand test mode — license activation uses mock data (no remote API calls).", :yellow
      say ""
      say "  Test license keys (paste any into Settings → Brand & License):", :cyan
      say ""
      say "    00000001-FFFFFFFF-DEADBEEF-CAFEBABE-00000001  →  Brand1"
      say "    00000002-FFFFFFFF-DEADBEEF-CAFEBABE-00000002  →  Brand2"
      say "    00000003-FFFFFFFF-DEADBEEF-CAFEBABE-00000003  →  Brand3"
      say ""
      say "  To reset: rm ~/.clacky/brand.yml", :cyan
      say ""
    end

    extra_flags = []
    extra_flags << "--brand-test" if options[:brand_test]
    extra_flags << "--no-compression" if options[:no_compression]
    extra_flags << "--no-memory" if options[:no_memory]
    extra_flags << "--no-caching" if options[:no_caching]
    extra_flags << "--no-skill-evolution" if options[:no_skill_evolution]

    Clacky::Logger.console = true

    # ── Telemetry (anonymous, opt-out via CLACKY_TELEMETRY=0) ──────────
    Clacky::Telemetry.startup!

    Clacky::Server::Master.new(
      host:        options[:host],
      port:        options[:port],
      extra_flags: extra_flags
    ).run
  end
end