Question 1

How do I add argument autocompletion to a Sub command?

Accepted Answer

Include a magic comment '# Provide YOUR_SUB_NAME completions' and handle the --complete flag in your subcommand script, outputting possible arguments. This opt-in approach is detailed in the README's autocompletion section with examples from rbenv.

Question 2

Sub vs Cobra for Go CLI tools: which should I use?

Accepted Answer

Sub is language-agnostic and ideal for mixed-language subcommands, while Cobra is Go-specific with richer argument parsing and validation. Choose Sub for flexibility across scripts; pick Cobra for pure Go projects needing advanced features.

Question 3

Can Sub handle nested subcommands like 'git remote add'?

Accepted Answer

Sub does not natively support nested subcommands; each is a flat executable. For hierarchical structures, you must implement logic within subcommands or consider frameworks designed for nesting, which adds complexity.

Question 4

How to distribute a Sub-based CLI tool to users easily?

Accepted Answer

Distribution typically involves repository cloning and manual shell profile updates, which can be user-unfriendly. Consider providing install scripts or packaging for specific systems, though Sub lacks built-in packaging support.

Question 5

Does Sub work on Windows without installing bash?

Accepted Answer

No, Sub relies on bash for the main executable, so it requires a bash-compatible environment like WSL, Cygwin, or Git Bash. Native Windows support is limited, making it less suitable for pure Windows workflows.

Question 6

What are the performance trade-offs of using Sub?

Accepted Answer

Each subcommand spawns a new process, adding overhead compared to monolithic CLIs. For most tools, this is negligible, but for high-frequency commands or resource-constrained environments, it might impact responsiveness.

sub

What is sub?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions