Add automatic CI/CD environment detection using ci-info package. Generic pattern for any CLI tool that needs to adapt behavior (prompts, output, integrations) based on whether it's running in CI.
The English summary is being prepared. Showing the original description.
See how to installReview the instructions the agent will receive before you install.
Automatically detect CI environments and adapt CLI behavior — removing the need for explicit flags in most cases.
pnpm add ci-info
import ci from 'ci-info'
type RunMode = 'interactive' | 'non-interactive' | string
function detectRunMode(explicit?: string): RunMode {
// Explicit flag always wins
if (explicit) return explicit
// CI environment detected
if (ci.isCI) {
// Add CI-specific modes as needed, e.g.:
// if (ci.GITLAB) return 'gitlab'
// if (ci.GITHUB_ACTIONS) return 'github-actions'
return 'non-interactive'
}
// Local: check if terminal is interactive
return process.stdout.isTTY ? 'interactive' : 'non-interactive'
}
const mode = detectRunMode(options.mode)
if (isDebug()) {
logger.debug(`Run mode: ${mode}${ci.isCI ? ` (detected: ${ci.name})` : ''}`)
}
| Environment | TTY | Explicit flag | Result |
|---|---|---|---|
| Local terminal | yes | not set | interactive |
Local pipe (mycli show | jq) | no | not set | non-interactive |
| GitHub Actions | no | not set | non-interactive |
| GitLab CI | no | not set | non-interactive |
| Any CI | no | interactive (explicit) | interactive (user override) |
test('detects CI from environment', () => {
vi.mock('ci-info', () => ({ isCI: true, GITLAB: false, name: 'GitHub Actions' }))
expect(detectRunMode()).toBe('non-interactive')
})
test('explicit flag overrides detection', () => {
expect(detectRunMode('interactive')).toBe('interactive')
})
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Add --json flag to CLI commands for machine-readable output on stdout. Generic pattern for any CLI tool, enabling piping to jq and CI/CD integration while keeping human-readable output on stderr.
The English summary is being prepared. Showing the original description.
Add shell completion support via a 'completion' subcommand for bash, zsh, and fish. Generic pattern for any Commander.js CLI, with static and dynamic completion examples.
The English summary is being prepared. Showing the original description.
Add zod schema validation for CLI options and YAML/JSON config files. Generic pattern for runtime validation with type-safe parsing and clear error messages in any Commander.js CLI.
The English summary is being prepared. Showing the original description.
Set up @changesets/cli for semantic versioning, CHANGELOG generation, and npm publishing in a monorepo or single package. Covers init, config, contributor workflow, GitHub Actions release automation, and npm provenance.
The English summary is being prepared. Showing the original description.
Polish CLI user experience with @clack/prompts for interactive flows, update-notifier for version awareness, and enhanced Commander.js help text with examples and colors. Generic patterns for any Node.js CLI.
The English summary is being prepared. Showing the original description.
Implement a structured error class hierarchy with actionable messages, proper exit codes, debug mode via env var, and bug report hints on unexpected errors. Generic pattern for any CLI tool or Node.js application.
The English summary is being prepared. Showing the original description.