buildx-cli 1.0.3 → 1.0.4

package/README.md

@@ -1,16 +1,22 @@
 # BuildX CLI
 
-A command-line interface tool for BuildX API with authentication and schema synchronization capabilities.
+A command-line interface tool for BuildX API with authentication, project management, and schema synchronization capabilities.
 
 ## Features
 
-- **Authentication Management**: Store and manage API tokens securely
-- **Schema Synchronization**: Generate TypeScript types from API schema
-- **Project Management**: Handle multiple project configurations
-- **Interactive CLI**: User-friendly command-line interface
+- **🔐 Authentication Management**: Secure login/logout with token validation
+- **📁 Project Management**: List, set default, and manage multiple projects
+- **🔄 Schema Synchronization**: Generate TypeScript types from API schema
+- **⚙️ Configuration Management**: Store settings or use environment variables
+- **🎯 Interactive CLI**: User-friendly command-line interface with prompts
 
 ## Installation
 
+### Using npx (Recommended)
+```bash
+npx buildx-cli --help
+```
+
 ### Global Installation
 ```bash
 npm install -g buildx-cli
@@ -20,105 +26,167 @@ npm install -g buildx-cli
 ```bash
 git clone <repository-url>
 cd buildx-cli
-npm install
-npm run build
+yarn install
+yarn build
+yarn start --help
+```
+
+## Quick Start
+
+1. **Configure API settings:**
+   ```bash
+   npx buildx-cli config:setup
+   ```
+
+2. **Authenticate:**
+   ```bash
+   npx buildx-cli auth:login
+   ```
+
+3. **List projects:**
+   ```bash
+   npx buildx-cli projects:list
+   ```
+
+4. **Sync schema:**
+   ```bash
+   npx buildx-cli schema:sync --project-id <project-id>
+   ```
+
+## Configuration
+
+### Method 1: Interactive Setup
+```bash
+npx buildx-cli config:setup
 ```
 
-## Usage
+### Method 2: Environment Variables
+Set these environment variables or add them to a `.env` file:
 
-### Authentication
+```bash
+BUILDX_API_ENDPOINT=https://api.example.com
+BUILDX_API_KEY=your-api-key
+BUILDX_PROJECT_ID=your-default-project-id
+```
 
-#### Login with token
+### Method 3: Command Line Options
 ```bash
-buildx login --token <your-api-token>
+npx buildx-cli config:setup --endpoint https://api.example.com --api-key your-api-key
 ```
 
-#### Interactive login
+### View Current Configuration
+```bash
+npx buildx-cli config:show
+```
+
+### Clear Configuration
+```bash
+npx buildx-cli config:clear
+```
+
+## Commands
+
+### Authentication Commands
+
+#### Login
 ```bash
-buildx login
+npx buildx-cli auth:login
 ```
+Interactive login with username/password or token.
 
 #### Logout
 ```bash
-buildx logout
+npx buildx-cli auth:logout
 ```
+Clear stored authentication.
 
-#### Check authentication status
+#### Check Status
 ```bash
-buildx auth:status
+npx buildx-cli auth:status
 ```
+Display authentication status and user information.
 
-### Schema Synchronization
+### Project Management Commands
 
-#### Sync schema for a project
+#### List Projects
 ```bash
-buildx sync --project-id <project-id>
+npx buildx-cli projects:list
 ```
+Display all available projects.
 
-#### Sync schema with custom output path
+#### Set Default Project
 ```bash
-buildx sync --project-id <project-id> --output ./src/types/generated.ts
+npx buildx-cli projects:set-default <project-id>
 ```
+Set the default project for operations.
 
-#### Sync schema with custom API base URL
+#### Show Current Project
 ```bash
-buildx sync --project-id <project-id> --api-url https://custom-api.example.com
+npx buildx-cli projects:current
 ```
+Display the currently selected default project.
 
-### Project Management
+### Schema Synchronization Commands
 
-#### List projects
+#### Sync Schema
 ```bash
-buildx projects:list
+npx buildx-cli schema:sync --project-id <project-id>
 ```
 
-#### Set default project
+#### Sync with Custom Output
 ```bash
-buildx projects:set-default <project-id>
+npx buildx-cli schema:sync --project-id <project-id> --output ./src/types/generated.ts
 ```
 
-#### Get current project
+#### Sync with Custom API URL
 ```bash
-buildx projects:current
+npx buildx-cli schema:sync --project-id <project-id> --api-url https://custom-api.example.com
 ```
 
-## Configuration
+### Configuration Commands
+
+#### Setup Configuration
+```bash
+npx buildx-cli config:setup
+```
+Interactive configuration setup.
 
-The CLI stores configuration in the following locations:
-- **Global config**: `~/.config/buildx-cli/config.json`
-- **Project config**: `./buildx.json` (optional)
-
-### Configuration File Structure
-
-```json
-{
-  "auth": {
-    "token": "your-api-token",
-    "expiresAt": "2024-01-01T00:00:00.000Z"
-  },
-  "projects": {
-    "default": "project-id",
-    "list": [
-      {
-        "id": "project-id",
-        "name": "Project Name",
-        "apiUrl": "https://api.bbb.com"
-      }
-    ]
-  },
-  "sync": {
-    "outputPath": "./generated/types.ts",
-  }
-}
+#### Show Configuration
+```bash
+npx buildx-cli config:show
 ```
+Display current configuration and sources.
+
+#### Clear Configuration
+```bash
+npx buildx-cli config:clear
+```
+Clear all stored configuration.
+
+## Configuration Sources
+
+The CLI checks for configuration in this order:
+
+1. **Stored Configuration** (via `config:setup`)
+2. **Environment Variables** (`BUILDX_API_ENDPOINT`, `BUILDX_API_KEY`)
+3. **`.env` File** (in current directory)
+
+### Configuration File Location
+- **Global config**: `~/.config/buildx-cli-nodejs/config.json`
+
+### Environment Variables
+- `BUILDX_API_ENDPOINT` - Your API endpoint URL
+- `BUILDX_API_KEY` - Your API key
+- `BUILDX_PROJECT_ID` - Default project ID (optional)
 
 ## API Endpoints
 
 The CLI interacts with the following API endpoints:
 
-- `GET /:project_id/collections/schema` - Fetch project schema
+- `POST /auth/login` - User authentication
+- `GET /auth/me` - Get current user info
 - `GET /projects` - List user projects
-- `POST /auth/validate` - Validate authentication token
+- `GET /project/:project_id/collections/schema` - Fetch project schema
 
 ## Development
 
@@ -127,6 +195,10 @@ The CLI interacts with the following API endpoints:
 ```
 src/
 ├── commands/          # CLI commands
+│   ├── auth/         # Authentication commands
+│   ├── config/       # Configuration commands
+│   ├── projects/     # Project management commands
+│   └── sync.ts       # Schema synchronization
 ├── services/          # Business logic services
 ├── types/            # TypeScript type definitions
 ├── utils/            # Utility functions
@@ -134,34 +206,50 @@ src/
 └── index.ts          # Main entry point
 ```
 
-### Building
+### Available Scripts
 
 ```bash
-npm run build
+yarn build          # Build the project
+yarn dev            # Run in development mode
+yarn start          # Run built version
+yarn test           # Run tests
+yarn lint           # Run linter
+yarn format         # Format code
 ```
 
-### Development Mode
+### Building
 
 ```bash
-npm run dev
+yarn build
 ```
 
-### Testing
+### Development Mode
 
 ```bash
-npm test
+yarn dev
 ```
 
-### Linting
+## Examples
 
+### CI/CD Pipeline
 ```bash
-npm run lint
-```
+# Set environment variables
+export BUILDX_API_ENDPOINT=https://api.example.com
+export BUILDX_API_KEY=$CI_API_KEY
+export BUILDX_PROJECT_ID=$CI_PROJECT_ID
 
-### Formatting
+# Run schema sync
+npx buildx-cli schema:sync --project-id $BUILDX_PROJECT_ID --output ./src/types/api.ts
+```
 
+### Local Development
 ```bash
-npm run format
+# Setup once
+npx buildx-cli config:setup
+
+# Use regularly
+npx buildx-cli projects:list
+npx buildx-cli schema:sync --project-id my-project
 ```
 
 ## Contributing