🤖 feat: pass PROJECT_PATH env var to init hooks #575
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- LocalRuntime: Pass PROJECT_PATH when spawning init hook - SSHRuntime: Pass PROJECT_PATH in env when executing init hook remotely This allows init hooks to reference the project path without relying on inferring it from the workspace path.
Added new 'Environment Variables' section documenting that init hooks receive PROJECT_PATH pointing to the project root directory. Includes example showing how to reference files in the project root from within a workspace-scoped init hook.
Extract getInitHookEnv() helper in initHook.ts to avoid duplicating environment variable logic between LocalRuntime and SSHRuntime. This makes it easier to add new init hook env vars in the future - just update the helper function instead of maintaining duplicate env objects.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
SSH init hooks now receive PROJECT_PATH pointing to the remote project root (srcBaseDir/projectName) instead of the local project path. This ensures init scripts can access project-level files on the remote filesystem as documented in docs/init-hooks.md.
Changed init hook environment variables:
- PROJECT_PATH → MUX_PROJECT_PATH
- Added MUX_RUNTIME ("local" | "ssh")
MUX_RUNTIME is important because:
- On local workspaces, MUX_PROJECT_PATH points to local filesystem
- On SSH workspaces, MUX_PROJECT_PATH points to remote filesystem
- Scripts can check MUX_RUNTIME to handle platform differences
Updated docs with examples showing runtime-specific behavior.
MUX_PROJECT_PATH now always refers to the local project path, even on SSH workspaces. This is more useful for logging and debugging. Updated docs to clarify: - MUX_PROJECT_PATH = local project path (both local and SSH) - Use relative paths (e.g., '../.env') in init hooks to reference project files, which works for both local and SSH workspaces
ammario
approved these changes
Nov 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Generated with
cmuxChanges
Adds
PROJECT_PATHenvironment variable to init hooks, providing access to the project root directory.Implementation
PROJECT_PATHwhen spawning init hook processPROJECT_PATHin env when executing init hook remotelygetInitHookEnv()helper to avoid duplicationDocumentation
Updated
docs/init-hooks.mdwith:PROJECT_PATHThis allows init hooks to reliably access project-level files (like
.envtemplates) without inferring paths from the workspace directory structure.