https://github.com/octoherd/create-octoherd-script

CLI to create a new folder and repository for an Octoherd Script
https://github.com/octoherd/create-octoherd-script

Last synced: 3 months ago
JSON representation

CLI to create a new folder and repository for an Octoherd Script

• Host: GitHub
• URL: https://github.com/octoherd/create-octoherd-script
• Owner: octoherd
• License: isc
• Created: 2021-03-04T08:57:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-30T09:44:14.000Z (4 months ago)
• Last Synced: 2024-07-30T12:12:48.728Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 452 KB
• Stars: 12
• Watchers: 5
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-octoherd-scripts - Create new Octoherd Script - CLI to create a new folder and repository for an Octoherd Script. (Writing your own scripts)

README

        
# Create new Octoherd Script

> CLI to create a new folder and repository for an Octoherd Script

## Usage

```shell

npm init octoherd-script

```

## What it does

- Creates a new folder on your machine

- Inits git in the new folder

- Add `LICENSE`, `CODE_OF_CONDUCT.md`, `README.md` and issue templates

- Prompts for script options and adds according documentation to the `README.md` file

- Creates a repository

- Adds repository as `git remote add origin `

- Push the files to main

- Creates a new local branch called `initial-version`

- Adds files for the script, CLI, and more meta files

- Adds branch protection (if possible)

- Adds workflow files for tests and automated releases to GitHub and npm

- Creates a pull request with further instructions

## Contribute

Pull requests welcome!

## License

[ISC](LICENSE)