Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.remotemux.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Start Here

When RemoteMux behaves unexpectedly, inspect the resolved config and current binding first: 
rmux configure --show
rmux auth status
rmux env status
rmux workspace ls
Then run the backend-specific check if available: 
rmux aws-check    # AWS only
rmux gcp-check    # GCP only
backend=e2b and backend=managed do not have dedicated preflight commands — use rmux configure --show.
Many problems come from running commands outside the directory that created the environment binding. Make sure you are in the right project directory.

​
Binding And Directory

You are in the wrong directory or have not created an environment for this project. Re-enter the directory that ran rmux env new, or create a new environment.
Use rmux workspace attach to reconnect, rmux env status to inspect, or rmux env destroy if you want to replace the environment.

​
AWS

Confirm backend=aws is selected, AWS credentials are valid, and the region is correct. Run rmux configure --show to verify.
Attach uses the AWS Session Manager plugin, bundled in RemoteMux releases. If you have the plugin elsewhere, set RMUX_SESSION_MANAGER_PLUGIN_PATH.
RemoteMux needs a workspace bucket for staged sync. On the BYOC default path, rerun rmux aws-check or rmux env new to let RemoteMux auto-resolve it. Otherwise, set --workspace-bucket or aws.workspaceBucket explicitly.

​
GCP

Enable the Compute Engine API in the target project, then rerun rmux gcp-check.
Verify the resolved auth mode, project, and zone match the RemoteMux config. Compare rmux configure --show with gcloud auth list when gcp.authMode=gcloud-cli.If you use gcp.authMode=credentials-file, confirm gcp.credentialsFile or RMUX_GCP_CREDENTIALS_FILE points to a readable credential file, and re-check any gcp.impersonateServiceAccount setting.

​
Managed

Check apiBaseUrl and your auth state with rmux auth status. Hosted deployments require a valid OAuth session or scoped service token. If commands fail in an interactive terminal, rmux now offers an auth picker automatically; otherwise switch explicitly with rmux auth use oauth or rmux auth use api-key --token <api-key>.If the active source is env, unset RMUX_API_KEY. If the active source is none, select a stored auth method with rmux auth use ....
Contact your RemoteMux operator — the control plane may be using a sandbox template that lacks the required dev tools.

​
E2B

Confirm backend=e2b is selected and the API key is present. rmux configure --show should show the backend, template, timeout, and a masked key.
RemoteMux installs tmux, git, and python3 on first use. Choose a template with apt-get or dnf available.

​
Sync And Workspaces

rmux workspace new main only seeds the project once. Use rmux env sync or git to move later changes.
Run rmux claude status from the project directory. If local auth exists but remote auth is missing, run rmux claude sync. If local auth is missing, run rmux claude login.
Only main uses /workspace. Named workspaces use separate git worktrees (or copied folders for non-git projects).

​
Before You File A Bug

Capture these and include them in your report at github.com/autocomputer-ai/rmux/issues:
  • rmux configure --show
  • rmux auth status
  • rmux env status
  • rmux workspace ls
  • The relevant rmux aws-check or rmux gcp-check output
  • The exact command and error message
Last modified on April 9, 2026