✨ A Lightweight, TypeScript-Powered File System Wrapper for Node.js ✨

Sysify is a lightweight yet powerful wrapper for the Node.js filesystem module, providing an intuitive and typed API for essential terminal-like commands. It’s designed to enable developers to write scripts for managing files and directories quickly and efficiently.

With Sysify, you can leverage commands like mkdir, cd, ls, touch, rm, and more in a way that feels natural to developers familiar with terminal commands.

• 📂 Essential Terminal Commands: Execute familiar file system operations programmatically (“e.g., mkdir, ls, rm”).
• 📚 Typed and Extensible API: Built with TypeScript for type safety and scalability.
• 🔧 Script-Friendly: Simplify writing automation scripts and utilities.
• 📝 Metadata Tracking: Access file and directory metadata like size and permissions.
• 💰 Lightweight and Fast: Optimized for minimal overhead while retaining robust functionality.

Install sysify via pnpm:

pnpm install sysify

Here’s a quick example of how to get started with Sysify:

import { FileSystem } from 'sysify';

const fs = new FileSystem();

// Create a new directory
fs.mkdir('projects');

// Navigate into the directory
fs.cd('projects');

// Create a new file with content
fs.touch('readme.txt', 'Welcome to Sysify!');

// List contents of the current directory
console.log(fs.ls()); // Output: ['readme.txt']

// Delete the file
fs.delete('readme.txt');

// Go back to the root directory
fs.cd('..');

// Delete "projects" folder (a.k.a 'rm -rf projects/')
fs.delete('projects')

• mkdir(directory: string, options: { silent: boolean } = {}): Create a new directory.
• cd(directory: string): Change the current working directory.
• ls(): List contents of the current directory.
• touch(file: string, content?: string | Buffer): Create a new file.
• delete(target: string, options: { recursive?: boolean, silent: boolean, force?: boolean } = {}): Remove a file or directory.

• pwd(): Get the current working directory.

• Ease of Use: Intuitive API that mirrors terminal commands.
• Type Safety: Reduce errors and improve code clarity with TypeScript.
• Customization: Easily extend functionality to meet your specific needs.