{"id":18308701,"url":"https://github.com/devoctane/gitopus","last_synced_at":"2026-01-25T20:50:41.220Z","repository":{"id":257825944,"uuid":"872367614","full_name":"devoctane/gitopus","owner":"devoctane","description":"Committing made simple!","archived":false,"fork":false,"pushed_at":"2024-11-07T09:06:07.000Z","size":78,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-19T20:44:02.257Z","etag":null,"topics":["git","git-tools","gitoct","gitopus","octane","octopus"],"latest_commit_sha":null,"homepage":"https://www.devoctane.in/gitopus","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devoctane.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-14T10:11:19.000Z","updated_at":"2025-03-27T07:24:10.000Z","dependencies_parsed_at":"2025-04-05T17:42:32.511Z","dependency_job_id":null,"html_url":"https://github.com/devoctane/gitopus","commit_stats":null,"previous_names":["devoctane/gitoct"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/devoctane/gitopus","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devoctane%2Fgitopus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devoctane%2Fgitopus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devoctane%2Fgitopus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devoctane%2Fgitopus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devoctane","download_url":"https://codeload.github.com/devoctane/gitopus/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devoctane%2Fgitopus/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28758307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T20:20:48.599Z","status":"ssl_error","status_checked_at":"2026-01-25T20:20:31.796Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git","git-tools","gitoct","gitopus","octane","octopus"],"created_at":"2024-11-05T16:09:00.937Z","updated_at":"2026-01-25T20:50:41.204Z","avatar_url":"https://github.com/devoctane.png","language":"JavaScript","readme":"# Gitopus v2.0.5 stable\n\n![Gitopus Logo](https://octane-spaces.blr1.cdn.digitaloceanspaces.com/gitopus/images/gitopus.png)\n\n### **Gitopus** is an open-source command-line tool that leverages Google's Gemini AI to help generate meaningful commit messages and streamline your Git workflow through an interactive interface.\n\n## Features\n\n-   🤖 AI-powered commit message generation using Google's Gemini\n-   🎯 Interactive menu for choosing between AI-generated or manual commit messages\n-   📝 Conventional commit format support with predefined prefixes\n-   ⚡ Post-commit actions (push, status, log) for streamlined workflow\n-   ✨ Smart validation for commit message length and format\n-   🔄 Option to edit AI-generated messages before committing\n\n## Installation\n\nTo install **gitopus**, you need to have Node.js and npm (Node Package Manager) installed on your machine.\n\n1. **Install Node.js**: If you haven't already, download and install Node.js from [nodejs.org](https://nodejs.org/).\n\n2. **Install gitopus globally**: Open your terminal or command prompt and run:\n    ```bash\n    npm install -g gitopus\n    ```\n\n## Getting Started\n\n### Setting Up Your API Key\n\n1. **Get Your Gemini API Key**:\n\n    - Visit [Google AI Studio](https://makersuite.google.com/app/apikey)\n    - Sign in with your Google account\n    - Click on \"Create API Key\"\n    - Copy your new API key\n\n2. **First-Time Setup**:\n   When you first run Gitopus, it will automatically:\n    ```bash\n    gt\n    ```\n    You'll see:\n    ```\n    No API key found. Please enter your Gemini API key.\n    You can get an API key from: https://makersuite.google.com/app/apikey\n    ```\n3. **Enter Your API Key**:\n\n    - Paste your API key when prompted\n    - The key will be securely stored in `~/.gitopus/config.json`\n    - You won't need to enter it again on this machine\n\n4. **Verify Setup**:\n    - After entering your API key, you should see:\n    ```\n    API key stored successfully!\n    ```\n    - The tool will then proceed to the main menu\n\n### API Key Management\n\n-   **Location**: Your API key is stored in `~/.gitopus/config.json`\n-   **Update Key**: To update your API key, either:\n    -   Edit the config file directly\n    -   Delete the config file and run Gitopus again\n-   **Security**: Keep your API key secure and never share it\n\n## Usage\n\nOnce **gitopus** is installed and configured, follow these steps:\n\n1. Stage your changes in the Git repository:\n\n    ```bash\n    git add .\n    ```\n\n2. Run the command:\n\n    ```bash\n    gitopus\n    ```\n\n    or\n\n    ```bash\n    gitoct\n    ```\n\n    or\n\n    ```bash\n    gt\n    ```\n\n3. Choose your preferred method:\n    - **Generate commit message**: AI will analyze your changes and suggest commit messages\n    - **Custom commit message**: Manually create a commit with conventional prefixes\n    - **Exit**: Cancel the commit process\n\n### AI-Generated Commits\n\nWhen using the AI generation feature:\n\n1. The tool analyzes your staged changes\n2. Presents 5 AI-generated commit message options\n3. Select your preferred message\n4. Optionally edit the selected message\n5. Confirm and create the commit\n\n### Manual Commits\n\nFor manual commit creation:\n\n1. Select a conventional commit prefix (feat, fix, docs, etc.)\n2. Enter your commit message\n3. Review and confirm the complete commit message\n\n### Post-Commit Actions\n\nAfter committing, choose from:\n\n-   Push changes to remote repository\n-   View git status\n-   View latest commit in log\n-   Exit the tool\n\n## Configuration\n\nGitopus stores its configuration in `~/.gitopus/config.json`, including your API key. You can manually edit this file if needed.\n\n## Common Issues\n\n-   **No staged changes**: Ensure you've staged your changes with `git add`\n-   **API key issues**:\n    -   Make sure your API key is valid\n    -   Check if the config file exists at `~/.gitopus/config.json`\n    -   Try deleting the config file and entering the key again\n-   **Long commit messages**: Messages are limited to 70 characters for best practices\n\n## Contributing\n\nWe welcome contributions to **Gitopus**! Here's how you can help:\n\n### 1. Fork and Clone\n\n```bash\ngit clone https://github.com/devoctane/gitopus.git\ncd gitopus\n```\n\n### 2. Install Dependencies\n\n```bash\nnpm install\n```\n\n### 3. Make Changes\n\nCreate a new branch and make your changes:\n\n```bash\ngit checkout -b feature-name\n```\n\n### 4. Test\n\nEnsure your changes work as expected and add tests if necessary.\n\n### 5. Submit PR\n\n1. Push your changes to your fork\n2. Create a Pull Request with a clear description of your changes\n3. Wait for review and address any feedback\n\n## License\n\nMIT License - see LICENSE file for details\n\n---\n\nBuilt with ❤️ by Team Octane\n\nFor more information, check out the [Gitopus GitHub repository](https://github.com/devoctane/gitopus).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevoctane%2Fgitopus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevoctane%2Fgitopus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevoctane%2Fgitopus/lists"}