| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596 |
- /**
- * CodeGraph Interactive Installer
- *
- * Multi-target: writes MCP server config + instructions for the
- * agents the user picks (Claude Code, Cursor, Codex CLI, opencode,
- * Hermes Agent, Gemini CLI, Antigravity IDE).
- * Defaults to the Claude-only behavior for backwards compatibility
- * when no targets are explicitly chosen and nothing else is detected.
- *
- * Uses @clack/prompts for the interactive UI; `runInstallerWithOptions`
- * is the non-interactive entry point used by the `--target` /
- * `--print-config` CLI flags.
- */
- import { execSync } from 'child_process';
- import * as path from 'path';
- import * as fs from 'fs';
- import {
- ALL_TARGETS,
- detectAll,
- getTarget,
- resolveTargetFlag,
- } from './targets/registry';
- import type { AgentTarget, Location, TargetId, WriteResult } from './targets/types';
- import { getGlyphs } from '../ui/glyphs';
- // Import the lightweight submodules directly (not the ../sync barrel, which
- // re-exports FileWatcher and would transitively pull in ../extraction — the
- // installer must stay importable even when native modules can't load).
- import { watchDisabledReason } from '../sync/watch-policy';
- import { isGitRepo, isSyncHookInstalled, installGitSyncHook } from '../sync/git-hooks';
- // Backwards-compat: keep these named exports — downstream code may
- // import them. The shim in `config-writer.ts` continues to re-export
- // them too.
- export {
- writeMcpConfig,
- writePermissions,
- writeClaudeMd,
- hasMcpConfig,
- hasPermissions,
- hasClaudeMdSection,
- } from './config-writer';
- export type { InstallLocation } from './config-writer';
- // Dynamic import helper — tsc compiles import() to require() in CJS mode,
- // which fails for ESM-only packages. This bypasses the transformation.
- // eslint-disable-next-line @typescript-eslint/no-implied-eval
- const importESM = new Function('specifier', 'return import(specifier)') as
- (specifier: string) => Promise<typeof import('@clack/prompts')>;
- function formatNumber(n: number): string {
- return n.toLocaleString();
- }
- function getVersion(): string {
- try {
- const packageJsonPath = path.join(__dirname, '..', '..', 'package.json');
- const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
- return packageJson.version;
- } catch {
- return '0.0.0';
- }
- }
- export interface RunInstallerOptions {
- /** Comma-separated target list, or `auto` / `all` / `none`. */
- target?: string;
- /** Skip the location prompt; use this value directly. */
- location?: Location;
- /** Skip the auto-allow prompt; use this value directly. */
- autoAllow?: boolean;
- /**
- * Skip every confirm and use defaults: location=global,
- * autoAllow=true, target=auto. For scripting / CI.
- */
- yes?: boolean;
- }
- /**
- * Interactive entry point — preserves the historical UX (`codegraph
- * install` with no args goes through the prompts), but now starts
- * the targets multi-select pre-populated with detected agents.
- */
- export async function runInstaller(): Promise<void> {
- return runInstallerWithOptions({});
- }
- export async function runInstallerWithOptions(opts: RunInstallerOptions): Promise<void> {
- const clack = await importESM('@clack/prompts');
- clack.intro(`CodeGraph v${getVersion()}`);
- // --yes implies all defaults; explicit flags still win.
- const useDefaults = opts.yes === true;
- // Step 1: which agent targets? Asked FIRST so the user knows what
- // they're committing to before we touch npm or disk. Detection
- // probes the user-provided location if known, else 'global' as the
- // most common default — labels are a hint, not load-bearing.
- const detectionLocation: Location = opts.location ?? 'global';
- const targets = await resolveTargets(clack, opts, detectionLocation, useDefaults);
- if (targets.length === 0) {
- clack.outro('No agent targets selected — nothing to do.');
- return;
- }
- // Step 2: install the codegraph npm package on PATH (always offered;
- // matches existing behavior). Skipped when --yes (assume present).
- if (!useDefaults) {
- const shouldInstallGlobally = await clack.confirm({
- message: 'Install the codegraph CLI on your PATH? (Required so agents can launch the MCP server)',
- initialValue: true,
- });
- if (clack.isCancel(shouldInstallGlobally)) {
- clack.cancel('Installation cancelled.');
- process.exit(0);
- }
- if (shouldInstallGlobally) {
- const s = clack.spinner();
- s.start('Installing codegraph CLI...');
- try {
- execSync('npm install -g @colbymchenry/codegraph', { stdio: 'pipe' });
- s.stop('Installed codegraph CLI on PATH');
- } catch {
- s.stop('Could not install (permission denied)');
- clack.log.warn('Try: sudo npm install -g @colbymchenry/codegraph');
- }
- } else {
- clack.log.info('Skipped CLI install — agents will not be able to launch the MCP server without it');
- }
- }
- // Step 3: where the per-agent config files should land.
- let location: Location;
- if (opts.location) {
- location = opts.location;
- } else if (useDefaults) {
- location = 'global';
- } else {
- // If every selected target is global-only (e.g. Codex), skip the
- // prompt and force user-wide — project-local would just produce
- // skip warnings.
- const allGlobalOnly = targets.every((t) => !t.supportsLocation('local'));
- if (allGlobalOnly) {
- location = 'global';
- clack.log.info('Writing user-wide configs (selected agents have no project-local config).');
- } else {
- const sel = await clack.select({
- message: 'Apply agent configs to all your projects, or just this one?',
- options: [
- { value: 'global' as const, label: 'All projects', hint: '~/.claude, ~/.cursor, etc.' },
- { value: 'local' as const, label: 'Just this project', hint: './.claude, ./.cursor, etc.' },
- ],
- initialValue: 'global' as const,
- });
- if (clack.isCancel(sel)) {
- clack.cancel('Installation cancelled.');
- process.exit(0);
- }
- location = sel;
- }
- }
- // Step 4: auto-allow permissions (only meaningful for Claude;
- // skipped silently by other targets).
- let autoAllow: boolean;
- if (opts.autoAllow !== undefined) {
- autoAllow = opts.autoAllow;
- } else if (useDefaults) {
- autoAllow = true;
- } else if (targets.some((t) => t.id === 'claude')) {
- const ans = await clack.confirm({
- message: 'Auto-allow CodeGraph commands? (Skips permission prompts in Claude Code)',
- initialValue: true,
- });
- if (clack.isCancel(ans)) {
- clack.cancel('Installation cancelled.');
- process.exit(0);
- }
- autoAllow = ans;
- } else {
- autoAllow = false;
- }
- // Step 5: per-target install loop.
- for (const target of targets) {
- if (!target.supportsLocation(location)) {
- clack.log.warn(
- `${target.displayName}: skipped — does not support --location=${location}.`,
- );
- continue;
- }
- const result = target.install(location, { autoAllow });
- for (const file of result.files) {
- const verb = file.action === 'unchanged'
- ? 'Unchanged'
- : file.action === 'created' ? 'Created' : 'Updated';
- clack.log.success(`${target.displayName}: ${verb} ${tildify(file.path)}`);
- }
- for (const note of result.notes ?? []) {
- clack.log.info(`${target.displayName}: ${note}`);
- }
- }
- // Step 6: for local install, initialize the project.
- if (location === 'local') {
- await initializeLocalProject(clack, useDefaults);
- }
- if (location === 'global') {
- clack.note('cd your-project\ncodegraph init -i', 'Quick start');
- }
- const finalNote = targets.length > 0
- ? `Done! Restart your agent${targets.length > 1 ? 's' : ''} to use CodeGraph.`
- : 'Done!';
- clack.outro(finalNote);
- }
- export interface RunUninstallerOptions {
- /**
- * Comma-separated target list, or `auto` / `all` / `none`. Defaults
- * to `all` — uninstall sweeps every known agent and reports which
- * ones it actually touched, so the user doesn't have to know where
- * they configured it.
- */
- target?: string;
- /** Skip the location prompt; use this value directly. */
- location?: Location;
- /** Non-interactive: location=global, target=all, no prompts. */
- yes?: boolean;
- }
- export type UninstallStatus = 'removed' | 'not-configured' | 'unsupported';
- /**
- * Per-target outcome of an uninstall sweep. `removed` means we deleted
- * at least one thing; `not-configured` means the agent had no codegraph
- * config at this location (nothing to do); `unsupported` means the
- * agent has no config concept for this location (e.g. Codex is
- * global-only, so a `local` uninstall skips it).
- */
- export interface UninstallReport {
- id: TargetId;
- displayName: string;
- status: UninstallStatus;
- /** Absolute paths we actually edited/removed (action === 'removed'). */
- removedPaths: string[];
- /** Verbatim notes from the target (rare for uninstall). */
- notes: string[];
- }
- /**
- * Pure uninstall sweep — no prompts, no I/O beyond the targets' own
- * file edits. Exposed (and unit-tested) separately from the clack UI in
- * `runUninstaller` so the aggregation logic can be asserted directly.
- *
- * Each target's `uninstall()` is already safe to call when nothing was
- * installed (it returns `not-found` actions), so this is safe to run
- * across every target unconditionally.
- */
- export function uninstallTargets(
- targets: readonly AgentTarget[],
- location: Location,
- ): UninstallReport[] {
- return targets.map((target) => {
- if (!target.supportsLocation(location)) {
- const only: Location = location === 'local' ? 'global' : 'local';
- return {
- id: target.id,
- displayName: target.displayName,
- status: 'unsupported' as const,
- removedPaths: [],
- notes: [`no ${location} config — this agent is ${only}-only`],
- };
- }
- const result = target.uninstall(location);
- const removedPaths = result.files
- .filter((f) => f.action === 'removed')
- .map((f) => f.path);
- return {
- id: target.id,
- displayName: target.displayName,
- status: removedPaths.length > 0 ? ('removed' as const) : ('not-configured' as const),
- removedPaths,
- notes: result.notes ?? [],
- };
- });
- }
- /**
- * Interactive uninstaller — the inverse of `runInstallerWithOptions`.
- * Asks global-vs-local first (unless `--location`/`--yes` is given),
- * then sweeps every agent target (or the `--target` subset) and prints
- * one block per agent so the user sees exactly which providers it hit.
- *
- * Removes only what install wrote (MCP server entry, instructions
- * block, permissions) — never the `.codegraph/` index, which `codegraph
- * uninit` owns.
- */
- export async function runUninstaller(opts: RunUninstallerOptions): Promise<void> {
- const clack = await importESM('@clack/prompts');
- clack.intro(`CodeGraph v${getVersion()} — uninstall`);
- const useDefaults = opts.yes === true;
- // Step 1: which location — asked FIRST, the one decision the user
- // must make. Global sweeps ~/.claude, ~/.codex, etc.; local sweeps
- // the configs in this project directory.
- let location: Location;
- if (opts.location) {
- location = opts.location;
- } else if (useDefaults) {
- location = 'global';
- } else {
- const sel = await clack.select({
- message: 'Remove CodeGraph from all your projects, or just this one?',
- options: [
- { value: 'global' as const, label: 'All projects (global)', hint: '~/.claude, ~/.cursor, ~/.codex, ~/.config/opencode, ~/.hermes, ~/.gemini' },
- { value: 'local' as const, label: 'Just this project (local)', hint: './.claude, ./.cursor, ./opencode.jsonc, ./.gemini' },
- ],
- initialValue: 'global' as const,
- });
- if (clack.isCancel(sel)) {
- clack.cancel('Uninstall cancelled.');
- process.exit(0);
- }
- location = sel;
- }
- // Step 2: which agents. Default is every agent, so the user doesn't
- // have to remember where they installed it — unconfigured agents are
- // reported as "nothing to remove" and left untouched. An explicit
- // --target subsets this.
- let targets: AgentTarget[];
- if (opts.target !== undefined) {
- targets = resolveTargetFlag(opts.target, location);
- } else {
- targets = [...ALL_TARGETS];
- }
- if (targets.length === 0) {
- clack.outro('No agent targets selected — nothing to do.');
- return;
- }
- // Step 3: sweep + per-agent feedback.
- const reports = uninstallTargets(targets, location);
- const removed = reports.filter((r) => r.status === 'removed');
- for (const r of reports) {
- if (r.status === 'removed') {
- for (const p of r.removedPaths) {
- clack.log.success(`${r.displayName}: removed ${tildify(p)}`);
- }
- } else if (r.status === 'not-configured') {
- clack.log.info(`${r.displayName}: not configured — nothing to remove`);
- } else {
- clack.log.info(`${r.displayName}: skipped — ${r.notes[0] ?? 'unsupported location'}`);
- }
- }
- // Step 4: for local uninstall, the index dir is separate — point at
- // `uninit` so the user knows it's still there (and how to remove it).
- if (location === 'local' && fs.existsSync(path.join(process.cwd(), '.codegraph'))) {
- clack.log.info('The .codegraph/ index for this project is still here. Run `codegraph uninit` to delete it.');
- }
- // Step 5: summary.
- if (removed.length > 0) {
- const names = removed.map((r) => r.displayName).join(', ');
- clack.outro(
- `Removed CodeGraph from ${removed.length} agent${removed.length > 1 ? 's' : ''}: ${names}. ` +
- `Restart ${removed.length > 1 ? 'them' : 'it'} to apply.`,
- );
- } else {
- clack.outro(`CodeGraph was not configured in any ${location} agent — nothing to remove.`);
- }
- }
- /**
- * For every target that has a global config and exposes
- * `wireProjectSurfaces`, write its project-local surfaces (e.g.
- * Cursor's `.cursor/rules/codegraph.mdc`). Idempotent — runs
- * silently when there's nothing to write.
- *
- * Called by `codegraph init` so that a user who ran
- * `codegraph install` once globally doesn't have to re-run it per
- * project to get full agent support.
- *
- * Returns the list of `(target, file)` pairs that were created or
- * updated — caller decides how to surface them.
- */
- export function wireProjectSurfacesForGlobalAgents(): Array<{
- target: AgentTarget;
- file: WriteResult['files'][number];
- }> {
- const written: Array<{ target: AgentTarget; file: WriteResult['files'][number] }> = [];
- for (const target of ALL_TARGETS) {
- if (typeof target.wireProjectSurfaces !== 'function') continue;
- const detection = target.detect('global');
- if (!detection.alreadyConfigured) continue;
- const result = target.wireProjectSurfaces();
- for (const file of result.files) {
- if (file.action === 'created' || file.action === 'updated') {
- written.push({ target, file });
- }
- }
- }
- return written;
- }
- /**
- * Replace home-directory prefix in a path with `~/` for cleaner log
- * lines. Pure cosmetic.
- */
- function tildify(p: string): string {
- const home = require('os').homedir();
- if (p.startsWith(home + path.sep)) return '~' + p.substring(home.length);
- return p;
- }
- async function resolveTargets(
- clack: typeof import('@clack/prompts'),
- opts: RunInstallerOptions,
- location: Location,
- useDefaults: boolean,
- ): Promise<AgentTarget[]> {
- // Explicit --target flag wins.
- if (opts.target !== undefined) {
- return resolveTargetFlag(opts.target, location);
- }
- // --yes implies auto-detect.
- if (useDefaults) {
- return resolveTargetFlag('auto', location);
- }
- // Interactive multi-select.
- const detected = detectAll(location);
- const initialValues = detected
- .filter(({ detection }) => detection.installed)
- .map(({ target }) => target.id);
- // If nothing detected, default to Claude alone (matches the
- // historical default and the smallest-surprise outcome).
- const initial = initialValues.length > 0 ? initialValues : ['claude'];
- const choice = await clack.multiselect<string>({
- message: 'Which agents should CodeGraph configure?',
- options: ALL_TARGETS.map((t) => {
- const det = detected.find(({ target }) => target.id === t.id)!.detection;
- const flag = det.installed ? '(detected)' : '(not found)';
- const globalOnly = !t.supportsLocation('local') ? ' — global only' : '';
- return {
- value: t.id,
- label: `${t.displayName} ${flag}${globalOnly}`,
- };
- }),
- initialValues: initial,
- required: false,
- });
- if (clack.isCancel(choice)) {
- clack.cancel('Installation cancelled.');
- process.exit(0);
- }
- return choice
- .map((id) => getTarget(id))
- .filter((t): t is AgentTarget => t !== undefined);
- }
- /**
- * Initialize CodeGraph in the current project (for local installs), then
- * offer the watch fallback when the live watcher won't run here (see
- * offerWatchFallback). Agent-agnostic by nature.
- */
- async function initializeLocalProject(
- clack: typeof import('@clack/prompts'),
- useDefaults = false,
- ): Promise<void> {
- const projectPath = process.cwd();
- let CodeGraph: typeof import('../index').default;
- try {
- CodeGraph = (await import('../index')).default;
- } catch (err) {
- const msg = err instanceof Error ? err.message : String(err);
- clack.log.error(`Could not load native modules: ${msg}`);
- clack.log.info('Skipping project initialization. Run "codegraph init -i" later.');
- return;
- }
- // Check if already initialized
- if (CodeGraph.isInitialized(projectPath)) {
- clack.log.info('CodeGraph already initialized in this project');
- await offerWatchFallback(clack, projectPath, { yes: useDefaults });
- return;
- }
- // Initialize
- const cg = await CodeGraph.init(projectPath);
- clack.log.success('Created .codegraph/ directory');
- // Index the project with shimmer progress (worker thread for smooth animation)
- const { createShimmerProgress } = await import('../ui/shimmer-progress');
- process.stdout.write(`\x1b[2m${getGlyphs().rail}\x1b[0m\n`);
- const progress = createShimmerProgress();
- const result = await cg.indexAll({
- onProgress: progress.onProgress,
- });
- await progress.stop();
- if (result.filesErrored > 0) {
- clack.log.success(`Indexed ${formatNumber(result.filesIndexed)} files (${formatNumber(result.filesErrored)} failed, ${formatNumber(result.nodesCreated)} symbols)`);
- } else {
- clack.log.success(`Indexed ${formatNumber(result.filesIndexed)} files (${formatNumber(result.nodesCreated)} symbols)`);
- }
- cg.close();
- await offerWatchFallback(clack, projectPath, { yes: useDefaults });
- }
- /**
- * When the live file watcher will be disabled for this project (e.g. WSL2
- * /mnt drives, or CODEGRAPH_NO_WATCH), the index would silently go stale.
- * Explain that, and offer to keep it fresh automatically via git hooks
- * (commit / pull / checkout) instead of manual `codegraph sync`.
- *
- * No-op on environments where the watcher runs normally, so it's safe to
- * call unconditionally after init.
- */
- export async function offerWatchFallback(
- clack: typeof import('@clack/prompts'),
- projectPath: string,
- opts: { yes?: boolean } = {},
- ): Promise<void> {
- const reason = watchDisabledReason(projectPath);
- if (!reason) return; // Watcher runs normally — nothing to set up.
- clack.log.warn(`Live file watching is disabled here — ${reason}.`);
- clack.log.info('Until you re-sync, the CodeGraph index stays frozen — it will not pick up edits on its own.');
- // No git repo → the commit-hook path doesn't apply; point at manual sync.
- if (!isGitRepo(projectPath)) {
- clack.log.info('Run `codegraph sync` after changing files to refresh the index.');
- return;
- }
- // Already wired up on a previous run — confirm and move on without nagging.
- if (isSyncHookInstalled(projectPath)) {
- clack.log.info('Git sync hooks are already installed — the index refreshes after commit / pull / checkout.');
- return;
- }
- let choice: 'hook' | 'manual';
- if (opts.yes) {
- choice = 'hook';
- } else {
- const sel = await clack.select({
- message: 'How should CodeGraph keep its index fresh?',
- options: [
- { value: 'hook' as const, label: 'Sync on git commit / pull / checkout', hint: 'installs git hooks (recommended)' },
- { value: 'manual' as const, label: 'I\'ll run `codegraph sync` myself', hint: 'fully manual' },
- ],
- initialValue: 'hook' as const,
- });
- if (clack.isCancel(sel)) {
- clack.log.info('Skipped — run `codegraph sync` after changes to refresh the index.');
- return;
- }
- choice = sel;
- }
- if (choice === 'manual') {
- clack.log.info('Run `codegraph sync` after changing files to refresh the index.');
- return;
- }
- const result = installGitSyncHook(projectPath);
- if (result.installed.length > 0) {
- clack.log.success(
- `Installed git ${result.installed.join(', ')} hook${result.installed.length > 1 ? 's' : ''} — ` +
- 'the index refreshes in the background after each.',
- );
- clack.log.info('Run `codegraph sync` anytime to refresh immediately.');
- } else {
- clack.log.warn(
- `Could not install git hooks${result.skipped ? ` (${result.skipped})` : ''}. ` +
- 'Run `codegraph sync` after changes instead.',
- );
- }
- }
|