From f24b23070390b83bbcb0349adc5fd9e04376cf7b Mon Sep 17 00:00:00 2001 From: Max Date: Sat, 21 Feb 2026 17:45:59 -0600 Subject: [PATCH] Update README with user and meta CRUD documentation --- scripts/README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/scripts/README.md b/scripts/README.md index 9fdaa08..9e4cae7 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -113,6 +113,56 @@ A unified CLI that covers all API operations. # Log out ./scripts/gantt.sh auth logout + +# Register new account +./scripts/gantt.sh auth register [name] + +# Request password reset +./scripts/gantt.sh auth forgot-password + +# Reset password with token +./scripts/gantt.sh auth reset-password + +# Update account +./scripts/gantt.sh auth account + +# List all users +./scripts/gantt.sh auth users +``` + +### User Admin Commands + +```bash +# List all users +./scripts/gantt.sh user list + +# Get specific user +./scripts/gantt.sh user get + +# Update user field +./scripts/gantt.sh user update +./scripts/gantt.sh user update abc-123 name "New Name" +./scripts/gantt.sh user update abc-123 email "new@example.com" + +# Delete user +./scripts/gantt.sh user delete +``` + +### Meta Commands + +```bash +# List all meta entries +./scripts/gantt.sh meta list + +# Get specific meta value +./scripts/gantt.sh meta get + +# Set meta key-value +./scripts/gantt.sh meta set +./scripts/gantt.sh meta set lastBackup "2026-02-22" + +# Delete meta entry +./scripts/gantt.sh meta delete ``` ### Debug @@ -182,6 +232,16 @@ Displays text files in terminal, saves binary files to `/tmp/`. | Auth reset-password | ✅ | ✅ | ❌ | | Auth account update | ✅ | ✅ | ❌ | | Auth list users | ✅ | ✅ | ❌ | +| **User Admin** |||| +| Get user | ✅ | ✅ | ❌ | +| Update user | ✅ | ✅ | ❌ | +| Delete user | ✅ | ✅ | ❌ | +| **Meta** |||| +| List meta | ✅ | ✅ | ❌ | +| Get meta | ✅ | ✅ | ❌ | +| Set meta | ✅ | ✅ | ❌ | +| Delete meta | ✅ | ✅ | ❌ | +| **Other** |||| | View attachments | ✅ | ❌ | ✅ | ### Auditing Coverage