![](\"./.github/logo.png\"){kind=logo}
\n\n \n
\n ![](\"https://img.shields.io/npm/v/generi?style=for-the-badge&color=a0a3cf&label=\")
\n\n
\n
\n\n- ✅ Easy CLI\n- ✅ Monorepo support with [Lerna](https://lerna.js.org/)\n- ✅ Release support with [Github CLI](https://cli.github.com/)\n- ✅ Supports Node v20+\n\n### Install\n\n`npm i -g generi` or `yarn global add generi`\n\n### Usage\n\n#### `generi init`\n\nInit `generi.json` configuration, and, if necessary, a git project\n
\n\n#### `generi log
\n\n#### `generi revert`\n\nRevert `generi log` last command\n
\n\n### Monorepo\n\nMonorepo versions may depend on external tools. Given this, Generi supports lerna workspaces, using the command `lerna version` before creating the changelog. In other setups, we recommend disabling the `tag` and `version` options.\n\n### Runner\n\nUse generi in .js|.ts files programatically\n\n```ts\nimport * as generi from 'generi/runner'\n\n// ...\ngeneri.init().then(async () => {\n await generi.log('patch')\n\n // ...\n})\n```\n\n### Config\n\n#### v1 (generi.json)\n\n```json\n{\n\t\"silent\": false,\n\t\"commits\": \"none\",\n\t\"tag\": true,\n\t\"version\": true,\n\t\"push\": false,\n\t\"publish\": false,\n\t\"release\": false,\n\t\"exclude\": [\" typo\"],\n\t\"prerelease\": \"beta\",\n\t\"packagePath\": \"package.json\",\n\t\"lernaPath\": \"lerna.json\"\n}\n```\n\n#### v2 (generi.config.ts)\n\n```ts\nexport default {\n silent: false,\n\tcommits: \"none\",\n\ttag: true,\n\tversion: true,\n\tpush: false,\n\tpublish: false,\n\trelease: false,\n\texclude: [\" typo\"],\n\tprerelease: \"beta\",\n\tpackagePath: \"package.json\",\n\tlernaPath: \"lerna.json\"\n};\n```\n\n##### `silent` Default: `false`\n\nDo not emit any message in console\n\n##### `commits` Default: `\"none\"`\n\nDefault format content in CHANGELOG.md\n\nOptions: `none` | [`conventional-commits`](https://www.conventionalcommits.org/en/v1.0.0/)\n\n##### `tag` Default: `true`\n\nRelease a git tag\n\n##### `version` Default: `true`\n\nInsert new version in package.json\n\n##### `push` Default: `false`\n\nPush commits in actually branch after log\n\n##### `publish` Default: `false`\n\nPublish(NPM) package in final log\n\n##### `repository` Default: `force`\n\nA URL to git repository for sha256 open link. 'ignore' option skip all repository loads and 'force' option get remote origin. repository https: charges normally.\n\n##### `exclude` Default: `[\" typo\"]`\n\nInvalidates commits in CHANGELOG.md that contain the considered options\n\n##### `prerelease` Default: `beta`\n\nDefault 'canary', 'beta' or 'alpha' argument for prerelease log command\n\n#### `packagePath` Default `package.json`\n\nA custom package.json path. Example: ./foo/bar/package.json\n\n#### `lernaPath` Default `lerna.json`\n\nA custom lerna.json path. Example: ./foo/bar/lerna.json","readmeFilename":"README.md"}