Proton

A modular all-in-one toolkit for JavaScript and TypeScript projects.

Features

• Input Creation - Text, number, boolean, select, confirm, password inputs
• File Management - Create, read, write, copy, move, delete files and directories
• NPM Package Management - Install, uninstall, update, list, search packages
• Archive Operations - ZIP and 7z archiving and extraction
• Web Utilities - HTML utilities and HTML to PDF conversion
• Wikipedia Search - Search and retrieve Wikipedia summaries
• Network Utilities - HTTP/HTTPS requests with built-in error handling
• System Information - CPU, memory, platform, and process information
• CLI - Full-featured command-line interface

Installation

npm install proton

Usage

Programmatic API

import proton from 'proton';

// File Management
await proton.file_management.create('hello.txt');
await proton.file_management.write('hello.txt', 'Hello Proton');
const content = await proton.file_management.read('hello.txt');

// Input
const name = await proton.input.create({
  type: 'text',
  message: 'Name:'
});

// NPM
await proton.npm.install('express');
await proton.npm.uninstall('express');
await proton.npm.update('express');

// Archive
await proton.archive.zip.archive('./project', './project.zip');
await proton.archive.zip.extract('./project.zip', './output');

// Web
await proton.web.pdf.htmlToPDF('<h1>Hello</h1>', './output.pdf');

// Wikipedia
const results = await proton.wikipedia.search('JavaScript');

// Network
const response = await proton.network.get('https://api.example.com/data');

// System
const info = proton.system.getSystemInfo();

CLI

# NPM operations
proton npm install express
proton npm uninstall express
proton npm update express
proton npm list
proton npm search express

# File operations
proton file create test.txt
proton file read test.txt
proton file write test.txt "Hello"
proton file delete test.txt
proton file exists test.txt

# Archive operations
proton zip archive ./src ./src.zip
proton zip extract ./src.zip ./output

proton sz archive ./src ./src.7z
proton sz extract ./src.7z ./output

# Wikipedia
proton wiki search "JavaScript"

# Web utilities
proton web html-to-pdf index.html output.pdf

# System information
proton system info

# Help and version
proton help
proton version

API Reference

file_management

• create(path, content?) - Create file
• read(path) - Read file
• write(path, content) - Write to file
• append(path, content) - Append to file
• copy(source, destination) - Copy file
• move(source, destination) - Move file
• rename(path, newName) - Rename file
• delete(path) - Delete file
• exists(path) - Check if file exists
• stat(path) - Get file statistics
• directory.create(path) - Create directory
• directory.remove(path) - Remove directory
• directory.list(path) - List directory contents
• directory.listDeep(path) - Recursively list directory
• directory.isEmpty(path) - Check if directory is empty
• directory.exists(path) - Check if directory exists

input

• create(options) - Create user input prompt

Input Types:

• text - Text input
• number - Numeric input
• boolean - Yes/No input
• select - Multiple choice selection
• confirm - Confirmation prompt
• password - Password input

npm

• install(package, options?) - Install package
• uninstall(package, options?) - Uninstall package
• update(package, options?) - Update package
• list(options?) - List installed packages
• search(query) - Search npm registry
• readPackageJson(dir?) - Read package.json
• writePackageJson(json, dir?) - Write package.json

archive

• zip.archive(source, destination) - Create ZIP archive
• zip.extract(source, destination) - Extract ZIP archive
• sevenzip.archive(source, destination) - Create 7z archive
• sevenzip.extract(source, destination) - Extract 7z archive

web

• html.stripTags(html) - Remove HTML tags
• html.minify(html) - Minify HTML
• html.sanitize(html) - Sanitize HTML
• html.extractText(html) - Extract text from HTML
• html.escapeHtml(text) - Escape HTML entities
• html.wrapHtml(content, options) - Wrap content in HTML template
• pdf.htmlToPDF(html, path, options?) - Convert HTML to PDF
• pdf.fileToPDF(inputFile, path, options?) - Convert file to PDF

wikipedia

• search(query) - Search Wikipedia
• getSummary(title) - Get Wikipedia article summary

network

• request(url, options?) - Make HTTP request
• get(url, options?) - GET request
• post(url, body, options?) - POST request
• put(url, body, options?) - PUT request
• delete(url, options?) - DELETE request

system

• getPlatform() - Get OS platform
• getArchitecture() - Get system architecture
• getCPUCount() - Get CPU count
• getCPUInfo() - Get CPU information
• getMemory() - Get memory usage
• getUptime() - Get system uptime
• getHostname() - Get hostname
• getHomeDir() - Get home directory
• getTempDir() - Get temp directory
• getSystemInfo() - Get complete system information

Special Features

Non-Symlink NPM Install

Install packages without using symlinks:

await proton.npm.install('express', { symlink: false });

Custom PDF Options

await proton.web.pdf.htmlToPDF(html, './output.pdf', {
  format: 'A4',
  landscape: false,
  margin: { top: '10mm', right: '10mm', bottom: '10mm', left: '10mm' },
  printBackground: true,
});

Requirements

• Node.js >= 18.0.0
• zip and unzip for ZIP operations (usually pre-installed on most systems)
• 7z for 7-Zip operations (optional, install via package manager)

License

MIT