Update README with user and meta CRUD documentation

This commit is contained in:
Max 2026-02-21 17:45:59 -06:00
parent 3a618e384d
commit f24b230703

View File

@ -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 <email> <password> [name]
# Request password reset
./scripts/gantt.sh auth forgot-password <email>
# Reset password with token
./scripts/gantt.sh auth reset-password <token> <new-password>
# Update account
./scripts/gantt.sh auth account <field> <value>
# 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 <user-id>
# Update user field
./scripts/gantt.sh user update <user-id> <field> <value>
./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 <user-id>
```
### Meta Commands
```bash
# List all meta entries
./scripts/gantt.sh meta list
# Get specific meta value
./scripts/gantt.sh meta get <key>
# Set meta key-value
./scripts/gantt.sh meta set <key> <value>
./scripts/gantt.sh meta set lastBackup "2026-02-22"
# Delete meta entry
./scripts/gantt.sh meta delete <key>
```
### 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