A Node.js CLI template with explicit commands, help, version, and safe execution boundaries.
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- Configuration
- Operations
- Commands
- Exit codes
- Support
- Links
- License
This template provides a reusable starting point. Each derived repository owns its product behavior and operating decisions.
Use Node.js 26 or later and npm 12 or later for repository validation.
Create a repository from this template. Replace the template name, description, URLs, keywords, and sample content.
Run npm ci from the repository root.
Follow this README and the user guide. Read release notes for release history.
Read AGENTS.md and the specifications index before you change files. Keep documents and records in the repository that owns them.
Run npm test before handoff. It runs the repository checks through eliware-test.
Install the required Node.js and npm versions. Run npm ci after dependency changes.
Review the file and rule in any validation error.
Keep credentials, secrets, private data, and runtime state out of Git. Use only approved secret stores for secret values.
The starter has no runtime settings. It does not read environment variables or configuration files.
The starter prints help, a version, or an error. It does not change files or connect to a network. Use the authorized release process to publish the package.
Run eliware-cli-template --help to print usage. Run eliware-cli-template --version to print the package version. Run the command with no arguments to print usage.
The starter accepts no other arguments. An unsupported argument returns exit code 2. The starter does not change state.
| Code | Meaning |
|---|---|
0 |
Help, version, or usage completed. |
2 |
The command received an unsupported argument. |
For help, questions, or to chat with the author and community, visit:
