{"id":14673997,"url":"https://github.com/ribeirogab/commitfy","last_synced_at":"2025-05-15T17:32:18.368Z","repository":{"id":251691231,"uuid":"837738633","full_name":"ribeirogab/commitfy","owner":"ribeirogab","description":"Generating commits for you in 1 second using AI. ✨","archived":false,"fork":false,"pushed_at":"2024-11-28T15:46:38.000Z","size":460,"stargazers_count":10,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T12:52:11.871Z","etag":null,"topics":["ai","commit","git","productivity"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/commitfy","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ribeirogab.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-08-03T21:57:07.000Z","updated_at":"2024-12-20T18:45:16.000Z","dependencies_parsed_at":"2024-08-08T07:46:00.270Z","dependency_job_id":null,"html_url":"https://github.com/ribeirogab/commitfy","commit_stats":null,"previous_names":["ribeirogab/commitfy"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ribeirogab%2Fcommitfy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ribeirogab%2Fcommitfy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ribeirogab%2Fcommitfy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ribeirogab%2Fcommitfy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ribeirogab","download_url":"https://codeload.github.com/ribeirogab/commitfy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254388235,"owners_count":22063011,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["ai","commit","git","productivity"],"created_at":"2024-09-12T07:01:18.013Z","updated_at":"2025-05-15T17:32:17.748Z","avatar_url":"https://github.com/ribeirogab.png","language":"TypeScript","funding_links":[],"categories":["ai"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\".github/logo.png\" alt=\"commitfy\" width=\"180\"/\u003e\n\u003c/div\u003e\n\n# commitfy\n\n\u003e Generating **commits for you** in 1 second using AI. ✨\n\n## Description\n\n`commitfy` is a tool designed to help developers generate efficient and consistent commit messages using artificial intelligence. `commitfy` ensures that your commit messages follow established standards and are clear and informative.\n\n![Commitfy Example](.github/cfy-example.gif)\n\n## Installation\n\nInstall `commitfy` globally to use in any repository using npm:\n\n```bash\nnpm install -g commitfy\n```\n\n## Usage\n\nOnce installed, you can use the `commitfy` command or its alias `cfy` to interact with the tool.\n\n### Commands\n\n#### Initial Setup\n\nTo perform the initial setup configuration, run:\n\n```bash\ncfy setup\n```\n\nThis command will guide you through the necessary setup to use `commitfy`, such as choosing the AI provider and configuring API keys.\n\n#### Generate Commit Message\n\nTo generate a commit message using AI, simply run:\n\n```bash\ncfy\n```\n\n\u003e **Note:** Before generating a commit message, ensure you are in a repository with Git initialized and have files added to the stage using `git add`.\n\n#### Help\n\nIf you need assistance or want to see the available commands, run:\n\n```bash\ncommitfy --help\n```\n\nThis command will display a list of all available commands along with detailed descriptions.\n\n## Configuration\n\n### Configuration Files\n\n`commitfy` uses configuration files located in the `~/.commitfy` directory to manage its settings and behavior:\n\n- **`.env`**: This file contains all the necessary configurations for the app, such as API keys and other environment variables. You can edit this file to update your settings as needed.\n  \n- **`.commitfyignore`**: This file functions similarly to a `.gitignore` file. It is used to specify files and directories that should be ignored when generating commit messages. By customizing this file, you can control which changes are considered when `commitfy` creates a commit message.\n\n## AI Providers\n\n`commitfy` supports the following AI providers for generating commit messages:\n\n- **OpenAI**\n\n\u003e **Note:** Currently, we only support OpenAI, but we plan to add more providers in the future. If you have a suggestion for an AI provider, please [open an issue](https://github.com/ribeirogab/commitfy/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fribeirogab%2Fcommitfy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fribeirogab%2Fcommitfy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fribeirogab%2Fcommitfy/lists"}