puter-cli 1.1.4 → 1.2.0

package/.github/workflows/npm-build.yml

@@ -0,0 +1,21 @@
+# This workflow will run tests using node on every push
+
+name: Build package
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: ['18.x', '20.x', '23.x']
+    
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test

package/.github/workflows/{npm-publish-github-packages.yml → npm-publish.yml}

@@ -1,11 +1,9 @@
 # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
 # For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
 
-name: Node.js Package
+name: Publish package
 
-on:
-  release:
-    types: [created]
+on: push
 
 jobs:
   build:
@@ -18,19 +16,16 @@ jobs:
       - run: npm ci
       - run: npm test
 
-  publish-gpr:
+  publish-npm:
     needs: build
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-          registry-url: https://npm.pkg.github.com/
+          registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -1,7 +1,7 @@
 # Puter-CLI
 
 <p align="center">
-    <img alt="test" src="https://github.com/bitsnaps/puter-cli/actions/workflows/npm-publish-github-packages.yml/badge.svg">
+    <img alt="test" src="https://github.com/bitsnaps/puter-cli/actions/workflows/npm-build.yml/badge.svg">
     <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/bitsnaps/puter-cli">
 </p>
 
@@ -123,17 +123,17 @@ P.S. These commands consider the current directory as the base path for every op
 #### User Information
 - **Get User Info**: Display user information.
 ```bash
-  puter whoami
+  puter> whoami
 ```
 
 #### Disk Usage
 - **Check Disk Usage**: Display disk usage information.
 ```bash
-  puter df
+  puter> df
 ```
 - **Get Usage Info**: Fetch usage information for services.
 ```bash
-  puter usage
+  puter> usage
 ```
 
 #### Application Management
@@ -142,25 +142,25 @@ The **Application** are sepcial type of hosted web app, they're served from the
 
 - **List Applications**: List all applications.
 ```bash
-  puter apps [period]
+  puter> apps [period]
 ```
 P.S. Please check the help command `help apps` for more details about any argument.
 
 - **Create Application**: Create a new application.
 ```bash
-  puter app:create <name> [<remote_dir>] [--url=<url>]
+  puter> app:create <name> [<directory>] [--description="My App Description"] [--url=<url>]
 ```
 P.S. By default a new `index.html` with basic content will be created, but you can set a directory when you create a new application as follows: `app:create nameOfApp ./appDir`, so all files will be copied to the `AppData` directoy, you can then update your app using `app:update <name> <remote_dir>`. This command will attempt to create a subdomain with a random `uid` prefixed with the name of the app.
 
 - **Update Application**: Update an application.
 ```bash
-  puter app:update <name> <remote_dir>
+  puter> app:update <name> <remote_dir>
 ```
 **IMPORTANT** All existing files will be overwritten, new files are copied, other files are just ignored.
 
 - **Delete Application**: Delete an application.
 ```bash
-  puter app:delete [-f] <name>
+  puter> app:delete [-f] <name>
 ```
 P.S. This command will lookup for the allocated `subdomain` and attempt to delete it if it exists.
 
@@ -170,20 +170,31 @@ The static sites are served from the selected directory (or the current director
 
 - **Deploy Site**: Deploy a static website from a directory.
 ```bash
-  puter site:create <app_name> [<dir>] [--subdomain=<name>]
+  puter> site:create <app_name> [<dir>] [--subdomain=<name>]
 ```
 P.S. If the subdomain already exists, it will generate a new random one can set your own subdomain using `--subdomain` argument.
 
 - **List Sites**: List all hosted sites.
 ```bash
-  puter sites
+  puter> sites
 ```
 - **Delete Site**: Delete a hosted site.
 ```bash
-  puter site:delete <uid>
+  puter> site:delete <uid>
 ```
 P.S. You can find the `<uid>` in the list of `sites`.
 
+#### Commands history
+
+- **Display history**: Display the history executed commands
+```bash
+  puter> history
+```
+- **Copy command from history**: Copy a previous command from history by line number
+```bash
+  puter> history <line_number>
+```
+
 #### Interactive Shell
 - **Start Shell**: Launch an interactive shell.
 ```bash
@@ -198,10 +209,14 @@ or just type (you'll need to login):
 - **General Help**: Display a list of available commands.
 ```bash
   puter help
+  # or inside the interactive shell:
+  puter> help
 ```
 - **Command Help**: Display detailed help for a specific command.
 ```bash
   puter help <command>
+  # or inside the interactive shell:
+  puter> help <command>
 ```
 
 ---

package/bin/index.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 import { Command } from 'commander';
-import { login, logout } from '../commands/auth.js';
-import { init } from '../commands/init.js';
-import { startShell } from '../commands/shell.js';
-import { PROJECT_NAME, getLatestVersion } from '../commands/commons.js';
+import { login, logout } from '../src/commands/auth.js';
+import { init } from '../src/commands/init.js';
+import { startShell } from '../src/commands/shell.js';
+import { PROJECT_NAME, getLatestVersion } from '../src/commons.js';
 
 async function main() {
   const { version } = await getLatestVersion(PROJECT_NAME);
@@ -34,10 +34,32 @@ async function main() {
     .description('Start interactive shell')
     .action(startShell);
 
+
+  // App commands
+  program
+    .command('app:create <name>')
+    .description('Create a new Puter application')
+    .argument('<name>', 'Name of the application')
+    .argument('[directory]', 'Local directory path')
+    .option('-d, --description <description>', 'Application description')
+    .option('-u, --url <url>', 'Application URL', 'https://dev-center.puter.com/coming-soon.html')
+    .action(async (name, directory, options) => {
+      try {
+        await createApp({
+          name,
+          directory: directory || '',
+          description: options.description || '',
+          url: options.url
+        });
+      } catch (error) {
+        console.error(chalk.red(error.message));
+      }
+    });
+
   if (process.argv.length === 2) {
     startShell();
   } else {
-    program.parse();
+    program.parse(process.argv);
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "puter-cli",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "Command line interface for Puter cloud platform",
   "main": "index.js",
   "bin": {
@@ -26,7 +26,7 @@
   "dependencies": {
     "chalk": "^5.3.0",
     "cli-table3": "^0.6.5",
-    "commander": "^11.1.0",
+    "commander": "^13.0.0",
     "conf": "^12.0.0",
     "cross-spawn": "^7.0.3",
     "glob": "^11.0.0",
@@ -34,7 +34,8 @@
     "minimatch": "^10.0.1",
     "node-fetch": "^3.3.2",
     "ora": "^8.0.1",
-    "uuid": "^11.0.5"
+    "uuid": "^11.0.5",
+    "yargs-parser": "^21.1.1"
   },
   "devDependencies": {
     "vitest": "^2.1.8"

package/{commands → src/commands}/apps.js

@@ -2,13 +2,13 @@ import path from 'path';
 import chalk from 'chalk';
 import fetch from 'node-fetch';
 import Table from 'cli-table3';
-import { displayNonNullValues, formatDate } from './utils.js';
-import { API_BASE, getHeaders, getDefaultHomePage, isValidAppName, resolvePath } from './commons.js';
+import { displayNonNullValues, formatDate } from '../utils.js';
+import { API_BASE, getHeaders, getDefaultHomePage, isValidAppName, resolvePath } from '../commons.js';
 import { createSubdomain, getSubdomains } from './subdomains.js';
 import { deleteSite } from './sites.js';
 import { copyFile, createFile, listRemoteFiles, pathExists, removeFileOrDirectory } from './files.js';
 import { getCurrentDirectory } from './auth.js';
-import crypto from './crypto.js';
+import crypto from '../crypto.js';
 
 /**
  * List all apps
@@ -126,25 +126,28 @@ export async function appInfo(args = []) {
 /**
  * Create a new web application
  * @param {string} name The name of the App
+ * @param {string} directory Optional directory path
  * @param {string} description A description of the App
  * @param {string} url A default coming-soon URL
- * @returns Output JSON data
+ * @returns {Promise<Object>} Output JSON data
  */
-export async function createApp(args = []) {
-    if (args.length < 1 || !isValidAppName(args[0])) {
-        console.log(chalk.red('Usage: app:create <valid_name_app> [<remote_dir>] [--url=<url>]'));
-        console.log(chalk.yellow('Example: app:create myapp'));
-        console.log(chalk.yellow('Example: app:create myapp ./myapp'));
-        return;
+export async function createApp(args) {
+    const name = args.name; // App name (required)
+    console.log(args);
+    if (!isValidAppName(name)) {
+        throw new Error('Invalid application name');
     }
-    const name = args[0]; // App name (required)
     // Use the default home page if the root directory if none specified
-    const localDir = (args[1] && !args[1].startsWith('--'))? resolvePath(getCurrentDirectory(), args[1]):'';
-    // Optional description (disabled at the moment)
-    const description = ''; // (args.find(arg => arg.toLocaleLowerCase().startsWith('--description='))?.split('=')[1]) || '';
-    const url = (args.find(arg => arg.toLocaleLowerCase().startsWith('--url='))?.split('=')[1]) || 'https://dev-center.puter.com/coming-soon.html'; // Optional url
+    const localDir = args.directory ? resolvePath(getCurrentDirectory(), args.directory) : '';
+    // Optional description
+    const description = args.description || '';
+    const url = args.url || '';
+
+    console.log(chalk.green(`Creating app "${name}"...`));
+    console.log(chalk.dim(`Directory: ${localDir || '[default]'}`));
+    console.log(chalk.dim(`Description: ${description}`));
+    console.log(chalk.dim(`URL: ${url}`));
 
-    console.log(chalk.dim(`Creating app: ${chalk.green(name)}...\n`));
     try {
         // Step 1: Create the app
         const createAppResponse = await fetch(`${API_BASE}/drivers/call`, {

package/{commands → src/commands}/auth.js

@@ -3,7 +3,7 @@ import chalk from 'chalk';
 import Conf from 'conf';
 import ora from 'ora';
 import fetch from 'node-fetch';
-import { PROJECT_NAME, API_BASE, getHeaders, BASE_URL } from './commons.js'
+import { PROJECT_NAME, API_BASE, getHeaders, BASE_URL } from '../commons.js'
 const config = new Conf({ projectName: PROJECT_NAME });
 
 /**

package/{commands → src/commands}/files.js

@@ -6,12 +6,12 @@ import chalk from 'chalk';
 import ora from 'ora';
 import Conf from 'conf';
 import fetch from 'node-fetch';
-import { API_BASE, BASE_URL, PROJECT_NAME, getHeaders, showDiskSpaceUsage, resolvePath } from './commons.js';
-import { formatDate, formatDateTime, formatSize } from './utils.js';
+import { API_BASE, BASE_URL, PROJECT_NAME, getHeaders, showDiskSpaceUsage, resolvePath } from '../commons.js';
+import { formatDate, formatDateTime, formatSize } from '../utils.js';
 import inquirer from 'inquirer';
 import { getAuthToken, getCurrentDirectory, getCurrentUserName } from './auth.js';
 import { updatePrompt } from './shell.js';
-import crypto from './crypto.js';
+import crypto from '../crypto.js';
 
 const config = new Conf({ projectName: PROJECT_NAME });
 

package/{commands → src/commands}/init.js

@@ -3,7 +3,7 @@ import chalk from 'chalk';
 import ora from 'ora';
 import { promises as fs } from 'fs';
 import path from 'path';
-import { generateAppName } from './commons.js';
+import { generateAppName } from '../commons.js';
 
 export async function init() {
   const answers = await inquirer.prompt([

package/{commands → src/commands}/shell.js

@@ -1,13 +1,13 @@
 import readline from 'node:readline';
 import chalk from 'chalk';
 import Conf from 'conf';
-import { execCommand, getPrompt } from './executor.js';
+import { execCommand, getPrompt } from '../executor.js';
 import { getAuthToken } from './auth.js';
-import { PROJECT_NAME } from './commons.js';
+import { PROJECT_NAME } from '../commons.js';
 
 const config = new Conf({ projectName: PROJECT_NAME });
 
-const rl = readline.createInterface({
+export const rl = readline.createInterface({
   input: process.stdin,
   output: process.stdout,
   prompt: null

package/{commands → src/commands}/sites.js

@@ -2,8 +2,8 @@ import chalk from 'chalk';
 import fetch from 'node-fetch';
 import Table from 'cli-table3';
 import { getCurrentUserName, getCurrentDirectory } from './auth.js';
-import { API_BASE, getHeaders, generateAppName, resolvePath, isValidAppName } from './commons.js';
-import { displayNonNullValues, formatDate, formatDateTime } from './utils.js';
+import { API_BASE, getHeaders, generateAppName, resolvePath, isValidAppName } from '../commons.js';
+import { displayNonNullValues, formatDate, formatDateTime } from '../utils.js';
 import { getSubdomains, createSubdomain, deleteSubdomain } from './subdomains.js';
 
 

package/{commands → src/commands}/subdomains.js

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 import fetch from 'node-fetch';
-import { API_BASE, getHeaders } from './commons.js';
+import { API_BASE, getHeaders } from '../commons.js';
 
 /**
  * Get list of subdomains.

package/{commands → src}/commons.js

@@ -1,5 +1,5 @@
 import  chalk from 'chalk';
-import { getAuthToken } from './auth.js';
+import { getAuthToken } from './commands/auth.js';
 
 export const PROJECT_NAME = 'puter-cli';
 export const API_BASE = 'https://api.puter.com';

package/{commands → src}/executor.js

@@ -1,19 +1,23 @@
 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 { listApps, appInfo, createApp, updateApp, deleteApp } from './commands/apps.js';
+import { listSites, createSite, deleteSite, infoSite } from './commands/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';
+  downloadFile, copyFile, syncDirectory } from './commands/files.js';
+import { getUserInfo, getUsageInfo } from './commands/auth.js';
 import { PROJECT_NAME, API_BASE, getHeaders } from './commons.js';
 import inquirer from 'inquirer';
 import { exec } from 'node:child_process';
+import { parseArgs } from './utils.js';
+import { rl } from './commands/shell.js';
 
 const config = new Conf({ projectName: PROJECT_NAME });
 
+// History of commands
+const commandHistory = [];
+
 /**
  * Update the prompt function
  * @returns The current prompt
@@ -26,7 +30,7 @@ const commands = {
   help: showHelp,
   exit: () => process.exit(0),
   logout: async () => {
-    await import('./auth.js').then(m => m.logout());
+    await import('./commands/auth.js').then(m => m.logout());
     process.exit(0);
   },
   whoami: getUserInfo,
@@ -37,12 +41,48 @@ const commands = {
     });
   },
   app: appInfo,
-  'app:create': async (args) => {
-    if (args.length < 1) {
-        console.log(chalk.red('Usage: app:create <name> [<remote_dir>] [--description=<description>] [--url=<url>]'));
+  history: async (args) => {
+    const lineNumber = parseInt(args[0]);
+
+    if (isNaN(lineNumber)) {
+      // Display full history
+      commandHistory.forEach((command, index) => {
+        console.log(chalk.cyan(`${index + 1}: ${command}`));
+      });
+    } else {
+      // Copy the command at the specified line number
+      if (lineNumber < 1 || lineNumber > commandHistory.length) {
+        console.error(chalk.red(`Invalid line number. History has ${commandHistory.length} entries.`));
+        return;
+      }
+
+      const commandToCopy = commandHistory[lineNumber - 1];
+      // Simulate typing the command in the shell
+      rl.write(commandToCopy);
+    }
+  },
+  'app:create': async (rawArgs) => {
+    try {
+      const args = parseArgs(rawArgs.join(' '));
+      // Consider using explicit argument definition if necessary
+      // const args = parseArgs(rawArgs.join(' '), {string: ['description', 'url'],
+      //   alias: { d: 'description', u: 'url', },
+      // });
+
+      if (!args.length < 1) {
+        console.log(chalk.red('Usage: app:create <name> [directory] [--description="My App Description"] [--url=app-url]'));
         return;
+      }
+
+      await createApp({
+        name: args._[0],
+        directory: args._[1] || '',
+        description: args.description || '',
+        url: args.url || 'https://dev-center.puter.com/coming-soon.html'
+      });
+    } catch (error) {
+      console.error(chalk.red(error.message));
     }
-    await createApp(args);
   },
   'app:update': async (args) => {
     if (args.length < 1) {
@@ -51,13 +91,20 @@ const commands = {
     }
     await updateApp(args);
   },
-  'app:delete': async (args) => {
+  'app:delete': async (rawArgs) => {
+    const args = parseArgs(rawArgs.join(' '), {
+      string: ['_'],
+      boolean: ['f'],
+      configuration: {
+        'populate--': true
+      }
+    });
     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;
+    const name = args._[0];
+    const force = !!args.f;
 
     if (!force){
       const { confirm } = await inquirer.prompt([
@@ -96,7 +143,7 @@ const commands = {
   sites: listSites,
   site: infoSite,
   'site:delete': deleteSite,
-  'site:create': createSite
+  'site:create': createSite,
 };
 
 /**
@@ -106,6 +153,12 @@ const commands = {
 export async function execCommand(input) {
   const [cmd, ...args] = input.split(' ');
 
+  
+  // Add the command to history (skip the "history" command itself)
+  if (cmd !== 'history') {
+    commandHistory.push(input);
+  }
+
   if (cmd === 'help') {
     // Handle help command
     const command = args[0];
@@ -144,6 +197,7 @@ export async function execCommand(input) {
  * @param {string} [command] - The command to display help for.
  */
 function showHelp(command) {
+  // Consider using `program.helpInformation()` function for global "help" command...
   const commandHelp = {
     help: `
       ${chalk.cyan('help [command]')}
@@ -187,9 +241,9 @@ function showHelp(command) {
       Example: app myapp
     `,
     'app:create': `
-      ${chalk.cyan('app:create <name> [<remote_dir>] [--url=<url>]')}
+      ${chalk.cyan('app:create <name> [<remote_dir>] [--description="<description>"] [--url=<url>]')}
       Create a new app.
-      Example: app:create myapp https://example.com
+      Example: app:create myapp https://myapp.puter.site
     `,
     'app:update': `
       ${chalk.cyan('app:update <name> [dir]')}
@@ -288,6 +342,11 @@ function showHelp(command) {
       Execute a command on the host machine.
       Example: !ls -la
     `,
+    'history [line]': `
+      ${chalk.cyan('history [line]')}
+      Display history of commands or copy command by line number
+      Example: history 2
+    `,
   };
 
   if (command && commandHelp[command]) {

package/{commands → src}/utils.js

@@ -1,4 +1,5 @@
 import chalk from 'chalk';
+import yargsParser from 'yargs-parser';
 
 /**
  * Convert "2024-10-07T15:03:53.000Z" to "10/7/2024, 15:03:53"
@@ -89,4 +90,14 @@ export function displayNonNullValues(data) {
     });
     console.log(chalk.cyan('-'.repeat(maxKeyLength*3)));
     console.log(chalk.cyan(`You have ${chalk.green(tableData.length)} key/value pair(s).`));
-  }
+  }
+
+  /**
+ * Parse command line arguments including quoted strings
+ * @param {string} input Raw command line input
+ * @returns {Object} Parsed arguments
+ */
+export function parseArgs(input, options = {}) {
+  const result = yargsParser(input, options);
+  return result;
+}

package/tests/login.test.js

@@ -1,12 +1,12 @@
 import { describe, it, expect, vi, beforeEach } from 'vitest';
 import { login, logout, getUserInfo, isAuthenticated, getAuthToken, getCurrentUserName, 
-  getCurrentDirectory, getUsageInfo } from './commands/auth.js';
+  getCurrentDirectory, getUsageInfo } from '../src/commands/auth.js';
 import inquirer from 'inquirer';
 import ora from 'ora';
 import chalk from 'chalk';
 import fetch from 'node-fetch';
 import Conf from 'conf';
-import { BASE_URL } from '../commands/commons.js';
+import { BASE_URL } from '../src/commons.js';
 
 // Mock console to prevent actual logging
 vi.spyOn(console, 'log').mockImplementation(() => {});