Files
openclaw-openclaw/apps/macos/Sources/OpenClawMacCLI/WizardCommand.swift
Peter Steinberger 07bf384a8b feat(crestodian): conversational agent-loop onboarding across CLI, web install, and macOS app (#99935)
* feat(crestodian): AI-first conversational onboarding with typed-op guardrails

Interactive `openclaw onboard` (and bare `openclaw` on a fresh install) now
opens the Crestodian conversation: detection-backed first-run proposal
(Claude Code/Codex logins, API keys), persona AI turns for every free-form
message (configless local-runtime fallback, 60s deadline, deterministic
degradation), approval-gated typed operations, chat-hosted channel setup
(`connect <channel>`), config get/schema read ops with secret redaction, and
a post-write validation hook that feeds schema errors back for a self-fix
turn. Adds the additive gateway `crestodian.chat` method so app clients run
the same conversation. Classic wizard stays behind --classic/explicit flags;
non-interactive automation unchanged; `--modern` becomes a deprecated alias
for `openclaw crestodian`.

* feat(macos): Crestodian chat onboarding and importance-ordered permissions

Replace the gateway step-wizard page with a Crestodian chat over the new
crestodian.chat method (works before any model auth exists), sort the
permissions page by importance with no scrolling, drop the redundant manual
refresh, and bump the onboarding version.

* feat(crestodian): run the custodian on the real agent loop with a ring-zero tool

Crestodian conversations now execute through the same embedded agent runner
as regular agents: a persistent agent session with a single construction-gated
`crestodian` tool wrapping the typed operations (read actions free; mutations
require approved=true asserted from explicit user consent, audited, with
post-write config validation fed back into the loop). The engine prefers the
loop (configured models or the Codex app-server fallback) and degrades to the
single-turn planner, then to deterministic commands. Setup approval seeds the
crestodian exec approval so local model harnesses can run; the configless
Codex backend config now enables exec and direct tool loading (it was
dead-on-arrival behind tools.exec.mode=deny and the tool-search index).

* test(crestodian): type the engine mock signatures for the core test lane

* fix(crestodian): map the advertised create_agent tool action

* fix(crestodian): host-verified approval arming and a macOS setup completion gate

Review findings: the model-supplied approved flag alone could authorize
ring-zero mutations (prompt injection / model error), and removing the macOS
wizard gate let users Next past the Crestodian page with nothing configured.
Mutating tool actions now also require host-verified consent (the engine arms
approval only when the user's actual message is an explicit yes), and local
macOS onboarding blocks advancing until setup authored the config, using the
same signal the old step wizard checked.

* fix(crestodian): bind approval to the exact proposed operation and gate dot navigation

A generic yes no longer authorizes arbitrary mutations: denied mutating tool
calls register a canonical operation fingerprint (host-owned, per session),
and an armed turn executes only the identical call, once. The denial message
is arming-aware so the approved turn self-heals in one roundtrip, and the
agent protocol pre-registers proposals. macOS onboarding page dots now honor
the same setup-completion gate as the Next button.

* fix(crestodian): redact sensitive wizard answers, skip logged-out CLIs, gate programmatic advance

Sensitive channel-wizard answers (tokens, passwords) are redacted from the
AI-visible conversation history; setup and the onboarding welcome never pick
or advertise a definitively logged-out CLI as the model; and macOS
handleNext() honors the page gates for programmatic callers (chat handoff)
just like the Next button.

* fix(crestodian): align the onboarding welcome's configured predicate with the app gate

A valid config carrying only a default model (partial/hand-written) now still
gets the first-run proposal instead of the ready guide, so the macOS setup
gate can always be satisfied from the conversation.

* fix(crestodian): armed turns can never mint their own executable proposal

An approval-mismatched call inside an armed turn no longer re-registers and
invites a retry (which let the model swap the approved operation for another
in the same turn); it voids the approval entirely and requires a fresh yes.
Proposals register only in unarmed turns, which the agent protocol already
does when proposing.

* fix(onboard): route any explicit setup flag to the classic wizard

* fix(ci): satisfy new lint rules, tool-display guard, and generated artifacts for crestodian

* chore(i18n): refresh native inventory after permissions copy wrap

* fix(crestodian): harden conversational onboarding

* docs(crestodian): document conversational onboarding

* test(crestodian): type embedded runner mock

* fix(crestodian): close onboarding security gaps

* chore: retrigger ci
2026-07-05 01:02:53 -07:00

561 lines
21 KiB
Swift

import Darwin
import Foundation
import OpenClawKit
import OpenClawProtocol
struct WizardCliOptions {
var url: String?
var token: String?
var password: String?
var mode: String = "local"
var workspace: String?
var json: Bool = false
var help: Bool = false
static func parse(_ args: [String]) -> WizardCliOptions {
var opts = WizardCliOptions()
var i = 0
while i < args.count {
let arg = args[i]
switch arg {
case "-h", "--help":
opts.help = true
case "--json":
opts.json = true
case "--url":
opts.url = CLIArgParsingSupport.nextValue(args, index: &i)
case "--token":
opts.token = CLIArgParsingSupport.nextValue(args, index: &i)
case "--password":
opts.password = CLIArgParsingSupport.nextValue(args, index: &i)
case "--mode":
if let value = CLIArgParsingSupport.nextValue(args, index: &i) {
opts.mode = value
}
case "--workspace":
opts.workspace = CLIArgParsingSupport.nextValue(args, index: &i)
default:
break
}
i += 1
}
return opts
}
}
enum WizardCliError: Error, CustomStringConvertible {
case invalidUrl(String)
case missingRemoteUrl
case gatewayError(String)
case decodeError(String)
case cancelled
var description: String {
switch self {
case let .invalidUrl(raw): "Invalid URL: \(raw)"
case .missingRemoteUrl: "gateway.remote.url is missing"
case let .gatewayError(msg): msg
case let .decodeError(msg): msg
case .cancelled: "Wizard cancelled"
}
}
}
func runWizardCommand(_ args: [String]) async {
let opts = WizardCliOptions.parse(args)
if opts.help {
print("""
openclaw-mac wizard
Usage:
openclaw-mac wizard [--url <ws://host:port>] [--token <token>] [--password <password>]
[--mode <local|remote>] [--workspace <path>] [--json]
Options:
--url <url> Gateway WebSocket URL (overrides config)
--token <token> Gateway token (if required)
--password <pw> Gateway password (if required)
--mode <mode> Wizard mode (local|remote). Default: local
--workspace <path> Wizard workspace override
--json Print raw wizard responses
-h, --help Show help
""")
return
}
let config = loadGatewayConfig()
do {
guard isatty(STDIN_FILENO) != 0 else {
throw WizardCliError.gatewayError("Wizard requires an interactive TTY.")
}
let endpoint = try resolveWizardGatewayEndpoint(opts: opts, config: config)
let client = GatewayWizardClient(
url: endpoint.url,
token: endpoint.token,
password: endpoint.password,
json: opts.json)
try await client.connect()
defer { Task { await client.close() } }
try await runWizard(client: client, opts: opts)
} catch {
fputs("wizard: \(error)\n", stderr)
exit(1)
}
}
private func resolveWizardGatewayEndpoint(opts: WizardCliOptions, config: GatewayConfig) throws -> GatewayEndpoint {
if let raw = opts.url, !raw.isEmpty {
guard let url = URL(string: raw) else { throw WizardCliError.invalidUrl(raw) }
return GatewayEndpoint(
url: url,
token: resolvedToken(opts: opts, config: config),
password: resolvedPassword(opts: opts, config: config),
mode: (config.mode ?? "local").lowercased())
}
let mode = (config.mode ?? "local").lowercased()
if mode == "remote" {
guard let raw = config.remoteUrl?.trimmingCharacters(in: .whitespacesAndNewlines), !raw.isEmpty else {
throw WizardCliError.missingRemoteUrl
}
guard let url = URL(string: raw) else { throw WizardCliError.invalidUrl(raw) }
return GatewayEndpoint(
url: url,
token: resolvedToken(opts: opts, config: config),
password: resolvedPassword(opts: opts, config: config),
mode: mode)
}
let port = config.port ?? 18789
let host = "127.0.0.1"
guard let url = URL(string: "ws://\(host):\(port)") else {
throw WizardCliError.invalidUrl("ws://\(host):\(port)")
}
return GatewayEndpoint(
url: url,
token: resolvedToken(opts: opts, config: config),
password: resolvedPassword(opts: opts, config: config),
mode: mode)
}
private func resolvedToken(opts: WizardCliOptions, config: GatewayConfig) -> String? {
if let token = opts.token, !token.isEmpty { return token }
if (config.mode ?? "local").lowercased() == "remote" {
return config.remoteToken
}
return config.token
}
private func resolvedPassword(opts: WizardCliOptions, config: GatewayConfig) -> String? {
if let password = opts.password, !password.isEmpty { return password }
if (config.mode ?? "local").lowercased() == "remote" {
return config.remotePassword
}
return config.password
}
actor GatewayWizardClient {
private enum ConnectChallengeError: Error {
case timeout
}
private let url: URL
private let token: String?
private let password: String?
private let json: Bool
private let encoder = JSONEncoder()
private let decoder = JSONDecoder()
private let session = URLSession(configuration: .default)
private let connectChallengeTimeoutSeconds: Double = 0.75
private var task: URLSessionWebSocketTask?
init(url: URL, token: String?, password: String?, json: Bool) {
self.url = url
self.token = token
self.password = password
self.json = json
}
func connect() async throws {
let socket = self.session.webSocketTask(with: self.url)
socket.maximumMessageSize = 16 * 1024 * 1024
socket.resume()
self.task = socket
try await self.sendConnect()
}
func close() {
self.task?.cancel(with: .goingAway, reason: nil)
self.task = nil
}
func request(method: String, params: [String: ProtoAnyCodable]?) async throws -> ResponseFrame {
guard let task = self.task else {
throw WizardCliError.gatewayError("gateway not connected")
}
let id = UUID().uuidString
let frame = RequestFrame(
type: "req",
id: id,
method: method,
params: params.map { ProtoAnyCodable($0) })
let data = try self.encoder.encode(frame)
try await task.send(.data(data))
while true {
let message = try await task.receive()
let frame = try decodeFrame(message)
if case let .res(res) = frame, res.id == id {
if res.ok == false {
let msg = res.error?.message ?? "gateway error"
throw WizardCliError.gatewayError(msg)
}
return res
}
}
}
func decodePayload<T: Decodable>(_ response: ResponseFrame, as _: T.Type) throws -> T {
guard let payload = response.payload else {
throw WizardCliError.decodeError("missing payload")
}
let data = try self.encoder.encode(payload)
return try self.decoder.decode(T.self, from: data)
}
private func decodeFrame(_ message: URLSessionWebSocketTask.Message) throws -> GatewayFrame {
let data: Data? = switch message {
case let .data(data): data
case let .string(text): text.data(using: .utf8)
@unknown default: nil
}
guard let data else {
throw WizardCliError.decodeError("empty gateway response")
}
return try self.decoder.decode(GatewayFrame.self, from: data)
}
private func sendConnect() async throws {
guard let task = self.task else {
throw WizardCliError.gatewayError("gateway not connected")
}
let osVersion = ProcessInfo.processInfo.operatingSystemVersion
let platform = "macos \(osVersion.majorVersion).\(osVersion.minorVersion).\(osVersion.patchVersion)"
let clientId = "openclaw-macos"
let clientMode = "ui"
let role = "operator"
// Explicit scopes; gateway no longer defaults empty scopes to admin.
let scopes = defaultOperatorConnectScopes
let client: [String: ProtoAnyCodable] = [
"id": ProtoAnyCodable(clientId),
"displayName": ProtoAnyCodable(Host.current().localizedName ?? "OpenClaw macOS Wizard CLI"),
"version": ProtoAnyCodable("dev"),
"platform": ProtoAnyCodable(platform),
"deviceFamily": ProtoAnyCodable("Mac"),
"mode": ProtoAnyCodable(clientMode),
"instanceId": ProtoAnyCodable(UUID().uuidString),
]
var params: [String: ProtoAnyCodable] = [
"minProtocol": ProtoAnyCodable(GATEWAY_MIN_PROTOCOL_VERSION),
"maxProtocol": ProtoAnyCodable(GATEWAY_PROTOCOL_VERSION),
"client": ProtoAnyCodable(client),
"caps": ProtoAnyCodable([String]()),
"locale": ProtoAnyCodable(Locale.preferredLanguages.first ?? Locale.current.identifier),
"userAgent": ProtoAnyCodable(ProcessInfo.processInfo.operatingSystemVersionString),
"role": ProtoAnyCodable(role),
"scopes": ProtoAnyCodable(scopes),
]
if let token = self.token {
params["auth"] = ProtoAnyCodable(["token": ProtoAnyCodable(token)])
} else if let password = self.password {
params["auth"] = ProtoAnyCodable(["password": ProtoAnyCodable(password)])
}
let connectNonce = try await self.waitForConnectChallenge()
let identity = DeviceIdentityStore.loadOrCreate()
let signedAtMs = Int(Date().timeIntervalSince1970 * 1000)
let payload = GatewayDeviceAuthPayload.buildV3(
deviceId: identity.deviceId,
clientId: clientId,
clientMode: clientMode,
role: role,
scopes: scopes,
signedAtMs: signedAtMs,
token: self.token,
nonce: connectNonce,
platform: platform,
deviceFamily: "Mac")
if let device = GatewayDeviceAuthPayload.signedDeviceDictionary(
payload: payload,
identity: identity,
signedAtMs: signedAtMs,
nonce: connectNonce)
{
params["device"] = ProtoAnyCodable(device)
}
let reqId = UUID().uuidString
let frame = RequestFrame(
type: "req",
id: reqId,
method: "connect",
params: ProtoAnyCodable(params))
let data = try self.encoder.encode(frame)
try await task.send(.data(data))
while true {
let message = try await task.receive()
let frameResponse = try decodeFrame(message)
if case let .res(res) = frameResponse, res.id == reqId {
if res.ok == false {
let msg = res.error?.message ?? "gateway connect failed"
throw WizardCliError.gatewayError(msg)
}
_ = try self.decodePayload(res, as: HelloOk.self)
return
}
}
}
private func waitForConnectChallenge() async throws -> String {
guard let task = self.task else { throw ConnectChallengeError.timeout }
return try await AsyncTimeout.withTimeout(
seconds: self.connectChallengeTimeoutSeconds,
onTimeout: { ConnectChallengeError.timeout },
operation: {
while true {
let message = try await task.receive()
let frame = try await self.decodeFrame(message)
if case let .event(evt) = frame, evt.event == "connect.challenge",
let payload = evt.payload?.value as? [String: ProtoAnyCodable],
let nonce = GatewayConnectChallengeSupport.nonce(from: payload)
{
return nonce
}
}
})
}
}
private func runWizard(client: GatewayWizardClient, opts: WizardCliOptions) async throws {
var params: [String: ProtoAnyCodable] = [:]
let mode = opts.mode.trimmingCharacters(in: .whitespacesAndNewlines).lowercased()
if mode == "local" || mode == "remote" {
params["mode"] = ProtoAnyCodable(mode)
}
if let workspace = opts.workspace?.trimmingCharacters(in: .whitespacesAndNewlines), !workspace.isEmpty {
params["workspace"] = ProtoAnyCodable(workspace)
}
let startResponse = try await client.request(method: "wizard.start", params: params)
let startResult = try await client.decodePayload(startResponse, as: WizardStartResult.self)
if opts.json {
dumpResult(startResponse)
}
let sessionId = startResult.sessionid
var nextResult = WizardNextResult(
done: startResult.done,
step: startResult.step,
status: startResult.status,
error: startResult.error)
do {
while true {
let status = wizardStatusString(nextResult.status) ?? (nextResult.done ? "done" : "running")
if status == "cancelled" {
print("Wizard cancelled.")
return
}
if status == "error" || (nextResult.done && nextResult.error != nil) {
throw WizardCliError.gatewayError(nextResult.error ?? "wizard error")
}
if status == "done" || nextResult.done {
print("Wizard complete.")
return
}
if let error = nextResult.error, !opts.json {
fputs("wizard: \(error)\n", stderr)
}
if let step = nextResult.step {
let answer = try promptAnswer(for: step)
var answerPayload: [String: ProtoAnyCodable] = [
"stepId": ProtoAnyCodable(step.id),
]
if !(answer is NSNull) {
answerPayload["value"] = ProtoAnyCodable(answer)
}
let response = try await client.request(
method: "wizard.next",
params: [
"sessionId": ProtoAnyCodable(sessionId),
"answer": ProtoAnyCodable(answerPayload),
])
nextResult = try await client.decodePayload(response, as: WizardNextResult.self)
if opts.json {
dumpResult(response)
}
} else {
let response = try await client.request(
method: "wizard.next",
params: ["sessionId": ProtoAnyCodable(sessionId)])
nextResult = try await client.decodePayload(response, as: WizardNextResult.self)
if opts.json {
dumpResult(response)
}
}
}
} catch WizardCliError.cancelled {
_ = try? await client.request(
method: "wizard.cancel",
params: ["sessionId": ProtoAnyCodable(sessionId)])
throw WizardCliError.cancelled
}
}
private func dumpResult(_ response: ResponseFrame) {
guard let payload = response.payload else {
print("{\"error\":\"missing payload\"}")
return
}
let encoder = JSONEncoder()
encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
if let data = try? encoder.encode(payload), let text = String(data: data, encoding: .utf8) {
print(text)
}
}
private func promptAnswer(for step: WizardStep) throws -> Any {
let type = wizardStepType(step)
if let title = step.title, !title.isEmpty {
print("\n\(title)")
}
if let message = step.message, !message.isEmpty {
print(message)
}
switch type {
case "note":
_ = try readLineWithPrompt("Continue? (enter)")
return NSNull()
case "progress":
_ = try readLineWithPrompt("Continue? (enter)")
return NSNull()
case "action":
_ = try readLineWithPrompt("Run? (enter)")
return true
case "text":
let initial = anyCodableString(step.initialvalue)
let prompt = step.placeholder ?? "Value"
if step.sensitive == true {
let sensitivePrompt = initial.isEmpty ? prompt : "\(prompt) (leave blank to keep existing)"
let value = try readSensitiveLineWithPrompt(sensitivePrompt)
let trimmed = value.trimmingCharacters(in: .whitespacesAndNewlines)
return trimmed.isEmpty ? initial : trimmed
}
let value = try readLineWithPrompt("\(prompt)\(initial.isEmpty ? "" : " [\(initial)]")")
let trimmed = value.trimmingCharacters(in: .whitespacesAndNewlines)
return trimmed.isEmpty ? initial : trimmed
case "confirm":
let initial = anyCodableBool(step.initialvalue)
let value = try readLineWithPrompt("Confirm? (y/n) [\(initial ? "y" : "n")]")
let trimmed = value.trimmingCharacters(in: .whitespacesAndNewlines).lowercased()
if trimmed.isEmpty { return initial }
return trimmed == "y" || trimmed == "yes" || trimmed == "true"
case "select":
return try promptSelect(step)
case "multiselect":
return try promptMultiSelect(step)
default:
_ = try readLineWithPrompt("Continue? (enter)")
return NSNull()
}
}
private func promptSelect(_ step: WizardStep) throws -> Any {
let options = parseWizardOptions(step.options)
guard !options.isEmpty else { return NSNull() }
for (idx, option) in options.enumerated() {
let hint = option.hint?.isEmpty == false ? "\(option.hint!)" : ""
print(" [\(idx + 1)] \(option.label)\(hint)")
}
let initialIndex = options.firstIndex(where: { anyCodableEqual($0.value, step.initialvalue) })
let defaultLabel = initialIndex.map { " [\($0 + 1)]" } ?? ""
while true {
let input = try readLineWithPrompt("Select one\(defaultLabel)")
let trimmed = input.trimmingCharacters(in: .whitespacesAndNewlines)
if trimmed.isEmpty, let initialIndex {
return options[initialIndex].value?.value ?? options[initialIndex].label
}
if trimmed.lowercased() == "q" { throw WizardCliError.cancelled }
if let number = Int(trimmed), (1...options.count).contains(number) {
let option = options[number - 1]
return option.value?.value ?? option.label
}
print("Invalid selection.")
}
}
private func promptMultiSelect(_ step: WizardStep) throws -> [Any] {
let options = parseWizardOptions(step.options)
guard !options.isEmpty else { return [] }
for (idx, option) in options.enumerated() {
let hint = option.hint?.isEmpty == false ? "\(option.hint!)" : ""
print(" [\(idx + 1)] \(option.label)\(hint)")
}
let initialValues = anyCodableArray(step.initialvalue)
let initialIndices = options.enumerated().compactMap { index, option in
initialValues.contains { anyCodableEqual($0, option.value) } ? index + 1 : nil
}
let defaultLabel = initialIndices.isEmpty ? "" : " [\(initialIndices.map(String.init).joined(separator: ","))]"
while true {
let input = try readLineWithPrompt("Select (comma-separated)\(defaultLabel)")
let trimmed = input.trimmingCharacters(in: .whitespacesAndNewlines)
if trimmed.isEmpty {
return initialIndices.map { options[$0 - 1].value?.value ?? options[$0 - 1].label }
}
if trimmed.lowercased() == "q" { throw WizardCliError.cancelled }
let parts = trimmed.split(separator: ",").map { $0.trimmingCharacters(in: .whitespacesAndNewlines) }
let indices = parts.compactMap { Int($0) }.filter { (1...options.count).contains($0) }
if indices.isEmpty {
print("Invalid selection.")
continue
}
return indices.map { options[$0 - 1].value?.value ?? options[$0 - 1].label }
}
}
private func readLineWithPrompt(_ prompt: String) throws -> String {
print("\(prompt): ", terminator: "")
guard let line = readLine() else {
throw WizardCliError.cancelled
}
return line
}
private func readSensitiveLineWithPrompt(_ prompt: String) throws -> String {
print("\(prompt): ", terminator: "")
fflush(stdout)
var original = termios()
guard tcgetattr(STDIN_FILENO, &original) == 0 else {
throw WizardCliError.gatewayError("Could not configure hidden terminal input.")
}
var hidden = original
hidden.c_lflag &= ~tcflag_t(ECHO)
guard tcsetattr(STDIN_FILENO, TCSANOW, &hidden) == 0 else {
throw WizardCliError.gatewayError("Could not configure hidden terminal input.")
}
defer {
_ = tcsetattr(STDIN_FILENO, TCSANOW, &original)
print("")
}
guard let line = readLine() else {
throw WizardCliError.cancelled
}
return line
}