Frequently Asked Questions

Find answers to common questions about GitSet.dev, our features, security, and usage guidelines.

General Information

GitSet.dev serves as a comprehensive platform that streamlines Git-related documentation processes. The platform offers tools for automated README generation, .gitignore file creation, semantic commit message generation, tags & releases management, repository assessment, code decommenter, dependencies handler, leveraging advanced AI technology to enhance developer workflows.
GitSet.dev currently offers the following features:

Public AI-Readme Generator: Automatically generates professional README.md files for any public repository by analyzing the project’s content. This feature, requiring OAuth authentication, creates comprehensive documentation, including project features, installation instructions, usage guidelines, and contribution rules. Users can request modifications to the initial output, receiving different versions based on specific needs. The tool also allows users to compare various versions, ensuring the README aligns with the repository's presentation and functional requirements.

Personal AI-Readme Generator: Generates customized README.md files for both public and private repositories owned by authenticated users (OAuth required). It produces detailed documentation by analyzing the repository's content and context, including key project details, installation steps, and usage instructions. Users can refine the generated output by requesting iterative adjustments, comparing different versions, and ensuring the final README reflects the repository’s unique requirements. This tool ensures that both public and private repositories receive personalized, professional documentation tailored to the user's needs.

.gitignore Builder: Helps users generate `.gitignore` files tailored to the specific languages, frameworks, and tools used in their project. By selecting relevant technologies, the tool combines the appropriate rules into a comprehensive and optimized `.gitignore` file, eliminating the need for manually searching templates. No authentication is required, and this tool streamlines the process of maintaining clean repositories, ensuring that unnecessary files are excluded from version control, making it ideal for multi-technology projects.

Commit Messages Generator: A command-line interface (CLI) tool that uses AI to generate accurate, context-sensitive commit messages based on staged changes in the repository. By leveraging semantic versioning and custom user-defined styles, the tool ensures commit messages follow consistent patterns. The AI-powered system adapts to existing commit histories, providing relevant messages that can be manually applied, ensuring both clarity and consistency across the project's commit logs. OAuth authentication is required for this feature to ensure secure and personalized service.

Tags & Releases Manager: Simplifies the creation, editing, and management of tags and releases within GitHub repositories. Users can generate and modify tags and releases with the help of AI-generated release notes, which accurately reflect changes made in the code. This tool ensures a streamlined, consistent process for versioning and release management, reducing manual effort. All actions are fully reversible through Git, providing users with full control. Manual confirmation is required for every operation, ensuring security and accuracy.

Code Decommenter: This tool automatically removes unnecessary comments from code, making it cleaner and more readable. It allows users to specify the types of comments to remove—whether single-line, multi-line, documentation, or pragma comments. The tool parses the code efficiently, ensuring that all functionality remains intact while removing clutter. This feature is particularly useful for preparing codebases for production, optimizing them for automated processing, and maintaining clean, manageable repositories. The tool does not directly modify repositories, leaving the implementation of changes to the user.

Dependencies Handler: Simplifies dependency management by analyzing codebases to identify external dependencies and organizing imports according to best practices. The tool generates configuration files required for dependency management, such as `requirements.txt`, `pom.xml`, `Cargo.toml`, and `CMakeLists.txt`, ensuring that dependencies are properly structured. It supports multiple programming languages, including Python, Java, C/C++, and Rust. By creating standardized, well-organized configuration files, it ensures that projects across different languages maintain proper dependencies, minimizing conflicts and streamlining the development process.

Repository Assessment Tool: Provides detailed analysis of a repository's structure, complexity, and resource requirements. This tool generates reports offering valuable insights into project planning, including cost estimation, time/resource allocation, and code quality assessments. It helps developers and project managers gain a deeper understanding of the repository's potential, identify areas for optimization, and make informed decisions regarding resource planning. Importantly, this tool does not modify the repository, ensuring that the analysis is safe and non-invasive.
Currently, all features of Gitset.dev are available at no cost. However, users on the 'basic' plan have certain limitations on some features as detailed below:

- AI README Generators: Maximum 10 requests/month
- Git Ignore Builder: Unlimited and free for all plans
- Tags & Releases Manager: Unlimited tag and release management, but automated release notes are limited to 10 requests/month
- Commit Messages Generator (CLI): Maximum 10 requests/month
- Code Decommenter: Maximum 10 requests/month
- Dependencies Handler: Maximum 10 requests/month
- Repository Assessment Tool: Maximum 5 requests/month

When an authenticated user subscribes to the 'pro' plan through Gitset.dev - Pricing, they will receive an email with all subscription details, including their license key. All subscription-related matters can be managed through Gitset.dev - Dashboard or their Lemon Squeezy portal.

The Gitset Pro Plan benefits include:
- All features of the Basic Plan with unlimited usage.

With the following resources:
- Priority Support
- CLI Troubleshooter
- Early Access to New Features

IMPORTANT: For the subscription to be fully activated, after the payment has been processed through Lemon Squeezy, the user must access their Dashboard. This will automatically activate their Pro subscription.

If you have any questions or concerns regarding subscriptions on Gitset.dev, please Contact Support for appropriate assistance.

Features and Usage

The following features require GitHub OAuth authentication:

1. Public & Personal AI-Readme Generators - These tools analyze repository content to generate detailed and tailored README.md files. Authentication is required to access private repositories and create custom documentation for both public and private projects.

2. Commit Messages Generator - This CLI tool analyzes changes in your repository and generates semantic commit messages based on best practices. OAuth authentication is required to access repository changes and provide relevant commit suggestions.

3. Tags & Releases Manager - This tool allows users to manage tags and releases, create new versions, and generate release notes. Authentication is necessary to modify and manage releases within your repositories.

4. Repository Assessment Tool - This tool evaluates the structure and complexity of a repository, providing detailed reports on project metrics such as development time, resource usage, and cost estimates. Authentication is needed to access repository data and generate accurate insights.

5. Code Decommenter - This tool removes unnecessary comments from your code to improve readability. Authentication is required to process and clean code by removing specified types of comments (single-line, multi-line, documentation, or pragma comments).

6. Dependencies Handler - This feature analyzes your codebase to identify dependencies and generate necessary configuration files, such as `requirements.txt`, `pom.xml`, and more. Authentication is necessary to access and manage dependencies from your repositories across various programming languages.

The feature .gitignore Builder can be used without authentication.
While GitSet.dev employs advanced AI technology to generate content, users should note that these features are experimental. The platform recommends reviewing and validating all AI-generated content before implementation. Users maintain full control over whether to implement or modify any AI-suggested content.

Security and Privacy

GitSet.dev collects minimal data necessary for authentication and service provision. The platform uses Google Gemini AI for text generation. For detailed information about data handling, please review the privacy policies of our technology partners:

- GitHub Privacy Statement
- Google Privacy Policy
- Gemini Privacy Notice
You can revoke access in two ways:
1. Through GitSet.dev: Visit our Settings page, go to "Connected Accounts", and click "Revoke GitHub Access".
2. Through GitHub: Visit GitHub's applications settings, find GitSet.dev, click the three dots, and select "Revoke".
GitSet.dev ensures your account and repositories are secure. Below is a detailed overview of the features available on the platform, their permissions, and their impact on your repositories:

Non-interactive features:
-Git Ignore Builder:
Generate comprehensive .gitignore files by selecting the languages, frameworks, and tools relevant to your codebase. This feature provides customizable templates, helping you create a tailored .gitignore file that ensures proper exclusions for your project—all without modifying or reading your repository.

Read-only Features:
-Public AI-README Generator:
Creates README.md files from public repositories by automatically generating concise documentation. This tool reads the contents of public repositories and generates suggestions based on the project details, but no changes are made to the repository itself.

-Personal AI-README Generator:
Similar to the public version, this tool generates README.md files but for your private repositories. It provides tailored documentation suggestions based on your repository’s content and is available only for repositories you own. No changes are made to the repository itself.

-Commit Message Generator:
GitSet CLI automatically generates semantic commit messages based on your code changes, streamlining the commit process. You can integrate it into your project by installing the GitSet CLI, allowing you to generate commit messages without manually writing them. This feature does not modify your repository or code. It only generates suggestions for you to review and apply as needed.

-Repository Assessment Tool:
This tool analyzes your repository's structure and provides insights into code complexity, development time, resource allocation, and cost estimates. It only reads your code, offering detailed reports and evaluations but does not make any changes to the repository itself.

Write-capable Features:
-Tags & Releases Manager:
This tool enables you to manage your project's versioning by creating, editing, and deleting tags and releases. When creating a release, you can opt to generate release notes using AI. If the generated notes are unsatisfactory, you can refine them by providing additional inputs, ensuring that the final notes meet your expectations. Each operation requires your explicit confirmation, and all actions are logged and can be undone using Git.

Important Notes:
- No code modifications or commits are made automatically; all operations remain under your control.
- The 'repo' OAuth scope is necessary to enable code analysis features and generate accurate suggestions. Without this scope, accurate suggestions cannot be provided, as limited scopes do not allow code inspection of private repositories.

For more information on GitHub OAuth scopes, visit the official GitHub documentation. To manage or revoke permissions, you can always visit the Settings page on GitSet.dev.

Technical Details

No, GitSet.dev does not store or retain any generated content (README files, commit messages, .gitignore files, tags, releases notes, code decommented, or repository assessments) beyond the immediate session. Once generated, content must be saved or implemented by the user as it will not be accessible after the session ends.
Yes, GitSet.dev supports branch-specific operations for authenticated features. You can generate README files, analyze commits, and use other tools across different branches of both public and private repositories. This flexibility allows you to maintain consistent documentation and commit messages across all branches of your projects.
The Gitset desktop application provides all the features of the web platform in a convenient standalone application. Here's how to install it on different operating systems:

Windows:
1. Visit our download page and download the Windows installer (.exe)
2. Open the downloaded file and follow the installation prompts
3. Windows may display a security warning - this is normal for community-developed software
4. Click "Run anyway" to proceed with installation
5. After installation, launch Gitset from your Start menu or desktop shortcut

macOS:
1. Visit our download page and download the macOS disk image (.dmg)
2. Open the downloaded file
3. Drag the Gitset application to your Applications folder
4. When launching for the first time, macOS may display a security warning
5. Open System Preferences > Security & Privacy, then click "Open Anyway"

Linux:
1. Visit our download page and choose either:
- Debian/Ubuntu (.deb): Download and install using `sudo dpkg -i gitset-desktop_[version]_amd64.deb`
- AppImage: Download, make executable with `chmod +x Gitset-[version].AppImage`, and run directly
2. Create a desktop shortcut if desired using your distribution's method

If you encounter any installation issues, please contact support@gitset.dev. For security concerns, please visit our contact page.

Payments and Subscriptions

Yes, GitSet.dev offers a 14-day trial period exclusively with the 'GitSet Pro (Monthly)' subscription plan. If users don't cancel before the trial period ends, the subscription will automatically convert to a paid plan at $2.99 USD per month with automatic renewal.

Users have the flexibility to cancel their subscription at any time during or after the trial period through the Lemon Squeezy Customer Portal.
Yes, the 'GitSet Pro (Annually)' subscription includes a 15% annual discount, bringing the total annual cost to $29.99 USD.

Please note that subscription prices may be subject to change as new features and functionalities are added to the platform. For detailed information about our pricing structure and potential changes, please refer to our Terms of Service.
GitSet.dev offers subscription plans designed to provide Users with access to a variety of features tailored to their specific needs. These subscription plans are exclusively managed by Lemon Squeezy, LLC, a trusted third-party provider responsible for subscription processing, payment handling, billing cycles, and related services.

Users can manage their orders, subscriptions, and request refunds through the Lemon Squeezy Customer Portal. All payment-related matters, including subscription management and refund requests, can be handled directly through the specific subscription within the Lemon Squeezy platform.

For more information about our partnership with Lemon Squeezy and how we handle payments and subscriptions, please visit our Terms of Service or Contact Support.