> ## 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.

# Quick Start

> Launch your first RemoteMux environment and attach to a persistent remote shell.

## Before You Begin

<Accordion title="Install RemoteMux">
  ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -fsSL https://remotemux.com/releases/install.sh | bash
  ```
</Accordion>

<Tabs>
  <Tab title="AWS BYOC">
    You need AWS credentials, the AWS CLI, and the AWS Session Manager plugin.
  </Tab>

  <Tab title="GCP BYOC">
    You need `gcloud` installed and authenticated, plus a project with Compute Engine enabled.
  </Tab>

  <Tab title="E2B">
    You need an E2B API key and a template that supports `apt-get` or `dnf`.
  </Tab>

  <Tab title="Managed">
    You need a control-plane URL and `rmux login`.
  </Tab>
</Tabs>

***

<Steps>
  <Step title="Configure and validate the backend">
    From inside the project you want to bind:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    cd /path/to/project
    rmux login
    ```

    <Tabs>
      <Tab title="AWS BYOC">
        ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
        rmux configure --backend aws --from-aws-cli
        rmux aws-check
        ```
      </Tab>

      <Tab title="GCP BYOC">
        ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
        rmux configure \
          --backend gcp \
          --gcp-project-id YOUR_PROJECT \
          --gcp-zone us-central1-a

        rmux gcp-check
        ```
      </Tab>

      <Tab title="E2B">
        ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
        rmux configure \
          --backend e2b \
          --e2b-api-key e2b_xxx
        ```

        There is no dedicated preflight command for E2B. Use `rmux configure --show` to verify.
      </Tab>

      <Tab title="Managed">
        ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
        rmux login
        rmux configure --backend managed
        ```

        No cloud credentials needed -- the control plane provisions sandbox environments for you.
      </Tab>
    </Tabs>

    Not sure which backend to use? See [Choose a Backend](/concepts/backends).
  </Step>

  <Step title="Create the environment">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    rmux env new
    ```

    This provisions the environment and binds the current directory to it.
  </Step>

  <Step title="Bootstrap the project workspace">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    rmux workspace new main
    ```

    Syncs the current directory into `/workspace`, restores Git state, and creates the default `main` workspace.

    <Tip>Use `rmux env sync` later to push local changes into the environment without reprovisioning.</Tip>
  </Step>

  <Step title="Attach and work">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    rmux workspace attach
    ```

    You are now in a remote `tmux` session. Start Claude Code, run tests, or do anything you would in a local terminal.

    Press `Ctrl+B`, then `D` to detach. The session keeps running.
  </Step>

  <Step title="Stop or destroy when done">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    rmux env down       # stop compute, preserve state
    rmux env destroy    # remove entirely
    ```
  </Step>
</Steps>

## What To Do Next

<CardGroup cols={2}>
  <Card icon="bot" title="Use AI Agents" href="/guides/ai-agents">
    Run Claude Code or Codex on a persistent remote workspace.
  </Card>

  <Card icon="settings" title="Configuration" href="/guides/configuration">
    Config files, environment variables, and backend-specific settings.
  </Card>

  <Card icon="play" title="Workflow Patterns" href="/guides/workspaces">
    Day-to-day workspace commands and common patterns.
  </Card>

  <Card icon="terminal" title="Troubleshooting" href="/troubleshooting">
    Fix preflight, attach, sync, or binding issues.
  </Card>
</CardGroup>