Skip to content

Commit a75ecc9

Browse files
committed
docs(docker): document attaching to in-container tmux sessions
Add the `docker exec ... tmux attach -t agentic-mobile-manipulator-sim` recipe to the quickstart and compose header for inspecting a running demo, and tighten the repo-overview docker description for the layered build.
1 parent a25e866 commit a75ecc9

3 files changed

Lines changed: 15 additions & 2 deletions

File tree

docker/compose.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
# each in its own tmux session — identical to running the demo natively.
1010
#
1111
# Build everything: docker compose -f docker/compose.yaml build
12-
# Run the demo: xhost +local:root && docker compose -f docker/compose.yaml run --rm demo
12+
# Run the demo: xhost +local:root && docker compose -f docker/compose.yaml up demo
13+
# Attach to a session: docker exec -it $(docker ps -qf ancestor=robotecai/mobile-manipulator-demo:latest) tmux attach -t agentic-mobile-manipulator-sim
14+
# (sessions: -sim -stack -llm-servers -agents -hmi)
1315
#
1416
# Target is single-pc-gpu-and-npu (the default). For a GPU-only image — llama.cpp
1517
# (Vulkan) only, no FastFlowLM/NPU — build with:

docs/quickstart.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,17 @@ The container's entrypoint is `pixi run demo`, which brings the whole stack up i
6363
2. **HMI**: a window/terminal showing the Human-Machine Interface.
6464
3. **Agents**: the autonomous agents run in the background, driving the robot.
6565

66+
## Inspecting a component
67+
68+
Each component runs in its own tmux session inside the container. Attach to one (e.g. the simulation) from the host:
69+
70+
```bash
71+
docker exec -it $(docker ps -qf ancestor=robotecai/mobile-manipulator-demo:latest) \
72+
tmux attach -t agentic-mobile-manipulator-sim
73+
```
74+
75+
Swap the session for any of `-sim`, `-stack`, `-llm-servers`, `-agents`, `-hmi` (all prefixed `agentic-mobile-manipulator-`). Inside tmux, `Ctrl-b s` lists/switches sessions and `Ctrl-b d` detaches — the demo keeps running.
76+
6677
## Stopping
6778

6879
```bash

docs/repo_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The repository is organized into several key directories:
2323

2424
### Infrastructure & Simulation
2525

26-
- **`docker/`**: Deployment files. Contains `docker-compose` configurations for AMD GPUs and AMD Ryzen™ AI, and Dockerfiles for different components.
26+
- **`docker/`**: Deployment files for AMD GPU + AMD Ryzen™ AI. A layered build (`ros2``o3de``demo`) produces a single container that runs the whole demo via `pixi run demo`. See the [Quickstart Guide](./quickstart.md).
2727
- **`project_gems/`**: Assets and configurations for the **O3DE (Open 3D Engine)** simulation environment.
2828
- **`config.toml`**: The central configuration file for defining which LLMs and VLMs are used by the agents.
2929

0 commit comments

Comments
 (0)