polymech/zeroclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
acd09fbd86
zeroclaw/docs/setup-guides
History
simianastronaut 41b46f23e3 docs(setup): add Docker/Podman stop/restart instructions 
Users who installed via `./install.sh --docker` had no documented way to
restart the container after stopping it. Add clear lifecycle instructions
(stop, start, restart, logs, health check) to both the bootstrap guide and
the operations runbook, covering docker-compose, manual `docker run`, and
Podman-specific flags.

Closes #3474

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-15 16:26:28 -04:00
..
macos-update-uninstall.md docs: update all internal links to match topic-based directory layout 2026-03-09 23:09:09 -04:00
mattermost-setup.md docs: restructure docs/ into topic-based directory layout 2026-03-09 22:25:20 -04:00
nextcloud-talk-setup.md docs: restructure docs/ into topic-based directory layout 2026-03-09 22:25:20 -04:00
one-click-bootstrap.md docs(setup): add Docker/Podman stop/restart instructions 2026-03-15 16:26:28 -04:00
one-click-bootstrap.vi.md docs: update all internal links to match topic-based directory layout 2026-03-09 23:09:09 -04:00
README.md fix(docs): remove stale onboarding flags after CLI changes (#3516) 2026-03-14 17:54:14 -04:00
README.vi.md fix(docs): remove stale onboarding flags after CLI changes (#3516) 2026-03-14 17:54:14 -04:00
zai-glm-setup.md fix(docs): correct broken path references in contributing docs 2026-03-11 03:31:14 -04:00

README.md

Getting Started Docs

For first-time setup and quick orientation.

Start Path

  1. Main overview and quick start: ../../README.md
  2. One-click setup and dual bootstrap mode: one-click-bootstrap.md
  3. Update or uninstall on macOS: macos-update-uninstall.md
  4. Find commands by tasks: ../reference/cli/commands-reference.md

Choose Your Path

Scenario Command
I have an API key, want fastest setup zeroclaw onboard --api-key sk-... --provider openrouter
I want guided prompts zeroclaw onboard
Config exists, just fix channels zeroclaw onboard --channels-only
Config exists, I intentionally want full overwrite zeroclaw onboard --force
Using subscription auth See Subscription Auth

Onboarding and Validation

  • Quick onboarding: zeroclaw onboard --api-key "sk-..." --provider openrouter
  • Guided onboarding: zeroclaw onboard
  • Existing config protection: reruns require explicit confirmation (or --force in non-interactive flows)
  • Ollama cloud models (:cloud) require a remote api_url and API key (for example api_url = "https://ollama.com").
  • Validate environment: zeroclaw status + zeroclaw doctor

Next