Updates

[parteeksingh24]

• Fix inaccurate domain info in CLI commands
• Add default resource configuration info
• Add sandbox CLI commands
• Remove legacy object storage CLI commands
• Add CLI command for API key (authenticated)

Summary by CodeRabbit

Release Notes

• Documentation
  • Added documentation for SSH access to sandbox environments.
  • Updated deployment resource configuration guidance with CPU, memory, and disk settings.
  • Added API key retrieval command documentation.
  • Expanded sandbox file operations, runtime discovery, and environment variable management documentation.
  • Updated Storage command reference.
  • Removed legacy storage documentation.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR updates CLI reference documentation across multiple pages, adding new SSH sandbox access examples, reorienting deployment resource configuration from CLI commands to configuration file approach, introducing API key retrieval documentation, updating storage command references, and substantially expanding sandbox file operations with runtime commands and environment variable management guidance.

Changes

Cohort / File(s)	Summary
Sandbox Documentation Expansion content/Reference/CLI/debugging.mdx, content/Reference/CLI/sandbox.mdx	Added SSH sandbox access example to debugging guide (+3 lines). Significantly expanded sandbox reference with file operations (list, mkdir, rm, rmdir, download, upload), copy files section, runtime commands, and environment variables management (+182 lines).
Deployment Configuration Restructuring content/Reference/CLI/deployment.mdx	Removed CLI-centric custom domains workflow (Option 2: CLI Commands block). Introduced resource configuration paradigm via agentuity.json covering CPU, memory, and disk settings. Retained DNS and domain-related guidance within new "Resource Configuration" context (+13/-19 lines).
Authentication & Command Reference Updates content/Reference/CLI/getting-started.mdx, content/Reference/CLI/index.mdx	Added "Get Your API Key" subsection with agentuity auth apikey command documentation (+8 lines). Updated Storage command table entry from cloud object to cloud s3 (+1/-1 lines).
Storage Documentation Cleanup content/Reference/CLI/storage.mdx	Removed entire Object Storage (Legacy) documentation block, including repl, put, get, delete, url, presigned, and list operations (-57 lines). S3 storage section retained as recommended approach.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 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.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-docs

---

📜 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 0a07799 and b1d088d.

📒 Files selected for processing (6)

• content/Reference/CLI/debugging.mdx
• content/Reference/CLI/deployment.mdx
• content/Reference/CLI/getting-started.mdx
• content/Reference/CLI/index.mdx
• content/Reference/CLI/sandbox.mdx
• content/Reference/CLI/storage.mdx

💤 Files with no reviewable changes (1)

• content/Reference/CLI/storage.mdx

🔇 Additional comments (10)

content/Reference/CLI/index.mdx (1)

23-23: LGTM!

The storage command update from cloud object to cloud s3 aligns with the removal of legacy object storage commands. The description "Manage KV, vector, object, and Redis storage" remains appropriate since S3 is object storage.

content/Reference/CLI/debugging.mdx (1)

22-24: LGTM!

The sandbox SSH example follows the established pattern with the sbx_ prefix and is consistent with the expanded sandbox documentation in sandbox.mdx.

content/Reference/CLI/deployment.mdx (1)

312-328: LGTM!

The Resource Configuration section clearly documents the deployment resource options with appropriate Kubernetes-style units. The example shows customized values while the defaults are documented separately, which is helpful for users.

content/Reference/CLI/getting-started.mdx (1)

67-73: LGTM!

The API key retrieval command is well-placed under the Authentication section and follows the established agentuity auth subcommand pattern.

content/Reference/CLI/sandbox.mdx (6)

23-32: LGTM!

The Quick Reference table is updated comprehensively with all new sandbox file operations, runtime, and environment variable commands. The additions maintain consistency with the existing table format.

---

173-197: LGTM!

The List Files documentation is well-structured with clear options, alias (lsf), and practical examples covering common use cases.

---

199-240: LGTM!

The directory and file removal commands (mkdir, rm, rmdir) are documented clearly with appropriate options like -p/--parents for creating nested directories and -r/--recursive for removing directories with contents.

---

242-289: LGTM!

The archive download/upload documentation is comprehensive, covering format options (tar.gz, zip), path specifications, and auto-detection. The aliases (dl, ul) are clearly noted.

---

448-472: LGTM!

The Runtime Commands section provides clear documentation for listing available runtimes with pagination options and the rt alias.

---

474-499: LGTM!

The Environment Variables section clearly documents setting, deleting (with repeatable -d flag), and managing environment variables on running sandboxes. The examples cover common use cases effectively.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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