You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For each command, you can get detailed help by adding `--help`:
270
+
271
+
```sh
272
+
cz commit --help
273
+
cz bump --help
274
+
cz changelog --help
275
+
```
276
+
277
+
For more detailed documentation, visit our [documentation site](https://commitizen-tools.github.io/commitizen/).
278
+
245
279
## Setting up bash completion
246
280
247
-
When using bash as your shell (limited support for zsh, fish, and tcsh is available), Commitizen can use [argcomplete](https://kislyuk.github.io/argcomplete/) for auto-completion. For this, argcomplete needs to be enabled.
281
+
Commitizen supports command-line completion through [argcomplete](https://kislyuk.github.io/argcomplete/), which is automatically installed as a dependency. This feature provides intelligent auto-completion for all Commitizen commands and options.
282
+
283
+
### Supported Shells
284
+
285
+
- **Bash**: Full support
286
+
- **Zsh**: Limited support
287
+
- **Fish**: Limited support
288
+
- **Tcsh**: Limited support
248
289
249
-
argcomplete is installed when you install Commitizen since it's a dependency.
290
+
### Installation Methods
291
+
292
+
#### Global Installation (Recommended)
250
293
251
-
If Commitizen is installed globally, global activation can be executed:
294
+
If you installed Commitizen globally (e.g., using `pipx` or `brew`), you can enable global completion:
252
295
253
296
```bash
297
+
# Enable global completion for all Python applications
254
298
sudo activate-global-python-argcomplete
255
299
```
256
300
257
-
For permanent (but not global) Commitizen activation, use:
301
+
#### User-Specific Installation
302
+
303
+
For a user-specific installation that persists across sessions:
258
304
259
305
```bash
306
+
# Add to your shell's startup file (e.g., ~/.bashrc, ~/.zshrc)
260
307
register-python-argcomplete cz >>~/.bashrc
261
308
```
262
309
263
-
For one-time activation of argcomplete for Commitizen only, use:
310
+
#### Temporary Installation
311
+
312
+
For one-time activation in your current shell session:
264
313
265
314
```bash
315
+
# Activate completion for current session only
266
316
eval"$(register-python-argcomplete cz)"
267
317
```
268
318
269
-
For further information on activation, please visit the [argcomplete website](https://kislyuk.github.io/argcomplete/).
319
+
### Verification
320
+
321
+
After installation, you can verify the completion is working by:
322
+
323
+
1. Opening a new terminal session
324
+
2. Typing `cz` followed by a space and pressing `TAB` twice
325
+
3. You should see a list of available commands
326
+
327
+
For more detailed information about argcomplete configuration and troubleshooting, visit the [argcomplete documentation](https://kislyuk.github.io/argcomplete/).
0 commit comments