Skip to content

QUICKSTART-en.md

Latest commit

 

History

History
215 lines (156 loc) · 7.59 KB

QUICKSTART-en.md

File metadata and controls

215 lines (156 loc) · 7.59 KB

🚀 Quick Start for Non-Developers (English)

This guide assumes you have never used a terminal. Just copy each command line by line and paste it.

📖 Contents

🗺 If This Is Your First Time / Document Map

This is a linear 9-step recipe. Just go top-to-bottom. Each step has a single command to copy-paste:

Step What
1–4 Open Terminal · clone · cd · auto-create .env
5 ./openclaw doctor — see what's missing
6 ./openclaw install — auto-fill the missing pieces
7 Verify everything is ✓
8–9 Daily auto-update + safe backup

🎯 Recommended: read top-to-bottom in one sitting (~10 minutes). If anything breaks, jump to When something goes wrong at the bottom or TROUBLESHOOTING.md.

Prerequisites

  • A MacBook (Apple Silicon M1 or later — reference: MacBook Pro 16" M5 Pro / 24GB RAM)
  • An internet connection
  • At least 50GB of free disk space
  • About 30 minutes (mostly waiting for downloads)

1. Open Terminal

  1. Press ⌘ + Space (Command + Spacebar)
  2. Type Terminal and press Enter
  3. A black (or white) window appears — that's your terminal

When you open Terminal you'll see something like:

Last login: Sat Apr 25 10:30:12 on ttys000
yourname@MacBook-Pro ~ %

You type commands after the % prompt.

2. Get the code

Copy this single line, paste it into Terminal, and press Enter:

git clone https://github.com/GoGoComputer/openclaw-workspace.git ~/openclaw-workspace

💡 If you don't have git yet, macOS pops up a dialog to install Xcode Command Line Tools. Click Install and wait (~5 min).

3. Move into the folder

cd ~/openclaw-workspace/openclaw-mgr

4. Settings file (auto-created — nothing to do)

When you run ./openclaw for the first time, the .env settings file is created automatically. The official OpenClaw repo URL is already pre-filled.

✔ .env 자동 생성됨 (.env.example 기본값 적용)

When you see that message, you're good. No editing required — just move straight to install.

💡 If you later want to change the model, backup path, or other settings, open openclaw-mgr/.env in any text editor. You don't need to do this now.

5. Check current state

./openclaw doctor

You'll see red ✗ and yellow ⚠ marks — that's normal. The next step fixes them.

Example output (before install — most things missing):

━━━━━━━━ OpenClaw System Diagnosis ━━━━━━━━
  ✓  OS                     Darwin 15.4 arm64
  ✓  CPU                    Apple M5 Pro
  ✓  RAM                    24GB
  ✓  Disk free              142GB
  ─────────────────────────────────────────
  ✗  Xcode CLT              —
       ↳ install will set this up
  ✗  Homebrew               —
       ↳ install will set this up
  ✗  Docker                 —
       ↳ Docker Desktop required
  ⚠  Docker daemon          —
       ↳ Launch Docker Desktop
  ✗  Ollama                 —
  ─────────────────────────────────────────
  ⚠  OpenClaw repo          —
       ↳ Set OPENCLAW_REPO in .env first
  ⚠  Containers running     0
       ↳ ./openclaw start
  ─────────────────────────────────────────
  🔒 Network isolation       isolated (outbound blocked)
       ↳ Top security — flip to online during install/update

Colors in your real terminal: red (✗) / yellow (⚠) / green (✓).

6. Run the install

./openclaw install

What happens — just go along with it:

Step Action ETA
Xcode CLT System dialog appears → click Install 5 min
Homebrew If Press RETURN to continue shows, press Enter; enter password if prompted 2 min
Docker Desktop First launch shows EULA → Accept 3 min
Install Ollama Automatic 1 min
Pull model (qwen2.5-coder:7b, ~4.7GB) Automatic 5–10 min
Clone OpenClaw repo Automatic 1 min
Build/start container Automatic 5–15 min

Total ~20–40 min (mostly waiting). You can close the laptop mid-way — just rerun the same command later and it resumes from where it stopped.

7. Verify

./openclaw doctor

If everything is ✓ (green check), you're good 🎉

./openclaw logs

Live container logs. Stop with Ctrl + C.

8. Daily auto-update

./openclaw schedule enable

Updates run automatically every day at 3 AM. Disable with ./openclaw schedule disable.

9. Safe backup

./openclaw backup --name fresh-install

A .tar.gz file appears in ~/openclaw-backups/. Copy it to an external drive or cloud (after secret review).

Or just use the menu

If you don't want to remember commands, run:

./openclaw

This opens an interactive menu (Korean/English auto-detected) where you pick numbers to do everything above.

When something goes wrong

  1. ./openclaw doctor — tells you exactly what's wrong
  2. docs/TROUBLESHOOTING.md — common error fixes
  3. Still stuck? Open a GitHub Issue with the ./openclaw doctor output. (Secrets are auto-masked.)

🔗 관련 문서 / Related docs

문서 무엇이 있나
🌱 처음부터 / From zero 터미널·클릭·파일 개념부터 차근차근 (KO+EN)
🚀 빠른 시작 (KO) 터미널 열기 → 5개 명령 → 한 줄 설치
🪜 완전 수동 설치 brew/스크립트 없이 직접 다운 (KO+EN, 프로덕션 부록)
🐳 Docker 기초 컨테이너·이미지·compose 3분 가이드
🧠 Ollama 기초 로컬 LLM 데몬 사용법
🐾 OpenClaw 기초 에이전트 구조·웹에서 가져오기 단락
🌐 웹 정보 가져오기 / surf 코스피·뉴스·환율·논문 — surf 샌드박스 명령 포함
🎨 크리에이티브 파이프라인 Pinterest → 나노바나나(4창) → Figma 자동 배치
🎬 쇼츠 자동화 Pinterest → 미리캔버스 → CapCut → 9:16 MP4
🚑 트러블슈팅 흔한 오류와 해결 명령
🧠 아키텍처 디스패처·멱등 설계·compose override
🤝 기여 가이드 (입문) 오타·번역·베타테스트도 환영
🐙 기여 가이드 (코드) 코드 스타일·PR 절차
📦 릴리스 노트 v0.1.0 변경 사항

⬆️ README (KO) · README (EN)