postgresai 0.14.0-beta.2 → 0.14.0-beta.4

package/README.md

@@ -29,10 +29,10 @@ brew install postgresai
 
 ## Usage
 
-The CLI provides three command aliases:
+The `postgresai` package provides two command aliases:
 ```bash
-postgres-ai --help
-postgresai --help
+postgresai --help   # Canonical, discoverable
+pgai --help         # Short and convenient
 ```
 
 You can also run it without installing via `npx`:
@@ -41,26 +41,34 @@ You can also run it without installing via `npx`:
 npx postgresai --help
 ```
 
-## init (create monitoring user in Postgres)
+### Optional shorthand: `pgai`
 
-This command creates (or updates) the `postgres_ai_mon` user and grants the permissions described in the root `README.md` (it is idempotent).
+If you want `npx pgai ...` as a shorthand for `npx postgresai ...`, install the separate `pgai` wrapper package:
+
+```bash
+npx pgai --help
+```
+
+## prepare-db (create monitoring user in Postgres)
+
+This command creates (or updates) the `postgres_ai_mon` user, creates the required view(s), and grants the permissions described in the root `README.md` (it is idempotent). Where supported, it also enables observability extensions described there.
 
 Run without installing (positional connection string):
 
 ```bash
-npx postgresai init postgresql://admin@host:5432/dbname
+npx postgresai prepare-db postgresql://admin@host:5432/dbname
 ```
 
-It also accepts libpq “conninfo” syntax:
+It also accepts libpq "conninfo" syntax:
 
 ```bash
-npx postgresai init "dbname=dbname host=host user=admin"
+npx postgresai prepare-db "dbname=dbname host=host user=admin"
 ```
 
 And psql-like options:
 
 ```bash
-npx postgresai init -h host -p 5432 -U admin -d dbname
+npx postgresai prepare-db -h host -p 5432 -U admin -d dbname
 ```
 
 Password input options (in priority order):
@@ -74,7 +82,7 @@ By default, the generated password is printed **only in interactive (TTY) mode**
 Optional permissions (RDS/self-managed extras from the root `README.md`) are enabled by default. To skip them:
 
 ```bash
-npx postgresai init postgresql://admin@host:5432/dbname --skip-optional-permissions
+npx postgresai prepare-db postgresql://admin@host:5432/dbname --skip-optional-permissions
 ```
 
 ### Print SQL / dry run
@@ -82,7 +90,7 @@ npx postgresai init postgresql://admin@host:5432/dbname --skip-optional-permissi
 To see what SQL would be executed (passwords redacted by default):
 
 ```bash
-npx postgresai init postgresql://admin@host:5432/dbname --print-sql
+npx postgresai prepare-db postgresql://admin@host:5432/dbname --print-sql
 ```
 
 ### Verify and password reset
@@ -90,13 +98,13 @@ npx postgresai init postgresql://admin@host:5432/dbname --print-sql
 Verify that everything is configured as expected (no changes):
 
 ```bash
-npx postgresai init postgresql://admin@host:5432/dbname --verify
+npx postgresai prepare-db postgresql://admin@host:5432/dbname --verify
 ```
 
 Reset monitoring user password only (no other changes):
 
 ```bash
-npx postgresai init postgresql://admin@host:5432/dbname --reset-password --password 'new_password'
+npx postgresai prepare-db postgresql://admin@host:5432/dbname --reset-password --password 'new_password'
 ```
 
 ## Quick start
@@ -117,17 +125,17 @@ This will:
 
 Start monitoring with demo database:
 ```bash
-postgres-ai mon quickstart --demo
+postgresai mon local-install --demo
 ```
 
 Start monitoring with your own database:
 ```bash
-postgres-ai mon quickstart --db-url postgresql://user:pass@host:5432/db
+postgresai mon local-install --db-url postgresql://user:pass@host:5432/db
 ```
 
 Complete automated setup with API key and database:
 ```bash
-postgres-ai mon quickstart --api-key your_key --db-url postgresql://user:pass@host:5432/db -y
+postgresai mon local-install --api-key your_key --db-url postgresql://user:pass@host:5432/db -y
 ```
 
 This will:
@@ -144,22 +152,22 @@ This will:
 #### Service lifecycle
 ```bash
 # Complete setup with various options
-postgres-ai mon quickstart                                  # Interactive setup for production
-postgres-ai mon quickstart --demo                           # Demo mode with sample database
-postgres-ai mon quickstart --api-key <key>                  # Setup with API key
-postgres-ai mon quickstart --db-url <url>                   # Setup with database URL
-postgres-ai mon quickstart --api-key <key> --db-url <url>   # Complete automated setup
-postgres-ai mon quickstart -y                               # Auto-accept all defaults
+postgresai mon local-install                                  # Interactive setup for production
+postgresai mon local-install --demo                           # Demo mode with sample database
+postgresai mon local-install --api-key <key>                  # Setup with API key
+postgresai mon local-install --db-url <url>                   # Setup with database URL
+postgresai mon local-install --api-key <key> --db-url <url>   # Complete automated setup
+postgresai mon local-install -y                               # Auto-accept all defaults
 
 # Service management
-postgres-ai mon start                  # Start monitoring services
-postgres-ai mon stop                   # Stop monitoring services
-postgres-ai mon restart [service]      # Restart all or specific monitoring service
-postgres-ai mon status                 # Show monitoring services status
-postgres-ai mon health [--wait <sec>]  # Check monitoring services health
+postgresai mon start                  # Start monitoring services
+postgresai mon stop                   # Stop monitoring services
+postgresai mon restart [service]      # Restart all or specific monitoring service
+postgresai mon status                 # Show monitoring services status
+postgresai mon health [--wait <sec>]  # Check monitoring services health
 ```
 
-##### Quickstart options
+##### local-install options
 - `--demo` - Demo mode with sample database (testing only, cannot use with --api-key)
 - `--api-key <key>` - Postgres AI API key for automated report uploads
 - `--db-url <url>` - PostgreSQL connection URL to monitor (format: `postgresql://user:pass@host:port/db`)
@@ -167,21 +175,21 @@ postgres-ai mon health [--wait <sec>]  # Check monitoring services health
 
 #### Monitoring target databases (`mon targets` subgroup)
 ```bash
-postgres-ai mon targets list                       # List databases to monitor
-postgres-ai mon targets add <conn-string> <name>   # Add database to monitor
-postgres-ai mon targets remove <name>              # Remove monitoring target
-postgres-ai mon targets test <name>                # Test target connectivity
+postgresai mon targets list                       # List databases to monitor
+postgresai mon targets add <conn-string> <name>   # Add database to monitor
+postgresai mon targets remove <name>              # Remove monitoring target
+postgresai mon targets test <name>                # Test target connectivity
 ```
 
 #### Configuration and maintenance
 ```bash
-postgres-ai mon config                         # Show monitoring configuration
-postgres-ai mon update-config                  # Apply configuration changes
-postgres-ai mon update                         # Update monitoring stack
-postgres-ai mon reset [service]                # Reset service data
-postgres-ai mon clean                          # Cleanup artifacts
-postgres-ai mon check                          # System readiness check
-postgres-ai mon shell <service>                # Open shell to monitoring service
+postgresai mon config                         # Show monitoring configuration
+postgresai mon update-config                  # Apply configuration changes
+postgresai mon update                         # Update monitoring stack
+postgresai mon reset [service]                # Reset service data
+postgresai mon clean                          # Cleanup artifacts
+postgresai mon check                          # System readiness check
+postgresai mon shell <service>                # Open shell to monitoring service
 ```
 
 ### MCP server (`mcp` group)
@@ -241,16 +249,16 @@ postgresai issues view <issueId> > issue.json
 
 #### Grafana management
 ```bash
-postgres-ai mon generate-grafana-password      # Generate new Grafana password
-postgres-ai mon show-grafana-credentials       # Show Grafana credentials
+postgresai mon generate-grafana-password      # Generate new Grafana password
+postgresai mon show-grafana-credentials       # Show Grafana credentials
 ```
 
 ### Authentication and API key management
 ```bash
-postgres-ai auth               # Authenticate via browser (recommended)
-postgres-ai add-key <key>      # Manually store API key
-postgres-ai show-key           # Show stored key (masked)
-postgres-ai remove-key         # Remove stored key
+postgresai auth                    # Authenticate via browser (OAuth)
+postgresai auth --set-key <key>    # Store API key directly
+postgresai show-key                # Show stored key (masked)
+postgresai remove-key              # Remove stored key
 ```
 
 ## Configuration