{"_id":"@arietta-studio/arietta-compass","_rev":"2-cc322e7bb7ecbab72d3f19529cb50014","name":"@arietta-studio/arietta-compass","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.1":{"name":"@arietta-studio/arietta-compass","version":"1.0.1","description":"Arietta Compass is a CLI tool that uses ChatGPT to generate Gitmoji-based commit messages","keywords":["ai","git","commit","openai","gpt","gitmoji-cli","git-commits","chatgpt","aicommit","ai-commit"],"homepage":"https://github.com/arietta-studio/arietta-tools/tree/master/packages/arietta-compass","bugs":{"url":"https://github.com/arietta-studio/arietta-tools/issues/new"},"repository":{"type":"git","url":"git+https://github.com/arietta-studio/arietta-tools.git"},"license":"MIT","author":{"name":"Arietta Studio","email":"info@arietta-studio.ai"},"sideEffects":false,"type":"module","imports":{"@":"./src"},"bin":{"acgit":"dist/cli.js","arietta-compass":"dist/cli.js"},"scripts":{"build":"bun run type-check && pkgroll --minify -p tsconfig.prod.json --env.NODE_ENV=production && bun run shebang","dev":"pkgroll -p tsconfig.prod.json --env.NODE_ENV=development --watch","link":"bun run build && bun link -f","shebang":"arietta-shebang -t ./dist/cli.js","start":"node ./dist/cli.js","test":"vitest --passWithNoTests","test:coverage":"vitest run --coverage --passWithNoTests","type-check":"tsc --noEmit"},"dependencies":{"@arietta-studio/arietta-cli-ui":"latest","@inkjs/ui":"^1","@langchain/core":"latest","@langchain/openai":"latest","chalk":"^5","commander":"^11","conf":"^12","dotenv":"^16","execa":"^8","fast-deep-equal":"^3","gitconfig":"^2","gpt-tokenizer":"^2","ink":"^4.2","langchain":"latest","lodash-es":"^4","octokit":"^3","pangu":"^4","path-exists":"^5","react":"^18","swr":"^2","update-notifier":"^7","zustand":"^4"},"peerDependencies":{"ink":">=4","react":">=18"},"engines":{"node":">=18"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"gitHead":"a2ba72b9014803e1a1947395bb35109544a79f44","_id":"@arietta-studio/arietta-compass@1.0.1","_nodeVersion":"20.2.0","_npmVersion":"lerna/8.1.2/node@v20.2.0+arm64 (darwin)","dist":{"integrity":"sha512-87OvsxNzUYo8J3JMHpue3LGahCqVDf7CY/8Ahy5VQt0IhviJaSYZH/SZ1Y+3khAgvsecQJtP7CtvqyrdnWAUoQ==","shasum":"268602aa20262aff9be5961beb4177f1297b5f4b","tarball":"https://registry.npmjs.org/@arietta-studio/arietta-compass/-/arietta-compass-1.0.1.tgz","fileCount":4,"unpackedSize":56342,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF4dQxmdN4IwePBoyMdwRwsI1AZ+3nQvoZktTMsOQAwKAiEAz2Go6ugOup6qesg0lKVjy/BLHjEJvWZQ2eGzg6aM7QA="}]},"_npmUser":{"name":"gince","email":"ruzauskas.gintaras@gmail.com"},"directories":{},"maintainers":[{"name":"gince","email":"ruzauskas.gintaras@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/arietta-compass_1.0.1_1711281782674_0.7353962450762495"},"_hasShrinkwrap":false},"1.0.2":{"name":"@arietta-studio/arietta-compass","version":"1.0.2","description":"Arietta Compass is a CLI tool that uses ChatGPT to generate Gitmoji-based commit messages","keywords":["ai","git","commit","openai","gpt","gitmoji-cli","git-commits","chatgpt","aicommit","ai-commit"],"homepage":"https://github.com/arietta-studio/arietta-tools/tree/master/packages/arietta-compass","bugs":{"url":"https://github.com/arietta-studio/arietta-tools/issues/new"},"repository":{"type":"git","url":"git+https://github.com/arietta-studio/arietta-tools.git"},"license":"MIT","author":{"name":"Arietta Studio","email":"info@arietta-studio.ai"},"sideEffects":false,"type":"module","imports":{"@":"./src"},"bin":{"acgit":"dist/cli.js","arietta-compass":"dist/cli.js"},"scripts":{"build":"npm run type-check && pkgroll --minify -p tsconfig.prod.json --env.NODE_ENV=production && npm run shebang","dev":"pkgroll -p tsconfig.prod.json --env.NODE_ENV=development --watch","link":"npm run build && npm link -f","shebang":"arietta-shebang -t ./dist/cli.js","start":"node ./dist/cli.js","test":"vitest --passWithNoTests","test:coverage":"vitest run --coverage --passWithNoTests","type-check":"tsc --noEmit"},"dependencies":{"@arietta-studio/arietta-cli-ui":"1.0.2","@inkjs/ui":"^1","@langchain/core":"latest","@langchain/openai":"latest","chalk":"^5","commander":"^11","conf":"^12","dotenv":"^16","execa":"^8","fast-deep-equal":"^3","gitconfig":"^2","gpt-tokenizer":"^2","ink":"^4.2","langchain":"latest","lodash-es":"^4","octokit":"^3","pangu":"^4","path-exists":"^5","react":"^18","swr":"^2","update-notifier":"^7","zustand":"^4"},"peerDependencies":{"ink":">=4","react":">=18"},"engines":{"node":">=18"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_id":"@arietta-studio/arietta-compass@1.0.2","gitHead":"230fadc687784e36898a4bb5c758981c47aa9473","_nodeVersion":"18.19.1","_npmVersion":"9.9.3","dist":{"integrity":"sha512-1rGxygT3dLXZsMtiitJqXp5+kguxUpvDT76BN1z/WWOEhFFesp3eMp51OinXS1/M2Fjq8ATCK8RBkWtWENCmWQ==","shasum":"2415fc78e06c6e82364b13138ae23ee6a85e0035","tarball":"https://registry.npmjs.org/@arietta-studio/arietta-compass/-/arietta-compass-1.0.2.tgz","fileCount":3,"unpackedSize":37385,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDnQXlhgTpPbTQKPeRuL1QvAgicZyLKp7b4uSCrC8yq/QIgKYXbx3AnRSb6a882lTBFCQ8hGgd5yzUgkjQPrz9ROWs="}]},"_npmUser":{"name":"gince","email":"ruzauskas.gintaras@gmail.com"},"directories":{},"maintainers":[{"name":"gince","email":"ruzauskas.gintaras@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/arietta-compass_1.0.2_1711284994851_0.9164141545281443"},"_hasShrinkwrap":false},"1.0.3":{"name":"@arietta-studio/arietta-compass","version":"1.0.3","description":"Arietta Compass is a CLI tool that uses ChatGPT to generate Gitmoji-based commit messages","keywords":["ai","git","commit","openai","gpt","gitmoji-cli","git-commits","chatgpt","aicommit","ai-commit"],"homepage":"https://github.com/arietta-studio/arietta-tools/tree/master/packages/arietta-compass","bugs":{"url":"https://github.com/arietta-studio/arietta-tools/issues/new"},"repository":{"type":"git","url":"git+https://github.com/arietta-studio/arietta-tools.git"},"license":"MIT","author":{"name":"Arietta Studio","email":"info@arietta-studio.ai"},"sideEffects":false,"type":"module","imports":{"@":"./src"},"bin":{"acgit":"dist/cli.js","arietta-compass":"dist/cli.js"},"scripts":{"build":"bun run type-check && pkgroll --minify -p tsconfig.prod.json --env.NODE_ENV=production && bun run shebang","dev":"pkgroll -p tsconfig.prod.json --env.NODE_ENV=development --watch","link":"bun run build && bun link -f","shebang":"arietta-shebang -t ./dist/cli.js","start":"node ./dist/cli.js","test":"vitest --passWithNoTests","test:coverage":"vitest run --coverage --passWithNoTests","type-check":"tsc --noEmit"},"dependencies":{"@arietta-studio/arietta-cli-ui":"1.0.3","@inkjs/ui":"^1","@langchain/core":"latest","@langchain/openai":"latest","chalk":"^5","commander":"^11","conf":"^12","dotenv":"^16","execa":"^8","fast-deep-equal":"^3","gitconfig":"^2","gpt-tokenizer":"^2","ink":"^4.2","langchain":"latest","lodash-es":"^4","octokit":"^3","pangu":"^4","path-exists":"^5","react":"^18","swr":"^2","update-notifier":"^7","zustand":"^4"},"peerDependencies":{"ink":">=4","react":">=18"},"engines":{"node":">=18"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_id":"@arietta-studio/arietta-compass@1.0.3","gitHead":"45f2f2a8a2805f1903164d106b14167d877062db","_nodeVersion":"18.19.1","_npmVersion":"9.9.3","dist":{"integrity":"sha512-GZqRFVsj24heSKMW9Vqz76GS+GIcZ6kw1TDt6ZCAA4UGXTZmeQYsle28Hj/S2ota41l8BLc9CtipKmKXc9yRVg==","shasum":"e9ca4c578c61c161318d4f5de8f79bab62353633","tarball":"https://registry.npmjs.org/@arietta-studio/arietta-compass/-/arietta-compass-1.0.3.tgz","fileCount":3,"unpackedSize":37384,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCynbCZ/YigKLyVPI7CVTSLvPppiaJozWcLDTd7byb4qAIhAPGUsIa+B86EX9/LiUCtm7sqZA6wbZMK1na9zds/b2rJ"}]},"_npmUser":{"name":"gince","email":"ruzauskas.gintaras@gmail.com"},"directories":{},"maintainers":[{"name":"gince","email":"ruzauskas.gintaras@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/arietta-compass_1.0.3_1711286831481_0.6617625564859715"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-24T12:03:02.578Z","1.0.1":"2024-03-24T12:03:02.817Z","modified":"2024-03-24T13:27:12.172Z","1.0.2":"2024-03-24T12:56:35.076Z","1.0.3":"2024-03-24T13:27:11.666Z"},"maintainers":[{"name":"gince","email":"ruzauskas.gintaras@gmail.com"}],"description":"Arietta Compass is a CLI tool that uses ChatGPT to generate Gitmoji-based commit messages","homepage":"https://github.com/arietta-studio/arietta-tools/tree/master/packages/arietta-compass","keywords":["ai","git","commit","openai","gpt","gitmoji-cli","git-commits","chatgpt","aicommit","ai-commit"],"repository":{"type":"git","url":"git+https://github.com/arietta-studio/arietta-tools.git"},"author":{"name":"Arietta Studio","email":"info@arietta-studio.ai"},"bugs":{"url":"https://github.com/arietta-studio/arietta-tools/issues/new"},"license":"MIT","readme":"
\n\n\n\n\n\n

Arietta Compass

\n\nArietta Compass is a CLI tool that uses ChatGPT to generate Gitmoji-based commit messages\n\n[Changelog](./CHANGELOG.md) Β· [Report Bug][issues-url] Β· [Request Feature][issues-url]\n\n[![][npm-release-shield]][npm-release-link]\n[![][github-releasedate-shield]][github-releasedate-link]\n[![][github-action-test-shield]][github-action-test-link]\n[![][github-action-release-shield]][github-action-release-link]
\n[![][github-contributors-shield]][github-contributors-link]\n[![][github-forks-shield]][github-forks-link]\n[![][github-stars-shield]][github-stars-link]\n[![][github-issues-shield]][github-issues-link]\n[![][github-license-shield]][github-license-link]\n\n![](https://gw.alipayobjects.com/zos/kitchen/3%26ByxtP39X/preview.webp)\n\n
\n\n
\nTable of contents\n\n#### TOC\n\n- [✨ Features](#-features)\n- [πŸ“¦ Installation](#-installation)\n- [🀯 Usage](#-usage)\n - [Git hook](#git-hook)\n - [Configuration](#configuration)\n - [Options](#options)\n- [⌨️ Local Development](#️-local-development)\n- [🀝 Contributing](#-contributing)\n- [πŸ”— Links](#-links)\n - [More Products](#more-products)\n - [Credits](#credits)\n\n####\n\n
\n\n## ✨ Features\n\n- [x] 🀯 Supports auto-generating commit messages based on diffs using ChatGPT\n- [x] πŸ› οΈ Supports streamlined commit message editing workflow\n- [x] 😜 Supports adding Gitmojis\n- [x] πŸ“ Supports Conventional Commits specification\n- [x] ⚑️ Supports pulling a list of issues and convenient binding\n- [x] πŸ’„ Supports custom prompts\n- [x] πŸ—ΊοΈ Supports multi-language commit messages\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## πŸ“¦ Installation\n\nTo install Arietta Compass, run the following command:\n\n```bash\nnpm install -g @arietta-studio/arietta-compass\n```\n\n> \\[!IMPORTANT]\\\n> Please make sure you have `Node.js` version **>= 18**\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## 🀯 Usage\n\nYou can use the `arietta-compass` command to generate a commit message for your staged changes:\n\n```shell\n$ git add \n$ arietta-compass\n```\n\n> \\[!NOTE]\\\n> Use the `acgit` alias if `arietta-compass` is too long for you.\n\n
\n\n#### AI mode\n\nWith AI mode, you can generate a complete commit message using ChatGPT.\n\n> \\[!IMPORTANT]\\\n> To use AI auto-generation, you need to fill in your OpenAI token in the settings by `arietta-compass -o`. and if you have special network requirements, you can add OpenAI's forwarding address in the settings.\n\n![](https://gw.alipayobjects.com/zos/kitchen/qmXcNvnjKf/preview-ai.webp)\n\n
\n\n#### Editor mode\n\nIn Editor mode, you can choose the `(): []` format by following a simple flow.\n\n> \\[!NOTE]\\\n> If your project is a GitHub repository, the Editor mode feature will automatically fetch the issues associated with your repository. You can select multiple issues to link to your commit message by space .\n\n![](https://gw.alipayobjects.com/zos/kitchen/QkJ5V8nbY6/preview-editor.webp)\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n### Git hook\n\nYou can integrate Arietta Compass with Git via the `prepare-commit-msg` hook. This allows you to use Git as you normally would and edit the commit message before committing.\n\n
\n\n#### Install\n\nTo install the hook in the Git repository, run the following command:\n\n```shell\n$ arietta-compass --init # or use short flag -i\n```\n\n
\n\n#### Uninstall\n\nTo uninstall the hook from the Git repository, run the following command:\n\n```shell\n$ arietta-compass --remove # or use short flag -r\n```\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n### Configuration\n\nTo configure Arietta Compass, run the following command:\n\n```shell\n$ arietta-compass --option # or use short flag -o\n```\n\n- To use AI auto-generation, you need to fill in your [OpenAI token](<(https://platform.openai.com/account/api-keys)>) in the settings.\n- To automatically pull private issues, you need to fill in your [GitHub token](https://github.com/settings/tokens) with repo permissions in the settings.\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n### Options\n\nArietta Compass supports the following options:\n\n```shell\n--commit -c Interactively commit using the prompts\n--option -o Setup arietta-compass preferences\n--help -h Print basic options\n--init -i Initialize arietta-compass as a commit hook\n--remove -r Remove a previously initialized commit hook\n--list -l List all the available commit type\n--version -v Print arietta-compass installed version\n```\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## ⌨️ Local Development\n\nYou can use Github Codespaces for online development:\n\n[![][github-codespace-shield]][github-codespace-link]\n\nOr clone it for local development:\n\n[![][bun-shield]][bun-link]\n\n```bash\n$ git clone https://github.com/arietta-studio/arietta-tools.git\n$ cd arietta-tools\n$ bun install\n$ cd packages/arietta-compass\n$ bun dev\n```\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n## 🀝 Contributing\n\nContributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what you’re made of.\n\n[![][pr-welcome-shield]][pr-welcome-link]\n\n[![][github-contrib-shield]][github-contrib-link]\n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n### Credits\n\n- **langchainjs** - \n- **ink** - \n- **gitmoji-commit-workflow** - \n- **gitmoji-cli** - \n\n
\n\n[![][back-to-top]](#readme-top)\n\n
\n\n---\n\n#### πŸ“ License\n\nCopyright Β© 2024 [Arietta Studio][profile-link].
\nThis project is [MIT](./LICENSE) licensed.\n\n\n\n[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square\n[bun-link]: https://bun.sh\n[bun-shield]: https://img.shields.io/badge/-speedup%20with%20bun-black?logo=bun&style=for-the-badge\n[github-action-release-link]: https://github.com/arietta-studio/arietta-tools/actions/workflows/release.yml\n[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/arietta-studio/arietta-tools/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square\n[github-action-test-link]: https://github.com/arietta-studio/arietta-tools/actions/workflows/test.yml\n[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/arietta-studio/arietta-tools/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square\n[github-codespace-link]: https://codespaces.new/arietta-studio/arietta-tools\n[github-codespace-shield]: https://github.com/codespaces/badge.svg\n[github-contrib-link]: https://github.com/arietta-studio/arietta-tools/graphs/contributors\n[github-contrib-shield]: https://contrib.rocks/image?repo=arietta-studio%2Farietta-tools\n[github-contributors-link]: https://github.com/arietta-studio/arietta-tools/graphs/contributors\n[github-contributors-shield]: https://img.shields.io/github/contributors/arietta-studio/arietta-tools?color=c4f042&labelColor=black&style=flat-square\n[github-forks-link]: https://github.com/arietta-studio/arietta-tools/network/members\n[github-forks-shield]: https://img.shields.io/github/forks/arietta-studio/arietta-tools?color=8ae8ff&labelColor=black&style=flat-square\n[github-issues-link]: https://github.com/arietta-studio/arietta-tools/issues\n[github-issues-shield]: https://img.shields.io/github/issues/arietta-studio/arietta-tools?color=ff80eb&labelColor=black&style=flat-square\n[github-license-link]: https://github.com/arietta-studio/arietta-tools/blob/master/LICENSE\n[github-license-shield]: https://img.shields.io/github/license/arietta-studio/arietta-tools?color=white&labelColor=black&style=flat-square\n[github-releasedate-link]: https://github.com/arietta-studio/arietta-tools/releases\n[github-releasedate-shield]: https://img.shields.io/github/release-date/arietta-studio/arietta-tools?labelColor=black&style=flat-square\n[github-stars-link]: https://github.com/arietta-studio/arietta-tools/network/stargazers\n[github-stars-shield]: https://img.shields.io/github/stars/arietta-studio/arietta-tools?color=ffcb47&labelColor=black&style=flat-square\n[issues-url]: https://github.com/arietta-studio/arietta-compass/issues/new/choose\n[npm-release-link]: https://www.npmjs.com/package/@arietta-studio/arietta-compass\n[npm-release-shield]: https://img.shields.io/npm/v/@arietta-studio/arietta-compass?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square\n[pr-welcome-link]: https://github.com/arietta-studio/arietta-tools/pulls\n[pr-welcome-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge\n[profile-link]: https://github.com/arietta-studio\n","readmeFilename":"README.md"}