sentron-cli 1.0.22 → 1.0.24

package/README.md

@@ -6,7 +6,10 @@
   <img src="https://sentron.dev/logo-light.svg" width="32" height="32" alt="Sentron Logo" style="vertical-align: middle; margin-right: 8px;" />
 </picture> sentron-cli
 
-**Command-line interface for the Sentron API**
+**Command-line interface for the Sentron Platform**
+
+[![npm version](https://img.shields.io/npm/v/sentron-cli.svg)](https://www.npmjs.com/package/sentron-cli)
+[![License](https://img.shields.io/badge/license-proprietary-blue.svg)](https://sentron.dev/terms)
 
 ---
 
@@ -15,7 +18,7 @@
 ## Installation
 
 ```bash
-# Run directly with npx
+# Run directly with npx (no install required)
 npx sentron-cli auth signin
 
 # Or install globally
@@ -23,6 +26,27 @@ npm install -g sentron-cli
 sentron auth signin
 ```
 
+## Quick Start
+
+```bash
+# 1. Sign in with your email
+sentron auth signin
+
+# 2. Create an organization
+sentron org create --name "My Team"
+
+# 3. Create an app
+sentron app create <org-id> --name "Production"
+
+# 4. Invite team members
+sentron org invites create <org-id> --email teammate@example.com
+
+# 5. Check your usage metrics
+sentron metrics summary
+```
+
+---
+
 ## Commands
 
 ### Authentication
@@ -51,13 +75,13 @@ sentron auth signout
 sentron auth api-key create
 
 # Create with options
-sentron auth api-key create --name "My Key" --expires 30
+sentron auth api-key create --name "Production" --expires 90
 
 # List all API keys
 sentron auth api-key list
 
 # Revoke an API key
-sentron auth api-key revoke <id>
+sentron auth api-key revoke <key-id>
 ```
 
 ### OAuth Clients
@@ -73,9 +97,277 @@ sentron auth oauth-client create --name "ChatGPT Integration"
 sentron auth oauth-client list
 
 # Delete an OAuth client
-sentron auth oauth-client delete <id>
+sentron auth oauth-client delete <client-id>
+```
+
+---
+
+### Organizations
+
+```bash
+# List your organizations
+sentron org list
+sentron org ls                    # alias
+
+# Create a new organization
+sentron org create --name "My Team"
+sentron org create --name "My Team" --description "Our company workspace"
+
+# Get organization details
+sentron org get <org-id-or-slug>
+sentron org show <org-id-or-slug>  # alias
+
+# Update organization
+sentron org update <org-id> --name "New Name"
+sentron org update <org-id> --website "https://example.com"
+
+# Delete organization (requires confirmation)
+sentron org delete <org-id>
+sentron org delete <org-id> --force  # skip confirmation
+
+# Transfer ownership
+sentron org transfer <org-id> <new-owner-user-id>
+```
+
+#### Organization Members
+
+```bash
+# List members
+sentron org members list <org-id>
+
+# Update member role (owner, admin, manager, member)
+sentron org members update-role <org-id> <user-id> admin
+
+# Remove member
+sentron org members remove <org-id> <user-id>
+```
+
+#### Organization Invitations
+
+```bash
+# List pending invitations
+sentron org invites list <org-id>
+
+# Invite someone
+sentron org invites create <org-id> --email user@example.com
+sentron org invites create <org-id> --email user@example.com --role admin
+
+# Batch invite (up to 50 at once)
+sentron org invites batch <org-id> --emails "a@ex.com,b@ex.com,c@ex.com"
+sentron org invites batch <org-id> --emails "a@ex.com,b@ex.com" --role manager
+sentron org invites batch <org-id> --file invites.csv  # CSV: email,role
+
+# Cancel invitation
+sentron org invites cancel <org-id> <invitation-id>
+
+# Resend invitation (resets expiration)
+sentron org invites resend <org-id> <invitation-id>
+```
+
+#### Join Requests
+
+```bash
+# List pending join requests
+sentron org requests list <org-id>
+
+# Request to join an organization
+sentron org requests create <org-id>
+sentron org requests create <org-id> --message "Hi, I'd like to join!"
+
+# Approve join request
+sentron org requests approve <org-id> <request-id>
+
+# Reject join request
+sentron org requests reject <org-id> <request-id>
 ```
 
+#### Organization Logo
+
+```bash
+# Upload a logo
+sentron org logo upload <org-id> ./logo.png
+
+# Remove logo
+sentron org logo remove <org-id>
+```
+
+#### Organization Audit Logs
+
+```bash
+# List activity logs
+sentron org audit-logs list <org-id>
+sentron org activity list <org-id>  # alias
+
+# Filter by action
+sentron org audit-logs list <org-id> --action org.member.added
+
+# Filter by date range
+sentron org audit-logs list <org-id> --from 2026-01-01 --to 2026-01-31
+
+# Output as JSON
+sentron org audit-logs list <org-id> --json
+```
+
+---
+
+### Apps
+
+```bash
+# List apps in an organization
+sentron app list <org-id>
+
+# Create a new app
+sentron app create <org-id> --name "Production"
+
+# Get app details
+sentron app get <app-id>
+
+# Update app
+sentron app update <app-id> --name "New Name"
+
+# Delete app (requires confirmation)
+sentron app delete <app-id>
+sentron app delete <app-id> --force  # skip confirmation
+```
+
+#### App Members
+
+```bash
+# List app members
+sentron app members list <app-id>
+
+# Add member (must be org member first)
+sentron app members add <app-id> <user-id>
+sentron app members add <app-id> <user-id> --role app_admin
+
+# Update member role (app_admin, app_member, app_viewer)
+sentron app members update-role <app-id> <user-id> app_admin
+
+# Remove member
+sentron app members remove <app-id> <user-id>
+```
+
+#### App Invitations
+
+```bash
+# List pending invitations
+sentron app invites list <app-id>
+
+# Invite someone (auto-invites to org if not a member)
+sentron app invites create <app-id> --email user@example.com
+sentron app invites create <app-id> --email user@example.com --role app_admin
+
+# Batch invite (up to 50 at once)
+sentron app invites batch <app-id> --emails "a@ex.com,b@ex.com"
+sentron app invites batch <app-id> --file invites.csv  # CSV: email,role,organizationRole
+
+# Cancel invitation
+sentron app invites cancel <app-id> <invitation-id>
+
+# Resend invitation
+sentron app invites resend <app-id> <invitation-id>
+```
+
+#### App Join Requests
+
+```bash
+# List join requests
+sentron app requests list <app-id>
+
+# Request to join an app
+sentron app requests create <app-id>
+
+# Approve (assign role)
+sentron app requests approve <app-id> <request-id> --role app_member
+
+# Reject
+sentron app requests reject <app-id> <request-id>
+```
+
+#### App Audit Logs
+
+```bash
+# List app activity logs
+sentron app audit-logs list <app-id>
+
+# Filter and output as JSON
+sentron app audit-logs list <app-id> --action app.updated --json
+```
+
+---
+
+### Billing
+
+```bash
+# Get billing status for an organization
+sentron org billing status <org-id>
+
+# Add payment method (opens Stripe checkout)
+sentron org billing add-payment <org-id>
+
+# Open billing portal
+sentron org billing portal <org-id>
+
+# Get subscription details for an app type
+sentron org billing subscription <org-id> data_studio
+
+# Subscribe to a tier (starter, team, platform)
+sentron org billing subscribe <org-id> data_studio team
+sentron org billing subscribe <org-id> data_studio team --interval monthly
+
+# Preview plan change (see prorated amount)
+sentron org billing preview <org-id> data_studio platform
+
+# Confirm plan change
+sentron org billing change <org-id> data_studio platform
+
+# Cancel subscription
+sentron org billing cancel <org-id> data_studio
+sentron org billing cancel <org-id> data_studio --immediate  # immediate with prorated refund
+
+# Reactivate a subscription set to cancel
+sentron org billing reactivate <org-id> data_studio
+
+# Check if you can create a new app (tier limits)
+sentron org billing can-create-app <org-id> data_studio
+```
+
+---
+
+### Notifications
+
+```bash
+# List your notifications
+sentron notifications list
+sentron notifications ls  # alias
+
+# Filter unread only
+sentron notifications list --unread
+
+# Mark notification as read
+sentron notifications read <notification-id>
+
+# Mark all as read
+sentron notifications read-all
+
+# Delete a notification
+sentron notifications delete <notification-id>
+```
+
+#### Notification Preferences
+
+```bash
+# Get your notification preferences
+sentron notifications prefs
+
+# Update preferences
+sentron notifications prefs set --email-enabled true
+sentron notifications prefs set --email-billing false
+sentron notifications prefs set --email-security true
+```
+
+---
+
 ### Metrics
 
 ```bash
@@ -84,43 +376,131 @@ sentron metrics summary
 
 # View detailed metrics
 sentron metrics get
-
-# View metrics for specific time period
 sentron metrics get --days 7
 
+# Get time-series data for charts
+sentron metrics time-series --days 30
+
+# Get API key usage breakdown
+sentron metrics api-keys
+
+# Get metrics for a specific API key
+sentron metrics api-key <key-id>
+
 # Output as JSON
 sentron metrics get --json
 ```
 
+---
+
+### Mailing List
+
+```bash
+# Check subscription status
+sentron mailing-list status
+sentron ml status  # short alias
+
+# Subscribe to updates
+sentron mailing-list subscribe
+sentron ml sub  # short alias
+
+# Unsubscribe from updates
+sentron mailing-list unsubscribe
+sentron ml unsub  # short alias
+```
+
+---
+
 ### Documentation
 
 ```bash
 # Search across all documentation
 sentron docs search <query>
-
-# Search with JSON output
-sentron docs search oauth --json
+sentron docs search "authentication"
+sentron docs search "oauth" --json
 
 # Get full documentation by URL(s)
-sentron docs get /docs/api/docs-search
-
-# Get multiple documentation items
-sentron docs get /docs/api/docs-search /docs/changelogs/2025/12/23/230000
+sentron docs get /docs/platform/api/docs-search
+sentron docs get /docs/platform/api/docs-search /docs/changelogs/2025/12/23/230000
 
 # Output as JSON
-sentron docs get /docs/api/docs-search --json
+sentron docs get /docs/platform/api/docs-search --json
+```
+
+---
+
+### Health & Status
+
+```bash
+# Check system health
+sentron health
+
+# Detailed health check
+sentron health --verbose
+```
+
+---
+
+### Invitations (Your Pending Invitations)
+
+```bash
+# List invitations you've received
+sentron invitations list
+sentron invitations ls  # alias
+
+# Filter by type
+sentron invitations list --type organization
+sentron invitations list --type app
+
+# Accept an invitation
+sentron invitations accept <invitation-id>
+
+# Decline an invitation
+sentron invitations decline <invitation-id>
+```
+
+---
+
+## Global Options
+
+All commands support these options:
+
+```bash
+--json       # Output as JSON (where applicable)
+--help       # Show help for a command
 ```
 
+## JSON Output
+
+Most commands support `--json` for scripting and CI/CD pipelines:
+
+```bash
+sentron org list --json | jq '.[0].id'
+sentron metrics get --json > metrics.json
+```
 
 ## Configuration
 
 The CLI stores credentials in `~/.sentron/token`.
 
+```bash
+# Clear stored credentials
+rm ~/.sentron/token
+
+# Or just sign out
+sentron auth signout
+```
+
+---
+
 ## Links
 
-- Website: https://sentron.dev
-- Documentation: https://sentron.dev/docs
+- **Website:** https://sentron.dev
+- **Documentation:** https://sentron.dev/docs
+- **API Reference:** https://sentron.dev/docs/platform/api
+- **MCP Reference:** https://sentron.dev/docs/platform/mcp
+- **Status:** https://sentron.dev/status
 
 ## License
 
-Proprietary - All rights reserved. See https://sentron.dev for terms.
+Proprietary - All rights reserved. See https://sentron.dev/terms for terms.