puter-cli 1.8.5 → 2.0.0

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

@@ -1,7 +1,7 @@
-# This workflow will run tests using node on every push
+# This workflow will run tests using node on every push and pull request
 name: Build package
 
-on: push
+on: [push, pull_request]
 
 jobs:
   build:
@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: ['18.x', '20.x', '23.x']
+        node-version: ['20.x', '22.x', '24.x']
     steps:
     - uses: actions/checkout@v4
     - name: Install pnpm
@@ -26,6 +26,7 @@ jobs:
     - name: Run tests & coverage
       run: pnpm run coverage
     - name: Upload coverage reports to Codecov
+      if: github.event_name != 'pull_request'
       uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}

package/CHANGELOG.md

@@ -4,8 +4,46 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v2.0.0](https://github.com/HeyPuter/puter-cli/compare/v1.8.6...v2.0.0)
+
+- Add browser based login [`#75`](https://github.com/HeyPuter/puter-cli/pull/75)
+- Adjust actions for PR test [`#73`](https://github.com/HeyPuter/puter-cli/pull/73)
+- Add test for file commands [`#69`](https://github.com/HeyPuter/puter-cli/pull/69)
+- Add deploy test [`#68`](https://github.com/HeyPuter/puter-cli/pull/68)
+- Add executor test [`#67`](https://github.com/HeyPuter/puter-cli/pull/67)
+- Add ProfileModule test [`#66`](https://github.com/HeyPuter/puter-cli/pull/66)
+- Add commons.test.js [`#64`](https://github.com/HeyPuter/puter-cli/pull/64)
+- Add test shell [`#65`](https://github.com/HeyPuter/puter-cli/pull/65)
+- Add PuterModule test [`#63`](https://github.com/HeyPuter/puter-cli/pull/63)
+- Add test error module [`#62`](https://github.com/HeyPuter/puter-cli/pull/62)
+- Add subdomains test [`#61`](https://github.com/HeyPuter/puter-cli/pull/61)
+- Add sites test [`#60`](https://github.com/HeyPuter/puter-cli/pull/60)
+- Fix first init puter module [`#59`](https://github.com/HeyPuter/puter-cli/pull/59)
+- Fix puter module causing unref error [`#52`](https://github.com/HeyPuter/puter-cli/pull/52)
+- Migrate drivers call to Puter.js NPM [`#33`](https://github.com/HeyPuter/puter-cli/pull/33)
+- Add non interactive puter site deploy [`#30`](https://github.com/HeyPuter/puter-cli/pull/30)
+- Set program name to be hardcoded puter string [`#32`](https://github.com/HeyPuter/puter-cli/pull/32)
+- Enable site:deploy redeploy under same subdomain [`#26`](https://github.com/HeyPuter/puter-cli/pull/26)
+- Fix CLI close unexpectedly when first login [`#29`](https://github.com/HeyPuter/puter-cli/pull/29)
+- Fix logout [`#28`](https://github.com/HeyPuter/puter-cli/pull/28)
+- Site deploy from local dir [`#25`](https://github.com/HeyPuter/puter-cli/pull/25)
+- Fix CI [`0b189de`](https://github.com/HeyPuter/puter-cli/commit/0b189dede790280bdf6e2a4691843970eb7ea83f)
+- Init puter js npm [`b1bd5e7`](https://github.com/HeyPuter/puter-cli/commit/b1bd5e78a232391a2102e85e3ee0c0665ed1a00b)
+- Update pnpm-lock.yaml [`9f7f8fc`](https://github.com/HeyPuter/puter-cli/commit/9f7f8fc7921427a580fe0bb8ca0dd10fe5db8b6b)
+
+#### [v1.8.6](https://github.com/HeyPuter/puter-cli/compare/v1.8.5...v1.8.6)
+
+> 8 October 2025
+
+- Use random name if not specified for `site:deploy` [`#24`](https://github.com/HeyPuter/puter-cli/pull/24)
+- Use random name if not specified [`48ae3f0`](https://github.com/HeyPuter/puter-cli/commit/48ae3f04325f27b654e00050c7ec514bee72535e)
+- docs(readme): update site command [`aa4ba6e`](https://github.com/HeyPuter/puter-cli/commit/aa4ba6e1ee52e1c6e2c0cb5fb74c120fb1b5c0c3)
+- refactor(site): remove name argument from site:deploy [`1ffaacb`](https://github.com/HeyPuter/puter-cli/commit/1ffaacbd3e00dff4f75af66bd1d4b9aee1daf9c6)
+
 #### [v1.8.5](https://github.com/HeyPuter/puter-cli/compare/v1.8.4...v1.8.5)
 
+> 5 October 2025
+
 - feat(site): add site:deploy command for one-step project deployment [`94210ed`](https://github.com/HeyPuter/puter-cli/commit/94210ed796e7564647f4cd177a1b0bef72e66ef2)
 - Fix and add some details to the README file [`8acb6ea`](https://github.com/HeyPuter/puter-cli/commit/8acb6ea753b4f83c146f26473f61756e613a4953)
 - fix(files): touch command to creation a new file [`d30a067`](https://github.com/HeyPuter/puter-cli/commit/d30a0673e9aa5fb5b5d6b037a6a134a196a27529)

package/README.md

@@ -36,7 +36,7 @@ The **Puter CLI** is a command-line interface tool designed to interact with the
 ## Installation
 
 ### Prerequisites
-- Node.js (v18 or higher)
+- Node.js (v20 or higher)
 - npm (v7 or higher)
 
 Run the following command to install puter-cli globally in your system:
@@ -197,12 +197,18 @@ P.S. This command will look for the allocated `subdomain` and attempt to delete
 
 The static sites are served from the selected directory (or the current directory if none is specified).
 
-- **Deploy Site**: Deploy a static website from a directory.
+- **Create Site**: Create 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. You can set your own subdomain using `--subdomain` argument.
 
+- **Deploy Site**: Deploy a static website from the current local directory to a remote directory. If no remote directory is specified, it deploys to the current directory on the remote instance.
+```bash
+ puter> site:deploy [<remote_dir>] [--subdomain=<name>]
+```
+P.S. If the subdomain is not provided, it will be generated from the app name. The `--subdomain` argument allows you to specify a custom subdomain. All files in the remote directory will overwritten.
+
 - **List Sites**: List all hosted sites.
 ```bash
   puter> sites
@@ -252,10 +258,18 @@ or just type (you'll need to login):
 
 ## Examples
 
-1. **Log in and List Files**:
+In order to execute any command you'll need to authenticate first, this is a one time action:
  ```bash
+   # This will open the browser to authenticate you for the first time.
    puter login
+   # or (if you want to authenticate using your username/password)
+   #puter login --with-credentials
+ ```
+1. **Log in and List Files**:
+ ```bash
    puter> ls
+   # or list files in a specific directory:
+   puter> ls /
  ```
 
 2. **Create and Deploy a Static Site**:

package/bin/index.js

@@ -5,30 +5,43 @@ 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';
-import { createApp } from '../src/commands/apps.js';
-import { deploy } from '../src/commands/deploy.js';
+import { appInfo, createApp, listApps, deleteApp, updateApp } from '../src/commands/apps.js';
+import inquirer from 'inquirer';
+import { initProfileModule } from '../src/modules/ProfileModule.js';
+import { initPuterModule } from '../src/modules/PuterModule.js';
+import { createSite, infoSite, listSites, deleteSite } from '../src/commands/sites.js';
 
 async function main() {
+  initProfileModule();
+  initPuterModule();
+
   const version = await getLatestVersion(PROJECT_NAME);
 
   const program = new Command();
   program
-    .name(PROJECT_NAME)
+    .name('puter')
     .description('CLI tool for Puter cloud platform')
     .version(version);
 
   program
     .command('login')
     .description('Login to Puter account')
-    .option('-s, --save', 'Save authentication token in .env file', '')
-    .action(() => {
-      startShell('login');
+    .option('-s, --save', 'Save authentication token in .env file')
+    .option('--web', 'Use browser-based login (default)')
+    .option('--with-credentials', 'Use username/password login')
+    .option('--host <url>', 'Puter host URL', 'https://puter.com')
+    .action(async (options) => {
+      await login(options);
+      process.exit(0);
     });
 
   program
     .command('logout')
     .description('Logout from Puter account')
-    .action(logout);
+    .action(async () => {
+      await logout();
+      process.exit(0);
+    });
 
   program
     .command('init')
@@ -38,24 +51,46 @@ async function main() {
   program
     .command('shell')
     .description('Start interactive shell')
-    .action(startShell);
+    .action(() => startShell());
 
 
   // App commands
   program
-    .command('app:create')
-    .description('Create a new Puter application')
+    .command('apps')
+    .description('List all your apps')
+    .argument('[period]', 'period: today, yesterday, 7d, 30d, this_month, last_month')
+    .action(async (period) => {
+      await listApps({
+        statsPeriod: period || 'all'
+      });
+      process.exit(0);
+    });
+
+  const app = program
+    .command('app')
+    .description('App management commands');
+
+  app
+    .command('info')
+    .description('Get application information')
+    .argument('<app_name>', 'Name of the application')
+    .action(async (app_name) => {
+      await appInfo([app_name]);
+      process.exit(0);
+    });
+
+  app
+    .command('create')
+    .description('Create a new app')
     .argument('<name>', 'Name of the application')
-    .argument('[remoteDir]', 'Remote 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, remoteDir, options) => {
+    .argument('<remote_dir>', 'Remote directory URL')
+    .action(async (name, remote_dir) => {
       try {
         await createApp({
-          name,
-          directory: remoteDir || '',
-          description: options.description || '',
-          url: options.url
+          name: name,
+          directory: remote_dir || '',
+          description: '',
+          url: 'https://dev-center.puter.com/coming-soon.html'
         });
       } catch (error) {
         console.error(chalk.red(error.message));
@@ -63,22 +98,140 @@ async function main() {
       process.exit(0);
     });
 
-  /*/ Deploy command
+  app
+    .command('update')
+    .description('Update an app')
+    .argument('<name>', 'Name of the application')
+    .argument('[dir]', 'Directory path', '.')
+    .action(async (name, dir) => {
+      await updateApp([name, dir]);
+      process.exit(0);
+    });
+
+  app
+    .command('delete')
+    .description('Delete an app')
+    .argument('<name>', 'Name of the application')
+    .option('-f, --force', 'Force deletion without confirmation')
+    .action(async (name, options) => {
+      let shouldDelete = options.force;
+
+      if (!shouldDelete) {
+        const answer = await inquirer.prompt([
+          {
+            type: 'confirm',
+            name: 'confirm',
+            message: `Are you sure you want to delete the app "${name}"?`,
+            default: false
+          }
+        ]);
+        shouldDelete = answer.confirm;
+      }
+
+      if (shouldDelete) {
+        await deleteApp(name);
+      } else {
+        console.log(chalk.yellow('App deletion cancelled.'));
+      }
+      process.exit(0);
+    });
+
   program
-    .command('site:deploy')
+    .command('sites')
+    .description('List sites and subdomains')
+    .action(async () => {
+      await listSites();
+      process.exit(0);
+    });
+
+  const site = program
+    .command('site')
+    .description('Site management commands');
+
+  site
+    .command('info')
+    .description('Get site information by UID')
+    .argument('<site_uid>', 'Site UID')
+    .action(async (site_uid) => {
+      await infoSite([site_uid]);
+      process.exit(0);
+    });
+
+  site
+    .command('create')
+    .description('Create a static website from directory')
+    .argument('<app_name>', 'Application name')
+    .argument('[dir]', 'Directory path')
+    .option('--subdomain <name>', 'Subdomain name')
+    .action(async (app_name, dir, options) => {
+      const args = [app_name];
+      if (dir) args.push(dir);
+      if (options.subdomain) args.push(`--subdomain=${options.subdomain}`)
+
+      await createSite(args)
+      process.exit(0);
+    });
+
+  site
+    .command('deploy')
     .description('Deploy a local web project to Puter')
-    .argument('[name]', 'Name of the site')
-    .argument('[remoteDir]', 'Remote directory path')
-    .option('--subdomain <subdomain>', 'Subdomain for the site')
-    .action(async (name, remoteDir, options) => {
-        try {
-            await deploy([name, remoteDir, `--subdomain=${options.subdomain}`].filter(Boolean));
-        } catch (error) {
-            console.error(chalk.red(error.message));
-        }
-        process.exit(0);
+    .argument('[local_dir]', 'Local directory path')
+    .argument('[subdomain]', 'Deployment subdomain (<subdomain>.puter.site)')
+    .action(async (local_dir, subdomain) => {
+      if (!local_dir) {
+        const answer = await inquirer.prompt([
+          {
+            type: 'input',
+            name: 'local_dir',
+            message: 'Local directory path:',
+            default: '.'
+          }
+        ]);
+        local_dir = answer.local_dir;
+      }
+
+      if (!subdomain) {
+        const answer = await inquirer.prompt([
+          {
+            type: 'input',
+            name: 'subdomain',
+            message: 'Deployment subdomain (leave empty for random):',
+          }
+        ]);
+        subdomain = answer.subdomain;
+      }
+
+      await startShell(`site:deploy ${local_dir}${subdomain ? ` --subdomain=${subdomain}` : ''}`)
+      process.exit(0);
+    });
+
+  site
+    .command('delete')
+    .description('Delete a site by UID')
+    .argument('<uid>', 'Site UID')
+    .option('-f, --force', 'Force deletion without confirmation')
+    .action(async (uid, options) => {
+      let shouldDelete = options.force;
+
+      if (!shouldDelete) {
+        const answer = await inquirer.prompt([
+          {
+            type: 'confirm',
+            name: 'confirm',
+            message: `Are you sure you want to delete the site with UID "${uid}"?`,
+            default: false
+          }
+        ]);
+        shouldDelete = answer.confirm;
+      }
+
+      if (shouldDelete) {
+        await deleteSite([uid]);
+      } else {
+        console.log(chalk.yellow('Site deletion cancelled.'));
+      }
+      process.exit(0);
     });
-    */
 
   if (process.argv.length === 2) {
     startShell();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "puter-cli",
-  "version": "1.8.5",
+  "version": "2.0.0",
   "description": "Command line interface for Puter cloud platform",
   "main": "index.js",
   "bin": {
@@ -8,8 +8,15 @@
   },
   "preferGlobal": true,
   "type": "module",
+  "scripts": {
+    "start": "node bin/index.js",
+    "test": "TZ=UTC vitest run tests/*",
+    "test:watch": "TZ=UTC vitest --watch tests/*",
+    "version": "auto-changelog -p && git add CHANGELOG.md",
+    "coverage": "TZ=UTC vitest run --coverage"
+  },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "keywords": [
     "puter",
@@ -19,7 +26,7 @@
   "author": "Ibrahim.H",
   "license": "MIT",
   "dependencies": {
-    "@heyputer/putility": "^1.0.2",
+    "@heyputer/puter.js": "^2.2.8",
     "chalk": "^5.3.0",
     "cli-table3": "^0.6.5",
     "commander": "^13.0.0",
@@ -46,12 +53,5 @@
   "bugs": {
     "url": "https://github.com/HeyPuter/puter-cli/issues"
   },
-  "homepage": "https://github.com/HeyPuter/puter-cli",
-  "scripts": {
-    "start": "node bin/index.js",
-    "test": "TZ=UTC vitest run tests/*",
-    "test:watch": "TZ=UTC vitest --watch tests/*",
-    "version": "auto-changelog -p && git add CHANGELOG.md",
-    "coverage": "TZ=UTC vitest run --coverage"
-  }
-}
+  "homepage": "https://github.com/HeyPuter/puter-cli"
+}