Skip to content

generateFishCompletion

Generated reference page for the generateFishCompletion function export.

Signatures

ts
function generateFishCompletion(schema: CLISchema, options?: CompletionOptions): string;
ParameterTypeDescription
schemaCLISchemaThe CLI schema.
optionsCompletionOptions | undefinedOptional generator configuration.

Members

Members

generateFishCompletion

Generate a fish completion script for the CLI.

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

Examples

ts
const script = generateFishCompletion(app.schema);
// install with: mycli completions fish > ~/.config/fish/completions/mycli.fish

See Also

Released under the MIT License.