sphereai-cli 1.0.3 → 1.0.5

package/README.md

@@ -1,219 +1,106 @@
 # SphereAI CLI
 
-A command-line interface tool for interacting with the SphereAI API.
-
-## Features
-
-- **Key-Based Authentication** - Authenticate using UserChannelKey (recommended)
-- **OAuth2 Authentication** - Secure browser-based authentication flow with local callback server (legacy)
-- **JWT Token Management** - Secure token storage with automatic user info extraction from token payload
-- **File Tracking** - Git-like file tracking system with .sphereignore support
-- **Multiple Output Formats** - JSON and table formats for all commands
-- **Environment Override** - Support for environment variables and command-line options
-- **Offline User Info** - User information extracted from JWT token (no API calls needed)
+Official command-line interface for interacting with SphereAI services.
 
 ## Installation
 
-### From npm (Global Installation)
-
 ```bash
 npm install -g sphereai-cli
 ```
 
-### From Source
-
-```bash
-# Clone the repository
-git clone <repository-url>
-cd SphereAI.CLI
-
-# Install dependencies
-npm install
-
-# Build the project
-npm run build
-
-# Link globally for local development
-npm link
-```
-
 ## Quick Start
 
-### 1. Configure API URLs
-
-Set the required API URLs using environment variables:
-
-```bash
-# Main API URL (for prompts and other resources)
-export SPHEREAI_API_URL=https://api.develop.sphereai.nava.com.br
-
-# CLI API URL (for key-based authentication)
-export SPHEREAI_CLI_API_URL=https://cli.api.develop.sphereai.nava.com.br
-```
-
-Or create a `.env` file in your project directory:
-
-```bash
-# Main API URL (for prompts and other resources after authentication)
-SPHEREAI_API_URL=https://api.develop.sphereai.nava.com.br
-
-# CLI API URL (for key-based authentication)
-SPHEREAI_CLI_API_URL=https://cli.api.develop.sphereai.nava.com.br
+### 1. Authenticate
 
-# OAuth2 URL (for legacy OAuth authentication)
-SPHEREAI_AUTH_URL=http://localhost:3000/login?callback=http://localhost:3001/callback
-SPHEREAI_OAUTH_CALLBACK_PORT=3001
-```
-
-### 2. Authentication
-
-#### Option A: UserChannelKey Authentication (Recommended)
-
-Authenticate using your UserChannelKey:
+Login using your UserChannelKey (provided by your administrator):
 
 ```bash
 sphereai auth login YOUR_USER_CHANNEL_KEY
 ```
 
-This will:
-1. Send your key to the CLI API endpoint `https://cli.api.develop.sphereai.nava.com.br/api/v1/Auth`
-2. Receive a JWT token and user information
-3. Save the token securely to `~/.config/sphereai-cli/config.json`
-4. Display user and channel information
-
-Example response:
-```
-✔ Successfully authenticated!
-✓ Logged in as: John Doe
-ℹ Channel: Production Channel
-ℹ Token expires in: 3600 seconds
-ℹ Token expiration: 1/13/2025, 10:00:00 AM
-```
-
-#### Option B: OAuth2 Flow (Legacy)
-
-For legacy OAuth2 authentication:
-
-```bash
-export SPHEREAI_AUTH_URL=https://your-auth-url.com/authorize
-sphereai auth login-oauth
-```
-
-This will:
-1. Open your browser to the authorization page
-2. Start a local callback server on port 3001
-3. Save the token securely to `~/.config/sphereai-cli/config.json`
-
-#### Option C: Manual Token Setting
-
-If you already have a JWT token:
-
-```bash
-sphereai auth set-token YOUR_JWT_TOKEN
-```
-
-### 3. Verify Authentication
+### 2. Verify Authentication
 
 ```bash
 sphereai auth whoami
 ```
 
-This command extracts your user information directly from the JWT token payload (no API call required), displaying:
-- User ID
-- Channel ID
-- Name
-- Channel Name
-- Role
-- Account creation date
+### 3. Start Using
+
+You're ready to use SphereAI CLI commands.
 
 ## Commands
 
-### Authentication Commands
+### Authentication
 
 | Command | Description |
 |---------|-------------|
-| `sphereai auth login <key>` | Authenticate using UserChannelKey (recommended) |
-| `sphereai auth login-oauth` | Authenticate using OAuth2 flow (legacy) |
-| `sphereai auth logout` | Clear stored credentials |
-| `sphereai auth whoami` | Display current user information |
-| `sphereai auth set-token <token>` | Manually set authentication token |
+| `sphereai auth login <key>` | Authenticate with your UserChannelKey |
+| `sphereai auth logout` | Sign out and clear stored credentials |
+| `sphereai auth whoami` | Display your current user information |
 | `sphereai auth config` | Display current configuration |
 
-#### Authentication Examples
+**Examples:**
 
 ```bash
-# Authenticate with UserChannelKey (recommended)
+# Login
 sphereai auth login YOUR_USER_CHANNEL_KEY
 
-# OAuth2 login (legacy - requires SPHEREAI_AUTH_URL)
-sphereai auth login-oauth
-
-# Set token manually
-sphereai auth set-token YOUR_JWT_TOKEN
-
-# Check current user
+# Check who you are logged in as
 sphereai auth whoami
 
-# Check current user (with JSON output)
+# View as JSON
 sphereai auth whoami --output json
 
-# View configuration
-sphereai auth config
-
-# Logout (clear stored token)
+# Logout
 sphereai auth logout
 ```
 
-### File Management Commands
+### File Management
+
+Track files for use with SphereAI services. Works similar to git staging.
 
 | Command | Description |
 |---------|-------------|
-| `sphereai files add [path]` | Add files to tracking (defaults to current directory) |
+| `sphereai files add [path]` | Add files to tracking |
 | `sphereai files list` | List all tracked files |
 | `sphereai files remove <path>` | Remove a file from tracking |
-| `sphereai files clear` | Clear all tracked files |
+| `sphereai files clear --force` | Clear all tracked files |
 | `sphereai files status` | Show status of tracked files |
-| `sphereai files ignore` | Show .sphereignore patterns |
+| `sphereai files ignore` | Show current ignore patterns |
 
-#### File Management Examples
+**Examples:**
 
 ```bash
-# Add all files from current directory (respects .sphereignore)
+# Add all files from current directory
 sphereai files add .
 
 # Add a specific file
-sphereai files add src/index.ts
+sphereai files add myfile.txt
 
-# Add files from a specific directory
+# Add files from a directory
 sphereai files add src/
 
 # List tracked files
 sphereai files list
 
-# List tracked files with details
+# List with details (size, date)
 sphereai files list --verbose
 
-# Show status of tracked files
+# Check status
 sphereai files status
 
 # Remove a file from tracking
-sphereai files remove src/index.ts
+sphereai files remove myfile.txt
 
-# Clear all tracked files (with confirmation)
+# Clear all tracked files
 sphereai files clear --force
-
-# Show .sphereignore patterns
-sphereai files ignore
-
-# Reload .sphereignore patterns
-sphereai files ignore --reload
 ```
 
-#### .sphereignore File
+### .sphereignore File
 
-The `.sphereignore` file works similar to `.gitignore`. Create a `.sphereignore` file in your project root to specify patterns for files that should be ignored when adding files to tracking.
+Create a `.sphereignore` file in your project root to exclude files from tracking. It works like `.gitignore`.
 
-**Example .sphereignore:**
+**Example `.sphereignore`:**
 
 ```gitignore
 # Dependencies
@@ -223,14 +110,14 @@ node_modules/
 dist/
 build/
 
-# Environment variables
+# Environment files
 .env
 .env.*
 
 # Logs
 *.log
 
-# IDE
+# IDE files
 .vscode/
 .idea/
 
@@ -238,292 +125,62 @@ build/
 .DS_Store
 ```
 
-**Pattern Syntax:**
-
-- Use `#` for comments
-- Directory patterns: `node_modules/`
-- Wildcard patterns: `*.log`, `*.env.*`
-- Exact matches: `.DS_Store`
-
-If no `.sphereignore` file exists, the following default patterns are used:
-
-- `node_modules`, `.git`, `dist`, `build`
-- `.env`, `.env.*`, `*.log`
-- `.DS_Store`, `coverage`, `.vscode`, `.idea`
-
-## Global Options
-
-All commands support these global options:
-
-| Option | Description | Environment Variable |
-|--------|-------------|---------------------|
-| `--token <token>` | Override stored authentication token | `SPHEREAI_TOKEN` |
-| `--output <format>` | Output format: `json` or `table` | - |
-
-## Environment Variables
-
-| Variable | Description | Required | Default |
-|----------|-------------|----------|---------|
-| `SPHEREAI_API_URL` | Main API URL for resources (prompts, etc.) | Yes | - |
-| `SPHEREAI_CLI_API_URL` | CLI API URL for key-based authentication | Yes (for login) | - |
-| `SPHEREAI_TOKEN` | Override stored authentication token | No | - |
-| `SPHEREAI_AUTH_URL` | OAuth2 authorization URL (legacy) | No | - |
-| `SPHEREAI_OAUTH_CALLBACK_PORT` | OAuth2 callback port (legacy) | No | 3001 |
-
-### Examples
-
-```bash
-# Set required environment variables
-export SPHEREAI_API_URL="https://api.develop.sphereai.nava.com.br"
-export SPHEREAI_CLI_API_URL="https://cli.api.develop.sphereai.nava.com.br"
-
-# Use custom token
-sphereai --token YOUR_TOKEN auth whoami
-
-# JSON output
-sphereai auth whoami --output json
-```
-
-## Configuration
-
-### Configuration File
-
-The CLI stores configuration in: `~/.config/sphereai-cli/config.json`
-
-This file contains:
-- JWT authentication token
-- API base URL
-- OAuth2 authorization URL
-- OAuth callback port (default: 3000)
-
-**Note**: User information is extracted from the JWT token payload when needed, so it's always up-to-date with your current token.
-
-### View Configuration
-
-```bash
-sphereai auth config
-```
-
-### Clear Configuration
-
-```bash
-sphereai auth logout
-```
+If no `.sphereignore` file exists, common patterns are ignored by default (node_modules, .git, dist, build, .env, etc.).
 
 ## Output Formats
 
-### Table Format (Default)
-
-Human-readable formatted tables with colors.
-
-```bash
-sphereai auth whoami
-```
-
-### JSON Format
-
-Machine-readable JSON output for scripting and automation.
-
-```bash
-sphereai auth whoami --output json
-```
-
-## Error Handling
-
-The CLI provides clear error messages for common issues:
-
-- **401 Unauthorized**: Authentication required or token expired
-- **403 Forbidden**: Insufficient permissions
-- **404 Not Found**: Resource does not exist
-- **400 Bad Request**: Validation errors with detailed field information
-- **500 Internal Server Error**: Server-side issues
-
-### Debug Mode
-
-Enable debug output for troubleshooting:
+All commands support two output formats:
 
 ```bash
-DEBUG=1 sphereai auth whoami
-```
-
-## Examples
-
-### Complete Authentication Workflow
-
-```bash
-# 1. Set API URLs (in .env file or environment variables)
-export SPHEREAI_API_URL=https://api.develop.sphereai.nava.com.br
-export SPHEREAI_CLI_API_URL=https://cli.api.develop.sphereai.nava.com.br
-
-# 2. Authenticate using UserChannelKey
-sphereai auth login YOUR_USER_CHANNEL_KEY
-
-# 3. Check authentication
+# Table format (default) - human readable
 sphereai auth whoami
 
-# 4. View configuration
-sphereai auth config
-
-# 5. Use JSON output
+# JSON format - for scripting
 sphereai auth whoami --output json
-
-# 6. Logout when done
-sphereai auth logout
-```
-
-### Scripting with JSON Output
-
-```bash
-#!/bin/bash
-
-# Get current user info as JSON
-user=$(sphereai auth whoami --output json)
-
-# Parse with jq (requires jq to be installed)
-user_id=$(echo "$user" | jq -r '.id')
-user_email=$(echo "$user" | jq -r '.email')
-user_role=$(echo "$user" | jq -r '.role')
-
-echo "User ID: $user_id"
-echo "Email: $user_email"
-echo "Role: $user_role"
 ```
 
-## Development
-
-### Prerequisites
-
-- Node.js >= 14.0.0
-- npm or yarn
-
-### Setup
-
-```bash
-# Install dependencies
-npm install
-
-# Build
-npm run build
-
-# Development mode (watch for changes)
-npm run dev
-
-# Link for local testing
-npm link
-```
-
-### Project Structure
-
-```
-src/
-├── commands/                    # CLI command implementations
-│   ├── auth.ts                 # Authentication commands
-│   ├── prompts.ts              # Prompt management commands
-│   └── files.ts                # File tracking commands
-├── services/                    # Core services
-│   ├── api-client.ts           # HTTP client wrapper
-│   ├── cli-api-client.ts       # CLI auth API client
-│   ├── auth-service.ts         # OAuth2 flow handler
-│   ├── config-service.ts       # Configuration management
-│   └── file-tracking-service.ts # File tracking management
-├── types/                       # TypeScript type definitions
-│   └── api-types.ts            # API type definitions
-├── utils/                       # Utility functions
-│   ├── formatters.ts           # Output formatting
-│   ├── errors.ts               # Error handling
-│   └── sphereignore.ts         # .sphereignore parser
-└── index.ts                     # CLI entry point
-```
+## Global Options
 
-### Building
+| Option | Description |
+|--------|-------------|
+| `--output <format>` | Output format: `table` (default) or `json` |
+| `--help` | Show help for any command |
+| `--version` | Show CLI version |
 
-```bash
-# Clean build directory
-npm run clean
-
-# Compile TypeScript
-npm run build
+## Configuration
 
-# The compiled output will be in the dist/ directory
-```
+Your credentials are stored securely in your user configuration directory. Use `sphereai auth config` to view the current configuration.
 
 ## Troubleshooting
 
-### Port Already in Use
+### Token Expired
 
-If OAuth2 callback port (3000) is in use:
+Re-authenticate with your UserChannelKey:
 
 ```bash
-# The error message will suggest closing other instances
-# Or you can change the port in config (future enhancement)
+sphereai auth login YOUR_USER_CHANNEL_KEY
 ```
 
-### Token Expired
+### Clear All Data
 
 ```bash
-# Re-authenticate
-sphereai auth login --email user@example.com --password secret
+sphereai auth logout
 ```
 
-### Authentication Issues
+### Check Your Configuration
 
 ```bash
-# Check current configuration
 sphereai auth config
-
-# Clear all authentication data and reconfigure
-sphereai auth logout
-sphereai auth set-auth-url https://your-auth-url.com/authorize
-sphereai auth login
 ```
 
-### Clear Configuration
+## Requirements
 
-```bash
-# Logout to clear all stored data
-sphereai auth logout
-```
+- Node.js 14.0.0 or higher
 
-## Contributing
+## Support
 
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Run tests and build
-5. Submit a pull request
+For issues and questions, please contact your SphereAI administrator.
 
 ## License
 
 ISC
-
-## Support
-
-For issues and questions, please refer to your SphereAI system administrator.
-
-## Security
-
-### JWT Token Storage
-The CLI stores JWT tokens in your local configuration file (`~/.config/sphereai-cli/config.json`). The token contains encoded user information that is decoded locally when needed.
-
-### Token Claims
-The JWT token includes the following claims that are used by the CLI:
-- `sub` - User ID
-- `customer_id` - Customer ID
-- `unique_name` - User name
-- `email` - User email
-- `role` - User role (Admin/User)
-- `iat` - Issued at timestamp
-- `exp` - Expiration timestamp
-
-The `whoami` command decodes these claims locally without making API calls, providing instant user information display.
-
-## Changelog
-
-### Version 1.0.0
-- Initial release
-- OAuth2 authentication support with browser-based flow
-- JWT token-based user information (decoded locally)
-- Credential-based authentication
-- Token management (set, view, clear)
-- JSON and table output formats
-- Comprehensive error handling with user-friendly messages

package/dist/index.js

@@ -13,12 +13,13 @@ const prompts_1 = require("./commands/prompts");
 const files_1 = require("./commands/files");
 const config_service_1 = require("./services/config-service");
 const api_client_1 = require("./services/api-client");
+const package_json_1 = __importDefault(require("../package.json"));
 // Create the main CLI program
 const program = new commander_1.Command();
 program
     .name('sphereai')
     .description('CLI tool for interacting with the SphereAI API')
-    .version('1.0.0')
+    .version(package_json_1.default.version)
     .option('--token <token>', 'Override stored authentication token')
     .hook('preAction', (thisCommand) => {
     // Handle global options before any command runs
@@ -86,13 +87,6 @@ Examples:
 Configuration:
   Config file location: ~/.config/sphereai-cli/config.json
   View config: sphereai auth config
-
-Environment Variables:
-  SPHEREAI_API_URL - Main API URL for resources (required)
-  SPHEREAI_CLI_API_URL - CLI API URL for key-based auth (required for login)
-  SPHEREAI_TOKEN - Override stored token
-  SPHEREAI_AUTH_URL - OAuth2 URL (for legacy login-oauth)
-  SPHEREAI_OAUTH_CALLBACK_PORT - OAuth2 callback port (default: 3001)
 `);
 // Parse command line arguments
 program.parse(process.argv);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AACA,oDAA4B;AAE5B,4CAA4C;AAC5C,gBAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAE/B,yCAAoC;AACpC,0CAAuD;AACvD,gDAA6D;AAC7D,4CAAyD;AACzD,8DAA0D;AAC1D,sDAAkD;AAGlD,8BAA8B;AAC9B,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,UAAU,CAAC;KAChB,WAAW,CAAC,gDAAgD,CAAC;KAC7D,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CAAC,iBAAiB,EAAE,sCAAsC,CAAC;KACjE,IAAI,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;IACjC,gDAAgD;IAChD,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;IAEhC,+BAA+B;IAC/B,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,8BAAa,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED,6BAA6B;IAC7B,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,sBAAS,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;SAAM,CAAC;QACN,mBAAmB;QACnB,MAAM,WAAW,GAAG,8BAAa,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,WAAW,EAAE,CAAC;YAChB,sBAAS,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,0BAA0B;AAC1B,IAAA,2BAAoB,EAAC,OAAO,CAAC,CAAC;AAC9B,IAAA,iCAAuB,EAAC,OAAO,CAAC,CAAC;AACjC,IAAA,6BAAqB,EAAC,OAAO,CAAC,CAAC;AAE/B,oBAAoB;AACpB,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiD5B,CAAC,CAAC;AAEH,+BAA+B;AAC/B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5B,mCAAmC;AACnC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,OAAO,CAAC,UAAU,EAAE,CAAC;AACvB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AACA,oDAA4B;AAE5B,4CAA4C;AAC5C,gBAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAE/B,yCAAoC;AACpC,0CAAuD;AACvD,gDAA6D;AAC7D,4CAAyD;AACzD,8DAA0D;AAC1D,sDAAkD;AAClD,mEAA0C;AAG1C,8BAA8B;AAC9B,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,UAAU,CAAC;KAChB,WAAW,CAAC,gDAAgD,CAAC;KAC7D,OAAO,CAAC,sBAAW,CAAC,OAAO,CAAC;KAC5B,MAAM,CAAC,iBAAiB,EAAE,sCAAsC,CAAC;KACjE,IAAI,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;IACjC,gDAAgD;IAChD,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;IAEhC,+BAA+B;IAC/B,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,8BAAa,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED,6BAA6B;IAC7B,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,sBAAS,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;SAAM,CAAC;QACN,mBAAmB;QACnB,MAAM,WAAW,GAAG,8BAAa,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,WAAW,EAAE,CAAC;YAChB,sBAAS,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,0BAA0B;AAC1B,IAAA,2BAAoB,EAAC,OAAO,CAAC,CAAC;AAC9B,IAAA,iCAAuB,EAAC,OAAO,CAAC,CAAC;AACjC,IAAA,6BAAqB,EAAC,OAAO,CAAC,CAAC;AAE/B,oBAAoB;AACpB,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0C5B,CAAC,CAAC;AAEH,+BAA+B;AAC/B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5B,mCAAmC;AACnC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,OAAO,CAAC,UAAU,EAAE,CAAC;AACvB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sphereai-cli",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "CLI tool for interacting with the SphereAI API",
   "main": "dist/index.js",
   "bin": {