Skip to content

Commit

Permalink
feat(cli): Add license management
Browse files Browse the repository at this point in the history
- Implemented license activation, status check, and deactivation commands.
- Added usage tracking and quota limits for free tier.
- Updated documentation and help messages.
- Improved error handling and reporting.
  • Loading branch information
imprvhub committed Jan 21, 2025
1 parent a2e683b commit b2e962e
Show file tree
Hide file tree
Showing 4 changed files with 398 additions and 111 deletions.
40 changes: 37 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<br>
<br>
<h3>
GitSet CLI - Command Line Interface Commit Message Generation with AI-Driven Analysis
GitSet CLI - AI-Driven Commit Message Generation
</h3>
</div>

Expand All @@ -27,6 +27,8 @@ The GitSet CLI enhances repository management through:
- **Style Adaptation**: Analyzes existing commit patterns to match personal or team commit message conventions
- **Efficient Processing**: Provides rapid analysis and suggestion generation while maintaining minimal resource utilization
- **Cross-Platform Architecture**: Ensures consistent operation across various operating systems and environments
- **License Management**: Flexible licensing system with both free and pro tiers for different usage needs
- **Usage Tracking**: Built-in monitoring of API usage and license status

## System Requirements

Expand Down Expand Up @@ -65,6 +67,20 @@ gitset suggest --mode custom
git commit -m "generated_message"
```

### License Management

Activate your GitSet license:
```bash
# Activate with license key
gitset activate <license-key>

# Check license status and usage
gitset status

# Remove current license
gitset deactivate
```

### Operational Modes

#### Semantic Mode (Default Implementation)
Expand Down Expand Up @@ -107,16 +123,33 @@ FEATURE_126: Implemented user preferences 🎯

### Command Structure

Primary command:
Available commands:
- `gitset suggest` - Initiates commit message generation based on staged changes
- `gitset activate` - Activates GitSet with a license key
- `gitset status` - Checks current license status and usage
- `gitset deactivate` - Removes current license configuration
- `gitset help` - Displays detailed usage information

### Available Parameters

For suggest command:
- `--mode <mode>` - Specifies generation mode ('semantic' or 'custom')
- `--commit-count <count>` - Defines number of commits to analyze (default: 20)
- `--version` - Displays CLI version information
- `--help` - Provides command usage information

## Plans and Pricing

- **Basic (Free)**
- 10 requests per month
- Basic commit message generation
- Semantic and custom modes support

- **Pro**
- Unlimited requests
- Advanced features and priority support
- Visit https://gitset.dev/pricing for details

## Development Contribution

We welcome contributions to enhance the GitSet CLI. Please follow these steps:
Expand Down Expand Up @@ -145,6 +178,7 @@ This project operates under the Mozilla Public License 2.0 - refer to [LICENSE.m
- Technical Support: support@gitset.dev
- Contact Form: https://gitset.dev/contact
- Issue Tracking: https://github.com/gitset-dev/gitset-cli/issues
- Account Management: https://gitset.dev/account

## Acknowledgments

Expand All @@ -154,4 +188,4 @@ This project operates under the Mozilla Public License 2.0 - refer to [LICENSE.m

---

Part of the [GitSet.dev](https://gitset.dev) ecosystem - Smart AI Documentation & Version Control for GitHub Repositories.
Part of the [GitSet.dev](https://gitset.dev) ecosystem - Smart AI Documentation & Version Control for GitHub Repositories.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@gitset-dev/cli",
"version": "1.1.0",
"version": "1.2.1",
"description": "Generate semantic commit messages using AI-driven analysis of staged code changes.",
"main": "src/index.js",
"type": "module",
Expand Down
Loading

0 comments on commit b2e962e

Please sign in to comment.