@xpulse/cli – API

Events

Event	Payload	Wann
`cli:init`	`{ sources }`	Discovery beginnt
`cli:command:discovered`	`{ name, alias, source }`	Command gefunden
`cli:ready`	`{ count, commands }`	Alle Commands geladen
`cli:command`	`{ name, args, verbose }`	Command startet
`cli:done`	`{ name, exitCode, duration }`	Command abgeschlossen

Command schreiben

1 import { Command } from '@xpulse/cli/command';
2  
3 export class MyCommand extends Command {
4     configure() {
5         this.setName('my:command')
6             .setDescription('Macht etwas')
7             .addArgument('name', null, 'Name')
8             .addFlag('dry-run', false, 'Nur simulieren');
9     }
10     async run(input, output) {
11         const name   = input.getArgument('name');
12         const dryRun = input.getFlag('dryRun');
13         output.success(`Hallo ${name}!`);
14         return 0;
15     }
16 }

Globale Flags

Flag	Kürzel	Beschreibung
`--help [command]`	`-h`	CLI-Hilfe, oder Command-Hilfe wenn Name angegeben
`--list`	–	Alle Commands mit Alias und Beschreibung
`--version`	`-v`	Version ausgeben
`--verbose`	`-V`	Verbose-Ausgabe → `input.isVerbose()`
`--quiet`	`-q`	Nur Fehler → `input.isQuiet()`
`--no-ansi`	–	Keine Farben → `input.isAnsi() = false`
`--no-debug`	–	Logger-Console-Level auf `warn` hochsetzen – info/debug erscheinen nicht auf der Konsole, Log-Datei bleibt unverändert

In Commands erreichbar via input.isNoDebug().

Bootstrap

Vor dem Command-Start ruft @xpulse/cli app.init() aus @xpulse/app auf (sofern installiert). Damit haben alle Commands vollen Service-Context (Config, Logger, Debug, Router, Controller) – ohne dass der HTTP-Server startet.

Ist @xpulse/app nicht installiert, wird config.load() als Fallback verwendet.

Konfiguration

1 { "cli": { "timeout": 30 } }

1	import { Command } from '@xpulse/cli/command';
2
3	export class MyCommand extends Command {
4	configure() {
5	this.setName('my:command')
6	.setDescription('Macht etwas')
7	.addArgument('name', null, 'Name')
8	.addFlag('dry-run', false, 'Nur simulieren');
9	}
10	async run(input, output) {
11	const name = input.getArgument('name');
12	const dryRun = input.getFlag('dryRun');
13	output.success(`Hallo ${name}!`);
14	return 0;
15	}
16	}