docs: document command onboarding batch

This commit is contained in:
Peter Steinberger
2026-06-04 18:56:56 -04:00
parent 646eb00112
commit 0156de5c34
20 changed files with 22 additions and 0 deletions

View File

@@ -1,3 +1,4 @@
// Agents add tests cover agent creation, workspace setup, channel binding, and onboarding integration.
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";

View File

@@ -1,3 +1,4 @@
// Auth-choice plugin provider tests cover loaded provider setup, plugin install, and credential routing.
import { beforeEach, describe, expect, it, vi } from "vitest";
import {
applyAuthChoiceLoadedPluginProvider,

View File

@@ -1,3 +1,4 @@
// Channels logs tests cover gateway log path resolution and channel log tailing.
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";

View File

@@ -1,3 +1,4 @@
// Daemon install helper tests cover install plan construction, tokens, and platform-specific service setup.
import fs from "node:fs";
import os from "node:os";
import path from "node:path";

View File

@@ -1,3 +1,4 @@
// Doctor flat auth-profile tests cover legacy flat profile repair and persisted auth-profile loading.
import fs from "node:fs";
import { afterEach, describe, expect, it, vi } from "vitest";
import { loadPersistedAuthProfileStore } from "../agents/auth-profiles/persisted.js";

View File

@@ -1,3 +1,4 @@
// Doctor OAuth sidecar tests cover encrypted sidecar detection and auth repair guidance.
import { createCipheriv } from "node:crypto";
import fs from "node:fs";
import path from "node:path";

View File

@@ -1,3 +1,4 @@
// Doctor config-flow safe-bin tests cover executable allowlist validation and repair behavior.
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";

View File

@@ -1,3 +1,4 @@
// Doctor heartbeat template repair tests cover migration and repair of heartbeat prompt templates.
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
@@ -208,6 +209,8 @@ Add short tasks below the comments only when you want the agent to check somethi
await expect(fs.readFile(heartbeatPath, "utf-8")).resolves.toBe(
`${[
"<!-- Heartbeat template; comments-only content prevents scheduled heartbeat API calls. -->",
"",
"# Keep this file empty (or with only comments) to skip heartbeat API calls.",
"",
"# Add tasks below when you want the agent to check something periodically.",

View File

@@ -1,3 +1,4 @@
// Doctor platform note tests cover startup optimization hints and note output.
import { describe, expect, it, vi } from "vitest";
import { noteStartupOptimizationHints } from "./doctor-platform-notes.js";

View File

@@ -1,3 +1,4 @@
// Message command tests cover CLI message sending, environment handling, and runtime dependency wiring.
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
import type { CliDeps } from "../cli/deps.js";
import type { RuntimeEnv } from "../runtime.js";

View File

@@ -1,3 +1,4 @@
// OAuth TLS preflight doctor tests cover certificate warnings and repair notes.
import { beforeEach, describe, expect, it, vi } from "vitest";
import type { OpenClawConfig } from "../config/config.js";

View File

@@ -1,3 +1,4 @@
// Onboard auth tests cover provider auth setup, credential persistence, and auth-profile state.
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";

View File

@@ -1,3 +1,4 @@
// Onboard config tests cover workspace, bootstrap, and local setup config mutations.
import { describe, expect, it } from "vitest";
import type { OpenClawConfig } from "../config/config.js";
import {

View File

@@ -1,3 +1,4 @@
// Interactive onboarding tests cover wizard cancellation, setup routing, and runtime output.
import { afterEach, describe, expect, it, vi } from "vitest";
import type { RuntimeEnv } from "../runtime.js";
import { WizardCancelledError } from "../wizard/prompts.js";

View File

@@ -1,3 +1,4 @@
// Onboard command tests cover guided setup entrypoints, setup aliases, and CLI messaging.
import path from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
import { formatCliCommand } from "../cli/command-format.js";

View File

@@ -1,3 +1,4 @@
// Search setup cold-import tests guard onboarding search setup against loading heavy runtime modules.
import fs from "node:fs";
import path from "node:path";
import { fileURLToPath } from "node:url";

View File

@@ -1,3 +1,4 @@
// Status JSON tests cover command output and runtime JSON writes.
import { beforeEach, describe, expect, it, vi } from "vitest";
import type { RuntimeEnv } from "../runtime.js";
import { statusJsonCommand } from "./status-json.js";

View File

@@ -1,3 +1,4 @@
// Status overview value tests cover compact display values for agents, events, tasks, and services.
import { describe, expect, it } from "vitest";
import {
buildStatusAllAgentsValue,

View File

@@ -1,3 +1,4 @@
// Status node-mode tests cover node host config and node status rendering.
import { beforeEach, describe, expect, it, vi } from "vitest";
const mocks = vi.hoisted(() => ({

View File

@@ -1,3 +1,4 @@
// Status scan result tests cover cold-start summaries and gateway probe snapshot aggregation.
import { describe, expect, it } from "vitest";
import { buildStatusScanResult } from "./status.scan-result.ts";
import { buildColdStartStatusSummary } from "./status.scan.bootstrap-shared.ts";