Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

twc-rs ssh

Manage SSH keys

SubcommandDescription
listList all SSH keys
addAdd an SSH key from a file or stdin
deleteDelete an SSH key by ID
infoShow detailed information about an SSH key
editEdit an SSH key’s name and/or default flag
attachAttach existing SSH key(s) to a cloud server
detachDetach an SSH key from a cloud server

twc-rs ssh list

List all SSH keys

ArgumentDescriptionRequiredEnvDefault
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs ssh add

Add an SSH key from a file or stdin

ArgumentDescriptionRequiredEnvDefault
--nameHuman-readable name for the keyyes
--filePath to the public key file. Reads from stdin if omitted
--defaultMark this key as default for new serversfalse
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs ssh delete

Delete an SSH key by ID

ArgumentDescriptionRequiredEnvDefault
--idSSH key IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs ssh info

Show detailed information about an SSH key

ArgumentDescriptionRequiredEnvDefault
--idSSH key IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs ssh edit

Edit an SSH key’s name and/or default flag

ArgumentDescriptionRequiredEnvDefault
--idSSH key IDyes
--nameNew name for the key
--defaultMark this key as default for new servers
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs ssh attach

Attach existing SSH key(s) to a cloud server

ArgumentDescriptionRequiredEnvDefault
--serverTarget server IDyes
--keySSH key ID to attach. Repeat to attach several at once
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs ssh detach

Detach an SSH key from a cloud server

ArgumentDescriptionRequiredEnvDefault
--serverTarget server IDyes
--keySSH key ID to detachyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE