@slothmoney/agent-cli 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.12.0 - 2026-08-16
+
+- Add read-only `budget status` for current-period assigned, spent, and
+  available category amounts, including refresh and unallocated-activity
+  signals for safer automated budget review.
+
 ## 0.11.0 - 2026-08-16
 
 - Add preview-by-default `budget move` for atomically moving current assigned

package/README.md

@@ -15,7 +15,7 @@ sloth-agent --version
 For a one-off pinned run:
 
 ```bash
-npm exec --yes --package=@slothmoney/agent-cli@0.11.0 -- sloth-agent --help
+npm exec --yes --package=@slothmoney/agent-cli@0.12.0 -- sloth-agent --help
 ```
 
 ## Authenticate
@@ -104,6 +104,7 @@ options, output, and examples:
 sloth-agent auth login --help
 sloth-agent accounts --help
 sloth-agent budget --help
+sloth-agent budget status --help
 sloth-agent budget update --help
 sloth-agent budget move --help
 sloth-agent categories --help
@@ -249,6 +250,21 @@ The result includes the budget period and status, currency, the effective plan,
 stored funding amounts when available, categories, line items, and planned
 amounts in pence.
 
+Read current assigned, spent, and available money without aggregating
+transactions yourself:
+
+```bash
+sloth-agent budget status --scope personal
+```
+
+The server applies its normal once-per-UTC-day automatic transaction refresh
+policy before returning the current Sloth period dates and signed booked
+activity. For each category, `availablePence` is
+`assignedPence - spentPence`; a negative value is over budget, and refunds
+reduce `spentPence`. Check `refresh`,
+`activity.uncategorizedSpentPence`, and `activity.unmappedSpentPence` before
+using the result to suggest a reallocation. This command is read-only.
+
 Update selected line-item amounts by creating `budget.json`:
 
 ```json

package/dist/args.js

@@ -372,21 +372,38 @@ function parseInvestments(args, baseUrl) {
     return withBaseUrl({ command: 'investments', ...(accountRef ? { accountRef } : {}) }, baseUrl);
 }
 function parseBudget(args, baseUrl) {
-    const subcommand = args[0] === 'update' || args[0] === 'move' ? args.shift() : undefined;
+    const subcommand = args[0] === 'status' || args[0] === 'update' || args[0] === 'move'
+        ? args.shift()
+        : undefined;
+    const status = subcommand === 'status';
     const update = subcommand === 'update';
     const move = subcommand === 'move';
-    const commandLabel = update ? 'budget update' : move ? 'budget move' : 'budget';
-    const { values, apply } = parseNamedOptions(args, commandLabel, new Set(update
-        ? ['--scope', '--period', '--input']
-        : move
-            ? ['--scope', '--period', '--from-category-id', '--to-category-id', '--amount']
-            : ['--scope', '--period']));
+    const commandLabel = status
+        ? 'budget status'
+        : update
+            ? 'budget update'
+            : move
+                ? 'budget move'
+                : 'budget';
+    const { values, apply } = parseNamedOptions(args, commandLabel, new Set(status
+        ? ['--scope']
+        : update
+            ? ['--scope', '--period', '--input']
+            : move
+                ? ['--scope', '--period', '--from-category-id', '--to-category-id', '--amount']
+                : ['--scope', '--period']));
     if (!update && !move && apply)
-        throw new UsageError('Unknown budget option: --apply');
+        throw new UsageError(`Unknown ${commandLabel} option: --apply`);
     const scope = requiredOption(values, '--scope', commandLabel);
     if (scope !== 'personal' && scope !== 'joint') {
         throw new UsageError('--scope must be personal or joint');
     }
+    if (status) {
+        return withBaseUrl({
+            command: 'budget-status',
+            scope: scope,
+        }, baseUrl);
+    }
     const period = values.get('--period');
     const common = {
         scope: scope,
@@ -769,6 +786,8 @@ function helpTopic(argv) {
         return undefined;
     }
     if (command === 'budget') {
+        if (subcommand === 'status')
+            return 'budget-status';
         if (subcommand === 'update')
             return 'budget-update';
         if (subcommand === 'move')

package/dist/cli.js

@@ -4,7 +4,7 @@ import { ICON_KEYS } from './category-metadata.js';
 import { parseApiResponse, validateAssignmentPayload, validateBudgetMovementResponse, validateBudgetUpdatePayload, } from './contracts.js';
 import { createSystemCredentialStore, secureStorageUnavailableError, } from './credential-store.js';
 import { ApiError, CliError, ConfigError, UsageError, } from './errors.js';
-export const CLI_VERSION = '0.11.0';
+export const CLI_VERSION = '0.12.0';
 const REQUEST_TIMEOUT_MS = 60_000;
 const API_ORIGIN_HELP_LINES = [
     '',
@@ -30,6 +30,7 @@ export function usageText() {
         '  sloth-agent accounts remove --account-ref REF [--apply]',
         '  sloth-agent investments [--account-ref REF] [--base-url URL]',
         '  sloth-agent budget --scope personal|joint [--period YYYY-MM] [--base-url URL]',
+        '  sloth-agent budget status --scope personal|joint [--base-url URL]',
         '  sloth-agent budget update --scope personal|joint [--period YYYY-MM]',
         '    --input budget.json [--apply] [--base-url URL]',
         '  sloth-agent budget move --scope personal|joint [--period YYYY-MM]',
@@ -421,6 +422,35 @@ export function budgetHelpText() {
         '  Categories also include plannedPence and assignedPence.',
     ].join('\n');
 }
+export function budgetStatusHelpText() {
+    return [
+        'Sloth Agent CLI — budget status',
+        '',
+        'Read assigned, spent, and available money for the current Sloth budget period.',
+        '',
+        'Usage:',
+        '  sloth-agent budget status --scope personal|joint [--base-url URL]',
+        '',
+        'Options:',
+        '  --scope personal|joint  Required. Budget ownership scope.',
+        '  --base-url URL          Optional. Override the API origin.',
+        '  -h, --help              Show this help.',
+        ...API_ORIGIN_HELP_LINES,
+        '',
+        'Access and freshness:',
+        '  This command is read-only, requires agent:read, and never changes the budget.',
+        '  The server applies its normal once-per-UTC-day automatic transaction refresh policy.',
+        '  Inspect refresh.status and refresh.reason before relying on the result.',
+        '',
+        'Output:',
+        '  categories[].assignedPence is the money assigned to the category.',
+        '  categories[].spentPence is signed booked activity; refunds reduce it.',
+        '  categories[].availablePence equals assignedPence minus spentPence.',
+        '  Negative availablePence means the category is over budget.',
+        '  activity contains the period dates, transaction count, uncategorizedSpentPence,',
+        '  and unmappedSpentPence. Review either nonzero value before moving money.',
+    ].join('\n');
+}
 export function budgetUpdateHelpText() {
     return [
         'Sloth Agent CLI — budget update',
@@ -867,6 +897,7 @@ export function commandHelpText(topic) {
         'accounts-remove': accountsRemoveHelpText,
         investments: investmentsHelpText,
         budget: budgetHelpText,
+        'budget-status': budgetStatusHelpText,
         'budget-move': budgetMoveHelpText,
         'budget-update': budgetUpdateHelpText,
         categories: categoriesHelpText,
@@ -1429,16 +1460,19 @@ export async function runCli(argv = process.argv.slice(2), options = {}) {
             writeJson(writeStdout, withListedGoalPriorities(data));
             return 0;
         }
-        if (parsed.command === 'budget') {
+        if (parsed.command === 'budget' || parsed.command === 'budget-status') {
             const query = new URLSearchParams({ scope: parsed.scope });
-            if (parsed.periodKey !== undefined)
+            if (parsed.command === 'budget' && parsed.periodKey !== undefined) {
                 query.set('periodKey', parsed.periodKey);
-            const response = await fetchImplementation(`${baseUrl}/api/agent/v1/budgets?${query.toString()}`, {
+            }
+            const response = await fetchImplementation(`${baseUrl}/api/agent/v1/${parsed.command === 'budget' ? 'budgets' : 'budget-status'}?${query.toString()}`, {
                 method: 'GET',
-                headers,
+                headers: parsed.command === 'budget-status'
+                    ? { ...headers, Prefer: 'wait=45' }
+                    : headers,
                 signal: AbortSignal.timeout(REQUEST_TIMEOUT_MS),
             });
-            const data = parseApiResponse('budget', await parseHttpResponse(response, token));
+            const data = parseApiResponse(parsed.command, await parseHttpResponse(response, token));
             writeJson(writeStdout, data);
             return 0;
         }

package/dist/contracts.js

@@ -227,28 +227,32 @@ function isTransaction(value) {
             || value.incomeSubtype === 'pay'
             || value.incomeSubtype === 'interest'));
 }
+const REFRESH_STATUSES = new Set(['skipped', 'completed', 'in_progress', 'partial', 'failed']);
+const REFRESH_REASONS = new Set([
+    'all_fetched_today',
+    'no_api_connections',
+    'no_selected_accounts',
+    'refreshed',
+    'wait_timeout',
+    'account_failures',
+    'partial_already_attempted',
+    'refresh_error',
+]);
+function isRefreshStatus(value) {
+    return (isObject(value)
+        && hasOnlyFields(value, ['status', 'reason', 'utcDate'])
+        && typeof value.status === 'string'
+        && REFRESH_STATUSES.has(value.status)
+        && typeof value.reason === 'string'
+        && REFRESH_REASONS.has(value.reason)
+        && isIsoDate(value.utcDate));
+}
 function isTransactionsResponse(value) {
-    const validStatuses = new Set(['skipped', 'completed', 'in_progress', 'partial', 'failed']);
-    const validReasons = new Set([
-        'all_fetched_today',
-        'no_api_connections',
-        'no_selected_accounts',
-        'refreshed',
-        'wait_timeout',
-        'account_failures',
-        'refresh_error',
-    ]);
-    const refresh = isObject(value) ? value.refresh : undefined;
     return (isObject(value)
         && Array.isArray(value.transactions)
         && value.transactions.every(isTransaction)
         && (value.nextCursor === null || typeof value.nextCursor === 'string')
-        && isObject(refresh)
-        && typeof refresh.status === 'string'
-        && validStatuses.has(refresh.status)
-        && typeof refresh.reason === 'string'
-        && validReasons.has(refresh.reason)
-        && isIsoDate(refresh.utcDate));
+        && isRefreshStatus(value.refresh));
 }
 function isAssignmentResponse(value) {
     return (isObject(value)
@@ -375,6 +379,68 @@ function isBudgetResponse(value) {
         && Array.isArray(value.categories)
         && value.categories.every(isBudgetCategory));
 }
+function isBudgetStatusResponse(value) {
+    if (!isObject(value)
+        || !hasOnlyFields(value, [
+            'scope',
+            'periodKey',
+            'periodStatus',
+            'currency',
+            'effectiveFromPeriodKey',
+            'funding',
+            'activity',
+            'refresh',
+            'categories',
+        ]))
+        return false;
+    return ((value.scope === 'personal' || value.scope === 'joint')
+        && typeof value.periodKey === 'string'
+        && /^\d{4}-(0[1-9]|1[0-2])$/.test(value.periodKey)
+        && value.periodStatus === 'current'
+        && isCurrency(value.currency)
+        && typeof value.effectiveFromPeriodKey === 'string'
+        && /^\d{4}-(0[1-9]|1[0-2])$/.test(value.effectiveFromPeriodKey)
+        && (value.funding === null
+            || (isObject(value.funding)
+                && hasOnlyFields(value.funding, ['toAssignPence', 'nextPeriodReservePence'])
+                && isSafeInteger(value.funding.toAssignPence)
+                && isSafeInteger(value.funding.nextPeriodReservePence)))
+        && isObject(value.activity)
+        && hasOnlyFields(value.activity, [
+            'startDate',
+            'endDate',
+            'transactionCount',
+            'uncategorizedSpentPence',
+            'unmappedSpentPence',
+        ])
+        && isIsoDate(value.activity.startDate)
+        && isIsoDate(value.activity.endDate)
+        && value.activity.startDate <= value.activity.endDate
+        && isNonnegativeSafeInteger(value.activity.transactionCount)
+        && isSafeInteger(value.activity.uncategorizedSpentPence)
+        && isSafeInteger(value.activity.unmappedSpentPence)
+        && isRefreshStatus(value.refresh)
+        && Array.isArray(value.categories)
+        && value.categories.every((category) => (isObject(category)
+            && hasOnlyFields(category, [
+                'id',
+                'name',
+                'plannedPence',
+                'assignedPence',
+                'spentPence',
+                'availablePence',
+            ])
+            && typeof category.id === 'string'
+            && category.id.trim().length > 0
+            && typeof category.name === 'string'
+            && category.name.trim().length > 0
+            && isNonnegativeSafeInteger(category.plannedPence)
+            && isSafeInteger(category.assignedPence)
+            && isSafeInteger(category.spentPence)
+            && isSafeInteger(category.availablePence)
+            && Number.isSafeInteger(category.assignedPence - category.spentPence)
+            && category.availablePence === category.assignedPence - category.spentPence)));
+}
 function isBudgetMovementResponse(value) {
     return (isObject(value)
         && hasOnlyFields(value, [
@@ -568,25 +634,27 @@ export function parseApiResponse(command, value) {
                     ? isInvestmentsResponse(value)
                     : command === 'budget' || command === 'budget-update'
                         ? isBudgetResponse(value)
-                        : command === 'budget-move'
-                            ? isBudgetMovementResponse(value)
-                            : command === 'categories'
-                                ? isCategoryResponse(value)
-                                : command === 'categories-create' || command === 'categories-rename'
-                                    ? isCategoryMutationResponse(value)
-                                    : command === 'line-items-create' || command === 'line-items-rename'
-                                        ? isLineItemMutationResponse(value)
-                                        : command === 'transactions'
-                                            ? isTransactionsResponse(value)
-                                            : command === 'assign'
-                                                ? isAssignmentResponse(value)
-                                                : command === 'ask-partner'
-                                                    ? isPartnerResponse(value)
-                                                    : command === 'goals-list'
-                                                        ? isGoalsResponse(value)
-                                                        : command === 'goals-delete'
-                                                            ? isGoalDeleteResponse(value)
-                                                            : isGoalMutationResponse(value);
+                        : command === 'budget-status'
+                            ? isBudgetStatusResponse(value)
+                            : command === 'budget-move'
+                                ? isBudgetMovementResponse(value)
+                                : command === 'categories'
+                                    ? isCategoryResponse(value)
+                                    : command === 'categories-create' || command === 'categories-rename'
+                                        ? isCategoryMutationResponse(value)
+                                        : command === 'line-items-create' || command === 'line-items-rename'
+                                            ? isLineItemMutationResponse(value)
+                                            : command === 'transactions'
+                                                ? isTransactionsResponse(value)
+                                                : command === 'assign'
+                                                    ? isAssignmentResponse(value)
+                                                    : command === 'ask-partner'
+                                                        ? isPartnerResponse(value)
+                                                        : command === 'goals-list'
+                                                            ? isGoalsResponse(value)
+                                                            : command === 'goals-delete'
+                                                                ? isGoalDeleteResponse(value)
+                                                                : isGoalMutationResponse(value);
     if (!valid) {
         const label = command === 'assign' ? 'assignment' : command;
         throw new ApiError(`Invalid ${label} response from the Agent API`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slothmoney/agent-cli",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Command-line access to the Sloth Money Agent API.",
   "type": "module",
   "bin": {