{"id":21057,"library":"colcon-zsh","title":"colcon-zsh","description":"An extension for the colcon build tool that provides Z shell (zsh) completion scripts. Version 0.5.0, maintained as part of colcon ecosystem, irregular releases.","status":"active","version":"0.5.0","language":"python","source_language":"en","source_url":"https://github.com/colcon/colcon-zsh/","tags":["colcon","zsh","completion","shell"],"install":[{"cmd":"pip install colcon-zsh","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"colcon-zsh is an extension and requires colcon to be installed","package":"colcon-core","optional":false}],"imports":[{"note":"Common mistake: the package name is 'colcon-zsh' but the Python import is 'colcon_zsh' (underscore).","wrong":"import colcon_zsh_shell","symbol":"colcon_zsh","correct":"import colcon_zsh"}],"quickstart":{"code":"import subprocess\nresult = subprocess.run(['colcon', 'completion', '--shell', 'zsh'], capture_output=True, text=True)\nprint(result.stdout)","lang":"python","description":"Generate zsh completion scripts using colcon's completion command provided by this extension."},"warnings":[{"fix":"Run 'colcon completion --shell zsh' and source the output, or redirect to a file and source it.","message":"colcon-zsh is only a shell completion provider; it does not affect build behavior. You must source the generated completion script in your .zshrc to use zsh completions.","severity":"gotcha","affected_versions":"all"},{"fix":"Use Python 3.8 or later.","message":"Python 3.6 support is deprecated as per requires_python; future versions may drop it.","severity":"deprecated","affected_versions":">=0.5.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Run 'pip install colcon-zsh' in the same environment where colcon is installed.","cause":"colcon-zsh is not installed or installed in a different environment.","error":"ModuleNotFoundError: No module named 'colcon_zsh'"},{"fix":"Ensure colcon-zsh is installed: 'pip install colcon-zsh' and verify with 'colcon extension list'.","cause":"colcon-zsh extension is not loaded; colcon does not recognize zsh as a shell option.","error":"colcon: error: argument --shell: invalid choice: 'zsh' (choose from 'bash')"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}