Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 148b9b9

Browse filesBrowse files
committed
docs(README.md): improve clarity of README reference section
1 parent a492596 commit 148b9b9
Copy full SHA for 148b9b9

File tree

1 file changed

+65
-7
lines changed
Filter options

1 file changed

+65
-7
lines changed

‎docs/README.md

Copy file name to clipboardExpand all lines: docs/README.md
+65-7Lines changed: 65 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,11 @@ pre-commit install --hook-type commit-msg --hook-type pre-push
209209
210210
For more details about commit validation, see the [check command documentation](commands/check.md).
211211
212-
## Usage
212+
## Help & Reference
213+
214+
### Command Line Interface
215+
216+
Commitizen provides a comprehensive CLI with various commands. Here's the complete reference:
213217
214218
<!-- Please manually update the following section after changing `cz --help` command output. -->
215219
@@ -242,31 +246,85 @@ commands:
242246
version get the version of the installed commitizen or the current project (default: installed commitizen)
243247
```
244248
249+
### Quick Reference
250+
251+
| Command | Description | Alias |
252+
|---------|-------------|-------|
253+
| `cz init` | Initialize Commitizen configuration | - |
254+
| `cz commit` | Create a new commit | `cz c` |
255+
| `cz bump` | Bump version and update changelog | - |
256+
| `cz changelog` | Generate changelog | `cz ch` |
257+
| `cz check` | Validate commit messages | - |
258+
| `cz version` | Show version information | - |
259+
260+
### Additional Resources
261+
262+
- [Conventional Commits Specification][conventional_commits]
263+
- [Exit Codes Reference](./exit_codes.md)
264+
- [Configuration Guide](./config.md)
265+
- [Command Documentation](./commands/init.md)
266+
267+
### Getting Help
268+
269+
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+
245279
## Setting up bash completion
246280
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
248289
249-
argcomplete is installed when you install Commitizen since it's a dependency.
290+
### Installation Methods
291+
292+
#### Global Installation (Recommended)
250293
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:
252295
253296
```bash
297+
# Enable global completion for all Python applications
254298
sudo activate-global-python-argcomplete
255299
```
256300
257-
For permanent (but not global) Commitizen activation, use:
301+
#### User-Specific Installation
302+
303+
For a user-specific installation that persists across sessions:
258304
259305
```bash
306+
# Add to your shell's startup file (e.g., ~/.bashrc, ~/.zshrc)
260307
register-python-argcomplete cz >> ~/.bashrc
261308
```
262309
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:
264313
265314
```bash
315+
# Activate completion for current session only
266316
eval "$(register-python-argcomplete cz)"
267317
```
268318
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/).
270328
271329
## Sponsors
272330

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.