Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 3, 2026

Summary

Adds a new "SSH Access to Sandboxes" section to the sandbox CLI documentation that explains how to SSH into sandboxes and the prerequisite of setting up SSH keys first.

This addresses user confusion from the #frictionlog Slack thread where a user encountered "Permission denied (publickey)" errors when trying to SSH into a sandbox without first registering their SSH key with Agentuity.

Changes:

  • Added new section showing agentuity cloud ssh sbx_xxx usage
  • Added warning callout explaining SSH key setup is required before connecting
  • Included instructions for generating SSH keys and adding them via agentuity auth ssh add
  • Linked to existing SSH Key Management section in getting-started.mdx

Review & Testing Checklist for Human

  • Verify the internal link /Reference/CLI/getting-started#ssh-key-management resolves correctly in the built docs
  • Confirm the CLI commands shown (agentuity auth ssh add, agentuity cloud ssh) match current CLI behavior

Suggested test: Run npm run dev and navigate to the sandbox documentation page to verify the new section renders correctly and the link works.

Notes

Requested by: Rick Blalock (@rblalock)
Devin session: https://app.devin.ai/sessions/dd7191c1b2af43b78d515e101fd447af

Summary by CodeRabbit

  • Documentation
    • Added SSH access guide for sandboxes with practical usage examples for direct access and remote command execution
    • Included SSH key setup guidance and troubleshooting instructions
    • Documented common use cases: debugging, inspection, interactive testing, and real-time log access

- Add new 'SSH Access to Sandboxes' section explaining how to SSH into sandboxes
- Include callout warning about SSH key requirement before connecting
- Document how to generate SSH keys and add them to Agentuity account
- Link to SSH Key Management section in getting-started for more details

This addresses user confusion about 'Permission denied (publickey)' errors
when trying to SSH into sandboxes without first setting up SSH keys.

Co-Authored-By: Rick Blalock <rickblalock@mac.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 3, 2026

📝 Walkthrough

Walkthrough

Added comprehensive SSH Access to Sandboxes documentation section covering usage examples, SSH key setup requirements, key generation instructions, and common use cases for direct sandbox access.

Changes

Cohort / File(s) Summary
Sandbox SSH Documentation
content/Reference/CLI/sandbox.mdx
Added new "SSH Access to Sandboxes" section with SSH usage examples, SSH key requirements and setup instructions, key generation guidance, and SSH access use cases for debugging and interactive testing.
🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


🧹 Recent nitpick comments
content/Reference/CLI/sandbox.mdx (1)

38-51: Consider adding ssh to the Quick Reference table for discoverability.

The Quick Reference table (lines 14-34) doesn't include the ssh command. Users scanning the table for available commands won't discover SSH access is available. Consider adding a row:

 | `sandbox env <id>` | Manage environment variables |
+| `ssh <id>` | SSH into sandbox |

Also, minor inconsistency: the example uses sbx_abc123xyz while the rest of the file uses sbx_abc123. Consider aligning for consistency.

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e21a167 and efba360.

📒 Files selected for processing (1)
  • content/Reference/CLI/sandbox.mdx
🔇 Additional comments (2)
content/Reference/CLI/sandbox.mdx (2)

73-79: LGTM!

The use cases are practical and help users understand when SSH access is valuable. Good documentation that addresses the user confusion mentioned in the #frictionlog thread.


70-70: Internal link resolves correctly.

The link /Reference/CLI/getting-started#ssh-key-management properly points to the ## SSH Key Management section in content/Reference/CLI/getting-started.mdx.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant