gent-cli 1.4.0 → 1.5.0

package/README.md

@@ -1,316 +1,142 @@
-# Gent CLI - A Git-like Version Control System
+# Gent CLI
 
-🚀 **Gent** is a lightweight, Git-inspired version control CLI tool built with Node.js. It provides essential version control features with an intuitive command-line interface.
+> A modern, Git-like version control CLI with built-in cloud authentication and global user identity management.
 
-## Features
+`gent` is a lightweight version control system that feels exactly like Git but handles user identity automatically through the cloud. No more configuring `user.name` and `user.email` for every repository!
 
-- **Repository Initialization** - Set up new Gent repositories with custom configuration
-- **File Staging** - Add files to staging area before committing
-- **Commit Management** - Record changes with descriptive messages
-- **Branch Operations** - Create, switch, and manage branches
-- **Status Tracking** - View working tree status and changes
-- **Commit History** - Browse commit logs with detailed information
+## 🚀 Features
 
-## Installation
+- **Cloud Authentication**: Login once, work everywhere. Your identity follows you across projects.
+- **Git-like Experience**: Familiar commands (`init`, `add`, `commit`, `status`, `log`, `branch`, `checkout`).
+- **Zero Configuration**: `gent init` is silent and auto-detects your authenticated user profile.
+- **Global Identity**: Commits are automatically authored with your cloud profile.
+- **Secure**: Tokens stored securely in your home directory.
 
-```bash
-# Navigate to the CLI directory
-cd apps/Cli
-
-# Install dependencies
-npm install
+## 📦 Installation
 
-# Link globally (optional)
-npm link
+```bash
+npm install -g gent-cli
 ```
 
-## Usage
+## 🔐 Authentication (The Magic mmss)
 
-### Initialize a Repository
+Gent uses a global authentication system. You only need to login once.
 
-Create a new Gent repository in the current directory:
+### Create an Account
 
 ```bash
-gent init
+gent register
 ```
 
-With default configuration (skip prompts):
+### Login
 
 ```bash
-gent init -y
+gent login
+# or
+gent login -e user@example.com -p YourPassword
 ```
 
 ### Check Status
 
-View the current state of your working tree:
-
 ```bash
-gent status
+gent whoami
 ```
 
-Short format:
+### Logout
 
 ```bash
-gent status -s
+gent logout
 ```
 
-### Stage Files
-
-Add files to the staging area:
-
-```bash
-# Add specific files
-gent add file1.js file2.js
-
-# Add all files
-gent add --all
-gent add .
-```
+## 🛠 Usage
 
-### Commit Changes
+### 1. Initialize a Repository
 
-Record changes to the repository:
+Just like Git, `gent init` is silent and sets up a new repository in your current directory. It automatically uses your logged-in identity for configuration.
 
 ```bash
-# With inline message
-gent commit -m "Your commit message"
-
-# Interactive (will prompt for message)
-gent commit
+gent init
+# Output: Initialized empty Gent repository in /path/to/project
 ```
 
-Auto-stage all modified files:
+### 2. Check Status
+
+See which files are modified or untracked.
 
 ```bash
-gent commit -a -m "Commit all changes"
+gent status
 ```
 
-### View Commit History
+### 3. Stage Files
 
-Display commit logs:
+Add files to the staging area.
 
 ```bash
-# Show last 10 commits (default)
-gent log
-
-# Show specific number of commits
-gent log -n 5
-
-# Compact oneline format
-gent log --oneline
+gent add filename.js
+# or add all files
+gent add .
 ```
 
-### Branch Management
+### 4. Commit Changes
 
-List all branches:
+Create a commit. Gent automatically fetches your name and email from your global login session.
 
 ```bash
-gent branch
+gent commit -m "Initial commit"
+# Output: [main a1b2c3d] Initial commit
+# Author: Your Name <your.email@example.com>
 ```
 
-Create a new branch:
-
-```bash
-gent branch feature-name
-```
+### 5. View History
 
-Delete a branch:
+See your commit history.
 
 ```bash
-gent branch -d branch-name
+gent log
+# or compact view
+gent log --oneline
 ```
 
-### Switch Branches
+## 🌿 Branching
 
-Switch to an existing branch:
+Manage branches just like you're used to.
 
 ```bash
-gent checkout branch-name
-```
-
-Create and switch to a new branch:
+# Create and switch to a new branch
+gent checkout -b feature-login
 
-```bash
-gent checkout -b new-branch
-```
+# List branches
+gent branch
 
-## Project Structure
+# Switch back to main
+gent checkout main
 
-```
-apps/Cli/
-├── src/
-│   ├── index.js              # Main entry point
-│   ├── commands/             # Command implementations
-│   │   ├── init.js          # Initialize repository
-│   │   ├── status.js        # Show status
-│   │   ├── add.js           # Stage files
-│   │   ├── commit.js        # Create commits
-│   │   ├── log.js           # View history
-│   │   ├── branch.js        # Manage branches
-│   │   └── checkout.js      # Switch branches
-│   └── utils/               # Utility modules
-│       ├── constants.js     # Application constants
-│       ├── fileSystem.js    # File operations
-│       └── helpers.js       # Helper functions
-├── package.json             # Dependencies and scripts
-└── README.md               # Documentation
+# Delete a branch
+gent branch -d feature-login
 ```
 
-## Repository Structure
+## 📂 Repository Structure
 
-When you initialize a Gent repository, it creates a `.gent` directory:
+Gent creates a `.gent` directory in your project root:
 
 ```
 .gent/
-├── config.json              # Repository configuration
-├── staging.json             # Staged files
-├── commits.json            # Commit history
-├── HEAD                    # Current branch reference
-├── objects/                # File objects (future use)
-└── refs/                   # Branch references
-    ├── heads/             # Branch pointers
-    └── tags/              # Tag references
-```
-
-## Configuration
-
-Gent stores configuration in `.gent/config.json`:
-
-```json
-{
-  "user": {
-    "name": "Your Name",
-    "email": "your.email@example.com"
-  },
-  "repository": {
-    "name": "project-name",
-    "description": "Project description",
-    "created": "2025-11-06T00:00:00.000Z"
-  }
-}
-```
-
-## Ignore Patterns
-
-Create a `.gentignore` file to exclude files from tracking:
-
-```
-# Dependencies
-node_modules/
-
-# Build outputs
-dist/
-build/
-
-# Environment files
-.env
-.env.local
-
-# Logs
-*.log
-
-# OS files
-.DS_Store
-```
-
-## Command Reference
-
-| Command | Description | Options |
-|---------|-------------|---------|
-| `gent init` | Initialize repository | `-y, --yes` Skip prompts |
-| `gent status` | Show working tree status | `-s, --short` Short format |
-| `gent add <files>` | Stage files | `-A, --all` Stage all files |
-| `gent commit` | Record changes | `-m <msg>` Message, `-a` Stage all |
-| `gent log` | Show commit history | `-n <num>` Limit, `--oneline` Compact |
-| `gent branch [name]` | Manage branches | `-d <name>` Delete, `-a` List all |
-| `gent checkout <branch>` | Switch branches | `-b` Create new |
-| `gent help [command]` | Show help | |
-
-## Dependencies
-
-- **commander** - CLI framework
-- **chalk** - Terminal styling
-- **inquirer** - Interactive prompts
-- **ora** - Elegant terminal spinners
-- **boxen** - Create boxes in terminal
-- **date-fns** - Date formatting utilities
-
-## Development
-
-```bash
-# Run locally
-npm start
-
-# Run specific command
-node src/index.js init
-node src/index.js status
+├── config.json       # Project configuration
+├── objects/          # Stored file contents
+├── refs/             # Branch pointers
+└── HEAD             # Current branch reference
 ```
 
-## Examples
+Your authentication tokens are stored globally in `~/.gent/auth.json`.
 
-### Complete Workflow
+## 🤝 Contributing
 
-```bash
-# Initialize repository
-gent init
+We welcome contributions! Please fork the repository and submit a Pull Request.
 
-# Add some files
-echo "console.log('Hello');" > app.js
-gent add app.js
-
-# Commit changes
-gent commit -m "Initial commit"
-
-# Create a feature branch
-gent branch feature-login
-gent checkout feature-login
-
-# Make changes and commit
-echo "// Login logic" >> app.js
-gent add app.js
-gent commit -m "Add login feature"
-
-# View history
-gent log
-
-# Switch back to main
-gent checkout main
-```
-
-## Error Handling
-
-Gent provides clear error messages:
-
-- **Not a gent repository** - Run `gent init` first
-- **No changes to commit** - Stage files with `gent add`
-- **Branch not found** - Check available branches with `gent branch`
-
-## Best Practices
-
-1. **Commit Often** - Make small, focused commits
-2. **Write Clear Messages** - Describe what and why
-3. **Use Branches** - Isolate features and experiments
-4. **Check Status** - Review changes before committing
-5. **Update .gentignore** - Exclude unnecessary files
-
-## Future Enhancements
-
-- [ ] Diff visualization
-- [ ] Remote repository support
-- [ ] Merge functionality
-- [ ] Tag management
-- [ ] Stash implementation
-- [ ] File restoration
-- [ ] Conflict resolution
-
-## License
+## 📄 License
 
 ISC
 
-## Author
-
-Built with ❤️ using Node.js
-
 ---
 
-**Note**: Gent is a learning project and educational tool. For production use, consider established version control systems like Git.
+Built with ❤️ by [Abdalrahman Kanawati](https://github.com/SaadShaya7)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gent-cli",
-  "version": "1.4.0",
-  "description": "A Git-like version control CLI tool with cloud authentication",
+  "version": "1.5.0",
+  "description": "A modern, Git-like version control CLI with built-in cloud authentication and global user identity management.",
   "main": "src/index.js",
   "bin": {
     "gent": "src/index.js"