generateBashCompletion

Generated reference page for the generateBashCompletion function export.

• Import: @kjanat/dreamcli
• Export kind: function
• Declared in: src/core/completion/shells/bash.ts
• Source link: packages/dreamcli/src/core/completion/shells/bash.ts:49

Signatures

function generateBashCompletion(schema: CLISchema, options?: CompletionOptions): string;

Parameter	Type	Description
schema	CLISchema	The CLI schema.
options	CompletionOptions | undefined	Optional generator configuration.

Members

Members

generateBashCompletion

Generate a bash completion script for the CLI.

Use this when you want a bash-specific script directly rather than routing through generateCompletion. The generated script expects the bash-completion package because it relies on _init_completion.

(schema: CLISchema, options?: CompletionOptions): string;

Examples

const script = generateBashCompletion(app.schema);
// install with: mycli completions bash > /etc/bash_completion.d/mycli

See Also

• Examples overview
• Example Hover
• API overview
• @kjanat/dreamcli