@hwip/cli 0.0.1 → 0.1.0

package/dist/installer.d.ts

@@ -0,0 +1,96 @@
+import type { HwipConfig } from './config.js';
+import type { Agent } from './agents.js';
+interface InstallArgs {
+    key?: string;
+    hook?: string;
+    'base-url'?: string;
+}
+/**
+ * True when install should auto-open browser login (ADR 0002): interactive
+ * context with no existing credential (--key/env/config all absent).
+ */
+/**
+ * Interactive install, past the `--key` path: open a browser login only when
+ * there's nothing saved yet, or the user explicitly asked to re-authenticate
+ * with `--relogin`. A plain re-run keeps the saved login untouched.
+ */
+export declare const shouldReauth: (currentKey: string | undefined, relogin: boolean) => boolean;
+/**
+ * A merge step that left the user's file alone: why, then the JSON to add by
+ * hand. Exported for tests — it is the user's only way forward.
+ */
+export declare const mergeFailureLines: (label: string, filePath: string, err: unknown, snippet: Record<string, unknown>) => string[];
+/** Exported for tests, with `failedStepCount`. */
+export declare const failMerge: (label: string, filePath: string, err: unknown, snippet: Record<string, unknown>) => void;
+export declare const failedStepCount: () => number;
+/** The detection list. An agent that is not installed is information, not a
+ *  failed step — it never counts toward the closing line. Exported for tests. */
+export declare const reportDetectedAgents: (agents: Agent[]) => void;
+/** The install's last line. Exported for tests. */
+export declare const closingLine: (failed: number) => string;
+/** Exported for tests (installGemini shells out to the real `gemini` binary,
+ *  so the merge semantics can't be covered through it deterministically). */
+export declare const mergeJsonFile: (filePath: string, patch: Record<string, unknown>) => void;
+/**
+ * Write a Hwip rule into a SHARED agent rule file (Windsurf global_rules.md,
+ * Gemini GEMINI.md, Codex AGENTS.md) without clobbering the user's own
+ * content. The rule lands inside <!-- HWIP:START/END --> markers; a re-run
+ * replaces just that block.
+ */
+/** Exported for tests. */
+export declare const writeManagedRule: (filePath: string, rule: string) => void;
+/**
+ * Add a `read:` entry to ~/.aider.conf.yml so Aider always loads the Hwip
+ * conventions file. Idempotent — skips if the path is already referenced.
+ * Aider's config is YAML; we do a minimal text-level append to avoid
+ * pulling in a YAML dependency (the SDK is zero-dep by design).
+ */
+/** Exported for tests. */
+export declare const addAiderReadDirective: (confPath: string, conventionsPath: string) => void;
+/** Add the hwip entry under `key` in an MCP registry JSON file, preserving
+ *  everything else in it. Exported for tests (merge semantics). */
+export declare const injectMcpEntry: (filePath: string, key: string, entry: Record<string, unknown>) => void;
+/** `[mcp_servers.hwip]` in codex's own TOML config — the one registry that is
+ *  not JSON. Exported for tests, like `injectMcpEntry`. */
+export declare const injectCodexMcpEntry: (filePath: string) => void;
+/** The first non-empty line a failed child process wrote to stderr, cut to one terminal line; undefined when it wrote none. */
+export declare const firstStderrLine: (err: unknown) => string | undefined;
+/** Exported for tests — each runs against the HOME the module was loaded with. */
+export declare const AGENT_INSTALLERS: Record<string, () => void>;
+/**
+ * Resolve agents from a non-interactive `--only cursor,gemini` flag.
+ * Matches on agent id (`cc` is accepted for `claude`); ids that are not
+ * detected are dropped here, and `unknownOnlyIds` is what flags a typo.
+ * Exported for unit testing.
+ */
+export declare const filterAgentsByIds: (detected: Agent[], only: string) => Agent[];
+/** The `--only` ids that name no agent hwip knows (detected or not): a typo, not "nothing to install". Exported for tests. */
+export declare const unknownOnlyIds: (all: Agent[], only: string) => string[];
+interface ResolvedCredentials {
+    apiKey?: string;
+    hookId?: string;
+    baseUrl?: string;
+}
+/**
+ * Resolve API key + hook for install. Priority: --key/env/config (non-interactive)
+ * → a saved login is reused untouched on re-run → otherwise a brand-new
+ * interactive install opens browser login (ADR 0002), falling back to manual
+ * paste when headless. wsUrl/deviceId from a login are persisted by
+ * runLoginFlow and re-read at config-save time.
+ */
+/** Exported for tests. */
+export declare const collectCredentials: (args: Record<string, string | boolean>, installArgs: InstallArgs, nonInteractive: boolean, existing: HwipConfig) => Promise<ResolvedCredentials>;
+/**
+ * Whether this install should register the service that starts the listener
+ * at login (a LaunchAgent on macOS, a systemd user unit on Linux).
+ *
+ * Interactive installs offer it and default to yes: an empty phone picker
+ * after every reboot is precisely the kind of thing a default should fix.
+ * Scripted installs (`--key`, CI, provisioning) get it only when asked —
+ * planting a background job on a machine whose operator only wanted an API
+ * key written is a surprise, not a convenience.
+ */
+export declare const serviceInstallChoice: (args: Record<string, string | boolean>, nonInteractive: boolean) => "yes" | "no" | "ask";
+export declare const handleInstall: (args: Record<string, string | boolean>) => Promise<number>;
+export {};
+//# sourceMappingURL=installer.d.ts.map