Improve autocomplete migration documentation #553

New Issue

2025-05-01T22:34:44Z

marlon commented

2025-05-01 22:34:44 +00:00

Upon upgrading abra, now when trying to use tab to autocomplete, I get this error:
Error: unknown flag: --generate-bash-completion

abra version 0.10.1-beta-2fbef41

Upon upgrading abra, now when trying to use tab to autocomplete, I get this error: `Error: unknown flag: --generate-bash-completion` abra version 0.10.1-beta-2fbef41

decentral1se commented

2025-05-02 11:27:30 +00:00

@marlon what command did you run exactly to run into that error?

As noted in the migration docs, the autocomplete commands / flags have changed.

When you run abra autocomplete -h, you should see the necessary commands for bash?

🛠  abra autocomplete -h
To load completions:

Bash:
  # Load autocompletion for the current Bash session
  $ source <(abra autocomplete bash)

  # To load autocompletion for each session, execute once:
  # Linux:
  $ abra autocomplete bash | sudo tee /etc/bash_completion.d/abra
  # macOS:
  $ abra autocomplete bash | sudo tee $(brew --prefix)/etc/bash_completion.d/abra
  ... # omitted for brevity...

@marlon what command did you run exactly to run into that error? As noted [in the migration docs](https://docs.coopcloud.tech/abra/upgrade/#09x-beta-010x-beta), the autocomplete commands / flags have changed. When you run `abra autocomplete -h`, you should see the necessary commands for `bash`? ``` 🛠 abra autocomplete -h To load completions: Bash: # Load autocompletion for the current Bash session $ source <(abra autocomplete bash) # To load autocompletion for each session, execute once: # Linux: $ abra autocomplete bash | sudo tee /etc/bash_completion.d/abra # macOS: $ abra autocomplete bash | sudo tee $(brew --prefix)/etc/bash_completion.d/abra ... # omitted for brevity... ```

marlon commented

2025-05-02 16:06:40 +00:00

Yes, I should have clarified I'm running zsh 5.9 and I ran the following commands per the migration docs:

echo "autoload -U compinit; compinit" >> ~/.zshrc
abra autocomplete zsh > "${fpath[1]}/_abra"

Then I started a new terminal and typed:
abra ap<tab>

The output looks like

➜  ~ abra apError: unknown flag: --generate-bash-completion
Usage:
  abra [command]

Available Commands:
  app          Manage apps
  autocomplete Generate autocompletion script
  catalogue    Manage the recipe catalogue
  help         Help about any command
[...]

When I check the contents of ~/.zshrc it does contain the autoload command, and when I cat "${fpath[1]}/_abra" it shows a script for zsh completion.

Yes, I should have clarified I'm running zsh 5.9 and I ran the following commands per the migration docs: ``` echo "autoload -U compinit; compinit" >> ~/.zshrc abra autocomplete zsh > "${fpath[1]}/_abra" ``` Then I started a new terminal and typed: `abra ap<tab>` The output looks like ``` ➜ ~ abra apError: unknown flag: --generate-bash-completion Usage: abra [command] Available Commands: app Manage apps autocomplete Generate autocompletion script catalogue Manage the recipe catalogue help Help about any command [...] ``` When I check the contents of ~/.zshrc it does contain the autoload command, and when I `cat "${fpath[1]}/_abra"` it shows a script for zsh completion.

decentral1se commented

2025-05-03 06:07:11 +00:00

@marlon do you perhaps still have the old pre v0.10.x autocomplete config lying around?

		abra/cli/cli.go
		Lines 91 to 96 in e3a0af5840
	
							fmt.Println(fmt.Sprintf(`

				# Run the following commands to install auto-completion

				sudo mkdir /etc/zsh/completion.d/

				sudo cp %s /etc/zsh/completion.d/abra

				echo "PROG=abra\n_CLI_ZSH_AUTOCOMPLETE_HACK=1\nsource /etc/zsh/completion.d/abra" >> ~/.zshrc

				# To test, run the following: "abra app <hit tab key>" - you should see command completion!

abra/scripts/autocomplete/zsh Lines 8 to 12 in e3a0af5840

   if [[ "$cur" == "-"* ]]; then
     opts=("${(@f)$(_CLI_ZSH_AUTOCOMPLETE_HACK=1 ${words[@]:0:#words[@]-1} ${cur} --generate-bash-completion)}")
   else
     opts=("${(@f)$(_CLI_ZSH_AUTOCOMPLETE_HACK=1 ${words[@]:0:#words[@]-1} --generate-bash-completion)}")
   fi

@marlon do you perhaps still have the old pre v0.10.x autocomplete config lying around? https://git.coopcloud.tech/toolshed/abra/src/commit/e3a0af5840553c2c5a1a5135f474afb90c7f4375/cli/cli.go#L91-L96 https://git.coopcloud.tech/toolshed/abra/src/commit/e3a0af5840553c2c5a1a5135f474afb90c7f4375/scripts/autocomplete/zsh#L8-L12

marlon commented

2025-05-03 06:41:29 +00:00

Yes, seems the problem was that I had this pre v0.10.x line in my .zshrc file:
source /etc/zsh/completion.d/abra

Removing that line fixed the error.

Yes, seems the problem was that I had this pre v0.10.x line in my `.zshrc` file: `source /etc/zsh/completion.d/abra` Removing that line fixed the error.

👍 1

decentral1se added the documentation label 2025-05-03 06:50:22 +00:00

decentral1se added this to the (deleted) project 2025-05-03 06:50:30 +00:00

decentral1se changed title from ~~Autocomplete fails: "unknown flag: --generate-bash-completion"~~ to Improve autocomplete migration documentation

2025-05-03 11:59:59 +00:00

3wordchant self-assigned this 2025-06-30 15:00:41 +00:00

decentral1se modified the project from (deleted) to Abra v0.11.x

2025-07-08 10:06:51 +00:00

decentral1se referenced this issue from a commit

2025-08-18 07:36:32 +00:00

docs: more warn on auto-complete migrate

decentral1se commented

2025-08-18 07:37:01 +00:00

Oh woops, drive-by picked this one up but saw it wasn't assigned to me! Sorry!

decentral1se closed this issue

2025-08-18 07:37:01 +00:00