From 38b222f08057276ec5144db487d84ceb4d9daebe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20H=C3=B6rtenhuber?= Date: Thu, 1 Dec 2022 10:13:31 +0000 Subject: [PATCH] add comment about `compinit` --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 425b7b5a2a..aa985cd471 100644 --- a/README.md +++ b/README.md @@ -225,9 +225,11 @@ fish | ~/.config/fish/completions/nf-core.fish | `eval (env _NF_CORE_COMPLETE=fi After a restart of the shell session you should have auto-completion for the `nf-core` command and all its sub-commands and options. -> **NB:** The added line will run the command `nf-core`. You must therefore have the nf-core/tools installed globally. +> **NB:** The added line will run the command `nf-core` (which will also slow down startup time of your shell). You should therefore either have the nf-core/tools installed globally. > You can also wrap it inside `if type nf-core > /dev/null; then ` \ `fi` for bash and zsh or `if command -v nf-core &> /dev/null eval (env _NF_CORE_COMPLETE=fish_source nf-core) end` for fish. You need to then source the config in your environment for the completions to be activated. +> **NB:** If you see the error `command not found compdef` , be sure that your config file contains the line `autoload -Uz compinit && compinit` before the eval line. + ## Listing pipelines The command `nf-core list` shows all available nf-core pipelines along with their latest version, when that was published and how recently the pipeline code was pulled to your local system (if at all).