@studiometa/forge-cli 0.4.3 → 0.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -59,6 +59,7 @@ forge <command> [subcommand] [options]
59
59
  | `nginx-templates` | | List, get, create, update, delete Nginx templates |
60
60
  | `certificates` | `certs` | List, get, activate SSL certificates for a site |
61
61
  | `firewall-rules` | `fw` | List, get firewall rules on a server |
62
+ | `ssh` | | Open an SSH session to a server |
62
63
  | `ssh-keys` | | List, get SSH keys on a server |
63
64
  | `security-rules` | | List, get, create, delete security rules for a site |
64
65
  | `redirect-rules` | | List, get, create, delete redirect rules for a site |
@@ -181,6 +182,19 @@ forge firewall-rules list --server <id> # List firewall rules
181
182
  forge firewall-rules get <rule_id> --server <id> # Get rule details
182
183
  ```
183
184
 
185
+ ### `ssh` — Open an SSH session to a server
186
+
187
+ ```bash
188
+ forge ssh <server> # Interactive session (forge@<ip>)
189
+ forge ssh <server> --user deploy # Connect as a custom user
190
+ forge ssh <server> --private # Connect over the private IP
191
+ forge ssh <server> --port 2222 # Override the SSH port
192
+ forge ssh <server> uptime # Run a remote command, then exit
193
+ forge ssh <server> --dry-run # Print the ssh command instead
194
+ ```
195
+
196
+ Requires your local SSH key to be authorized on the server; this command launches `ssh`, it does not upload keys.
197
+
184
198
  ### `ssh-keys` — Manage SSH keys
185
199
 
186
200
  ```bash