Files

import { CMDOPClient } from '@cmdop/node';
 
// Connect via cloud relay and select the target machine for file operations
const client = await CMDOPClient.remote({ apiKey: 'cmdop_xxx' });
await client.files.setMachine('my-server');

// List all files and directories at the given path
const files = await client.files.list('/var/log');
 
for (const file of files) {
  console.log(file.name, file.size, file.isDirectory);
}

// List with hidden files included, non-recursive (current directory only)
const files = await client.files.list('/home/user', {
  includeHidden: true,
  recursive: false,
});

// Read a file as a UTF-8 string
const content = await client.files.read('/etc/nginx/nginx.conf');
console.log(content);

// Read a binary file as a raw Buffer (e.g., images, executables)
const buffer = await client.files.readBuffer('/path/to/binary');

// Write a Buffer to a file on the remote machine
await client.files.write('/tmp/config.json', Buffer.from('{"key": "value"}'));

// Write a plain string directly -- auto-converted to UTF-8
await client.files.write('/tmp/hello.txt', 'Hello, World!');

// Copy a file from source path to destination path on the remote machine
await client.files.copy('/src/file.txt', '/dst/file.txt');

// Move (or rename) a file from old path to new path
await client.files.move('/old/path.txt', '/new/path.txt');

// Delete a single file on the remote machine
await client.files.delete('/tmp/old-file.txt');

// Delete an entire directory and its contents recursively
await client.files.delete('/tmp/old-dir', { recursive: true });

// Create a new directory (creates parent directories if needed)
await client.files.mkdir('/new/dir');

// Search for files matching a glob pattern within a directory tree
const results = await client.files.search('/var/log', {
  pattern: '*.log',    // Match all .log files
  maxDepth: 3,         // Search up to 3 levels deep
});

// Archive a directory into a compressed tar.gz file
await client.files.archive('/path/to/dir', '/tmp/backup.tar.gz');

// Retrieve file size, modification time, and permission info
const info = await client.files.info('/etc/nginx/nginx.conf');
console.log(info.size, info.modified, info.permissions);