cli-boilerplate

🌙 Dark Mode

npx @greenarmor/cli-boilerplate

@greenarmor/cli-boilerplate

• A fully-featured starter boilerplate for building and publishing your own CLI tools using Node.js + npm.

Use the prebuilt cli inside an existing web application, or rebrand this boilerplate to create your own CLI with extra automation tools. Rebranding aims to boost automation for web app development and is perfect for DevOps workflows.

---

Features

• Publish-ready scoped CLI
• cli global command
• cli-bump version bump tool
• --dry-run mode
• Git commit + tag + push
• Optional npm publish
• GitHub release note generation
• GitHub Releases automation
• Semantic release support
• Banner, help menu, and badges
• Ideal for open-source CLI products
• Generators for components, pages, hooks, layouts, services, styles, and tests
• Framework detection with per-framework templates and a --framework override
• DevOps-friendly automation for releases and scaffolding

---

Generators

Built-in scaffolding for:

• Components
• Pages
• Hooks
• Layouts
• Services
• Styles
• Tests

Framework-Aware Templates

Generators automatically select templates based on your project’s framework. The CLI inspects package.json for dependencies like React, Vue, or Angular and loads files from templates/<framework>. Override detection with the --framework flag:

cli generate:component Button --framework vue

If no framework is detected, the generators fall back to templates/default.

---

CLI Tooling

Version Bump

cli-bump

Supports:

• Select bump type (patch, minor, major)
• Git log + changelog preview
• Optional GitHub push + npm publish
• GitHub release notes preview
• --dry-run support

---

GitHub Release Automation

To create a release on GitHub:

export GITHUB_TOKEN=ghp_YourTokenHere
node scripts/release-to-github.js

---

Semantic Release via CI

This project includes semantic-release support out of the box:

• Automated changelog
• GitHub Releases
• npm publishing

Requirements:

• NPM_TOKEN in GitHub Actions secrets
• GITHUB_TOKEN in GitHub Actions secrets

---

License

MIT — Customize and distribute freely under your own CLI brand.

---

Quick Start

Choose the workflow that fits your needs.

Use cli in an existing project

npm install -g @greenarmor/cli-boilerplate
cd path/to/your-existing-project
cli generate:component Button

The generators detect your framework and drop files into your project automatically.

Rebrand and extend your own CLI

1. Set Git identity (optional but recommended):

git config --global user.name "your_github_username"
git config --global user.email "your_email@example.com"

1. Scaffold a new CLI, ready to receive more automation tools:

npx @greenarmor/cli-boilerplate my-cli

1. (Optional) Include extras during creation:

• --with-emoji – show emoji-enhanced output
• --full-stack – add ESLint, Prettier, Husky, Lint-Staged, Jest, ZX, Inquirer, Update Notifier, and more CLI polish libraries

npx @greenarmor/cli-boilerplate my-cli --with-emoji --full-stack

1. Link and try your branded CLI:

cd my-cli
npm install
npm link
my-cli --help

---

Built by @greenarmor

This site is open source. Improve this page.