|
15 | 15 |
|
16 | 16 | [Quick Start](#-quick-start) • [Installation](#-installation-today) • [Architecture](#-architecture) • [Capabilities](#-core-capabilities) • [Documentation](#-documentation) |
17 | 17 |
|
18 | | ---- |
19 | | - |
20 | 18 | </div> |
21 | 19 |
|
22 | 20 | --- |
@@ -83,6 +81,12 @@ This public repo is meant to be: |
83 | 81 |
|
84 | 82 | Two fast paths: |
85 | 83 |
|
| 84 | +Prerequisites for both paths: |
| 85 | +- Python 3.11+ |
| 86 | +- `git` |
| 87 | +- `bash` |
| 88 | +- `ripgrep` |
| 89 | + |
86 | 90 | ### A. Fastest Path From A Repo Checkout |
87 | 91 |
|
88 | 92 | Best for: |
@@ -125,12 +129,14 @@ hyperclaw-validate-config "$TARGET_ROOT/config/openclaw.public.example.jsonc" |
125 | 129 | hyperclaw-ops-fabric summary --state-dir "$TARGET_ROOT/runtime/state" |
126 | 130 | ``` |
127 | 131 |
|
128 | | -### Optional Smoke |
| 132 | +### Optional Smoke Test |
129 | 133 |
|
130 | 134 | ```bash |
131 | 135 | PYTHONPATH=src python3 -m hyperclaw_max.context_intel.pack "telegram inbound dedupe" --repo . --format human |
132 | 136 | ``` |
133 | 137 |
|
| 138 | +Use this as a quick sanity check for the shipped `context-intel` surface. |
| 139 | + |
134 | 140 | **What this proves:** |
135 | 141 | - the public core works from a source checkout |
136 | 142 | - the same surfaces are exposed as installed CLI entrypoints |
@@ -377,6 +383,8 @@ This is intentional: |
377 | 383 |
|
378 | 384 | ## 🆚 Why Not Just Use OpenClaw? |
379 | 385 |
|
| 386 | +OpenClaw is the open-source base framework that HyperClaw-Max builds upon. |
| 387 | + |
380 | 388 | | Feature | Stock OpenClaw | HyperClaw-Max | |
381 | 389 | |---------|---------------|---------------| |
382 | 390 | | Agents | single or ad-hoc | persistent specialist pack | |
@@ -415,7 +423,11 @@ These lanes are documented as part of the product direction, but are not yet shi |
415 | 423 | | [docs/CLI.md](docs/CLI.md) | command reference and install surfaces | |
416 | 424 | | [docs/BOUNDARIES.md](docs/BOUNDARIES.md) | public core vs optional adapters vs private overlay | |
417 | 425 | | [install/connectors/README.md](install/connectors/README.md) | connector templates and required inputs | |
| 426 | +| [install/systemd/README.md](install/systemd/README.md) | public-safe gateway service templates | |
418 | 427 | | [install/overlay/README.md](install/overlay/README.md) | pack materialization over a clean base install | |
| 428 | +| [examples/README.md](examples/README.md) | sample outputs and reviewer-facing examples | |
| 429 | +| [examples/quickstart/README.md](examples/quickstart/README.md) | quickstart example outputs | |
| 430 | +| [CHANGELOG.md](CHANGELOG.md) | notable repo changes over time | |
419 | 431 | | [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | detailed system design | |
420 | 432 | | [docs/MEMORY-FABRIC.md](docs/MEMORY-FABRIC.md) | layered memory model | |
421 | 433 | | [docs/OPERATIONAL-FABRIC.md](docs/OPERATIONAL-FABRIC.md) | public task / delegation / watchdog base | |
|
0 commit comments