cli_completion
0.6.0, released 3 months ago by verygood.ventures
Completion functionality for Dart Command-Line Interfaces built using CommandRunner.
What it does
Provides tab completion functionality for Dart Command-Line Interfaces built using CommandRunner. Automatically installs or allows manual installation of shell completion files.
AI-written summary of version 0.6.0, based on the package's README and metadata. Report an inaccuracy
Use it when
- You are building a custom Dart command-line interface using CommandRunner.
- You want to provide tab-completion functionality for your CLI users.
Skip it when
- You are not using CommandRunner for your Dart CLI.
Strengths
- Automates completion file installation on first run.
- Supports multiple shells like bash and zsh.
Weaknesses
- Requires manual zsh setup if not using a framework like Oh My Zsh.
- Requires fast tracking the completion command if extra checks are run.
Setup
- Kind
- Pure Dart
- Effort
- Low
- Code generation
- No
- Direct dependencies
- 5
Add cli_completion to your dependencies and extend CompletionCommandRunner in your CommandRunner class.
import 'package:cli_completion/cli_completion.dart';
class ExampleCommandRunner extends CompletionCommandRunner<int> {
// ...
}Alternatives
Packages that do the same job and could replace cli_completion.
- completion
Adds shell command completion support to Dart console apps.
79Compare - cli_util
Utilities to help build Dart command-line apps, find the SDK, and display progress.
88Compare - cli_tools
Utilities for building command‑line interfaces, including argument parsing, analytics, and progress reporting.
83Compare - config
Typed CLI argument and config file parser with env support
84Compare
Works with
Packages commonly used together with cli_completion: ones it builds on, ones built on it, and its own family.
- argscli_completion depends on itLibrary for parsing raw command-line arguments into options and values using GNU and POSIX styles.
- equatablecli_completion depends on itProvides value‑based equality for Dart objects without manual == and hashCode.
- mason_loggercli_completion depends on itA lightweight CLI logger with prompts, progress, and custom styling.
- very_good_cliBuilt on cli_completionCLI for creating and managing Dart/Flutter projects
- mason_cliBuilt on cli_completionCLI tool to create and consume reusable template bricks for code generation.
- patrol_cliBuilt on cli_completionCommand-line tool to run and debug Patrol UI tests on multiple platforms
- fvmBuilt on cli_completionCLI to manage Flutter SDK versions per project
- dart_frog_cliBuilt on cli_completionOfficial command-line interface for the Dart Frog backend framework.