favacli 0.0.6 → 0.0.7

package/build/commands/entries/add.d.mts

@@ -1,6 +1,7 @@
 import BaseCommand from '../../BaseCommand.mjs';
 declare class EntriesAddCommand extends BaseCommand {
     static paths: string[][];
+    static usage: import("clipanion").Usage;
     requireTwoFaLib: boolean;
     name: string;
     issuer: string;

package/build/commands/entries/add.mjs

@@ -12,6 +12,25 @@ class EntriesAddCommand extends BaseCommand {
         this.algorithm = Option.String('--algorithm', 'SHA-1');
     }
     static { this.paths = [['entries', 'add']]; }
+    static { this.usage = BaseCommand.Usage({
+        category: 'Entries',
+        description: 'Add a new TOTP entry to the vault',
+        details: `
+      This command adds a new time-based one-time password (TOTP) entry to your vault.
+
+      The secret must be provided in base32 format.
+    `,
+        examples: [
+            [
+                'Add a basic TOTP entry',
+                'entries add --name "My Account" --issuer "Example.com" --secret JBSWY3DPEHPK3PXP',
+            ],
+            [
+                'Add a TOTP entry with custom period and digits',
+                'entries add --name "Custom Account" --issuer "Example.com" --secret AAAAAAAA --period 60 --digits 8',
+            ],
+        ],
+    }); }
     async exec() {
         await this.twoFaLib.vault.addEntry({
             name: this.name,

package/build/commands/entries/list.d.mts

@@ -1,6 +1,7 @@
 import BaseCommand from '../../BaseCommand.mjs';
 declare class EntriesListCommand extends BaseCommand {
     static paths: string[][];
+    static usage: import("clipanion").Usage;
     requireTwoFaLib: boolean;
     withTokens: boolean | undefined;
     exec(): Promise<0 | readonly import("type-fest").JsonValue[]>;

package/build/commands/entries/list.mjs

@@ -10,6 +10,19 @@ class EntriesListCommand extends BaseCommand {
         });
     }
     static { this.paths = [['entries', 'list']]; }
+    static { this.usage = BaseCommand.Usage({
+        category: 'Entries',
+        description: 'List all stored 2FA entries',
+        details: `
+      This command displays a table of all stored two-factor authentication entries.
+      
+      When used with --withTokens, it will also show the current TOTP codes for each entry.
+    `,
+        examples: [
+            ['List all entries', 'entries list'],
+            ['List entries with current TOTP tokens', 'entries list --withTokens'],
+        ],
+    }); }
     async exec() {
         let entries;
         if (this.withTokens) {

package/build/commands/entries/search.d.mts

@@ -2,6 +2,7 @@ import type { JsonArray } from 'type-fest';
 import BaseCommand from '../../BaseCommand.mjs';
 declare class EntriesSearchCommand extends BaseCommand {
     static paths: string[][];
+    static usage: import("clipanion").Usage;
     requireTwoFaLib: boolean;
     withTokens: boolean | undefined;
     query: string;

package/build/commands/entries/search.mjs

@@ -11,6 +11,23 @@ class EntriesSearchCommand extends BaseCommand {
         this.query = Option.String({ required: true });
     }
     static { this.paths = [['entries', 'search']]; }
+    static { this.usage = BaseCommand.Usage({
+        category: 'Entries',
+        description: 'Search for stored 2FA entries',
+        details: `
+      This command searches through all stored two-factor authentication entries.
+      
+      The search query will match against entry names and issuers.
+      When used with --withTokens, it will also show the current TOTP codes for matching entries.
+    `,
+        examples: [
+            ['Search for entries containing "google"', 'entries search google'],
+            [
+                'Search and show current TOTP tokens',
+                'entries search google --withTokens',
+            ],
+        ],
+    }); }
     async exec() {
         let filteredEntries;
         if (this.withTokens) {

package/build/commands/sync/connect.d.mts

@@ -2,6 +2,7 @@ import BaseCommand from '../../BaseCommand.mjs';
 declare class ConnectCommand extends BaseCommand {
     static paths: string[][];
     requireTwoFaLib: boolean;
+    static usage: import("clipanion").Usage;
     exec(): Promise<{
         success: boolean;
     }>;

package/build/commands/sync/connect.mjs

@@ -7,6 +7,16 @@ class ConnectCommand extends BaseCommand {
         this.requireTwoFaLib = true;
     }
     static { this.paths = [['sync', 'connect']]; }
+    static { this.usage = BaseCommand.Usage({
+        category: 'Sync',
+        description: 'Connect to an existing vault using a connection string',
+        details: `
+      This command allows you to connect to an existing vault by providing a connection string.
+      
+      The connection string should be obtained from the device that hosts the vault you want to connect to.
+    `,
+        examples: [['Connect to an existing vault', 'sync connect']],
+    }); }
     async exec() {
         if (!this.twoFaLib.sync) {
             throw new Error('No server url set');

package/build/commands/sync/setServerUrl.d.mts

@@ -1,6 +1,7 @@
 import BaseCommand from '../../BaseCommand.mjs';
 declare class SetServerUrlCommand extends BaseCommand {
     static paths: string[][];
+    static usage: import("clipanion").Usage;
     requireTwoFaLib: boolean;
     serverUrl: string;
     exec(): Promise<{

package/build/commands/sync/setServerUrl.mjs

@@ -7,6 +7,18 @@ class SetServerUrlCommand extends BaseCommand {
         this.serverUrl = Option.String({ required: true });
     }
     static { this.paths = [['sync', 'setServerUrl']]; }
+    static { this.usage = BaseCommand.Usage({
+        category: 'Sync',
+        description: 'Set the server URL for syncing',
+        details: `
+      This command sets the URL of the server that will be used for syncing.
+      
+      The server URL must be provided as an argument.
+    `,
+        examples: [
+            ['Set sync server URL', 'sync setServerUrl https://example.com'],
+        ],
+    }); }
     async exec() {
         await this.twoFaLib.setSyncServerUrl(this.serverUrl);
         return { success: true };

package/build/commands/vault/create.d.mts

@@ -2,6 +2,7 @@ import BaseCommand from '../../BaseCommand.mjs';
 declare class VaultCreateCommand extends BaseCommand {
     static paths: string[][];
     requireTwoFaLib: boolean;
+    static usage: import("clipanion").Usage;
     exec(): Promise<{
         success: boolean;
     }>;

package/build/commands/vault/create.mjs

@@ -12,6 +12,17 @@ class VaultCreateCommand extends BaseCommand {
         this.requireTwoFaLib = false;
     }
     static { this.paths = [['vault', 'create']]; }
+    static { this.usage = BaseCommand.Usage({
+        category: 'Vault',
+        description: 'Create a new encrypted vault',
+        details: `
+      This command creates a new encrypted vault file to store your 2FA entries.
+      
+      You will be prompted to enter a passphrase that will be used to encrypt the vault.
+      The passphrase will be securely stored in your system's keychain.
+    `,
+        examples: [['Create a new vault', 'vault create']],
+    }); }
     async exec() {
         const passphrase = (await password({
             message: 'Enter your vault passphrase:',

package/build/main.mjs

@@ -1,16 +1,21 @@
 #!/usr/bin/env node
-import { Cli } from 'clipanion';
+import { Cli, Builtins } from 'clipanion';
 import VaultCreateCommand from './commands/vault/create.mjs';
 import EntriesAddCommand from './commands/entries/add.mjs';
 import EntriesListCommand from './commands/entries/list.mjs';
 import EntriesSearchCommand from './commands/entries/search.mjs';
 import SyncSetServerUrlCommand from './commands/sync/setServerUrl.mjs';
 import SyncConnect from './commands/sync/connect.mjs';
-const [node, app, ...args] = process.argv;
+// check node version
+const nodeRuntimeMajorVersion = parseInt(process.version.split('.')[0]);
+if (nodeRuntimeMajorVersion < 20) {
+    throw new Error('Node.js version must be 20 or higher');
+}
+const [...args] = process.argv;
 const cli = new Cli({
-    binaryLabel: `My Application`,
-    binaryName: `${node} ${app}`,
-    binaryVersion: `1.0.0`,
+    binaryLabel: 'FavaCli',
+    binaryName: `favacli`,
+    binaryVersion: '0.0.7',
 });
 cli.register(VaultCreateCommand);
 cli.register(EntriesAddCommand);
@@ -18,4 +23,9 @@ cli.register(EntriesListCommand);
 cli.register(EntriesSearchCommand);
 cli.register(SyncSetServerUrlCommand);
 cli.register(SyncConnect);
+cli.register(Builtins.HelpCommand);
+if (args[0].endsWith('node')) {
+    args.splice(0, 1);
+    args.splice(0, 1);
+}
 void cli.runExit(args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "favacli",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "",
   "type": "module",
   "author": "",
@@ -25,5 +25,8 @@
   },
   "files": [
     "/build"
-  ]
+  ],
+  "engines": {
+    "node": ">=20"
+  }
 }