puter-cli 1.0.0

package/commands/commons.js

@@ -0,0 +1,296 @@
+import  chalk from 'chalk';
+import { getAuthToken } from './auth.js';
+
+export const PROJECT_NAME = 'puter-cli';
+export const API_BASE = 'https://api.puter.com';
+export const BASE_URL = 'https://puter.com';
+
+/**
+ * Get headers with the correct Content-Type for multipart form data.
+ * @param {string} contentType - The "Content-Type" argument for the header ('application/json' is the default)
+ * Use the multipart form data for upload a file.
+ * @returns {Object} The headers object.
+ */
+export function getHeaders(contentType = 'application/json') {
+    return {
+      'Accept': '*/*',
+      'Accept-Language': 'en-US,en;q=0.9',
+      'Authorization': `Bearer ${getAuthToken()}`,
+      'Connection': 'keep-alive',
+      // 'Host': 'api.puter.com',
+      'Content-Type': contentType,
+      'Origin': `${BASE_URL}`,
+      'Referer': `${BASE_URL}/`,
+      'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36'
+    }
+}
+
+/**
+ * Generate a random app name
+ * @returns a random app name or null if it fails
+ * @see: [randName](https://github.com/HeyPuter/puter/blob/06a67a3b223a6cbd7ec2e16853b6d2304f621a88/src/puter-js/src/index.js#L389)
+ */
+export function generateAppName(separateWith = '-'){
+  console.log(chalk.cyan('Generating random app name...'));
+  try {        
+      const first_adj = ['helpful','sensible', 'loyal', 'honest', 'clever', 'capable','calm', 'smart', 'genius', 'bright', 'charming', 'creative', 'diligent', 'elegant', 'fancy', 
+      'colorful', 'avid', 'active', 'gentle', 'happy', 'intelligent', 'jolly', 'kind', 'lively', 'merry', 'nice', 'optimistic', 'polite', 
+      'quiet', 'relaxed', 'silly', 'victorious', 'witty', 'young', 'zealous', 'strong', 'brave', 'agile', 'bold'];
+
+      const nouns = ['street', 'roof', 'floor', 'tv', 'idea', 'morning', 'game', 'wheel', 'shoe', 'bag', 'clock', 'pencil', 'pen', 
+      'magnet', 'chair', 'table', 'house', 'dog', 'room', 'book', 'car', 'cat', 'tree', 
+      'flower', 'bird', 'fish', 'sun', 'moon', 'star', 'cloud', 'rain', 'snow', 'wind', 'mountain', 
+      'river', 'lake', 'sea', 'ocean', 'island', 'bridge', 'road', 'train', 'plane', 'ship', 'bicycle', 
+      'horse', 'elephant', 'lion', 'tiger', 'bear', 'zebra', 'giraffe', 'monkey', 'snake', 'rabbit', 'duck', 
+      'goose', 'penguin', 'frog', 'crab', 'shrimp', 'whale', 'octopus', 'spider', 'ant', 'bee', 'butterfly', 'dragonfly', 
+      'ladybug', 'snail', 'camel', 'kangaroo', 'koala', 'panda', 'piglet', 'sheep', 'wolf', 'fox', 'deer', 'mouse', 'seal',
+      'chicken', 'cow', 'dinosaur', 'puppy', 'kitten', 'circle', 'square', 'garden', 'otter', 'bunny', 'meerkat', 'harp']
+
+      // return a random combination of first_adj + noun + number (between 0 and 9999)
+      // e.g. clever-idea-123
+      const appName = first_adj[Math.floor(Math.random() * first_adj.length)] + separateWith + nouns[Math.floor(Math.random() * nouns.length)] + separateWith + Math.floor(Math.random() * 10000);
+      console.log(chalk.green(`AppName: "${appName}"`));
+      return appName;
+  } catch (error) {
+      console.error(`Error: ${error.message}`);
+      return null;
+  }
+}
+
+/**
+ * Display data in a structured format
+ * @param {Array} data - The data to display
+ * @param {Object} options - Display options
+ * @param {Array} options.headers - Headers for the table
+ * @param {Array} options.columns - Columns to display
+ * @param {number} options.columnWidth - Width of each column
+ */
+export function displayTable(data, options = {}) {
+  const { headers = [], columns = [], columnWidth = 20 } = options;
+
+  // Create the header row
+  const headerRow = headers.map(header => chalk.cyan(header.padEnd(columnWidth))).join(' | ');
+  console.log(headerRow);
+  console.log(chalk.dim('-'.repeat(headerRow.length)));
+
+  // Create and display each row of data
+  data.forEach(item => {
+      const row = columns.map(col => {
+          const value = item[col] || 'N/A';
+          return value.toString().padEnd(columnWidth);
+      }).join(' | ');
+      console.log(row);
+  });
+}
+
+/**
+ * Display structured ouput of disk usage informations
+ */
+export function showDiskSpaceUsage(data) {
+  const freeSpace = parseInt(data.capacity) - parseInt(data.used);
+  const usagePercentage = (parseInt(data.used) / parseInt(data.capacity)) * 100;
+  console.log(chalk.cyan('Disk Usage Information:'));
+  console.log(chalk.dim('----------------------------------------'));
+  console.log(chalk.cyan(`Total Capacity: `) + chalk.white(formatSize(data.capacity)));
+  console.log(chalk.cyan(`Used Space: `) + chalk.white(formatSize(data.used)));
+  console.log(chalk.cyan(`Free Space: `) + chalk.white(formatSize(freeSpace)));
+  // format the usagePercentage with 2 decimal floating point value:
+  console.log(chalk.cyan(`Usage Percentage: `) + chalk.white(`${usagePercentage.toFixed(2)}%`));
+  console.log(chalk.dim('----------------------------------------'));
+  console.log(chalk.green('Done.'));
+}
+ 
+/**
+ * Resolve a relative path to an absolute path
+ * @param {string} currentPath - The current working directory
+ * @param {string} relativePath - The relative path to resolve
+ * @returns {string} The resolved absolute path
+ */
+export function resolvePath(currentPath, relativePath) {
+    // Normalize the current path (remove trailing slashes)
+    currentPath = currentPath.replace(/\/+$/, '');
+
+    // Split the relative path into parts
+    const parts = relativePath.split('/').filter(p => p); // Remove empty parts
+
+    // Handle each part of the relative path
+    for (const part of parts) {
+        if (part === '..') {
+            // Move one level up
+            const currentParts = currentPath.split('/').filter(p => p);
+            if (currentParts.length > 0) {
+                currentParts.pop(); // Remove the last part
+            }
+            currentPath = '/' + currentParts.join('/');
+        } else if (part === '.') {
+            // Stay in the current directory (no change)
+            continue;
+        } else {
+            // Move into a subdirectory
+            currentPath += `/${part}`;
+        }
+    }
+
+    // Normalize the final path (remove duplicate slashes)
+    currentPath = currentPath.replace(/\/+/g, '/');
+
+    // Ensure the path ends with a slash if it's the root
+    if (currentPath === '') {
+        currentPath = '/';
+    }
+
+    return currentPath;
+}
+
+/**
+* Checks if a given string is a valid app name.
+* The name must:
+*  - Not be '.' or '..'
+*  - Not contain path separators ('/' or '\\')
+*  - Not contain wildcard characters ('*')
+*  - (Optional) Contain only allowed characters (letters, numbers, spaces, underscores, hyphens)
+*
+* @param {string} name - The app name to validate.
+* @returns {boolean} - Returns true if valid, false otherwise.
+*/
+export function isValidAppName(name) {
+   // Ensure the name is a non-empty string
+   if (typeof name !== 'string' || name.trim().length === 0) {
+       return false;
+   }
+
+   // Trim whitespace from both ends
+   const trimmedName = name.trim();
+
+   // Reject reserved names
+   if (trimmedName === '.' || trimmedName === '..') {
+       return false;
+   }
+
+   // Regex patterns for invalid characters
+   const invalidPattern = /[\/\\*]/; // Disallow /, \, and *
+
+   if (invalidPattern.test(trimmedName)) {
+       return false;
+   }
+
+   // Optional: Define allowed characters pattern
+   // Uncomment the following lines if you want to enforce allowed characters
+   /*
+   const allowedPattern = /^[A-Za-z0-9 _-]+$/;
+   if (!allowedPattern.test(trimmedName)) {
+       return false;
+   }
+   */
+
+   // All checks passed
+   return true;
+}
+
+export function getDefaultHomePage(appName) {
+    const defaultIndexContent = `<!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>${appName}</title>
+        <style>
+            body {
+                font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+                line-height: 1.6;
+                max-width: 800px;
+                margin: 0 auto;
+                padding: 20px;
+                background: #f9fafb;
+                color: #1f2937;
+            }
+            .container {
+                background: white;
+                padding: 2rem;
+                border-radius: 8px;
+                box-shadow: 0 1px 3px rgba(0,0,0,0.1);
+            }
+            h1 {
+                color: #2563eb;
+                margin-bottom: 1rem;
+            }
+            .code-block {
+                background: #f1f5f9;
+                padding: 1rem;
+                border-radius: 4px;
+                font-family: monospace;
+                overflow-x: auto;
+            }
+            .tip {
+                background: #dbeafe;
+                border-left: 4px solid #2563eb;
+                padding: 1rem;
+                margin: 1rem 0;
+            }
+            .links {
+                display: flex;
+                gap: 1rem;
+                margin-top: 2rem;
+            }
+            .links a {
+                color: #2563eb;
+                text-decoration: none;
+            }
+            .links a:hover {
+                text-decoration: underline;
+            }
+            .footer {
+                text-align: center;
+                margin-top: 50px;
+                color: var(--color-grey);
+                font-size: 0.9rem;
+            }
+        </style>
+    </head>
+    <body>
+        <div class="container">
+            <h1>🚀 Welcome to ${appName}!</h1>
+            
+            <p>This is your new website powered by Puter. You can start customizing it right away!</p>
+    
+            <div class="tip">
+                <strong>Quick Tip:</strong> Replace this content with your own by editing the <code>index.html</code> file.
+            </div>
+    
+            <h2>🌟 Getting Started</h2>
+            
+            <p>Here's a simple example using Puter.js:</p>
+            
+            <div class="code-block">
+    &lt;script src="https://js.puter.com/v2/">&lt;/script>
+    &lt;script>
+        // Create a new file in the cloud
+        puter.fs.write('hello.txt', 'Hello, Puter!')
+            .then(file => console.log(\`File created at: \${file.path}\`));
+    &lt;/script>
+            </div>
+    
+            <h2>💡 Key Features</h2>
+            <ul>
+                <li>Cloud Storage</li>
+                <li>AI Services (GPT-4, DALL-E)</li>
+                <li>Static Website Hosting</li>
+                <li>Key-Value Store</li>
+                <li>Authentication</li>
+            </ul>
+    
+            <div class="links">
+                <a href="https://docs.puter.com" target="_blank">📚 Documentation</a>
+                <a href="https://discord.gg/puter" target="_blank">💬 Discord Community</a>
+                <a href="https://github.com/HeyPuter" target="_blank">👩‍💻 GitHub</a>
+            </div>
+        </div>
+
+        <footer class="footer">
+            &copy; 2025 ${appName}. All rights reserved.
+        </footer>
+    </body>
+    </html>`;
+    
+    return defaultIndexContent;
+}

package/commands/executor.js

@@ -0,0 +1,306 @@
+import chalk from 'chalk';
+import ora from 'ora';
+import Conf from 'conf';
+import { listApps, appInfo, createApp, updateApp, deleteApp } from './apps.js';
+import { listSites, createSite, deleteSite, infoSite } from './sites.js';
+import { listFiles, makeDirectory, renameFileOrDirectory, 
+  removeFileOrDirectory, emptyTrash, changeDirectory, showCwd, 
+  getInfo, getDiskUsage, createFile, readFile, uploadFile, 
+  downloadFile, copyFile, syncDirectory } from './files.js';
+import { getUserInfo, getUsageInfo } from './auth.js';
+import { PROJECT_NAME, API_BASE, getHeaders } from './commons.js';
+import inquirer from 'inquirer';
+import { exec } from 'node:child_process';
+
+const config = new Conf({ projectName: PROJECT_NAME });
+
+/**
+ * Update the prompt function
+ * @returns The current prompt
+ */
+export function getPrompt() {
+  return chalk.cyan(`puter@${config.get('cwd').slice(1)}> `);
+}
+
+const commands = {
+  help: showHelp,
+  exit: () => process.exit(0),
+  logout: async () => {
+    await import('./auth.js').then(m => m.logout());
+    process.exit(0);
+  },
+  whoami: getUserInfo,
+  stat: getInfo,
+  apps: async (args) => {
+      await listApps({
+        statsPeriod: args[0] || 'all'
+    });
+  },
+  app: appInfo,
+  'app:create': async (args) => {
+    if (args.length < 1) {
+        console.log(chalk.red('Usage: app:create <name> [<remote_dir>] [--description=<description>] [--url=<url>]'));
+        return;
+    }
+    await createApp(args);
+  },
+  'app:update': async (args) => {
+    if (args.length < 1) {
+        console.log(chalk.red('Usage: app:update <name> <remote_dir>'));
+        return;
+    }
+    await updateApp(args);
+  },
+  'app:delete': async (args) => {
+    if (args.length < 1) {
+        console.log(chalk.red('Usage: app:delete <name>'));
+        return;
+    }
+    const name = args.find(arg => arg !=='-f')
+    const force = args.some(arg => arg =='-f')? true: false;
+
+    if (!force){
+      const { confirm } = await inquirer.prompt([
+        {
+            type: 'confirm',
+            name: 'confirm',
+            message: chalk.yellow(`Are you sure you want to delete "${name}"?`),
+            default: false
+        }
+      ]);
+      if (!confirm) {
+          console.log(chalk.yellow('Operation cancelled.'));
+          return false;
+      }
+    }
+    await deleteApp(name);
+  },
+  ls: listFiles,
+  cd: async (args) => {
+    await changeDirectory(args);
+  },
+  pwd: showCwd,
+  mkdir: makeDirectory,
+  mv: renameFileOrDirectory,
+  rm: removeFileOrDirectory,
+  // rmdir: deleteFolder, // Not implemented in Puter API
+  clean: emptyTrash,
+  df: getDiskUsage,
+  usage: getUsageInfo,
+  cp: copyFile,
+  touch: createFile,
+  cat: readFile,
+  push: uploadFile,
+  pull: downloadFile,
+  update: syncDirectory,
+  sites: listSites,
+  site: infoSite,
+  'site:delete': deleteSite,
+  'site:create': createSite
+};
+
+/**
+ * Execute a command
+ * @param {string} input The command line input
+ */
+export async function execCommand(input) {
+  const [cmd, ...args] = input.split(' ');
+
+  if (cmd === 'help') {
+    // Handle help command
+    const command = args[0];
+    showHelp(command);
+  } else if (cmd.startsWith('!')) {
+    // Execute the command on the host machine
+    const hostCommand = input.slice(1); // Remove the "!"
+    exec(hostCommand, (error, stdout, stderr) => {
+      if (error) {
+        console.error(chalk.red(`Host Error: ${error.message}`));
+        return;
+      }
+      if (stderr) {
+        console.error(chalk.red(stderr));
+        return;
+      }
+      console.log(stdout);
+      console.log(chalk.green(`Press <Enter> to return.`));
+    });
+  } else if (commands[cmd]) {
+    try {
+      await commands[cmd](args);
+    } catch (error) {
+      console.error(chalk.red(`Error executing command: ${error.message}`));
+    }
+  } else {
+    if (!['Y', 'N'].includes(cmd.toUpperCase()[0])) {
+      console.log(chalk.red(`Unknown command: ${cmd}`));
+      showHelp();
+    }
+  }
+}
+
+/**
+ * Display help for a specific command or general help if no command is provided.
+ * @param {string} [command] - The command to display help for.
+ */
+function showHelp(command) {
+  const commandHelp = {
+    help: `
+      ${chalk.cyan('help [command]')}
+      Display help for a specific command or show general help.
+      Example: help ls
+    `,
+    exit: `
+      ${chalk.cyan('exit')}
+      Exit the shell.
+    `,
+    logout: `
+      ${chalk.cyan('logout')}
+      Logout from Puter account.
+    `,
+    whoami: `
+      ${chalk.cyan('whoami')}
+      Show user information.
+    `,
+    stat: `
+      ${chalk.cyan('stat <path>')}
+      Show file or directory information.
+      Example: stat /path/to/file
+    `,
+    df: `
+      ${chalk.cyan('df')}
+      Show disk usage information.
+    `,
+    usage: `
+      ${chalk.cyan('usage')}
+      Show usage information.
+    `,
+    apps: `
+      ${chalk.cyan('apps [period]')}
+      List all your apps.
+      period: today, yesterday, 7d, 30d, this_month, last_month
+      Example: apps today
+    `,
+    app: `
+      ${chalk.cyan('app <app_name>')}
+      Get application information.
+      Example: app myapp
+    `,
+    'app:create': `
+      ${chalk.cyan('app:create <name> [url]')}
+      Create a new app.
+      Example: app:create myapp https://example.com
+    `,
+    'app:update': `
+      ${chalk.cyan('app:update <name> [dir]')}
+      Update an app.
+      Example: app:update myapp .
+    `,
+    'app:delete': `
+      ${chalk.cyan('app:delete <name>')}
+      Delete an app.
+      Example: app:delete myapp
+    `,
+    ls: `
+      ${chalk.cyan('ls [dir]')}
+      List files and directories.
+      Example: ls /path/to/dir
+    `,
+    cd: `
+      ${chalk.cyan('cd [dir]')}
+      Change the current working directory.
+      Example: cd /path/to/dir
+    `,
+    pwd: `
+      ${chalk.cyan('pwd')}
+      Print the current working directory.
+    `,
+    mkdir: `
+      ${chalk.cyan('mkdir <dir>')}
+      Create a new directory.
+      Example: mkdir /path/to/newdir
+    `,
+    mv: `
+      ${chalk.cyan('mv <src> <dest>')}
+      Move or rename a file or directory.
+      Example: mv /path/to/src /path/to/dest
+    `,
+    rm: `
+      ${chalk.cyan('rm <file>')}
+      Move a file or directory to the system's Trash.
+      Example: rm /path/to/file
+    `,
+    clean: `
+      ${chalk.cyan('clean')}
+      Empty the system's Trash.
+    `,
+    cp: `
+      ${chalk.cyan('cp <src> <dest>')}
+      Copy files or directories.
+      Example: cp /path/to/src /path/to/dest
+    `,
+    touch: `
+      ${chalk.cyan('touch <file>')}
+      Create a new empty file.
+      Example: touch /path/to/file
+    `,
+    cat: `
+      ${chalk.cyan('cat <file>')}
+      Output file content to the console.
+      Example: cat /path/to/file
+    `,
+    push: `
+      ${chalk.cyan('push <file>')}
+      Upload file to Puter cloud.
+      Example: push /path/to/file
+    `,
+    pull: `
+      ${chalk.cyan('pull <file>')}
+      Download file from Puter cloud.
+      Example: pull /path/to/file
+    `,
+    update: `
+      ${chalk.cyan('update <src> <dest>')}
+      Sync local directory with remote cloud.
+      Example: update /local/path /remote/path
+    `,
+    sites: `
+      ${chalk.cyan('sites')}
+      List sites and subdomains.
+    `,
+    site: `
+      ${chalk.cyan('site <site_uid>')}
+      Get site information by UID.
+      Example: site sd-123456
+    `,
+    'site:delete': `
+      ${chalk.cyan('site:delete <uid>')}
+      Delete a site by UID.
+      Example: site:delete sd-123456
+    `,
+    'site:create': `
+      ${chalk.cyan('site:create <dir> [--subdomain=<name>]')}
+      Create a static website from directory.
+      Example: site:create /path/to/dir --subdomain=myapp
+    `,
+    '!': `
+      ${chalk.cyan('!<command>')}
+      Execute a command on the host machine.
+      Example: !ls -la
+    `,
+  };
+
+  if (command && commandHelp[command]) {
+    console.log(chalk.yellow(`\nHelp for command: ${chalk.cyan(command)}`));
+    console.log(commandHelp[command]);
+  } else if (command) {
+    console.log(chalk.red(`Unknown command: ${command}`));
+    console.log(chalk.yellow('Use "help" to see a list of available commands.'));
+  } else {
+    console.log(chalk.yellow('\nAvailable commands:'));
+    for (const cmd in commandHelp) {
+      console.log(chalk.cyan(cmd.padEnd(20)) + '- ' + commandHelp[cmd].split('\n')[2].trim());
+    }
+    console.log(chalk.yellow('\nUse "help <command>" for detailed help on a specific command.'));
+  }
+}