Skip to content

Commit 5a9c46e

Browse files
committed
update: add SSH agent documentation to manpage
1 parent 1e94e77 commit 5a9c46e

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/man/bssh.1

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ Default username for SSH connections
3737
.BR \-i ", " \-\-identity " " \fIIDENTITY\fR
3838
SSH private key file path
3939

40+
.TP
41+
.BR \-A ", " \-\-use\-agent
42+
Use SSH agent for authentication (Unix/Linux/macOS only).
43+
When this option is specified, bssh will attempt to use the SSH agent
44+
for authentication. Falls back to key file authentication if the agent
45+
is not available or authentication fails.
46+
4047
.TP
4148
.BR \-p ", " \-\-parallel " " \fIPARALLEL\fR
4249
Maximum parallel connections (default: 10)
@@ -166,6 +173,10 @@ Increase verbosity for debugging:
166173
Use custom SSH key:
167174
.B bssh -i ~/.ssh/custom_key -c staging "systemctl status"
168175

176+
.TP
177+
Use SSH agent for authentication:
178+
.B bssh -A -c production "systemctl status"
179+
169180
.TP
170181
Save output to files:
171182
.B bssh --output-dir ./results -c production "ps aux"
@@ -196,6 +207,10 @@ SSH known hosts file for host key verification
196207
.I ~/.ssh/id_rsa
197208
Default SSH private key
198209

210+
.TP
211+
.I $SSH_AUTH_SOCK
212+
SSH agent socket for agent-based authentication
213+
199214
.SH ENVIRONMENT
200215
.TP
201216
.B USER
@@ -217,14 +232,19 @@ Backend.AI current node hostname
217232
.B BACKENDAI_CLUSTER_ROLE
218233
Backend.AI node role (main/sub)
219234

235+
.TP
236+
.B SSH_AUTH_SOCK
237+
SSH agent socket path. When set, bssh can automatically detect and use
238+
the SSH agent for authentication without specifying the -A flag
239+
220240
.SH AUTHOR
221241
Written by Jeongkyu Shin and the Lablup team.
222242

223243
.SH REPORTING BUGS
224244
Report bugs to: https://github.com/lablup/bssh/issues
225245

226246
.SH COPYRIGHT
227-
Copyright © 2025 Lablup Inc. and Jeongkyu Shin
247+
Copyright 2025 Lablup Inc. and Jeongkyu Shin
228248
.br
229249
Licensed under the Apache License, Version 2.0
230250

0 commit comments

Comments
 (0)