OSS Starter Kit

A small command-line tool that creates starter files for open-source projects.

It pairs well with OSS Readiness Checker: check what is missing, then generate a practical starter set.

日本語で試す

OSS として公開するときによく必要になるファイルをまとめて作るCLIツールです。 既にあるファイルは上書きせず、スキップします。

Windows の PowerShell:

npx.cmd oss-starter-kit init .

macOS または Linux:

npx oss-starter-kit init .

What it creates

• CONTRIBUTING.md
• SECURITY.md
• CODE_OF_CONDUCT.md
• .github/pull_request_template.md
• .github/ISSUE_TEMPLATE/bug-report.yml
• .github/ISSUE_TEMPLATE/feature-request.yml
• .github/ISSUE_TEMPLATE/config.yml

Requirements

• Node.js 20 or later

Usage

Create starter files in the current folder:

npx oss-starter-kit init .

Preview what would be created:

npx oss-starter-kit init . --dry-run

Output machine-readable JSON:

npx oss-starter-kit init . --dry-run --json

Existing files are never overwritten.

Development

Run the local source code:

node ./src/cli.js init . --dry-run

Run the tests:

npm test

Contributing

Contributions are welcome. See CONTRIBUTING.md.

Security

For security reports, see SECURITY.md.

License

MIT