@skyreve/reve 1.0.3 → 1.0.5

package/README.md

@@ -1,6 +1,6 @@
 # Reve - SkyReve Platform Command Line Tool
 
-Reve is a command line tool that connects the SkyReve platform with GitHub repositories to manage projects and environments seamlessly.
+Reve is a comprehensive command line tool that connects the SkyReve platform with GitHub repositories to manage projects, environments, and deployments seamlessly. It provides a complete workflow for syncing local development with cloud environments.
 
 ## 📋 Table of Contents
 
@@ -11,6 +11,7 @@ Reve is a command line tool that connects the SkyReve platform with GitHub repos
 5. [Using Reve CLI](#5-using-reve-cli)
 6. [Development Tools](#6-development-tools)
 7. [Publishing to npm](#7-publishing-to-npm)
+8. [Project Structure](#8-project-structure)
 
 ---
 
@@ -302,6 +303,30 @@ reve env deploy
 reve env deploy --force
 ```
 
+### **5.6 Advanced Features**
+
+#### **🔹 File Generation**
+
+The `reve env sync` command automatically generates the following files in your project:
+
+- **Settings**: `src/settings.yaml` - Project configuration
+- **Tables**: `src/tables/*.yaml` - Database table definitions
+- **APIs**: `src/apis/*.yaml` + `src/apis/*.apy` - API endpoint definitions and view code
+- **Libraries**: `src/libs/*.apy` - Code library implementations
+
+#### **🔹 Environment Management**
+
+- **Multiple Environments**: Support for dev, staging, production environments
+- **Branch Linking**: Link specific Git branches to Reve environments
+- **Auto Deploy**: Configure automatic deployment on Git push
+- **Conflict Resolution**: Handle deployment conflicts with force option
+
+#### **🔹 GitHub Integration**
+
+- **Device Flow Authentication**: Secure GitHub login without storing passwords
+- **GitHub App Installation**: Automated GitHub App setup for repositories
+- **Repository Linking**: Connect GitHub repositories to SkyReve projects
+
 ---
 
 ## **6. Development Tools**
@@ -394,6 +419,7 @@ npm version major
    ```
 
 3. **Publish to npm**:
+
    ```bash
    npm publish
    ```
@@ -488,39 +514,73 @@ npm unpublish @skyreve/reve@version
 ```
 reve-cli/
 ├── cmd/                    # Command definitions
-│   ├── root.go            # Root command
-│   ├── start.go           # Complete setup start command
-│   ├── login.go           # Login command
-│   ├── project.go         # Project selection command
-│   ├── env.go             # Environment management command
-│   ├── github.go          # GitHub related commands
+│   ├── root.go            # Root command with logging and config
+│   ├── start.go           # Complete setup start command (6-step process)
+│   ├── login.go           # SkyReve platform login with email/password
+│   ├── project.go         # Project selection/creation
+│   ├── env.go             # Environment management command group
+│   ├── github.go          # GitHub related commands group
 │   ├── env/               # Environment management sub-commands
-│   │   ├── start.go       # Environment management start
-│   │   ├── info.go        # Project info check
-│   │   ├── list.go        # Environment list
-│   │   ├── link.go        # Branch linking
-│   │   ├── sync.go        # Synchronization
-│   │   ├── deploy.go      # Deployment
-│   │   └── common.go      # Common functions
+│   │   ├── start.go       # Interactive environment management
+│   │   ├── info.go        # Project and environment information
+│   │   ├── list.go        # List all environments with branch info
+│   │   ├── link.go        # Link GitHub branch to environment
+│   │   ├── sync.go        # Sync files (settings, tables, APIs, libs)
+│   │   ├── deploy.go      # Deploy to environment
+│   │   └── common.go      # Common environment functions
 │   └── github/            # GitHub sub-commands
-│       ├── login.go       # GitHub login
+│       ├── login.go       # GitHub Device Flow authentication
 │       └── install.go     # GitHub App installation
 ├── internal/              # Internal packages
-│   ├── config/           # Configuration management
-│   ├── constants/        # Constant definitions
-│   ├── git/              # Git related functionality
-│   ├── github/           # GitHub API
-│   ├── logger/           # Logging
-│   └── reve/             # Reve API and utilities
+│   ├── api/              # SkyReve API client and data structures
+│   ├── config/           # Configuration management (.reve directory)
+│   ├── constants/        # Application constants
+│   ├── gen/              # File generation (YAML files for tables, APIs, etc.)
+│   ├── git/              # Git repository operations
+│   ├── github/           # GitHub API client
+│   ├── http/             # HTTP client utilities
+│   ├── logger/           # Logging system
+│   ├── reve/             # SkyReve platform utilities
+│   └── cmd_common/       # Common command utilities
 ├── scripts/              # Node.js wrapper scripts
-│   └── reve.js           # Main wrapper script
-├── bin/                  # Built binaries
-├── main.go               # Main entry point
+│   └── reve.js           # Cross-platform binary launcher
+├── bin/                  # Built binaries (platform-specific)
+├── samples/              # Example files and configurations
+├── tests/                # Test files
+├── main.go               # Application entry point
 ├── package.json          # npm package configuration
 ├── go.mod               # Go module definition
+├── Makefile             # Build and development commands
 └── README.md           # This file
 ```
 
+### **8.1 Key Components**
+
+#### **🔹 Command Structure**
+
+- **Cobra Framework**: Modern CLI framework with subcommands and flags
+- **Persistent Flags**: Global logging and configuration options
+- **Command Groups**: Organized commands (`env`, `github`)
+
+#### **🔹 Configuration Management**
+
+- **`.reve` Directory**: Local configuration storage
+- **Multi-Environment**: Support for dev/staging/production configs
+- **Secure Storage**: Encrypted token storage
+
+#### **🔹 File Generation System**
+
+- **YAML Configuration**: Human-readable configuration files for settings, tables, and API definitions
+- **APY Implementation**: Actual implementation code files for APIs and libraries
+- **Modular Structure**: Separate files for tables, APIs, libraries
+- **Template System**: Consistent file generation across environments
+
+#### **🔹 GitHub Integration**
+
+- **Device Flow**: Secure OAuth without password storage
+- **App Installation**: Automated GitHub App setup
+- **Repository Linking**: Connect repos to SkyReve projects
+
 ---
 
 ## **9. Requirements**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyreve/reve",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Reve - A command line tool for Reve platform",
   "main": "index.js",
   "scripts": {