chore(scripts): add engine shell command #3311

NathanFlurry · 2025-11-03T22:20:17Z

No description provided.

vercel · 2025-11-03T22:20:24Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
rivetkit-serverless	Ready	Preview	Comment	Nov 4, 2025 7:26pm

3 Skipped Deployments

Project	Deployment	Preview	Updated (UTC)
rivet-cloud	Ignored		Nov 4, 2025 7:26pm
rivet-inspector	Ignored	Preview	Nov 4, 2025 7:26pm
rivet-site	Ignored	Preview	Nov 4, 2025 7:26pm

NathanFlurry · 2025-11-03T22:20:34Z

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

How to use the Graphite Merge Queue

Add the label merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

_{An organization admin has enabled the Graphite Merge Queue in this repository.} _{Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.}

This stack of pull requests is managed by Graphite. Learn more about stacking.

claude · 2025-11-03T22:21:38Z

Code Review

This PR adds a new development helper script for opening a subshell with Rivet engine environment variables. Overall, the implementation is clean and follows good practices. Here are my findings:

✅ Strengths

Good Shell Practices: Uses set -euo pipefail for proper error handling
Consistent Pattern: Follows the same structure as other scripts in scripts/run/
Path Resolution: Properly resolves script directory and repo root
User Feedback: Provides clear informational output about the environment setup
Shell Flexibility: Respects the user's preferred shell via ${SHELL:-bash}

💡 Suggestions

1. Missing Postgres Availability Check

The script hardcodes the Postgres URL but doesn't verify that Postgres is actually running. Consider adding a check similar to engine-postgres.sh:7-29:

if ! command -v nc >/dev/null 2>&1; then
  echo "warning: 'nc' not found, cannot verify postgres availability"
else
  if ! nc -z localhost 5432 >/dev/null 2>&1; then
    echo "warning: Postgres is not reachable at localhost:5432."
    echo "You may need to start postgres with: ./scripts/run/postgres.sh"
  fi
fi

This would provide a better developer experience by catching the issue early.

2. Documentation Consideration

Since this is a new development tool, consider:

Adding a comment at the top of the script explaining its purpose and use cases
Mentioning this script in the repo's development documentation (if it exists)

Example header:

#!/usr/bin/env bash
# Opens a subshell with Rivet engine environment variables configured.
# Useful for running engine commands without cargo run, or for debugging.
# Example: After running this, you can use 'rivet-engine' directly.

3. Minor: PATH Order

The PATH prepends debug before release binaries. This is likely intentional (prefer debug builds), but worth confirming this is the desired behavior for all use cases.

🔒 Security

No security concerns. The script:

Uses local development credentials only
Doesn't persist any sensitive data
Properly quotes all variables

🧪 Testing

The script is straightforward and follows established patterns. Manual testing should verify:

Works when Postgres is running
Handles missing SHELL variable gracefully
Correctly sets environment variables in the subshell

📊 Performance

N/A - This is a simple shell script with negligible performance impact.

✅ Conclusion

LGTM with suggestions! The script is functional and follows good practices. The suggestions above would enhance the developer experience but aren't blocking issues.

pkg-pr-new · 2025-11-03T22:22:48Z

More templates

@rivetkit/actor

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/actor@3311

@rivetkit/cloudflare-workers

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/cloudflare-workers@3311

@rivetkit/core

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/core@3311

@rivetkit/db

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/db@3311

@rivetkit/framework-base

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/framework-base@3311

@rivetkit/next-js

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/next-js@3311

@rivetkit/react

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/react@3311

rivetkit

pnpm add https://pkg.pr.new/rivet-dev/rivet/rivetkit@3311

@rivetkit/sql-loader

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/sql-loader@3311

@rivetkit/engine-runner

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner@3311

@rivetkit/engine-runner-protocol

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner-protocol@3311

commit: 2d5829b

claude · 2025-11-04T19:03:29Z

Code Review

Thank you for this contribution! This is a useful developer utility script. Here's my review:

✅ Strengths

Good bash practices: Uses set -euo pipefail for proper error handling
Consistent structure: Follows the same pattern as other scripts in scripts/run/ (proper shebang, directory resolution)
Clear user feedback: Informative echo statements help users understand what's happening
Executable permissions: Correctly set as executable

💡 Suggestions

1. Consider PostgreSQL availability check

The script sets RIVET__POSTGRES__URL=postgres://postgres:postgres@localhost:5432/postgres but doesn't verify that PostgreSQL is actually running. Consider adding a check similar to engine-postgres.sh:

# Check if postgres is running
if ! command -v nc >/dev/null 2>&1; then
  echo "warning: 'nc' not found. Cannot verify postgres is running."
elif ! nc -z localhost 5432 >/dev/null 2>&1; then
  echo "warning: postgres does not appear to be running at localhost:5432"
  echo "consider running: ./scripts/run/postgres.sh"
fi

This would provide better developer experience by catching configuration issues early.

2. Script naming clarity

The script name engine-postgres-shell.sh is a bit ambiguous - it could be interpreted as:

A shell/REPL for the postgres database
A shell environment for running engine commands

Consider either:

Adding a comment at the top explaining the purpose
Or renaming to something like engine-postgres-env.sh or engine-dev-shell.sh

Example header comment:

#!/usr/bin/env bash
# Opens a subshell with environment variables configured for running rivet-engine
# with PostgreSQL backend. Useful for manual testing and debugging.
set -euo pipefail

3. Document the script's purpose

Since this is a developer utility, consider adding it to project documentation or a README in the scripts/run/ directory so developers know it exists and when to use it.

🔒 Security

No security concerns - this is a local development script with hardcoded localhost credentials, which is appropriate for dev environments.

🎯 Use Cases

This script would be particularly useful for:

Manual debugging of engine commands
Running quick one-off engine operations
Testing different engine configurations

Overall Assessment

This is a solid addition to the developer tooling. The suggestions above are minor improvements that would enhance discoverability and user experience, but the script is functional and follows repository conventions as-is.

Recommendation: Approve with optional improvements

claude · 2025-11-04T19:05:03Z

PR Review: Add engine shell command

Summary

This PR adds a new utility script engine-postgres-shell.sh that opens a subshell with pre-configured environment variables for working with the Rivet engine and PostgreSQL. This is a helpful developer tool for debugging and manual testing.

Code Quality ✅

Positives:

Follows existing script conventions (shebang, set -euo pipefail, path resolution)
Consistent with other scripts in scripts/run/ directory
Clear, helpful output messages for the user
Properly uses exec to replace the current shell process
Respects user's preferred shell via ${SHELL:-bash}

Suggestions:

Add PostgreSQL availability check (Low Priority)

Similar to engine-postgres.sh (lines 12-29), consider adding a check to ensure PostgreSQL is running:

if ! command -v nc >/dev/null 2>&1; then
  echo "warning: 'nc' not found, skipping postgres availability check"
elif ! nc -z localhost 5432 >/dev/null 2>&1; then
  echo "warning: Postgres may not be reachable at localhost:5432"
  echo "Consider running: ./scripts/run/postgres.sh"
fi

This would improve the user experience by catching configuration issues early.

Documentation (Low Priority)

Consider adding a brief comment at the top of the file explaining the script's purpose:

#!/usr/bin/env bash
# Opens a subshell with Rivet engine environment variables configured
# for PostgreSQL development. Useful for running engine commands manually.
set -euo pipefail

Potential Issues

None identified - The script is straightforward and doesn't have any bugs or security concerns.

Performance Considerations

N/A - This is a simple shell script with negligible performance impact.

Security Concerns

Low Risk - The hardcoded credentials (postgres:postgres@localhost:5432) are appropriate for local development environments. The script clearly targets local development only, as indicated by the localhost connection string.

Test Coverage

N/A - This is a developer utility script. Manual testing is sufficient.

Overall Assessment

LGTM! ✅

This is a clean, simple utility that follows repository conventions. The suggestions above are minor improvements that could enhance usability but are not blockers. The script is ready to merge as-is.

Review generated with assistance from Claude Code

claude · 2025-11-04T19:36:03Z

Code Review

Overview

This PR adds a new utility script engine-postgres-shell.sh that provides a convenient subshell environment with Rivet engine PostgreSQL configuration pre-loaded. Overall, this is a useful developer tool that follows good practices.

✅ Positive Observations

Consistent Structure: The script follows the same patterns as other scripts in scripts/run/:
- Uses set -euo pipefail for proper error handling
- Calculates SCRIPT_DIR and REPO_ROOT using the same approach
- Follows the executable permissions convention
Good User Experience:
- Clear echo messages explaining what's happening
- Instructions on how to exit the subshell
- Uses the user's preferred shell via ${SHELL:-bash}
PATH Extension: Smart addition of both debug and release target directories to PATH, allowing easy execution of built binaries

💡 Suggestions for Improvement

1. Consider PostgreSQL Availability Check

The related script engine-postgres.sh includes a check to ensure PostgreSQL is running before proceeding. Consider adding a similar check here to provide better UX:

if ! command -v nc >/dev/null 2>&1; then
  echo "warning: 'nc' not found, cannot verify postgres connectivity"
elif ! nc -z localhost 5432 >/dev/null 2>&1; then
  echo "warning: Postgres may not be reachable at localhost:5432"
  echo "Consider running ./scripts/run/postgres.sh first"
fi

This is optional since a shell environment might be used for various purposes, not just immediate database access.

2. Environment Variable Documentation

Consider adding a brief comment at the top explaining what this script does and when to use it:

#!/usr/bin/env bash
# Opens a subshell with Rivet engine environment variables configured
# Useful for running engine binaries or debugging without starting the full engine
set -euo pipefail

3. Hardcoded Credentials

The PostgreSQL URL contains hardcoded credentials (postgres:postgres). While this is consistent with other scripts in the repository and appropriate for local development, consider:

Adding a comment noting these are local dev credentials only
Or supporting an optional override via environment variable check

🔍 Security Considerations

✅ No security concerns for a local development script
✅ Credentials are appropriate for local Docker environments
✅ Script properly validates paths and uses safe variable expansion

🧪 Testing Considerations

Manual testing recommended: Verify the script works with different shells (bash, zsh, fish)
Verify PATH extension allows running engine binaries as expected
Test behavior when PostgreSQL is not running

📊 Performance

✅ No performance concerns - this is a lightweight utility script

Summary

This is a solid addition to the developer tooling. The script is well-structured, follows repository conventions, and provides clear value. The suggestions above are optional enhancements that could improve the user experience slightly, but the script is merge-ready as-is.

Recommendation: ✅ Approve

graphite-app · 2025-11-04T20:09:47Z

Merge activity

Nov 4, 8:09 PM UTC: NathanFlurry added this pull request to the Graphite merge queue.
Nov 4, 8:11 PM UTC: CI is running for this pull request on a draft pull request (#3349) due to your merge queue CI optimization settings.
Nov 4, 8:41 PM UTC: The Graphite merge queue removed this pull request due to removal of a downstack PR #3342.
Nov 4, 8:49 PM UTC: NathanFlurry added this pull request to the Graphite merge queue.
Nov 4, 8:50 PM UTC: CI is running for this pull request on a draft pull request (#3352) due to your merge queue CI optimization settings.
Nov 4, 8:52 PM UTC: Merged by the Graphite merge queue via draft PR: #3352.

vercel · 2025-11-04T20:25:31Z

Deployment failed with the following error:

Too many requests - try again in 5 minutes (more than 120, code: "api-deployments-flood-pro").

Learn More: https://vercel.com/docs/limits#rate-limits

claude · 2025-11-04T20:40:31Z

Code Review

Summary

This PR adds a new shell script engine-postgres-shell.sh that opens a subshell with Rivet engine environment variables pre-configured for Postgres development. The script is well-structured and follows existing patterns in the codebase.

✅ Strengths

Consistent with existing patterns: The script follows the same structure as other scripts in scripts/run/, using set -euo pipefail and the same directory resolution pattern.
Good user experience: Clear echo statements inform the user about the environment and how to exit the subshell.
PATH modification: Smart addition of both debug and release build directories to PATH, making it easy to run compiled binaries.
Shell flexibility: Uses the user's preferred shell with a bash fallback.

🔍 Observations & Suggestions

1. Missing Postgres availability check

Unlike engine-postgres.sh (lines 7-29), this script doesn't check if Postgres is running or start it automatically. Users might be confused if they run this script without Postgres running.

Suggestion: Consider adding a check similar to engine-postgres.sh:

Check if Postgres is reachable on localhost:5432
If not, either start it automatically or print a helpful error message

2. Environment variable consistency

The script exports RIVET__POSTGRES__URL and RUST_LOG, which is good. However, engine-postgres.sh doesn't export these (uses inline environment variables on line 33-35).

Question: Is there a reason for this difference? If this script is meant to provide an interactive development environment, exporting makes sense. Just want to ensure this is intentional.

3. Documentation/Comments

The script lacks a header comment explaining its purpose and usage.

Suggestion: Add a brief comment at the top explaining the script's purpose.

4. Hard-coded credentials

The Postgres URL contains hard-coded credentials (postgres:postgres), which matches postgres.sh and engine-postgres.sh. This is fine for local development.

Security: ✅ No concerns - these are local development credentials only.

📊 Code Quality Assessment

Aspect	Rating	Notes
Code Quality	⭐⭐⭐⭐	Clean, readable, follows conventions
Error Handling	⭐⭐⭐	Basic bash safety, could add Postgres check
Documentation	⭐⭐⭐	Good inline output, missing header comment
Security	⭐⭐⭐⭐⭐	No security concerns for dev script
Consistency	⭐⭐⭐⭐	Matches existing script patterns

🎯 Verdict

Recommendation: ✅ Approve with minor suggestions

This is a useful developer experience improvement. The script is solid and ready to merge. The suggestions above are optional enhancements that could improve consistency and user experience, but they're not blockers.

📝 Optional Enhancements (Non-blocking)

Add Postgres availability check or at least a warning message
Add header comment explaining the script's purpose
Consider verifying consistency with other scripts regarding environment variable exports

Great work on improving the developer workflow! 🚀

claude · 2025-11-04T20:43:57Z

Code Review Summary

This PR adds a helper script to open a subshell with engine environment variables pre-configured for local development. Overall, the implementation is clean and follows good shell scripting practices.

✅ Positives

Good error handling: Uses set -euo pipefail for safe shell execution
Clean path resolution: Properly resolves script directory and repo root using standard patterns
User-friendly output: Provides clear feedback about what environment is being set up
Shell flexibility: Respects user's $SHELL preference with sensible fallback
Executable permissions: File is properly marked as executable (0755)
Consistent style: Follows the same patterns as existing scripts in the repository (e.g., engine-postgres.sh)

🔍 Observations & Suggestions

1. Security Note: Hardcoded Credentials

The script contains hardcoded postgres credentials (postgres:postgres@localhost:5432). While this is acceptable for local development scripts, it's worth noting:

✅ Safe for local development environments
✅ Consistent with engine-postgres.sh which uses the same credentials
Consider adding a comment explaining these are local dev credentials only

2. Potential Enhancement: Postgres Availability Check

Unlike engine-postgres.sh (lines 7-29), this script doesn't verify that Postgres is running at localhost:5432 before opening the shell. Consider:

Adding a similar check or warning if Postgres isn't reachable
Or documenting that users should run ./scripts/run/postgres.sh first
This would prevent confusion when users try to run commands that need the database

3. Minor: Path Export Order

export PATH="${REPO_ROOT}/target/debug:${REPO_ROOT}/target/release:${PATH}"

This prepends both debug and release directories, with debug taking precedence. This is fine, but worth noting that debug builds will shadow release builds. Consider if this is intentional or if only one should be included based on build mode.

🎯 Code Quality Assessment

Best Practices: ✅ Excellent
Security: ✅ Appropriate for local dev scripts
Performance: ✅ N/A (script is lightweight)
Test Coverage: ⚠️ Shell scripts typically aren't unit tested, but manual testing recommended
Documentation: ⚠️ Could benefit from a comment block at the top explaining purpose and usage

📝 Recommendation

Approve with minor suggestions. The code is production-ready for its intended purpose. The suggestions above are optional enhancements that could improve user experience but aren't blockers.

Optional Enhancement Example

If you want to add the Postgres check, here's a pattern from engine-postgres.sh:

if ! command -v nc >/dev/null 2>&1; then
  echo "warning: 'nc' not found, cannot check if postgres is running"
elif ! nc -z localhost 5432 >/dev/null 2>&1; then
  echo "warning: postgres is not reachable at localhost:5432"
  echo "Run './scripts/run/postgres.sh' to start postgres"
fi

Great addition to the developer tooling! 🚀

vercel bot deployed to Preview – rivetkit-serverless November 3, 2025 22:22 View deployment

MasterPtato approved these changes Nov 4, 2025

View reviewed changes

This was referenced Nov 4, 2025

fix(guard): include method in cache key #3338

Closed

chore(guard): simplify gateway routing #3339

Closed

chore(guard): add support for routing runner ws to /runners/connect #3340

Closed

chore(guard): handle cors on the gateway #3341

Closed

NathanFlurry force-pushed the 11-02-chore_set_minimum_node_version_to_20 branch from d825c16 to e17af20 Compare November 4, 2025 18:59

NathanFlurry force-pushed the 11-02-chore_scripts_add_engine_shell_command branch from 2ec6506 to ad122ff Compare November 4, 2025 18:59

vercel bot deployed to Preview – rivetkit-serverless November 4, 2025 19:00 View deployment

NathanFlurry force-pushed the 11-02-chore_scripts_add_engine_shell_command branch from ad122ff to 87a9fb6 Compare November 4, 2025 19:24

vercel bot deployed to Preview – rivetkit-serverless November 4, 2025 19:26 View deployment

This was referenced Nov 4, 2025

chore(rivetkit): debounce ws message ack #3345

Closed

chore(rivetkit): auto-update auto-start engine version #3344

Closed

ci: trigger rust ci for generated bare artifacts #3346

Closed

graphite-app bot pushed a commit that referenced this pull request Nov 4, 2025

chore(scripts): add engine shell command (#3311)

f5fba63

chore(scripts): add engine shell command

2d5829b

NathanFlurry force-pushed the 11-02-chore_set_minimum_node_version_to_20 branch from 141efff to 33ba42a Compare November 4, 2025 20:25

NathanFlurry force-pushed the 11-02-chore_scripts_add_engine_shell_command branch from 87a9fb6 to 2d5829b Compare November 4, 2025 20:25

graphite-app bot pushed a commit that referenced this pull request Nov 4, 2025

chore(scripts): add engine shell command (#3311)

cd067d2

graphite-app bot closed this Nov 4, 2025

graphite-app bot deleted the 11-02-chore_scripts_add_engine_shell_command branch November 4, 2025 20:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(scripts): add engine shell command #3311

chore(scripts): add engine shell command #3311

Uh oh!

NathanFlurry commented Nov 3, 2025

Uh oh!

vercel bot commented Nov 3, 2025 •

edited

Loading

Uh oh!

NathanFlurry commented Nov 3, 2025 •

edited

Loading

Uh oh!

claude bot commented Nov 3, 2025

Uh oh!

pkg-pr-new bot commented Nov 3, 2025 •

edited

Loading

Uh oh!

claude bot commented Nov 4, 2025

Uh oh!

claude bot commented Nov 4, 2025

Uh oh!

claude bot commented Nov 4, 2025

Uh oh!

graphite-app bot commented Nov 4, 2025 •

edited

Loading

Uh oh!

vercel bot commented Nov 4, 2025

Uh oh!

claude bot commented Nov 4, 2025

Uh oh!

claude bot commented Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chore(scripts): add engine shell command #3311

chore(scripts): add engine shell command #3311

Uh oh!

Conversation

NathanFlurry commented Nov 3, 2025

Uh oh!

vercel bot commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NathanFlurry commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

claude bot commented Nov 3, 2025

Code Review

✅ Strengths

💡 Suggestions

1. Missing Postgres Availability Check

2. Documentation Consideration

3. Minor: PATH Order

🔒 Security

🧪 Testing

📊 Performance

✅ Conclusion

Uh oh!

pkg-pr-new bot commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

claude bot commented Nov 4, 2025

Code Review

✅ Strengths

💡 Suggestions

1. Consider PostgreSQL availability check

2. Script naming clarity

3. Document the script's purpose

🔒 Security

🎯 Use Cases

Overall Assessment

Uh oh!

claude bot commented Nov 4, 2025

PR Review: Add engine shell command

Summary

Code Quality ✅

Potential Issues

Performance Considerations

Security Concerns

Test Coverage

Overall Assessment

Uh oh!

claude bot commented Nov 4, 2025

Code Review

Overview

✅ Positive Observations

💡 Suggestions for Improvement

1. Consider PostgreSQL Availability Check

2. Environment Variable Documentation

3. Hardcoded Credentials

🔍 Security Considerations

🧪 Testing Considerations

📊 Performance

Summary

Uh oh!

graphite-app bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

vercel bot commented Nov 4, 2025

Uh oh!

claude bot commented Nov 4, 2025

Code Review

Summary

✅ Strengths

🔍 Observations & Suggestions

1. Missing Postgres availability check

2. Environment variable consistency

3. Documentation/Comments

4. Hard-coded credentials

📊 Code Quality Assessment

🎯 Verdict

📝 Optional Enhancements (Non-blocking)

vercel bot commented Nov 3, 2025 •

edited

Loading

NathanFlurry commented Nov 3, 2025 •

edited

Loading

pkg-pr-new bot commented Nov 3, 2025 •

edited

Loading

graphite-app bot commented Nov 4, 2025 •

edited

Loading