Skip to content

docs: update qurickstart #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThomasRubini merged 1 commit into from
Mar 16, 2026
Merged

docs: update qurickstart #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions QUICKSTART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,24 @@ You also need a VM kernel file at `backend/vmlinux`.
From repository root:

```bash
cargo build -p backend -p cli && \
cargo build -p agent --target x86_64-unknown-linux-musl && \
cp ./target/x86_64-unknown-linux-musl/debug/agent ./backend/cloude-agentd && \
chmod +x ./backend/cloude-agentd
cargo build -p backend -p cli
cargo build -p agent --target x86_64-unknown-linux-musl
cp ./target/x86_64-unknown-linux-musl/debug/agent ./backend/cloude-agentd
```

## 2) Start backend (one command, terminal A)

From repository root:
Run backend as root from its project folder:

```bash
cd backend && \
PATH="/usr/sbin:$PATH" \
LANGUAGES_CONFIG_PATH=./config/languages.json \
AGENT_BINARY_PATH=./cloude-agentd \
INIT_SCRIPT_PATH=./init.sh \
VM_KERNEL_PATH=./vmlinux \
VM_INITRAMFS_DIR=./tmp \
VM_LOG_GUEST_CONSOLE=false \
../target/debug/backend
cd backend
sudo LANGUAGES_CONFIG_PATH=./config/languages.json \
AGENT_BINARY_PATH=./cloude-agentd \
INIT_SCRIPT_PATH=./init.sh \
VM_KERNEL_PATH=./vmlinux \
VM_INITRAMFS_DIR=./tmp \
VM_LOG_GUEST_CONSOLE=false \
../target/debug/backend
```

Tip: set `VM_LOG_GUEST_CONSOLE=true` only when debugging VM boot/agent startup.
Expand Down