@wonderwhy-er/desktop-commander/dist/tools/filesystem.d.ts

MCP server for terminal operations and file editing

import type { ReadOptions, FileResult, PdfPageItem } from '../utils/files/base.js';
import { PdfOperations, PdfMetadata, IgnoredRenderOption } from './pdf/index.js';
export declare const READ_OPERATION_TIMEOUT_MS: number;
/**
 * Validates a path to ensure it can be accessed or created.
 * For existing paths, returns the real path (resolving symlinks).
 * For non-existent paths, returns where they would be created (resolving the
 * existing ancestors and any dangling link), and validates parent directories.
 *
 * With `entry`, the path names an entry to rename (move_file): links are
 * followed up to its folder, and its own name is kept as written, so a link
 * is renamed as a link and a change of letter case is kept. A rename only
 * ever touches that entry, never what a link at that name points to.
 *
 * @param requestedPath The path to validate
 * @returns Promise<string> The validated path
 * @throws Error if the path or its parent directories don't exist or if the path is not allowed
 */
export declare function validatePath(requestedPath: string, { entry }?: {
    entry?: boolean;
}): Promise<string>;
export type { FileResult } from '../utils/files/base.js';
type PdfPayload = {
    metadata: PdfMetadata;
    pages: PdfPageItem[];
};
type FileResultPayloads = PdfPayload;
/**
 * Read file content from a URL
 * @param url URL to fetch content from
 * @param svgAsImage An SVG is answered as an image, for the file preview widget; otherwise as text
 * @returns File content or file result with metadata
 */
export declare function readFileFromUrl(url: string, svgAsImage?: boolean): Promise<FileResult>;
/**
 * Read file content from the local filesystem
 * @param filePath Path to the file
 * @param options Read options (offset, length, sheet, range)
 * @returns File content or file result with metadata
 */
export declare function readFileFromDisk(filePath: string, options?: ReadOptions): Promise<FileResult>;
/**
 * Read a file from either the local filesystem or a URL
 * @param filePath Path to the file or URL
 * @param options Read options (isUrl, offset, length, sheet, range)
 * @returns File content or file result with metadata
 */
export declare function readFile(filePath: string, options?: ReadOptions): Promise<FileResult>;
/**
 * Read file content without status messages for internal operations
 * This function preserves exact file content including original line endings,
 * which is essential for edit operations that need to maintain file formatting.
 * @param filePath Path to the file
 * @param offset Starting line number to read from (default: 0)
 * @param length Maximum number of lines to read (default: from config or 1000)
 * @returns File content without status headers, with preserved line endings
 */
export declare function readFileInternal(filePath: string, offset?: number, length?: number): Promise<string>;
export declare function writeFile(filePath: string, content: string, mode?: 'rewrite' | 'append'): Promise<void>;
export interface MultiFileResult {
    path: string;
    content?: string;
    mimeType?: string;
    isImage?: boolean;
    error?: string;
    isPdf?: boolean;
    payload?: FileResultPayloads;
}
/**
 * Reads each file; a failure is that file's `error`. `stillLoadingError` (the
 * server's) gives the error for a file whose package is still loading, which
 * is then not read (utils/files/factory.ts).
 */
export declare function readMultipleFiles(paths: string[], stillLoadingError?: (filePath: string) => string | undefined): Promise<MultiFileResult[]>;
export declare function createDirectory(dirPath: string): Promise<void>;
export declare function listDirectory(dirPath: string, depth?: number): Promise<string[]>;
export declare function moveFile(sourcePath: string, destinationPath: string): Promise<void>;
export declare function searchFiles(rootPath: string, pattern: string): Promise<string[]>;
export declare function getFileInfo(filePath: string): Promise<Record<string, any>>;
/**
 * Validate the paths a PDF's page operations use besides the PDF itself: the
 * output path and each inserted PDF. write_pdf and edit_block both modify PDFs,
 * so both check here. An inserted PDF's path is replaced by its validated path.
 *
 * @param validPath The PDF the operations apply to, already validated
 * @returns Where to write the result: outputPath if provided, otherwise the PDF itself
 */
export declare function validatePdfOperationPaths(validPath: string, operations: PdfOperations[], outputPath?: string): Promise<string>;
/**
 * Write content to a PDF file.
 * Can create a new PDF from Markdown string, or modify an existing PDF using operations.
 *
 * @param filePath Path to the output PDF file
 * @param content Markdown string (for creation) or array of operations (for modification)
 * @param options Options for PDF generation or modification. For modification, can include `sourcePdf`.
 * @returns The render options Desktop Commander ignored (see resolveRender), so the caller can report them.
 */
export declare function writePdf(filePath: string, content: string | PdfOperations[], outputPath?: string, options?: any): Promise<IgnoredRenderOption[]>;
type DefaultEditorMetadata = {
    defaultEditorName?: string;
    defaultEditorPath?: string;
};
export declare function getDefaultEditorMetadata(filePath: string): Promise<DefaultEditorMetadata>;