@harnessforce/cli 0.3.0 → 0.4.0

package/README.md

@@ -31,7 +31,10 @@ harnessforce init
 | `harnessforce otel-headers` | Prints the `Authorization` header for Claude Code's `otelHeadersHelper`. Exits 3 when there is no key, 4 when the destination differs from the pinned origin, 5 while the CLI version is unsupported, and 1 on other failures. On Linux, after printing a key read from the kernel keyring, it moves that Workspace's items to an unlocked Secret Service (not when the hook starts it), so a reboot does not lose them |
 | `harnessforce run --issue <identifier> -- <agent> [args]` | Launches an agent with its session linked to an Issue |
 | `harnessforce import` | Sends the metadata of past Claude Code sessions in connected repositories |
+| `harnessforce status [--json]` | Shows the connected Workspace, your role, the setup steps that remain with their URLs, and whether the `origin` repository of the current directory is connected to the GitHub App. Reads only; the remote URL is compared on this machine and never sent. Exits 0 whenever the status was read |
 | `harnessforce tune [--all] [--no-send] [--show-report] [--json]` | Analyzes past sessions on this machine by public rules and sends the counts (analysis reports) |
+| `harnessforce tune --report-only [--all]` | Analyzes and sends like `harnessforce tune`, but writes nothing to stdout. Meant for your OS scheduler |
+| `harnessforce tune --print-schedule` | Prints one cron line that runs `harnessforce tune --report-only` every Monday at 9:00 local time. Changes nothing and makes no network request |
 | `harnessforce tune record` / `harnessforce tune --purge` | Records a proposal from stdin / deletes everything under `~/.harnessforce/tune/` |
 | `harnessforce top [--once] [--json] [--ascii] [--theme <auto\|light\|dark\|ansi>]` | Shows the Claude Code and Codex sessions on this machine in the terminal: state, tokens, context and tool failures. Reads only local files and never connects to Harnessforce |
 | `harnessforce hook session-start` | The entry of Codex's `SessionStart` hook: reads `session_id`, `cwd` and `source` from stdin, registers the session, and prints the session ID for the agent's context. Always exits 0 |
@@ -295,6 +298,9 @@ role cannot use it.
 - `--json` also lists, for each recorded proposal whose application was detected, the value of its
   category in the 14 days before and after the detection time (`followups`). The difference is not
   a cause. Once a `--json` run outputs a follow-up whose after period has ended, later runs omit it.
+- To send weekly without opening Claude Code, add the line that `harnessforce tune --print-schedule`
+  prints to your crontab yourself. Harnessforce never registers it. To stop, remove the line or set
+  `send_report` to `false`.
 - Everything it keeps is under `~/.harnessforce/tune/`; `harnessforce tune --purge` deletes it.
 
 ## License

package/dist/bin.js

@@ -1445,6 +1445,38 @@ Exit codes:
 
 Examples:
   harnessforce import
+`
+	},
+	status: {
+		summary: "Show the Workspace setup steps that remain",
+		text: `Usage: harnessforce status [--json]
+
+When to use:
+  After init, and any time you want to see which setup steps of the connected
+  Workspace remain and whether this repository is connected to the GitHub App.
+
+What it does:
+  Reads the setup checklist of the connected Workspace and the list of
+  connected repositories, and prints your role, each step (done, to do with its
+  URL, or "?" when it cannot be read), and whether the repository of the current
+  directory (its origin remote) is connected.
+
+Options:
+  --json   Print the checklist and the repository as one JSON object.
+
+Sends:
+  Read requests with the API token. It writes nothing.
+
+Does not send:
+  The URL of the origin remote: it is compared on this machine.
+
+Exit codes:
+  0  The status was read, whether or not steps remain.
+  1  Not logged in, the login expired, or communication failed.
+
+Examples:
+  harnessforce status
+  harnessforce status --json
 `
 	},
 	"otel-headers": {
@@ -1509,6 +1541,8 @@ Examples:
 	tune: {
 		summary: "Analyze your past sessions and report counts",
 		text: `Usage: harnessforce tune [--all] [--no-send] [--show-report] [--json]
+       harnessforce tune --report-only [--all]
+       harnessforce tune --print-schedule
        harnessforce tune record
        harnessforce tune --purge
 
@@ -1528,6 +1562,11 @@ Options:
   --show-report   Print the exact values that would be sent.
   --json          Print the result as one JSON object on stdout. Messages go to
                   stderr.
+  --report-only   Analyze and send, writing nothing to stdout (for your OS
+                  scheduler). Combines with --all only.
+  --print-schedule
+                  Print a cron line that runs --report-only every Monday at
+                  9:00. It changes nothing and sends nothing.
   record          Read one proposal as JSON from stdin and store it locally.
   --purge         Delete the analysis, proposals, and unsent results.
 
@@ -1549,6 +1588,7 @@ Exit codes:
 Examples:
   harnessforce tune
   harnessforce tune --no-send --json
+  harnessforce tune --print-schedule
   harnessforce tune --purge
 `
 	},
@@ -1623,6 +1663,7 @@ Examples:
 const ORDER = [
 	"init",
 	"import",
+	"status",
 	"run",
 	"tune",
 	"top",
@@ -2382,6 +2423,48 @@ async function fetchSessionImportDays(base, apiToken, fetchImpl) {
 		value: days
 	} : FAILED$1;
 }
+const ROLES = /* @__PURE__ */ new Set([
+	"owner",
+	"admin",
+	"member",
+	"viewer"
+]);
+const STEP_STATUSES = /* @__PURE__ */ new Set([
+	"done",
+	"todo",
+	"unavailable"
+]);
+function parseSteps(value) {
+	if (!Array.isArray(value)) return void 0;
+	const steps = value.map((item) => {
+		if (typeof item !== "object" || item === null) return void 0;
+		const { step, status, url } = item;
+		return Number.isInteger(step) && step >= 2 && step <= 5 && STEP_STATUSES.has(status) && typeof url === "string" ? {
+			step,
+			status,
+			url
+		} : void 0;
+	});
+	return steps.every((step) => step !== void 0) ? steps : void 0;
+}
+async function fetchOnboarding(base, apiToken, fetchImpl) {
+	const outcome = await getJson(underBase(base, "api/v1/onboarding"), apiToken, fetchImpl);
+	if (outcome.kind !== "ok") return outcome;
+	const body = outcome.value;
+	const steps = parseSteps(body.steps);
+	const adminSteps = body.admin_steps === void 0 ? void 0 : parseSteps(body.admin_steps);
+	if (typeof body.workspace_name !== "string" || !ROLES.has(body.role) || typeof body.has_seat !== "boolean" || !steps || body.admin_steps !== void 0 && !adminSteps) return FAILED$1;
+	return {
+		kind: "ok",
+		value: {
+			workspace_name: body.workspace_name,
+			role: body.role,
+			has_seat: body.has_seat,
+			steps,
+			...adminSteps && { admin_steps: adminSteps }
+		}
+	};
+}
 // src/import/record-base.ts
 async function readSettingsEnv(path) {
 	const read = await readUserSettings(path);
@@ -3254,7 +3337,7 @@ async function scanCodexSessions(options) {
 }
 // src/import/command.ts
 const DAY_MS$1 = 864e5;
-const MESSAGES = {
+const MESSAGES$1 = {
 	runInit: "Run `harnessforce init`",
 	invalidUrl: "The connection URL is invalid",
 	keychainUnavailable: INIT_MESSAGES.keychainUnavailable,
@@ -3271,15 +3354,15 @@ const limitMessage = {
 	monthly_event_limit: (count) => `Could not import ${count} session(s) because the monthly event limit was reached. Run \`harnessforce import\` again after the limit is lifted to resume importing`,
 	workspace_read_only: (count) => `Could not import ${count} session(s) because the Workspace is view-only. Run \`harnessforce import\` again after view-only mode is lifted to resume importing`
 };
-const ACCESS_MESSAGES$2 = {
-	keychainUnavailable: MESSAGES.keychainUnavailable,
-	initRequired: MESSAGES.runInit,
-	invalidUrl: MESSAGES.invalidUrl,
-	apiTokenMissing: MESSAGES.runInit
+const ACCESS_MESSAGES$3 = {
+	keychainUnavailable: MESSAGES$1.keychainUnavailable,
+	initRequired: MESSAGES$1.runInit,
+	invalidUrl: MESSAGES$1.invalidUrl,
+	apiTokenMissing: MESSAGES$1.runInit
 };
-function unwrap(outcome) {
+function unwrap$1(outcome) {
 	if (outcome.kind === "ok") return outcome.value;
-	return stopWith(outcome.kind === "unauthorized" ? MESSAGES.loginExpired : MESSAGES.readFailed);
+	return stopWith(outcome.kind === "unauthorized" ? MESSAGES$1.loginExpired : MESSAGES$1.readFailed);
 }
 const NOT_IMPORTED_LABELS = [
 	["alreadySent", "already sent"],
@@ -3295,8 +3378,8 @@ function reportNotImported(imported, notes, deps) {
 	const line = breakdownLine(notes.breakdown);
 	if (line) deps.stdout(`${line}\n`);
 	if (imported > 0) return;
-	if (notes.breakdown.notConnected > 0) deps.stdout(`${notes.connectedCount === 0 ? MESSAGES.connectNone : MESSAGES.connectOther}\n`);
-	else if (!line && !notes.otherNoticeShown) deps.stdout(`${MESSAGES.nothingFound}\n`);
+	if (notes.breakdown.notConnected > 0) deps.stdout(`${notes.connectedCount === 0 ? MESSAGES$1.connectNone : MESSAGES$1.connectOther}\n`);
+	else if (!line && !notes.otherNoticeShown) deps.stdout(`${MESSAGES$1.nothingFound}\n`);
 }
 function report(result, notes, deps) {
 	switch (result.kind) {
@@ -3312,10 +3395,10 @@ function report(result, notes, deps) {
 			deps.stderr(`${limitMessage[result.reason](result.notImported)}\n`);
 			return 1;
 		case "unauthorized":
-			deps.stderr(`${MESSAGES.revoked}\n`);
+			deps.stderr(`${MESSAGES$1.revoked}\n`);
 			return 1;
 		case "failed":
-			deps.stderr(`${MESSAGES.sendFailed}\n`);
+			deps.stderr(`${MESSAGES$1.sendFailed}\n`);
 			return 1;
 	}
 }
@@ -3325,7 +3408,7 @@ const sumNotImported = (a, b) => ({
 	notConnected: a.notConnected + b.notConnected
 });
 async function runImport(deps) {
-	const access = await verifyCliAccess(deps, ACCESS_MESSAGES$2);
+	const access = await verifyCliAccess(deps, ACCESS_MESSAGES$3);
 	const destination = {
 		workspaceId: access.workspaceId,
 		endpoint: withoutExtras(access.ingest)
@@ -3339,8 +3422,8 @@ async function runImport(deps) {
 		sleep: deps.sleep,
 		homeDir: deps.homeDir
 	}).authorizedFetch(deps.fetch);
-	const connected = unwrap(await listConnectedRepositories(access.readApiBase, access.accessToken, readFetch));
-	const days = unwrap(await fetchSessionImportDays(access.readApiBase, access.accessToken, readFetch));
+	const connected = unwrap$1(await listConnectedRepositories(access.readApiBase, access.accessToken, readFetch));
+	const days = unwrap$1(await fetchSessionImportDays(access.readApiBase, access.accessToken, readFetch));
 	const sinceMs = deps.now() - days * DAY_MS$1;
 	const claude = await scanSessions({
 		projectsDir: join(await recordBase(deps), "projects"),
@@ -3369,7 +3452,7 @@ async function runImport(deps) {
 		sessions: unsent,
 		fetch: deps.fetch,
 		sleep: deps.sleep,
-		record: (ids) => recordSentSessions(statePath, destination, ids).catch(() => stopWith(MESSAGES.stateFailed))
+		record: (ids) => recordSentSessions(statePath, destination, ids).catch(() => stopWith(MESSAGES$1.stateFailed))
 	}), {
 		breakdown: {
 			alreadySent: scanned.length - unsent.length,
@@ -10579,14 +10662,14 @@ function candidateList(candidates) {
 	const lines = candidates.map(({ identifier, title }) => `${printable(identifier)}  ${printable(title)}`);
 	return [RUN_MESSAGES.candidatesHeader, ...lines].join("\n");
 }
-const ACCESS_MESSAGES$1 = {
+const ACCESS_MESSAGES$2 = {
 	keychainUnavailable: RUN_MESSAGES.keychainUnavailable,
 	initRequired: RUN_MESSAGES.initRequired,
 	invalidUrl: RUN_MESSAGES.invalidUrl,
 	apiTokenMissing: RUN_MESSAGES.issueInitRequired
 };
 async function prepareLaunch(args, deps) {
-	const { workspaceId, ingestEndpoint, readApiBase, accessToken } = await verifyCliAccess(deps, ACCESS_MESSAGES$1);
+	const { workspaceId, ingestEndpoint, readApiBase, accessToken } = await verifyCliAccess(deps, ACCESS_MESSAGES$2);
 	if (!isIssueIdentifier(args.issue)) stop("invalidIssue");
 	const readFetch = createApiTokenSession({
 		keychain: deps.keychain,
@@ -10651,6 +10734,87 @@ async function runWithoutHarnessforce(args, deps) {
 	deps.stderr(`${launchFailedMessage(args.agent)}\n`);
 	return 1;
 }
+// src/status/command.ts
+const STATUS_USAGE = "Usage: harnessforce status [--json]\n";
+const MESSAGES = {
+	failed: "Could not read the Harnessforce status. Run `harnessforce init` and try again.",
+	loginExpired: "Your login has expired. Run `harnessforce init`"
+};
+const ACCESS_MESSAGES$1 = {
+	keychainUnavailable: INIT_MESSAGES.keychainUnavailable,
+	initRequired: MESSAGES.failed,
+	invalidUrl: MESSAGES.failed,
+	apiTokenMissing: MESSAGES.failed
+};
+const STEP_TITLES = {
+	2: "Connect the GitHub App",
+	3: "Assign repositories to a project",
+	4: "Set up telemetry",
+	5: "Wait for your first run"
+};
+const STATUS_MARKS = {
+	done: "✓",
+	todo: "・",
+	unavailable: "?"
+};
+function unwrap(outcome) {
+	if (outcome.kind === "ok") return outcome.value;
+	return stopWith(outcome.kind === "unauthorized" ? MESSAGES.loginExpired : MESSAGES.failed);
+}
+async function originRepository(cwd, git) {
+	const url = await git(cwd, [
+		"remote",
+		"get-url",
+		"origin"
+	]);
+	return url === void 0 ? void 0 : normalizeRepository(url);
+}
+function stepLine(step) {
+	const parts = [STATUS_MARKS[step.status], STEP_TITLES[step.step]];
+	if (step.status === "todo") parts.push(step.url);
+	return parts.join(" ");
+}
+async function runStatus(json, deps) {
+	const access = await verifyCliAccess(deps, ACCESS_MESSAGES$1);
+	const readFetch = createApiTokenSession({
+		keychain: deps.keychain,
+		workspaceId: access.workspaceId,
+		readBase: access.readApiBase,
+		fetch: deps.fetch,
+		now: deps.now,
+		sleep: deps.sleep,
+		homeDir: deps.homeDir
+	}).authorizedFetch(deps.fetch);
+	const onboarding = unwrap(await fetchOnboarding(access.readApiBase, access.accessToken, readFetch));
+	const name = await originRepository(deps.cwd, deps.git);
+	const repository = name === void 0 ? null : {
+		name,
+		connected: unwrap(await listConnectedRepositories(access.readApiBase, access.accessToken, readFetch)).has(name)
+	};
+	if (json) {
+		deps.stdout(`${JSON.stringify({
+			...onboarding,
+			repository
+		})}\n`);
+		return 0;
+	}
+	const lines = [...onboarding.admin_steps ?? [], ...onboarding.steps].sort((a, b) => a.step - b.step).map(stepLine);
+	const repositoryLine = repository && `This repository (${repository.name}) is ${repository.connected ? "connected" : "not connected"} to the GitHub App`;
+	deps.stdout(`${[
+		`${onboarding.workspace_name} (${onboarding.role})`,
+		...lines,
+		...repositoryLine ? [repositoryLine] : []
+	].join("\n")}\n`);
+	return 0;
+}
+function statusCommand(args, deps) {
+	const json = args.length === 1 && args[0] === "--json";
+	if (args.length > 0 && !json) {
+		deps.stderr(STATUS_USAGE);
+		return Promise.resolve(1);
+	}
+	return runUntilStop(() => runStatus(json, deps), deps.stderr);
+}
 // src/top/args.ts
 const TOP_USAGE = "Usage: harnessforce top [--once] [--json] [--ascii] [--theme <auto|light|dark|ansi>]\n";
 const THEMES = [
@@ -12284,7 +12448,7 @@ const TUNE_MESSAGES = {
 	unwritable: "Cannot write to `~/.harnessforce/tune/`, so the analysis results are not sent",
 	recordFailed: "Could not record the suggestion",
 	recordInvalid: (field) => `The suggestion record input is invalid: ${field}`,
-	usage: "Usage: harnessforce tune [--all] [--no-send] [--show-report] [--json], harnessforce tune record, or harnessforce tune --purge",
+	usage: "Usage: harnessforce tune [--all] [--no-send] [--show-report] [--json], harnessforce tune --report-only [--all], harnessforce tune --print-schedule, harnessforce tune record, or harnessforce tune --purge",
 	purged: "Deleted the analysis results, suggestions and unsent analysis results in `~/.harnessforce/tune/`",
 	purgeFailed: "Could not delete some files in `~/.harnessforce/tune/`"
 };
@@ -12870,7 +13034,7 @@ async function analyzeUnderLock(options, access, paths, deps) {
 	]).then(() => true, () => false);
 	if (!isWritten) notices.add("unwritable", TUNE_MESSAGES.unwritable, 1);
 	if (options.json) deps.stdout(`${asciiJson(output)}\n`);
-	else {
+	else if (!options.reportOnly) {
 		deps.stdout(renderAnalysis(analyzed.map((a) => a.report), analyzed.map((a) => a.tune.usage), {
 			sessionCount: analyzed.length,
 			analyzerVersion: ANALYZER_VERSION,
@@ -13110,27 +13274,36 @@ const FLAGS = {
 	"--all": "all",
 	"--no-send": "noSend",
 	"--show-report": "showReport",
-	"--json": "json"
+	"--json": "json",
+	"--report-only": "reportOnly"
 };
+const REPORT_ONLY = "--report-only";
 function parseArgs(args) {
 	if (args.length === 1 && args[0] === "record") return { kind: "record" };
 	if (args.length === 1 && args[0] === "--purge") return { kind: "purge" };
+	if (args.length === 1 && args[0] === "--print-schedule") return { kind: "printSchedule" };
 	const options = {
 		all: false,
 		noSend: false,
 		showReport: false,
-		json: false
+		json: false,
+		reportOnly: false
 	};
 	for (const arg of args) {
 		const key = FLAGS[arg];
 		if (key === void 0 || options[key]) return void 0;
 		options[key] = true;
 	}
+	if (options.reportOnly && (options.noSend || options.showReport || options.json)) return void 0;
 	return {
 		kind: "analyze",
 		options
 	};
 }
+function cronCommandPath(path) {
+	return (/^[A-Za-z0-9_./-]+$/.test(path) ? path : `'${path.replaceAll("'", "'\\''")}'`).replaceAll("%", "\\%");
+}
+const scheduleLine = (selfPath) => `0 9 * * 1 ${cronCommandPath(selfPath)} tune ${REPORT_ONLY}\n`;
 function canTuneSend(args) {
 	const parsed = parseArgs(args);
 	return parsed?.kind === "analyze" && !parsed.options.noSend;
@@ -13180,6 +13353,10 @@ async function tuneCommand(args, deps) {
 		return 2;
 	}
 	if (parsed.kind === "record") return record(deps);
+	if (parsed.kind === "printSchedule") {
+		deps.stdout(scheduleLine(deps.selfPath));
+		return 0;
+	}
 	if (parsed.kind === "purge") return underLock(deps, TUNE_MESSAGES.purgeFailed, async (paths) => {
 		if (!await purgeTuneFiles(paths)) return stopWith(TUNE_MESSAGES.purgeFailed);
 		deps.stderr(`${TUNE_MESSAGES.purged}\n`);
@@ -13284,6 +13461,11 @@ async function run(argv, deps) {
 		git: cli.importGit,
 		now: () => cli.now().getTime()
 	}));
+	if (command === "status") return guarded(() => statusCommand(rest, {
+		...cli,
+		git: cli.importGit,
+		now: () => cli.now().getTime()
+	}));
 	if (command === "tune") return guarded(() => tuneCommand(rest, {
 		...cli,
 		git: cli.importGit,
@@ -13341,6 +13523,7 @@ const SENDING_COMMANDS = /* @__PURE__ */ new Set([
 	"init",
 	"run",
 	"import",
+	"status",
 	"hook"
 ]);
 const isSending = (argv) => SENDING_COMMANDS.has(argv[0] ?? "") || argv[0] === "tune" && canTuneSend(argv.slice(1));
@@ -13543,6 +13726,7 @@ process.exitCode = relaunched ?? await run(argv, {
 	devBuild: !isDefault,
 	callbackTimeoutMs: CALLBACK_TIMEOUT_MS,
 	cwd: process.cwd(),
+	selfPath: process.argv[1],
 	git: createGitRunner({
 		platform: process.platform,
 		env: process.env,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessforce/cli",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Harnessforce command line (harnessforce)",
   "keywords": [
     "harnessforce",