Skip to content

Commit 5beaab0

Browse files
piedpiprpiedpipr
committed
Enhance command references
1 parent 9cbd7f4 commit 5beaab0

File tree

4 files changed

+46
-26
lines changed

4 files changed

+46
-26
lines changed

‎README.md‎

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,58 +19,78 @@ USAGE:
1919
2020
SETUP & INITIALIZATION:
2121
init Initialize GitSSH configuration
22-
onboard Interactive first-time setup wizard
23-
validate Validate system configuration
22+
onboard|setup-wizard Interactive first-time setup wizard
23+
validate|check|doctor Validate gitssh system configuration
2424
25+
ENHANCED GIT OPERATIONS:
26+
clone <url> Enhanced git clone with auto-setup
27+
status|st Enhanced git status with user info
28+
commit|ci [opts] Enhanced git commit with user verification
29+
push [opts] Enhanced git push with verification
30+
fetch [opts] Enhanced git fetch with SSH verification
31+
pull [opts] Enhanced git pull with SSH verification
32+
info Show detailed repository information and SSH connection
33+
2534
USER MANAGEMENT:
26-
user add Add new user account
27-
user remove <user> Remove user account
35+
switch|sw <user> Switch to user locally
36+
switch|sw -g <user> Switch to user globally
37+
user|users See user accounts and ssh accounts status
38+
user add [opts] Add new user account
39+
user remove|rm|delete <user> Remove user account
2840
user list List all configured users
29-
user switch <user> Switch to user globally
41+
user switch <user> Switch to user locally
42+
user switch -g <user> Switch to user globally
3043
user status Show current user status
3144
3245
SESSION MANAGEMENT:
46+
session|sess Show current repository and user session information
3347
session set Set user for current repository
34-
session show Show current session status
48+
session status [options]Show current repository and user session information
49+
session show [options] Show current repository and user session information
3550
session clear Clear session data
36-
session forget Remove persistent config for repo
51+
session forget|remove Remove persistent config for repo
3752
session list List all session repositories
3853
54+
session export <path> Export session data to file
55+
session import <path> Import session data from file
56+
session cleanup Cleanup stale session data
57+
3958
SSH MANAGEMENT:
40-
ssh status Show SSH configuration status
59+
ssh status|info Show SSH configuration status
4160
ssh doctor Diagnose SSH connection issues
4261
ssh repair Fix common SSH problems
4362
ssh test <host> Test SSH connection
63+
ssh backup Backup SSH configuration
64+
ssh restore <path> Restore SSH configuration from backup
65+
ssh learn Guide to adding new SSH hosts
4466
4567
SETUP WIZARDS:
4668
setup github Setup GitHub SSH authentication
4769
setup gitlab Setup GitLab SSH authentication
4870
49-
REPOSITORY OPERATIONS:
50-
clone <url> Enhanced git clone with auto-setup
51-
status Enhanced git status with user info
52-
info Show detailed repository information
53-
commit [opts] Enhanced git commit with verification
54-
push [opts] Enhanced git push with verification
5571
5672
REMOTE MANAGEMENT:
73+
remote|remotes Show git repository remotes
5774
remote convert Convert HTTPS remote to SSH
5875
remote add <name> <url> Add remote with SSH conversion
5976
remote check Check remote configuration
6077
remote list List all remotes with details
78+
remote recommendations Show remote configuration recommendations
79+
6180
6281
CONFIGURATION:
6382
config show Show current configuration
6483
config reset Reset configuration to defaults
6584
config backup Backup configuration files
6685
config restore <path> Restore from backup
86+
config migrate Migrate from old configuration format
6787
6888
INSTALLATION/UNINSTALLATION/UPDATE MANAGEMENT:
6989
gitssh reinstall Reinstall GitSSH system
70-
gitssh uninstall Completely remove GitSSH
71-
gitssh update Update to latest version
72-
gitssh verify Verify installation integrity
73-
gitssh diagnose Run installation diagnostics
90+
gitssh uninstall|remove Completely remove GitSSH
91+
gitssh update|upgrade Update to latest version
92+
gitssh verify|test-install Verify installation integrity
93+
gitssh diagnose|doctor-install Run installation diagnostics
7494
7595
INFORMATION:
7696
help [command] Show help (general or command-specific)

‎modules/gitssh-init.sh‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ git_ssh_validate() {
315315
_print_success "Configuration is valid and ready to use"
316316
else
317317
_print_warning "Found $issues_found issue(s)"
318-
printf "Run 'git_ssh_init' to fix configuration issues\n"
318+
printf "Run 'gitssh init' to fix configuration issues\n"
319319
fi
320320

321321
return "$issues_found"
@@ -342,8 +342,8 @@ git_ssh_init() {
342342
# Validate final configuration
343343
if _validate_final_config; then
344344
_print_success "Initialization complete!"
345-
printf "Use 'git_add_user' to add more users interactively\n"
346-
printf "Use 'git_ssh_help' for full command reference\n"
345+
printf "Use 'gitssh user add' to add more users interactively\n"
346+
printf "Use 'gitssh help' for full command reference\n"
347347
return 0
348348
else
349349
_print_error "Initialization failed validation"

‎modules/gitssh-remotes.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ check_remote() {
368368
if _is_github_https_url "$remote_url"; then
369369
printf " Type: GitHub HTTPS\n"
370370
_print_warning " Recommendation: Convert to SSH for passwordless access"
371-
printf " Use: ssh_remote\n"
371+
printf " Use: gitssh remote convert\n"
372372

373373
# Check if user has matching SSH host
374374
repo_path=$(_extract_repo_path "$remote_url")
@@ -606,7 +606,7 @@ show_remote_recommendations() {
606606
https)
607607
if _is_github_https_url "$origin_url"; then
608608
_print_info "Recommendation: Convert to SSH for passwordless access"
609-
printf " Command: ssh_remote\n"
609+
printf " Command: gitssh remote convert\n"
610610

611611
repo_path=$(_extract_repo_path "$origin_url")
612612
username=$(printf "%s" "$repo_path" | cut -d'/' -f1)

‎modules/gitssh-sessions.sh‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ _git_auto_prompt() {
169169
origin_url=$(_get_remote_url)
170170
case "$origin_url" in
171171
https://github.com/*)
172-
_print_info "Tip: Use 'ssh_remote' for passwordless access"
172+
_print_info "Tip: Use 'gitssh remote convert' for passwordless access"
173173
;;
174174
esac
175175
;;
@@ -189,7 +189,7 @@ _git_auto_prompt() {
189189
case "$origin_url" in
190190
https://github.com/*)
191191
printf "Using HTTPS remote\n"
192-
_print_info "Tip: Use 'ssh_remote' to convert to SSH for passwordless access"
192+
_print_info "Tip: Use 'gitssh remote convert' to convert to SSH for passwordless access"
193193
;;
194194
esac
195195
fi
@@ -206,7 +206,7 @@ _git_auto_prompt() {
206206

207207
# Suggest matching user if available
208208
if _check_dependencies 2>/dev/null && _user_exists "$remote_user"; then
209-
_print_info "You have '$remote_user' configured - use 'session_set' to switch"
209+
_print_info "You have '$remote_user' configured - use 'gitssh session set' to switch"
210210
fi
211211
fi
212212

0 commit comments

Comments
 (0)