Skip to content

feat(devbox): added devbox.shell(shellName) command and stateful shell class to SDK#665

Merged
dines-rl merged 5 commits intomainfrom
dines/stateful-shells
Nov 26, 2025
Merged

feat(devbox): added devbox.shell(shellName) command and stateful shell class to SDK#665
dines-rl merged 5 commits intomainfrom
dines/stateful-shells

Conversation

@dines-rl
Copy link
Copy Markdown
Contributor

@dines-rl dines-rl commented Nov 26, 2025

CodeAnt-AI Description

Add stateful named shell sessions to Devbox

What Changed

  • Devbox.shell now opens or reattaches to a named shell so commands run sequentially with a preserved working directory and environment, just like a persistent local shell.
  • DevboxNamedShell.exec and execAsync run commands inside that session, honor streaming callbacks, and queue executions so each waits for prior commands to finish before the next begins.
  • Smoke tests exercise the new named-shell APIs, confirming basic runs, env and CWD persistence, streaming output, sequential queuing, and isolated state across multiple shells.

Impact

✅ Stateful shell sessions keep env and CWD across commands
✅ Sequential command execution avoids overlapping runs in a named shell
✅ Streaming callbacks reflect the same output as final results

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

@dines-rl dines-rl requested a review from jrvb-rl November 26, 2025 00:13
@codeant-ai
Copy link
Copy Markdown
Contributor

codeant-ai bot commented Nov 26, 2025

CodeAnt AI is reviewing your PR.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@dines-rl dines-rl requested review from adam-rl and sid-rl November 26, 2025 00:13
@codeant-ai codeant-ai bot added the size:L This PR changes 100-499 lines, ignoring generated files label Nov 26, 2025
@codeant-ai
Copy link
Copy Markdown
Contributor

codeant-ai bot commented Nov 26, 2025

CodeAnt AI finished reviewing your PR.

@github-actions
Copy link
Copy Markdown

✅ Object Smoke Tests & Coverage Report

Test Results

✅ All smoke tests passed

Coverage Results

Metric Coverage Required Status
Functions 100% 100%
Lines 86.92% - ℹ️
Branches 54.71% - ℹ️
Statements 86.46% - ℹ️

Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)

✅ All tests passed and all object methods are covered!

View detailed coverage report

Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.

📋 View workflow run

Copy link
Copy Markdown
Contributor

@adam-rl adam-rl left a comment

Choose a reason for hiding this comment

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

Looks awesome

Copy link
Copy Markdown
Contributor

@jrvb-rl jrvb-rl left a comment

Choose a reason for hiding this comment

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

Overall this looks good. We should think a bit about what guarantees we want to make for this primitive.

Also, I didn't notice the command queuing / serialization here. Is that something that already happens on the server side for named shells?

Comment thread src/sdk/devbox.ts
*
* Named shells are stateful and maintain environment variables and the current working directory (CWD)
* across commands, just like a real shell on your local computer. Commands executed through the same
* named shell instance will execute sequentially - the shell can only run one command at a time with
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What happens if the user does

shell.exec("long_running_thing &")
shell.exec("BG_PID=$!")

My personal take is that we should not promise a long running bash shell, so we should make no guarantees about any shell-specific features or syntax. So maybe explicitly say that the only thing we are guaranteeing will persist are the values in 'env' output and the CWD?

If we want to be a bit more specific, we could say:

"Persistent shells will run in a bash shell, with the same CWD and env. Commands may not all run in the exact same shell process, so more exotic bash shell features may work in some cases."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yah so Jon wrote a whole queuing thing, so this should work just fine. So only one will run at a time. I will update it not to say like a real shell.

Comment thread src/sdk/devbox.ts
@codeant-ai
Copy link
Copy Markdown
Contributor

codeant-ai bot commented Nov 26, 2025

CodeAnt AI is running Incremental review


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai codeant-ai bot added size:L This PR changes 100-499 lines, ignoring generated files and removed size:L This PR changes 100-499 lines, ignoring generated files labels Nov 26, 2025
@codeant-ai
Copy link
Copy Markdown
Contributor

codeant-ai bot commented Nov 26, 2025

CodeAnt AI Incremental review completed.

@dines-rl dines-rl merged commit ad9474f into main Nov 26, 2025
8 of 9 checks passed
@dines-rl dines-rl deleted the dines/stateful-shells branch November 26, 2025 21:20
@stainless-app stainless-app bot mentioned this pull request Nov 26, 2025
@github-actions
Copy link
Copy Markdown

⚠️ Object Smoke Tests & Coverage Report

Test Results

✅ All smoke tests passed

Coverage Results

Metric Coverage Required Status
Functions 98.24% 100%
Lines 85.48% - ℹ️
Branches 51.54% - ℹ️
Statements 85.03% - ℹ️

Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)

⚠️ Some object methods are not covered in smoke tests. Please add tests that call all public methods.

View detailed coverage report

Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.

📋 View workflow run

@github-actions
Copy link
Copy Markdown

✅ Object Smoke Tests & Coverage Report

Test Results

✅ All smoke tests passed

Coverage Results

Metric Coverage Required Status
Functions 100% 100%
Lines 86.55% - ℹ️
Branches 50.51% - ℹ️
Statements 86.08% - ℹ️

Coverage Requirement: 100% function coverage (all public methods must be called in smoke tests)

✅ All tests passed and all object methods are covered!

View detailed coverage report

Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.

📋 View workflow run

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

Labels

size:L This PR changes 100-499 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants