{"id":20551481,"url":"https://github.com/generate/generate-git","last_synced_at":"2025-06-15T20:42:12.321Z","repository":{"id":57246100,"uuid":"57172495","full_name":"generate/generate-git","owner":"generate","description":"Generator for initializing a git repository and adding first commit.","archived":false,"fork":false,"pushed_at":"2018-03-11T06:53:12.000Z","size":391,"stargazers_count":9,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-14T11:44:57.060Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/generate.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}},"created_at":"2016-04-27T01:02:39.000Z","updated_at":"2024-05-27T06:36:00.000Z","dependencies_parsed_at":"2022-08-24T16:31:37.187Z","dependency_job_id":null,"html_url":"https://github.com/generate/generate-git","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/generate/generate-git","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-git","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-git/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-git/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-git/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/generate","download_url":"https://codeload.github.com/generate/generate-git/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-git/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260046690,"owners_count":22950897,"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":[],"created_at":"2024-11-16T02:31:25.143Z","updated_at":"2025-06-15T20:42:12.291Z","avatar_url":"https://github.com/generate.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://github.com/generate/generate\"\u003e\n\u003cimg height=\"150\" width=\"150\" src=\"https://raw.githubusercontent.com/generate/generate/master/docs/logo.png\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\nGenerator for initializing a git repository and adding first commit.\n\n# generate-git\n\n[![NPM version](https://img.shields.io/npm/v/generate-git.svg?style=flat)](https://www.npmjs.com/package/generate-git) [![NPM monthly downloads](https://img.shields.io/npm/dm/generate-git.svg?style=flat)](https://npmjs.org/package/generate-git) [![Build Status](https://img.shields.io/travis/generate/generate-git.svg?style=flat)](https://travis-ci.org/generate/generate-git)\n\n![generate-git demo](https://raw.githubusercontent.com/generate/generate-git/master/docs/demo.gif)\n\n## Getting started\n\n### Install\n\n**Installing the CLI**\n\nTo run the `readme` generator from the command line, you'll need to install [Generate](https://github.com/generate/generate) globally first. You can do that now with the following command:\n\n```sh\n$ npm install --global generate\n```\n\nThis adds the `gen` command to your system path, allowing it to be run from any directory.\n\n**Install generate-git**\n\nInstall this module with the following command:\n\n```sh\n$ npm install --global generate-git\n```\n\n### CLI\n\nRun this generator's `default` [task](https://github.com/generate/generate/blob/master/docs/tasks.md#default) with the following command:\n\n```sh\n$ gen readme\n```\n\n**What will happen?**\n\nRunning `$ gen git` will run this generator's `default` task, which initializes a new git repository, git adds the files, and does a first commit with the message `first commit`.\n\nWhen [generate](https://github.com/generate/generate) is installed globally, you can run this generator with the `$ gen readme` command, or use in your own generator as a plugin or sub-generator to make it a continuous part of the build workflow when scaffolding out a new project.\n\n**What you should see in the terminal**\n\nIf completed successfully, you should see both `starting` and `finished` events in the terminal, like the following:\n\n```sh\n[00:44:21] starting ...\n...\n[00:44:22] finished ✔\n```\n\nIf you do not see one or both of those events, please [let us know about it](../../issues).\n\n### Help\n\nTo see a general help menu and available commands for Generate's CLI, run:\n\n```sh\n$ gen help\n```\n\n## Available tasks\n\nAll available tasks for this generator.\n\n### [default](generator.js#L33)\n\nInitialize a git repository, including `git add` and first commit.\n\n**Example**\n\n```sh\n$ gen git\n```\n\n### [first-commit](generator.js#L46)\n\nAlias for the default task, to provide a semantic task name when using this generator as a plugin or sub-generator.\n\n**Example**\n\n```sh\n$ gen git:first-commit\n```\n\n### [clone](generator.js#L75)\n\nAlias for the default task, to provide a semantic task name when using this generator as a plugin or sub-generator.\n\n**Example**\n\n```sh\n$ gen git:clone\n$ gen git:git-clone # aliased for API usage\n```\n\n### [updater:prompt-git](generator.js#L109)\n\nPrompts the user to confirm if they'd like to initialize a git repository with first [first-commit](#first-commit).\n\n**Example**\n\n```sh\n$ gen updater:prompt-git\n```\n\nVisit Generate's [documentation for tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).\n\n## Next steps\n\n### Running unit tests\n\nIt's never too early to begin running unit tests. When you're ready to get started, the following command will ensure the project's dependencies are installed then run all of the unit tests:\n\n```sh\n$ npm install \u0026\u0026 test\n```\n\n### Publishing your generator\n\nIf you're tests are passing and you're ready to publish your generator to [npm](https://www.npmjs.com), you can do that now with the following command:\n\n**Are you sure you're ready?!**\n\nLet's go!\n\n```sh\n$ npm publish\n```\n\n## About\n\n### What is \"Generate\"?\n\nGenerate is a command line tool and developer framework for scaffolding out new GitHub projects using [generators](https://github.com/generate/generate/blob/master/docs/generators.md) and [tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).\n\nAnswers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for [gulp](http://gulpjs.com), [base](https://github.com/node-base/base) and [assemble](https://github.com/assemble/assemble) plugins, and much more.\n\n**For more information**:\n\n* Visit the [generate project](https://github.com/generate/generate/)\n* Visit the [generate documentation](https://github.com/generate/generate/blob/master/docs/)\n* Find [generators on npm](https://www.npmjs.com/browse/keyword/generate-generator) (help us [author generators](https://github.com/generate/generate/blob/master/docs/micro-generators.md))\n\n### Related projects\n\n* [generate-license](https://www.npmjs.com/package/generate-license): Generate a license file. Choose any of the licenses supported by https://github.com/github/choosealicense.com. | [homepage](https://github.com/generate/generate-license \"Generate a license file. Choose any of the licenses supported by https://github.com/github/choosealicense.com.\")\n* [generate-mocha](https://www.npmjs.com/package/generate-mocha): Generate mocha test files. | [homepage](https://github.com/generate/generate-mocha \"Generate mocha test files.\")\n* [generate](https://www.npmjs.com/package/generate): Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate \"Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the robustness and configurability of Yeoman, the expressiveness and simplicity of Slush, and more powerful flow control and composability than either.\")\n\n### Community\n\nBigger community means more plugins, better support and more progress. Help us make Generate better by spreading the word:\n\n* Show your love by starring the project\n* Tweet about Generate. Mention using `@generatejs`, or use the `#generatejs` hashtag\n* Get implementation help on [StackOverflow](http://stackoverflow.com/questions/tagged/generate) with the `generatejs` tag\n* Discuss Generate with us on [Gitter](https://gitter.im/generate/generate)\n* If you publish a generator, to make your project as discoverable as possible, please add the unique keyword `generategenerator` to your project's package.json.\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install \u0026\u0026 npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)\n* [GitHub Profile](https://github.com/jonschlinkert)\n* [Twitter Profile](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 11, 2018._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-git","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenerate%2Fgenerate-git","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-git/lists"}