Repomix

import * as fs from 'node:fs/promises'; import os from 'node:os'; import path from 'node:path'; import pc from 'picocolors'; import { execGitShallowClone } from '../../core/git/gitCommand.js'; import { downloadGitHubArchive, isArchiveDownloadSupported } from '../../core/git/gitHubArchive.js'; import { getRemoteRefs } from '../../core/git/gitRemoteHandle.js'; import { isGitHubRepository, parseGitHubRepoInfo, parseRemoteValue } from '../../core/git/gitRemoteParse.js'; import { isGitInstalled } from '../../core/git/gitRepositoryHandle.js'; import { generateDefaultSkillNameFromUrl, generateProjectNameFromUrl } from '../../core/skill/skillUtils.js'; import { RepomixError } from '../../shared/errorHandle.js'; import { logger } from '../../shared/logger.js'; import { Spinner } from '../cliSpinner.js'; import { promptSkillLocation, type SkillLocation } from '../prompts/skillPrompts.js'; import type { CliOptions } from '../types.js'; import { type DefaultActionRunnerResult, runDefaultAction } from './defaultAction.js'; export const runRemoteAction = async ( repoUrl: string, cliOptions: CliOptions, deps = { isGitInstalled, execGitShallowClone, getRemoteRefs, runDefaultAction, downloadGitHubArchive, isGitHubRepository, parseGitHubRepoInfo, isArchiveDownloadSupported, }, ): Promise<DefaultActionRunnerResult> => { let tempDirPath = await createTempDirectory(); let result: DefaultActionRunnerResult; let downloadMethod: 'archive' | 'git' = 'git'; try { // Check if this is a GitHub repository and archive download is supported const githubRepoInfo = deps.parseGitHubRepoInfo(repoUrl); const shouldTryArchive = githubRepoInfo && deps.isArchiveDownloadSupported(githubRepoInfo); if (shouldTryArchive) { // Try GitHub archive download first const spinner = new Spinner('Downloading repository archive...', cliOptions); try { spinner.start(); // Override ref with CLI option if provided const repoInfoWithBranch = { ...githubRepoInfo, ref: cliOptions.remoteBranch ?? githubRepoInfo.ref, }; await deps.downloadGitHubArchive( repoInfoWithBranch, tempDirPath, { timeout: 60000, // 1 minute timeout for large repos retries: 2, }, (progress) => { if (progress.percentage !== null) { spinner.update(`Downloading repository archive... (${progress.percentage}%)`); } else { // Show downloaded bytes when percentage is not available const downloadedMB = (progress.downloaded / 1024 / 1024).toFixed(1); spinner.update(`Downloading repository archive... (${downloadedMB} MB)`); } }, ); downloadMethod = 'archive'; spinner.succeed('Repository archive downloaded successfully!'); logger.log(''); } catch (archiveError) { spinner.fail('Archive download failed, trying git clone...'); logger.trace('Archive download error:', (archiveError as Error).message); // Clear the temp directory for git clone attempt await cleanupTempDirectory(tempDirPath); tempDirPath = await createTempDirectory(); // Fall back to git clone await performGitClone(repoUrl, tempDirPath, cliOptions, deps); downloadMethod = 'git'; } } else { // Use git clone directly await performGitClone(repoUrl, tempDirPath, cliOptions, deps); downloadMethod = 'git'; } // For skill generation, prompt for location using current directory (not temp directory) let skillName: string | undefined; let skillDir: string | undefined; let skillLocation: SkillLocation | undefined; let skillProjectName: string | undefined; if (cliOptions.skillGenerate !== undefined) { skillName = typeof cliOptions.skillGenerate === 'string' ? cliOptions.skillGenerate : generateDefaultSkillNameFromUrl(repoUrl); // Generate project name from URL for use in skill description skillProjectName = generateProjectNameFromUrl(repoUrl); const promptResult = await promptSkillLocation(skillName, process.cwd()); skillDir = promptResult.skillDir; skillLocation = promptResult.location; } // Run the default action on the downloaded/cloned repository // Pass the pre-computed skill name, directory, project name, and source URL const skillSourceUrl = cliOptions.skillGenerate !== undefined ? repoUrl : undefined; const optionsWithSkill = { ...cliOptions, skillName, skillDir, skillProjectName, skillSourceUrl }; result = await deps.runDefaultAction([tempDirPath], tempDirPath, optionsWithSkill); // Copy output to current directory // Skip copy for stdout mode (output goes directly to stdout) // For skill generation with project location, copy the skill directory // For personal location, skill is already written to ~/.claude/skills/ if (!cliOptions.stdout) { if (result.config.skillGenerate !== undefined && skillLocation === 'project') { // Copy skill directory to current directory (only for project skills) await copySkillOutputToCurrentDirectory(tempDirPath, process.cwd()); } else if (result.config.skillGenerate === undefined) { await copyOutputToCurrentDirectory(tempDirPath, process.cwd(), result.config.output.filePath); } } logger.trace(`Repository obtained via ${downloadMethod} method`); } finally { // Cleanup the temporary directory await cleanupTempDirectory(tempDirPath); } return result; }; /** * Performs git clone operation with spinner and error handling */ const performGitClone = async ( repoUrl: string, tempDirPath: string, cliOptions: CliOptions, deps: { isGitInstalled: typeof isGitInstalled; getRemoteRefs: typeof getRemoteRefs; execGitShallowClone: typeof execGitShallowClone; }, ): Promise<void> => { // Check if git is installed only when we actually need to use git if (!(await deps.isGitInstalled())) { throw new RepomixError('Git is not installed or not in the system PATH.'); } // Get remote refs let refs: string[] = []; try { refs = await deps.getRemoteRefs(parseRemoteValue(repoUrl).repoUrl); logger.trace(`Retrieved ${refs.length} refs from remote repository`); } catch (error) { logger.trace('Failed to get remote refs, proceeding without them:', (error as Error).message); } // Parse the remote URL with the refs information const parsedFields = parseRemoteValue(repoUrl, refs); const spinner = new Spinner('Cloning repository...', cliOptions); try { spinner.start(); // Clone the repository await cloneRepository(parsedFields.repoUrl, tempDirPath, cliOptions.remoteBranch || parsedFields.remoteBranch, { execGitShallowClone: deps.execGitShallowClone, }); spinner.succeed('Repository cloned successfully!'); logger.log(''); } catch (error) { spinner.fail('Error during repository cloning. cleanup...'); throw error; } }; export const createTempDirectory = async (): Promise<string> => { const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'repomix-')); logger.trace(`Created temporary directory. (path: ${pc.dim(tempDir)})`); return tempDir; }; export const cloneRepository = async ( url: string, directory: string, remoteBranch?: string, deps = { execGitShallowClone, }, ): Promise<void> => { logger.log(`Clone repository: ${url} to temporary directory. ${pc.dim(`path: ${directory}`)}`); logger.log(''); try { await deps.execGitShallowClone(url, directory, remoteBranch); } catch (error) { throw new RepomixError(`Failed to clone repository: ${(error as Error).message}`); } }; export const cleanupTempDirectory = async (directory: string): Promise<void> => { logger.trace(`Cleaning up temporary directory: ${directory}`); await fs.rm(directory, { recursive: true, force: true }); }; export const copySkillOutputToCurrentDirectory = async (sourceDir: string, targetDir: string): Promise<void> => { // Only copy .claude/skills/ directory, not the entire .claude directory // This prevents conflicts with repository's own .claude config (commands, agents, etc.) const sourceSkillsDir = path.join(sourceDir, '.claude', 'skills'); const targetSkillsDir = path.join(targetDir, '.claude', 'skills'); try { // Check if source .claude/skills directory exists await fs.access(sourceSkillsDir); } catch { // No skill output was generated logger.trace('No .claude/skills directory found in source, skipping skill output copy'); return; } try { logger.trace(`Copying skill output from: ${sourceSkillsDir} to: ${targetSkillsDir}`); // Copy only the skills directory await fs.cp(sourceSkillsDir, targetSkillsDir, { recursive: true }); } catch (error) { const nodeError = error as NodeJS.ErrnoException; if (nodeError.code === 'EPERM' || nodeError.code === 'EACCES') { throw new RepomixError( `Failed to copy skill output to ${targetSkillsDir}: Permission denied. The current directory may be protected or require elevated permissions. Please try running from a different directory (e.g., your home directory or Documents folder).`, ); } throw new RepomixError(`Failed to copy skill output: ${(error as Error).message}`); } }; export const copyOutputToCurrentDirectory = async ( sourceDir: string, targetDir: string, outputFileName: string, ): Promise<void> => { const sourcePath = path.resolve(sourceDir, outputFileName); const targetPath = path.resolve(targetDir, outputFileName); // Skip copy if source and target are the same // This can happen when an absolute path is specified for the output file if (sourcePath === targetPath) { logger.trace(`Source and target are the same (${sourcePath}), skipping copy`); return; } try { logger.trace(`Copying output file from: ${sourcePath} to: ${targetPath}`); // Create target directory if it doesn't exist await fs.mkdir(path.dirname(targetPath), { recursive: true }); await fs.copyFile(sourcePath, targetPath); } catch (error) { const nodeError = error as NodeJS.ErrnoException; // Provide helpful message for permission errors if (nodeError.code === 'EPERM' || nodeError.code === 'EACCES') { throw new RepomixError( `Failed to copy output file to ${targetPath}: Permission denied. The current directory may be protected or require elevated permissions. Please try one of the following: • Run from a different directory (e.g., your home directory or Documents folder) • Use the --output flag to specify a writable location: --output ~/repomix-output.xml • Use --stdout to print output directly to the console`, ); } throw new RepomixError(`Failed to copy output file: ${(error as Error).message}`); } };