@circleback/cli 0.3.5 → 0.4.0

package/README.md

@@ -13,7 +13,7 @@ Requires Node.js 18 or later. The package installs two binaries: `circleback` an
 ## Quick start
 
 ```bash
-# Authenticate via browser
+# Log in with your browser
 cb auth login
 
 # Search recent meetings
@@ -39,9 +39,9 @@ cb meetings --json
 
 | Command                        | Description                                                  |
 | ------------------------------ | ------------------------------------------------------------ |
-| `cb auth login`                | Login with Circleback via browser                            |
-| `cb auth login --api-key`      | Authenticate with a Public API key                           |
-| `cb auth logout`               | Clear stored login credentials                               |
+| `cb auth login`                | Log in to Circleback with your browser                       |
+| `cb auth login --api-key`      | Log in with an API key                                       |
+| `cb auth logout`               | Sign out on this device                                      |
 | `cb update`                    | Update CLI to the latest version                             |
 | `cb meetings [search]`         | Search meetings                                              |
 | `cb meetings read <ids...>`    | Read detailed meeting info, notes, and action items (max 50) |
@@ -86,12 +86,12 @@ Pass `--json` to any command to get raw JSON instead of formatted tables. Useful
 cb meetings "standup" --json | jq '.[].name'
 ```
 
-## Authentication
+## Login
 
 ```bash
-cb auth login              # Opens the browser for OAuth
-cb auth login --api-key    # Prompts securely for a Public API key
-cb auth logout             # Clears stored credentials
+cb auth login              # Opens your browser to log in
+cb auth login --api-key    # Asks for your API key securely
+cb auth logout             # Signs out on this device
 ```
 
 API-key login links to [Settings → API keys](https://circleback.ai/settings?tab=api-access), verifies the key, and stores it locally on your device.

package/dist/auth/credentials.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCredentialSnapshot = exports.getEnvironmentApiKey = void 0;
+exports.getCredentialSnapshot = exports.getLoginStatus = exports.getEnvironmentApiKey = void 0;
+const node_util_1 = require("node:util");
+const zod_1 = require("zod");
 const constants_1 = require("../constants");
 const types_1 = require("../types");
 const oauth_1 = require("./oauth");
@@ -10,6 +12,49 @@ const getEnvironmentApiKey = () => {
     return apiKey || undefined;
 };
 exports.getEnvironmentApiKey = getEnvironmentApiKey;
+const fetchLoginStatus = async (credentials) => {
+    if (credentials.type === types_1.CredentialType.OAuth &&
+        Math.floor(Date.now() / 1000) >= credentials.tokens.expiresAt) {
+        return 'Unable to check login';
+    }
+    try {
+        const bearerCredential = credentials.type === types_1.CredentialType.OAuth
+            ? credentials.tokens.accessToken
+            : credentials.apiKey;
+        const response = await fetch(`${constants_1.BASE_URL}/api/oauth/test`, {
+            headers: { Authorization: `Bearer ${bearerCredential}` },
+            signal: AbortSignal.timeout(5_000),
+        });
+        if (response.status === 401)
+            return 'Not logged in';
+        if (!response.ok)
+            return 'Unable to check login';
+        const account = zod_1.z
+            .object({ email: zod_1.z.email(), apiKeyName: zod_1.z.string().optional() })
+            .parse(await response.json());
+        if (credentials.type === types_1.CredentialType.ApiKey) {
+            const name = (0, node_util_1.stripVTControlCharacters)(account.apiKeyName ?? '')
+                .replace(/[\p{Cc}\p{Cf}]/gu, '')
+                .trim();
+            return name
+                ? `Logged in with API key “${name}”`
+                : 'Logged in with an API key';
+        }
+        return `Logged in as ${account.email}`;
+    }
+    catch {
+        return 'Unable to check login';
+    }
+};
+const getLoginStatus = async () => {
+    try {
+        return await fetchLoginStatus(requireCredentials());
+    }
+    catch {
+        return 'Not logged in';
+    }
+};
+exports.getLoginStatus = getLoginStatus;
 const requireCredentials = () => {
     const environmentApiKey = (0, exports.getEnvironmentApiKey)();
     if (environmentApiKey) {
@@ -24,7 +69,7 @@ const requireCredentials = () => {
     }
     const storedCredentials = (0, tokenStorage_1.loadCredentials)();
     if (!storedCredentials) {
-        throw new Error(`Not authenticated. Run \`circleback auth login\` or set ${constants_1.API_KEY_ENVIRONMENT_VARIABLE}.`);
+        throw new Error(`Not logged in. Run \`circleback auth login\` or set ${constants_1.API_KEY_ENVIRONMENT_VARIABLE}.`);
     }
     if ((0, types_1.isStoredApiKey)(storedCredentials)) {
         return {

package/dist/auth/server.js

@@ -13,7 +13,7 @@ const SUCCESS_HTML = `
   <head><title>Circleback CLI</title></head>
   <body style="font-family: system-ui, sans-serif; display: flex; justify-content: center; align-items: center; height: 100vh; margin: 0;">
     <div style="text-align: center;">
-      <h1>Authentication successful</h1>
+      <h1>Login complete</h1>
       <p>You can close this tab and return to the terminal.</p>
     </div>
   </body>
@@ -44,7 +44,7 @@ const startCallbackServer = () => new Promise((resolve, reject) => {
                 .replace(/>/g, '&gt;')
                 .replace(/"/g, '&quot;')
                 .replace(/'/g, '&#039;');
-            response.end(`<h1>Authentication failed: ${escapedError}</h1>`);
+            response.end(`<h1>Login failed: ${escapedError}</h1>`);
             callbackReject(new Error(`OAuth error: ${error}.`));
             return;
         }
@@ -72,7 +72,7 @@ const startCallbackServer = () => new Promise((resolve, reject) => {
             waitForCallback: async () => {
                 const timeout = setTimeout(() => {
                     shutdown();
-                    callbackReject(new Error('Authentication timed out. Please try again.'));
+                    callbackReject(new Error('Login timed out. Please try again.'));
                 }, constants_1.CALLBACK_TIMEOUT_MILLISECONDS);
                 server.once('close', () => clearTimeout(timeout));
                 const result = await callbackPromise;

package/dist/commands/auth.js

@@ -14,16 +14,16 @@ const constants_1 = require("../constants");
 const output_1 = require("../helpers/output");
 const types_1 = require("../types");
 const loginCommand = new commander_1.Command('login')
-    .description('Authenticate with Circleback.')
-    .option('--api-key', 'Authenticate with a Public API key')
+    .description('Log in to Circleback.')
+    .option('--api-key', 'Log in with an API key')
     .action(async (options) => {
     try {
         if ((0, credentials_1.getEnvironmentApiKey)()) {
-            (0, output_1.printText)(`${constants_1.API_KEY_ENVIRONMENT_VARIABLE} is active. Unset it before changing stored authentication.`, output_1.TextType.Warning);
+            (0, output_1.printText)(`${constants_1.API_KEY_ENVIRONMENT_VARIABLE} is active. Unset it before logging in with another account or API key.`, output_1.TextType.Warning);
             return;
         }
         if ((0, tokenStorage_1.loadCredentials)()) {
-            (0, output_1.printText)('Already authenticated. Run `circleback auth logout` first to re-authenticate.', output_1.TextType.Warning);
+            (0, output_1.printText)('Already logged in. Run `cb auth logout` first to log in again.', output_1.TextType.Warning);
             return;
         }
         if (options.apiKey) {
@@ -33,39 +33,39 @@ const loginCommand = new commander_1.Command('login')
             const apiKey = await (0, apiKey_1.promptForApiKey)();
             await (0, apiKey_1.validateApiKey)(apiKey);
             (0, tokenStorage_1.saveCredentials)({ type: types_1.CredentialType.ApiKey, apiKey });
-            (0, output_1.printText)('API key authentication successful.', output_1.TextType.Success);
+            (0, output_1.printText)('Logged in with your API key.', output_1.TextType.Success);
             return;
         }
-        (0, output_1.printText)('Opening your browser for authentication…', output_1.TextType.Default);
+        (0, output_1.printText)('Opening your browser to log in…', output_1.TextType.Default);
         await (0, oauth_1.login)();
-        (0, output_1.printText)('Authentication successful.', output_1.TextType.Success);
+        (0, output_1.printText)('Logged in successfully.', output_1.TextType.Success);
     }
     catch (error) {
-        const message = error instanceof Error ? error.message : 'Authentication failed.';
+        const message = error instanceof Error ? error.message : 'Login failed.';
         (0, output_1.printText)(message, output_1.TextType.Error);
         process.exit(1);
     }
 });
 const logoutCommand = new commander_1.Command('logout')
-    .description('Clear stored authentication credentials.')
+    .description('Sign out on this device.')
     .action(() => {
     const environmentApiKey = (0, credentials_1.getEnvironmentApiKey)();
     const didClearCredentials = (0, tokenStorage_1.clearCredentials)();
     if (!didClearCredentials) {
         if (environmentApiKey) {
-            (0, output_1.printText)(`No stored credentials to clear. ${constants_1.API_KEY_ENVIRONMENT_VARIABLE} is still active.`, output_1.TextType.Warning);
+            (0, output_1.printText)(`No saved login to clear. ${constants_1.API_KEY_ENVIRONMENT_VARIABLE} is still active.`, output_1.TextType.Warning);
             return;
         }
-        (0, output_1.printText)('Not currently authenticated.', output_1.TextType.Warning);
+        (0, output_1.printText)('Not logged in.', output_1.TextType.Warning);
         return;
     }
     if (environmentApiKey) {
-        (0, output_1.printText)(`Stored credentials cleared. ${constants_1.API_KEY_ENVIRONMENT_VARIABLE} is still active.`, output_1.TextType.Warning);
+        (0, output_1.printText)(`Saved login cleared. ${constants_1.API_KEY_ENVIRONMENT_VARIABLE} is still active.`, output_1.TextType.Warning);
         return;
     }
-    (0, output_1.printText)('Logged out successfully.', output_1.TextType.Success);
+    (0, output_1.printText)('Signed out successfully.', output_1.TextType.Success);
 });
 exports.authCommand = new commander_1.Command('auth')
-    .description('Manage authentication.')
+    .description('Log in or sign out.')
     .addCommand(loginCommand)
     .addCommand(logoutCommand);

package/dist/commands/meetings.js

@@ -33,7 +33,7 @@ exports.searchMeetingsCommand = new commander_1.Command('search')
             intent: query ?? 'Listing recent meetings.',
             pageIndex,
         };
-        if (query)
+        if (typeof query === 'string')
             args['searchTerm'] = query;
         if (options.last) {
             args['startDate'] = (0, date_1.getStartDateFromDaysAgo)((0, parse_1.parseIntOption)(options.last, '--last'));

package/dist/commands/registry.js

@@ -17,12 +17,12 @@ const standaloneCommands = [auth_1.authCommand, update_1.updateCommand];
 const commandGroups = [
     {
         name: 'meetings',
-        description: 'Search meetings with `cb meetings search [term]` and read them with `cb meetings read <id>`.',
+        description: 'Find meetings and read notes.',
         subcommands: [meetings_1.searchMeetingsCommand, meetings_1.readMeetingsCommand],
     },
     {
         name: 'transcripts',
-        description: 'Search transcripts with `cb transcripts search <term>` and read them with `cb transcripts read <id>`.',
+        description: 'Find and read meeting transcripts.',
         subcommands: [transcripts_1.searchTranscriptsCommand, transcripts_1.getTranscriptsCommand],
     },
     {

package/dist/helpers/help.js

@@ -9,6 +9,7 @@ const SECTION_HEADERS = {
     'Options:': 'options',
     'Commands:': 'commands',
     'Arguments:': 'arguments',
+    'Examples:': 'commands',
 };
 const styleLine = (line, section) => {
     if (/^Usage:/.test(line)) {
@@ -25,7 +26,7 @@ const styleLine = (line, section) => {
         const match = line.match(/^(\s+)(.+?)(  +)(.*)$/);
         if (match) {
             return [
-                `${match[1]}${chalk_1.default.bold(match[2])}${match[3]}${match[4]}`,
+                `${match[1]}${chalk_1.default.cyan(match[2])}${match[3]}${chalk_1.default.dim(match[4])}`,
                 section,
             ];
         }

package/dist/helpers/style.js

@@ -3,19 +3,38 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BANNER = exports.tableStyle = exports.brand = void 0;
+exports.formatWelcomeBanner = exports.tableStyle = exports.brand = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const constants_1 = require("../constants");
 exports.brand = chalk_1.default.hex(constants_1.BRAND_COLOR);
 const secondary = chalk_1.default.hex(constants_1.SECONDARY_COLOR);
 exports.tableStyle = { head: [], border: [] };
-exports.BANNER = [
-    '',
-    `  ${exports.brand.bold(constants_1.CLIENT_PACKAGE_NAME)}  ${chalk_1.default.dim(`v${constants_1.CLIENT_VERSION}`)}`,
-    constants_1.ASCII_LOGO.split('\n')
-        .map((line) => line
-        .replace(/=+/g, (match) => (0, exports.brand)(match))
-        .replace(/\++/g, (match) => secondary(match)))
-        .join('\n'),
-    '',
-].join('\n');
+const formatWelcomeBanner = (width, loginStatus) => {
+    const logo = constants_1.ASCII_LOGO.trimEnd().split('\n').slice(1);
+    const logoWidth = Math.max(...logo.map((line) => line.length));
+    const title = `${constants_1.CLIENT_NAME}  v${constants_1.CLIENT_VERSION}`;
+    const details = [
+        `${exports.brand.bold(constants_1.CLIENT_NAME)}  ${chalk_1.default.dim(`v${constants_1.CLIENT_VERSION}`)}`,
+        '',
+        chalk_1.default.bold(loginStatus),
+    ];
+    const isWide = width >= logoWidth + 4 + Math.max(title.length, loginStatus.length);
+    const detailsStart = Math.floor((logo.length - details.length) / 2);
+    const artwork = logo.map((line, index) => {
+        const colored = line
+            .replace(/=+/g, (match) => (0, exports.brand)(match))
+            .replace(/\++/g, (match) => secondary(match));
+        const detail = isWide ? details[index - detailsStart] : undefined;
+        return detail
+            ? `${colored}${' '.repeat(logoWidth - line.length + 4)}${detail}`
+            : colored;
+    });
+    return [
+        '',
+        ...artwork,
+        '',
+        ...(isWide ? [] : details.map((line) => `  ${line}`)),
+        '',
+    ].join('\n');
+};
+exports.formatWelcomeBanner = formatWelcomeBanner;

package/dist/index.js

@@ -2,6 +2,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
+const credentials_1 = require("./auth/credentials");
 const registry_1 = require("./commands/registry");
 const constants_1 = require("./constants");
 const help_1 = require("./helpers/help");
@@ -11,19 +12,23 @@ const update_1 = require("./helpers/update");
 const program = new commander_1.Command();
 const updateCheck = (0, update_1.getUpdateCheckResult)(constants_1.CLIENT_PACKAGE_NAME);
 const configureCommandOutput = (command) => {
+    command.helpOption('-h, --help', 'Display help for command');
+    if (command.commands.length > 0) {
+        command.addHelpCommand('help [command]', 'Display help for command');
+    }
     command.configureOutput({
-        writeOut: (text) => (0, output_1.printText)((0, help_1.styleHelpOutput)(text).trimEnd(), output_1.TextType.Default),
-        writeErr: (text) => (0, output_1.printTextToStderr)((0, help_1.styleHelpOutput)(text).trimEnd(), output_1.TextType.Default),
+        writeOut: (text) => process.stdout.write((0, help_1.styleHelpOutput)(text)),
+        writeErr: (text) => process.stderr.write((0, help_1.styleHelpOutput)(text)),
         outputError: (text) => (0, output_1.printText)((0, help_1.styleHelpOutput)(text).trim(), output_1.TextType.Error),
     });
     command.commands.forEach(configureCommandOutput);
 };
 program
     .name('circleback')
-    .description('Search and access meetings, emails, calendar events, and more.')
-    .version(constants_1.CLIENT_VERSION)
+    .version(constants_1.CLIENT_VERSION, '-V, --version', 'Output the version number')
     .option('--json', 'Output raw JSON instead of formatted text')
-    .addHelpText('before', style_1.BANNER)
+    .allowExcessArguments(false)
+    .action(() => program.help())
     .exitOverride();
 (0, registry_1.getAllCommands)().reduce((p, command) => p.addCommand(command), program);
 configureCommandOutput(program);
@@ -35,7 +40,27 @@ program.hook('postAction', async (_thisCommand, actionCommand) => {
     }
     catch { }
 });
-program.parseAsync().catch((error) => {
+const run = async () => {
+    const isRootHelp = process.argv
+        .slice(2)
+        .every((argument) => ['--help', '-h', '--json', 'help', '--'].includes(argument));
+    if (isRootHelp) {
+        const loginStatus = await (0, credentials_1.getLoginStatus)();
+        program
+            .addHelpText('before', () => (0, style_1.formatWelcomeBanner)(process.stdout.columns ?? 80, loginStatus))
+            .addHelpText('before', [
+            'Examples:',
+            '  cb auth login                  Log in to Circleback',
+            '  cb meetings                    See recent meetings',
+            '  cb meetings "product review"   Find a meeting',
+            '  cb transcripts "pricing"       Search transcript text',
+            '  cb meetings --json             Get JSON for scripts',
+            '',
+        ].join('\n'));
+    }
+    await program.parseAsync();
+};
+run().catch((error) => {
     if (error instanceof commander_1.CommanderError)
         process.exit(error.exitCode);
     (0, output_1.printText)(error instanceof Error ? error.message : String(error), output_1.TextType.Error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@circleback/cli",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "Circleback CLI. Search and access meetings, emails, calendar events, and more.",
   "license": "MIT",
   "author": "Circleback <support@circleback.ai> (https://circleback.ai)",