puter-cli 1.1.5 → 1.2.1

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/CHANGELOG.md

@@ -0,0 +1,70 @@
+### Changelog
+
+All notable changes to this project will be documented in this file. Dates are displayed in UTC.
+
+Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
+
+#### [v1.2.1](https://github.com/bitsnaps/puter-cli/compare/v1.2.0...v1.2.1)
+
+- feat: update changelog [`028ca0c`](https://github.com/bitsnaps/puter-cli/commit/028ca0cf72e09bb63468d2b0a0ba7602d3b870ad)
+- feat: auto-update changelog [`3004bed`](https://github.com/bitsnaps/puter-cli/commit/3004beda6afcf68cc916d544a45be85fa7e658e3)
+
+#### [v1.2.0](https://github.com/bitsnaps/puter-cli/compare/v1.1.5...v1.2.0)
+
+> 18 January 2025
+
+- ci: attempt to fix npm install [`32fc508`](https://github.com/bitsnaps/puter-cli/commit/32fc508c4807119de485926674274b70e034288f)
+- feat: basic history command [`18da28c`](https://github.com/bitsnaps/puter-cli/commit/18da28c83aa0760128d7b18e66e6b4d2b08b48d3)
+- chore: improve structure [`70b67ad`](https://github.com/bitsnaps/puter-cli/commit/70b67adad5bd5e0bad4a9276160d17538d9b4bb6)
+
+#### [v1.1.5](https://github.com/bitsnaps/puter-cli/compare/v1.1.4...v1.1.5)
+
+> 16 January 2025
+
+- fix: description arg handling & improve args parsing [`45c5a8c`](https://github.com/bitsnaps/puter-cli/commit/45c5a8c19034379e3cd7f30e724b8675d98bf28f)
+
+#### [v1.1.4](https://github.com/bitsnaps/puter-cli/compare/v1.1.3...v1.1.4)
+
+> 16 January 2025
+
+- improve compatibility crypto api [`b015e6f`](https://github.com/bitsnaps/puter-cli/commit/b015e6f1318a2c4994675dd7390fab09d45bf3e9)
+- fix: temporary disabled description [`c7456be`](https://github.com/bitsnaps/puter-cli/commit/c7456bed1c496f1a52156801aa4c0ea0191279c7)
+
+#### [v1.1.3](https://github.com/bitsnaps/puter-cli/compare/v1.1.2...v1.1.3)
+
+> 14 January 2025
+
+- fix: unavailable subdomain when update app [`2497de4`](https://github.com/bitsnaps/puter-cli/commit/2497de41b5691df4d3a141952841c08cace4703c)
+
+#### [v1.1.2](https://github.com/bitsnaps/puter-cli/compare/v1.1.1...v1.1.2)
+
+> 14 January 2025
+
+- grab latest version from npm [`9c32190`](https://github.com/bitsnaps/puter-cli/commit/9c321906415dfb5baa3d2bbba7b352f2766f8b84)
+
+#### [v1.1.1](https://github.com/bitsnaps/puter-cli/compare/v1.1.0...v1.1.1)
+
+> 14 January 2025
+
+- Create npm-publish action [`48d9a70`](https://github.com/bitsnaps/puter-cli/commit/48d9a709417664900681e2219ea2af5e9bf33c01)
+- update README: badges [`49241d7`](https://github.com/bitsnaps/puter-cli/commit/49241d7144c8c128955891a64acb448e79e1822c)
+
+#### [v1.1.0](https://github.com/bitsnaps/puter-cli/compare/v1.0.3...v1.1.0)
+
+> 14 January 2025
+
+- feat: add support for 2FA logins [`#1`](https://github.com/bitsnaps/puter-cli/pull/1)
+
+#### [v1.0.3](https://github.com/bitsnaps/puter-cli/compare/v1.0.1...v1.0.3)
+
+> 13 January 2025
+
+- update README [`479b8fc`](https://github.com/bitsnaps/puter-cli/commit/479b8fc9c784061146f453bc68759dbdb417ea1e)
+
+#### v1.0.1
+
+> 13 January 2025
+
+- initial commit [`604d4a4`](https://github.com/bitsnaps/puter-cli/commit/604d4a47c8b593b7e24757c115df728f09233664)
+- output nicely formatted table [`a0adb75`](https://github.com/bitsnaps/puter-cli/commit/a0adb75813bcecb21878c8ae7228b0ecbfdb397f)
+- remove unused packages [`925b6cb`](https://github.com/bitsnaps/puter-cli/commit/925b6cbf827e619e65eb5afaa566a4d14e919cb8)

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> [<directory>] [--description="My App Description"] [--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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "puter-cli",
-  "version": "1.1.5",
+  "version": "1.2.1",
   "description": "Command line interface for Puter cloud platform",
   "main": "index.js",
   "bin": {
@@ -11,7 +11,8 @@
   "scripts": {
     "start": "node bin/index.js",
     "test": "vitest run tests/*",
-    "test:watch": "vitest --watch tests/*"
+    "test:watch": "vitest --watch tests/*",
+    "version": "auto-changelog -p && git add CHANGELOG.md"
   },
   "engines": {
     "node": ">=18.0.0"
@@ -38,6 +39,7 @@
     "yargs-parser": "^21.1.1"
   },
   "devDependencies": {
+    "auto-changelog": "^2.5.0",
     "vitest": "^2.1.8"
   },
   "repository": {

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

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 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,6 +41,26 @@ const commands = {
     });
   },
   app: appInfo,
+  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(' '));
@@ -119,7 +143,7 @@ const commands = {
   sites: listSites,
   site: infoSite,
   'site:delete': deleteSite,
-  'site:create': createSite
+  'site:create': createSite,
 };
 
 /**
@@ -129,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];
@@ -312,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/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(() => {});