@beauraines/toggl-cli 2.6.6 → 2.8.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.8.0](https://github.com/beauraines/toggl-cli/compare/v2.7.0...v2.8.0) (2026-02-28)
+
+
+### Features
+
+* add toggl quota command for API usage reporting ([#227](https://github.com/beauraines/toggl-cli/issues/227)) ([474541f](https://github.com/beauraines/toggl-cli/commit/474541f556f29a753fb7d8c108850f56c8c678d0))
+
+## [2.7.0](https://github.com/beauraines/toggl-cli/compare/v2.6.6...v2.7.0) (2026-02-28)
+
+
+### Features
+
+* add automatic API quota warning on every command ([#228](https://github.com/beauraines/toggl-cli/issues/228)) ([9c0ce3f](https://github.com/beauraines/toggl-cli/commit/9c0ce3f971e99ef31cbc66bbcff10bffae89a050))
+
 ### [2.6.6](https://github.com/beauraines/toggl-cli/compare/v2.6.5...v2.6.6) (2026-02-28)
 
 

package/client.js

@@ -1,10 +1,12 @@
 import dotenv from 'dotenv'
 import togglClient from 'toggl-client'
+import chalk from 'chalk'
 import { readConfig } from './config.js'
 dotenv.config({quiet:true})
 import debugClient from 'debug'
 const debug = debugClient('toggl-cli-client')
 
+const QUOTA_WARNING_THRESHOLD = 5
 
 export default async function () {
   let  conf
@@ -27,7 +29,16 @@ export default async function () {
      process.exit(1)
    }
 
+  // Wrap request method to warn when API quota is running low
+  const originalRequest = client.request.bind(client)
+  client.request = async function (...args) {
+    const result = await originalRequest(...args)
+    if (client.quota && client.quota.remaining !== null && client.quota.remaining <= QUOTA_WARNING_THRESHOLD) {
+      const minutes = client.quota.resetsIn ? Math.ceil(client.quota.resetsIn / 60) : '?'
+      console.error(chalk.yellow(`\n⚠ API quota low: ${client.quota.remaining} requests remaining (resets in ~${minutes}m)`))
+    }
+    return result
+  }
+
   return client
 }
-
-

package/cmds/index.mjs

@@ -13,6 +13,7 @@ import * as removeTimeEntry from './removeTimeEntry.mjs'
 import * as today from './today.mjs'
 import * as weekly from './weekly.mjs'
 import * as createConfig from './create-config.mjs'
+import * as quota from './quota.mjs'
 export const commands = [
   continueEntry,
   current,
@@ -20,6 +21,7 @@ export const commands = [
   ls,
   me,
   projects,
+  quota,
   startTimeEntry,
   stopTimeEntry,
   addTimeEntry,

package/cmds/quota.mjs

@@ -0,0 +1,59 @@
+import Client from '../client.js'
+import chalk from 'chalk'
+import { defaultWorkspaceId } from '../utils.js'
+
+export const command = 'quota'
+export const desc = 'Displays API quota usage information'
+export const builder = {}
+
+function formatQuota(remaining, resetsIn) {
+  let remainingDisplay
+  if (remaining > 10) {
+    remainingDisplay = chalk.green(remaining)
+  } else if (remaining > 5) {
+    remainingDisplay = chalk.yellow(remaining)
+  } else {
+    remainingDisplay = chalk.red(remaining)
+  }
+
+  let resetDisplay = ''
+  if (resetsIn !== null) {
+    const minutes = Math.floor(resetsIn / 60)
+    const seconds = resetsIn % 60
+    resetDisplay = ` (resets in ${minutes}m ${seconds}s)`
+  }
+
+  return `${remainingDisplay} requests${resetDisplay}`
+}
+
+export const handler = async function (argv) {
+  const client = await Client()
+
+  // Call a user-specific endpoint to get the user quota
+  await client.user.current()
+  const userQuota = client.quota ? { ...client.quota } : null
+
+  // Call a workspace-scoped endpoint to get the workspace/org quota
+  await client.workspaces.projects(defaultWorkspaceId)
+  const workspaceQuota = client.quota ? { ...client.quota } : null
+
+  if (!userQuota && !workspaceQuota) {
+    console.log('No API quota information available in the response headers.')
+    console.log('The Toggl API may not be returning quota headers yet.')
+    return
+  }
+
+  if (workspaceQuota && workspaceQuota.remaining !== null) {
+    console.log(`Workspace quota: ${formatQuota(workspaceQuota.remaining, workspaceQuota.resetsIn)}`)
+  }
+
+  if (userQuota && userQuota.remaining !== null) {
+    console.log(`User quota:      ${formatQuota(userQuota.remaining, userQuota.resetsIn)}`)
+  }
+
+  const low = [userQuota, workspaceQuota].some(q => q && q.remaining !== null && q.remaining <= 5)
+  if (low) {
+    console.log(chalk.red('\n⚠ Warning: API quota is running low!'))
+    console.log(chalk.red('Consider waiting before making more requests.'))
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/toggl-cli",
-  "version": "2.6.6",
+  "version": "2.8.0",
   "description": "CLI client for Toggl Time Tracker",
   "main": "cli.js",
   "bin": {
@@ -36,7 +36,7 @@
     "debug": "^4.3.4",
     "dotenv": "^17.2.3",
     "open": "^11.0.0",
-    "toggl-client": "^3.1.1",
+    "toggl-client": "github:beauraines/toggl-client",
     "yargs": "^18.0.0"
   },
   "devDependencies": {