Command Reference - TomPlanche/rona GitHub Wiki
This page provides a comprehensive reference for all Rona commands and their options.
Add files to Git staging while excluding specified patterns.
rona add-with-exclude <pattern(s)>
# or
rona -a <pattern(s)>
Example:
rona -a "*.rs" "*.tmp" # Exclude Rust and temporary files
Commit changes using prepared message.
rona commit [extra args]
# or
rona -c [-p | --push] [extra args]
Generate shell completion scripts.
rona completion <shell>
Supported shells: bash
, fish
, zsh
, powershell
Example:
rona completion fish > ~/.config/fish/completions/rona.fish
Generate or update commit message template.
rona generate [--interactive]
# or
rona -g [-i | --interactive]
Features:
- Creates
commit_message.md
and.commitignore
- Interactive commit type selection
- Automatic file change tracking
-
Interactive mode: Input commit message directly in terminal (
-i
flag) - Editor mode: Opens in configured editor (default behavior)
Examples:
# Standard mode: Opens commit type selector, then editor
rona -g
# Interactive mode: Input message directly in terminal
rona -g -i
Initialize Rona configuration.
rona init [editor] # The editor to use for commit messages [vim, zed] (default: nano)
Display repository status (primarily for shell completion).
rona list-status
# or
rona -l
Push committed changes to remote repository.
rona push [extra args]
# or
rona -p [extra args]
Set the default editor for commit messages.
rona set-editor <editor> # The editor to use for commit messages [vim, zed], no default here
Display help information.
rona help
# or
rona -h
-
--version
: Display version information -
--verbose
: Enable verbose output -
--debug
: Enable debug mode -
--no-color
: Disable colored output
-
--no-verify
: Skip pre-commit hooks -
--amend
: Amend the previous commit -
--no-edit
: Use the previous commit message -
--signoff
: Add Signed-off-by line
-
--force
: Force push changes -
--no-verify
: Skip pre-push hooks -
--tags
: Push tags -
--all
: Push all branches
- Quick Commit and Push:
rona -a "src/" -g -c -p
- Interactive Commit:
rona -a "*.rs" -g -i -c
- Force Push:
rona -c -p --force
- Amend Commit:
rona -c --amend
-
RONA_EDITOR
: Set default editor -
RONA_NO_COLOR
: Disable colored output -
RONA_DEBUG
: Enable debug mode
-
commit_message.md
: Commit message template -
.commitignore
: File patterns to ignore -
.rona/config
: Rona configuration file
- Check the Usage Guide for practical examples
- Set up Shell Integration for your preferred shell
- Visit the FAQ for common questions and answers