Skip to content

Conversation

@flakey5
Copy link
Contributor

@flakey5 flakey5 commented Sep 10, 2025

Summary

Adds documentation for ssh'ing into a container with wrangler

Wrangler PR: cloudflare/workers-sdk#10582

Screenshots (optional)

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

Copy link
Contributor

@emily-shen emily-shen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flakey5 flakey5 requested review from a team, GregBrimble and WalshyDev as code owners September 12, 2025 15:14
@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

Hey there, this pull request has been automatically marked as stale because it has not had recent activity. It will be auto-closed after and additional 10 days of inactivity. If you need it open for longer, add the label stale-exempt.

@github-actions github-actions bot added the stale label Nov 3, 2025
- SSH option for log_file
- `--escape-char` <Type text="string" /> <MetaInfo text="optional" />
- SSH option for escape_char
- `--config-file` <Type text="string" /> <MetaInfo text="optional" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `--config-file` <Type text="string" /> <MetaInfo text="optional" />
- `-F` or `--config-file` <Type text="string" /> <MetaInfo text="optional" />

- SSH option for config-file
- `--pkcs11` <Type text="string" /> <MetaInfo text="optional" />
- SSH option for pkcs11
- `--identity-file` <Type text="string" /> <MetaInfo text="optional" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `--identity-file` <Type text="string" /> <MetaInfo text="optional" />
- `-i` or `--identity-file` <Type text="string" /> <MetaInfo text="optional" />

- SSH option for mac_spec
- `--ctl-cmd` <Type text="string" /> <MetaInfo text="optional" />
- SSH option for ctl_cmd
- `--option` <Type text="string" /> <MetaInfo text="optional" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `--option` <Type text="string" /> <MetaInfo text="optional" />
- `-o` or `--option` <Type text="string" /> <MetaInfo text="optional" />

- `--ctl-cmd` <Type text="string" /> <MetaInfo text="optional" />
- SSH option for ctl_cmd
- `--option` <Type text="string" /> <MetaInfo text="optional" />
- SSH option for option
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- SSH option for option
- Specify SSH options (can be given multiple times)

Comment on lines +105 to +107
```txt
wrangler containers ssh [CONTAINER_ID] [OPTIONS]
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```txt
wrangler containers ssh [CONTAINER_ID] [OPTIONS]
```
Connect to your container using SSH:
```console
wrangler containers ssh [OPTIONS] CONTAINER_ID
```
You can also specify a command to run, instead of the default shell. For example:
```console
wrangler containers ssh [OPTIONS] CONTAINER_ID -- ls -al
```

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants