Compare commits
96 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4daeb380a0 | |||
| ddacb2a917 | |||
| 77ca576be6 | |||
| 5a4f69e71f | |||
| e952838eef | |||
| 3fc4e66fb6 | |||
| 0a331a1440 | |||
| 5919becab9 | |||
| 287d9bdc17 | |||
| f900d7079e | |||
| 5a5b5a4402 | |||
| 06f65fb711 | |||
| 46d4b13c22 | |||
| 8fcbb6eb2d | |||
| ce22eba7d0 | |||
| 7ba4d06e78 | |||
| dc12d03876 | |||
| 3151604b04 | |||
| c5fcda06ad | |||
| 51a52dcadb | |||
| dd9e26eac6 | |||
| c4b2a21c61 | |||
| d6170ab49b | |||
| 399c896c3b | |||
| 71d32c3b04 | |||
| 27936b051d | |||
| 39d788a95f | |||
| 5d921bd37d | |||
| d17f0a946c | |||
| 2710ce65cc | |||
| 51e8fc8423 | |||
| ecf9d477bd | |||
| 625784c25f | |||
| 348c0c37b7 | |||
| 11a1dae55b | |||
| dd1681be44 | |||
| cabd3de3cb | |||
| 87cf6b0e93 | |||
| 2e2c1da4fa | |||
| 736347c71b | |||
| c384c34c31 | |||
| 4ca5fa500b | |||
| 1a0441a006 | |||
| ef770f15b9 | |||
| 05a0cdf6f4 | |||
| fc1b555b31 | |||
| b8ebe7bcd3 | |||
| 049edf4eec | |||
| 856a651dd1 | |||
| fd3b17edc1 | |||
| a9c7697c6b | |||
| 939edf5e86 | |||
| bbc82fd4f9 | |||
| a606f308f5 | |||
| 1162e3adc2 | |||
| bd75799644 | |||
| 35217bf457 | |||
| e5e3761020 | |||
| a52446c637 | |||
| 292952e563 | |||
| d115b28a1f | |||
| b563f5954e | |||
| e3e711073a | |||
| 1033287f38 | |||
| 6a4ccaeb73 | |||
| 4aead04916 | |||
| 7b23c8934c | |||
| 5d1543100d | |||
| e3a91bc805 | |||
| 833fdefbe5 | |||
| 13f74f0ecc | |||
| 9ff045d2e9 | |||
| 6fe8e3a5bb | |||
| 5dc1750df7 | |||
| b40c9e77af | |||
| 34cac3d9dd | |||
| badf96dcab | |||
| c1e1228fb0 | |||
| d2b923ae07 | |||
| 21fdef95f4 | |||
| d02fbf2d76 | |||
| 05cede29a8 | |||
| d34a2e6d3f | |||
| 576d22fedd | |||
| d5455c694c | |||
| 90275b057e | |||
| d46b4f29d2 | |||
| f25835f98c | |||
| 376579f9fa | |||
| b620fd6bba | |||
| 98d6c5af9e | |||
| c51ca19dc1 | |||
| ea6abc9f42 | |||
| e2f6f20bfb | |||
| 88df3d4b2e | |||
| 0dba55959d |
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 110 KiB |
@@ -77,6 +77,8 @@ jobs:
|
||||
target: x86_64-unknown-linux-gnu
|
||||
- os: macos-14
|
||||
target: aarch64-apple-darwin
|
||||
- os: windows-latest
|
||||
target: x86_64-pc-windows-msvc
|
||||
steps:
|
||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||
- uses: dtolnay/rust-toolchain@631a55b12751854ce901bb631d5902ceb48146f7 # stable
|
||||
@@ -84,6 +86,7 @@ jobs:
|
||||
toolchain: 1.92.0
|
||||
targets: ${{ matrix.target }}
|
||||
- uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2
|
||||
if: runner.os != 'Windows'
|
||||
|
||||
- name: Install mold linker
|
||||
if: runner.os == 'Linux'
|
||||
@@ -92,11 +95,12 @@ jobs:
|
||||
sudo apt-get install -y mold
|
||||
|
||||
- name: Ensure web/dist placeholder exists
|
||||
shell: bash
|
||||
run: mkdir -p web/dist && touch web/dist/.gitkeep
|
||||
|
||||
- name: Build release
|
||||
shell: bash
|
||||
run: cargo build --release --locked --target ${{ matrix.target }}
|
||||
run: cargo build --profile ci --locked --target ${{ matrix.target }}
|
||||
env:
|
||||
CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_LINKER: clang
|
||||
CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_RUSTFLAGS: "-C link-arg=-fuse-ld=mold"
|
||||
|
||||
@@ -105,6 +105,8 @@ jobs:
|
||||
target: x86_64-unknown-linux-gnu
|
||||
- os: macos-14
|
||||
target: aarch64-apple-darwin
|
||||
- os: windows-latest
|
||||
target: x86_64-pc-windows-msvc
|
||||
steps:
|
||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||
- uses: dtolnay/rust-toolchain@631a55b12751854ce901bb631d5902ceb48146f7 # stable
|
||||
@@ -112,6 +114,7 @@ jobs:
|
||||
toolchain: 1.92.0
|
||||
targets: ${{ matrix.target }}
|
||||
- uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2
|
||||
if: runner.os != 'Windows'
|
||||
|
||||
- name: Install mold linker
|
||||
if: runner.os == 'Linux'
|
||||
@@ -120,11 +123,12 @@ jobs:
|
||||
sudo apt-get install -y mold
|
||||
|
||||
- name: Ensure web/dist placeholder exists
|
||||
shell: bash
|
||||
run: mkdir -p web/dist && touch web/dist/.gitkeep
|
||||
|
||||
- name: Build release
|
||||
shell: bash
|
||||
run: cargo build --release --locked --target ${{ matrix.target }}
|
||||
run: cargo build --profile ci --locked --target ${{ matrix.target }}
|
||||
env:
|
||||
CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_LINKER: clang
|
||||
CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_RUSTFLAGS: "-C link-arg=-fuse-ld=mold"
|
||||
|
||||
@@ -81,7 +81,7 @@ Current maintainers with PR approval authority: `theonlyhennygod`, `JordanTheJet
|
||||
| `aarch64-unknown-linux-gnu` | | ✓ | ✓ | ✓ |
|
||||
| `aarch64-apple-darwin` | ✓ | | ✓ | ✓ |
|
||||
| `x86_64-apple-darwin` | | ✓ | | |
|
||||
| `x86_64-pc-windows-msvc` | | ✓ | ✓ | ✓ |
|
||||
| `x86_64-pc-windows-msvc` | ✓ | ✓ | ✓ | ✓ |
|
||||
|
||||
## Mermaid Diagrams
|
||||
|
||||
|
||||
@@ -0,0 +1,80 @@
|
||||
name: Publish to crates.io
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
version:
|
||||
description: "Version to publish (e.g. 0.2.0) — must match Cargo.toml"
|
||||
required: true
|
||||
type: string
|
||||
dry_run:
|
||||
description: "Dry run (validate without publishing)"
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
|
||||
concurrency:
|
||||
group: publish-crates
|
||||
cancel-in-progress: false
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
env:
|
||||
CARGO_TERM_COLOR: always
|
||||
|
||||
jobs:
|
||||
validate:
|
||||
name: Validate
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Check version matches Cargo.toml
|
||||
shell: bash
|
||||
env:
|
||||
INPUT_VERSION: ${{ inputs.version }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
cargo_version=$(sed -n 's/^version = "\([^"]*\)"/\1/p' Cargo.toml | head -1)
|
||||
if [[ "$cargo_version" != "$INPUT_VERSION" ]]; then
|
||||
echo "::error::Cargo.toml version (${cargo_version}) does not match input (${INPUT_VERSION})"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
publish:
|
||||
name: Publish to crates.io
|
||||
needs: [validate]
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
toolchain: 1.92.0
|
||||
|
||||
- uses: Swatinem/rust-cache@v2
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
cache: npm
|
||||
cache-dependency-path: web/package-lock.json
|
||||
|
||||
- name: Build web dashboard
|
||||
run: cd web && npm ci && npm run build
|
||||
|
||||
- name: Verify package
|
||||
run: cargo package --locked --allow-dirty
|
||||
|
||||
- name: Publish (dry run)
|
||||
if: inputs.dry_run
|
||||
run: cargo publish --dry-run --locked --allow-dirty
|
||||
env:
|
||||
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
|
||||
|
||||
- name: Publish to crates.io
|
||||
if: "!inputs.dry_run"
|
||||
run: cargo publish --locked --allow-dirty
|
||||
env:
|
||||
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
|
||||
@@ -37,6 +37,96 @@ jobs:
|
||||
echo "tag=${beta_tag}" >> "$GITHUB_OUTPUT"
|
||||
echo "Beta release: ${beta_tag}"
|
||||
|
||||
release-notes:
|
||||
name: Generate Release Notes
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
notes: ${{ steps.notes.outputs.body }}
|
||||
features: ${{ steps.notes.outputs.features }}
|
||||
contributors: ${{ steps.notes.outputs.contributors }}
|
||||
steps:
|
||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Build release notes
|
||||
id: notes
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
# Use a wider range — find the previous stable tag to capture all
|
||||
# contributors across the full release cycle, not just one beta bump
|
||||
PREV_TAG=$(git tag --sort=-creatordate \
|
||||
| grep -vE '\-beta\.' \
|
||||
| head -1 || echo "")
|
||||
if [ -z "$PREV_TAG" ]; then
|
||||
RANGE="HEAD"
|
||||
else
|
||||
RANGE="${PREV_TAG}..HEAD"
|
||||
fi
|
||||
|
||||
# Extract features only (feat commits) — skip bug fixes for clean notes
|
||||
FEATURES=$(git log "$RANGE" --pretty=format:"%s" --no-merges \
|
||||
| grep -iE '^feat(\(|:)' \
|
||||
| sed 's/^feat(\([^)]*\)): /\1: /' \
|
||||
| sed 's/^feat: //' \
|
||||
| sed 's/ (#[0-9]*)$//' \
|
||||
| sort -uf \
|
||||
| while IFS= read -r line; do echo "- ${line}"; done || true)
|
||||
|
||||
if [ -z "$FEATURES" ]; then
|
||||
FEATURES="- Incremental improvements and polish"
|
||||
fi
|
||||
|
||||
# Collect ALL unique contributors: git authors + Co-Authored-By
|
||||
GIT_AUTHORS=$(git log "$RANGE" --pretty=format:"%an" --no-merges | sort -uf || true)
|
||||
CO_AUTHORS=$(git log "$RANGE" --pretty=format:"%b" --no-merges \
|
||||
| grep -ioE 'Co-Authored-By: *[^<]+' \
|
||||
| sed 's/Co-Authored-By: *//i' \
|
||||
| sed 's/ *$//' \
|
||||
| sort -uf || true)
|
||||
|
||||
# Merge, deduplicate, and filter out bots
|
||||
ALL_CONTRIBUTORS=$(printf "%s\n%s" "$GIT_AUTHORS" "$CO_AUTHORS" \
|
||||
| sort -uf \
|
||||
| grep -v '^$' \
|
||||
| grep -viE '\[bot\]$|^dependabot|^github-actions|^copilot|^ZeroClaw Bot|^ZeroClaw Runner|^ZeroClaw Agent|^blacksmith' \
|
||||
| while IFS= read -r name; do echo "- ${name}"; done || true)
|
||||
|
||||
# Build release body
|
||||
BODY=$(cat <<NOTES_EOF
|
||||
## What's New
|
||||
|
||||
${FEATURES}
|
||||
|
||||
## Contributors
|
||||
|
||||
${ALL_CONTRIBUTORS}
|
||||
|
||||
---
|
||||
*Full changelog: ${PREV_TAG}...HEAD*
|
||||
NOTES_EOF
|
||||
)
|
||||
|
||||
# Output multiline values
|
||||
{
|
||||
echo "body<<BODY_EOF"
|
||||
echo "$BODY"
|
||||
echo "BODY_EOF"
|
||||
} >> "$GITHUB_OUTPUT"
|
||||
|
||||
{
|
||||
echo "features<<FEAT_EOF"
|
||||
echo "$FEATURES"
|
||||
echo "FEAT_EOF"
|
||||
} >> "$GITHUB_OUTPUT"
|
||||
|
||||
{
|
||||
echo "contributors<<CONTRIB_EOF"
|
||||
echo "$ALL_CONTRIBUTORS"
|
||||
echo "CONTRIB_EOF"
|
||||
} >> "$GITHUB_OUTPUT"
|
||||
|
||||
web:
|
||||
name: Build Web Dashboard
|
||||
runs-on: ubuntu-latest
|
||||
@@ -65,11 +155,11 @@ jobs:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- os: ubuntu-22.04
|
||||
- os: ubuntu-latest
|
||||
target: x86_64-unknown-linux-gnu
|
||||
artifact: zeroclaw
|
||||
ext: tar.gz
|
||||
- os: ubuntu-22.04
|
||||
- os: ubuntu-latest
|
||||
target: aarch64-unknown-linux-gnu
|
||||
artifact: zeroclaw
|
||||
ext: tar.gz
|
||||
@@ -132,7 +222,7 @@ jobs:
|
||||
|
||||
publish:
|
||||
name: Publish Beta Release
|
||||
needs: [version, build]
|
||||
needs: [version, release-notes, build]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||
@@ -148,17 +238,44 @@ jobs:
|
||||
find . -type f \( -name '*.tar.gz' -o -name '*.zip' \) -exec sha256sum {} + | sed 's| \./[^/]*/| |' > SHA256SUMS
|
||||
cat SHA256SUMS
|
||||
|
||||
- name: Create GitHub Release
|
||||
uses: softprops/action-gh-release@5be0e66d93ac7ed76da52eca8bb058f665c3a5fe # v2.4.2
|
||||
with:
|
||||
tag_name: ${{ needs.version.outputs.tag }}
|
||||
name: ${{ needs.version.outputs.tag }}
|
||||
prerelease: true
|
||||
generate_release_notes: true
|
||||
files: |
|
||||
artifacts/**/*
|
||||
- name: Collect release assets
|
||||
run: |
|
||||
mkdir -p release-assets
|
||||
find artifacts -type f \( -name '*.tar.gz' -o -name '*.zip' -o -name 'SHA256SUMS' \) -exec cp {} release-assets/ \;
|
||||
cp install.sh release-assets/
|
||||
echo "--- Assets ---"
|
||||
ls -lh release-assets/
|
||||
|
||||
- name: Write release notes
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
NOTES: ${{ needs.release-notes.outputs.notes }}
|
||||
run: printf '%s\n' "$NOTES" > release-notes.md
|
||||
|
||||
- name: Create GitHub Release
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
||||
TAG: ${{ needs.version.outputs.tag }}
|
||||
run: |
|
||||
gh release create "$TAG" release-assets/* \
|
||||
--repo "${{ github.repository }}" \
|
||||
--title "$TAG" \
|
||||
--notes-file release-notes.md \
|
||||
--prerelease
|
||||
|
||||
redeploy-website:
|
||||
name: Trigger Website Redeploy
|
||||
needs: [publish]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Trigger website redeploy
|
||||
env:
|
||||
PAT: ${{ secrets.WEBSITE_REPO_PAT }}
|
||||
run: |
|
||||
curl -fsSL -X POST \
|
||||
-H "Authorization: token $PAT" \
|
||||
-H "Accept: application/vnd.github+json" \
|
||||
https://api.github.com/repos/zeroclaw-labs/zeroclaw-website/dispatches \
|
||||
-d '{"event_type":"new-release","client_payload":{"install_script_url":"https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh"}}'
|
||||
|
||||
docker:
|
||||
name: Push Docker Image
|
||||
|
||||
@@ -74,6 +74,79 @@ jobs:
|
||||
path: web/dist/
|
||||
retention-days: 1
|
||||
|
||||
release-notes:
|
||||
name: Generate Release Notes
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
notes: ${{ steps.notes.outputs.body }}
|
||||
steps:
|
||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Build release notes
|
||||
id: notes
|
||||
shell: bash
|
||||
env:
|
||||
INPUT_VERSION: ${{ inputs.version }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
# Find the previous stable tag (exclude beta tags)
|
||||
PREV_TAG=$(git tag --sort=-creatordate | grep -vE '\-beta\.' | grep -v "^v${INPUT_VERSION}$" | head -1 || echo "")
|
||||
if [ -z "$PREV_TAG" ]; then
|
||||
RANGE="HEAD"
|
||||
else
|
||||
RANGE="${PREV_TAG}..HEAD"
|
||||
fi
|
||||
|
||||
# Extract features only — skip bug fixes for clean release notes
|
||||
FEATURES=$(git log "$RANGE" --pretty=format:"%s" --no-merges \
|
||||
| grep -iE '^feat(\(|:)' \
|
||||
| sed 's/^feat(\([^)]*\)): /\1: /' \
|
||||
| sed 's/^feat: //' \
|
||||
| sed 's/ (#[0-9]*)$//' \
|
||||
| sort -uf \
|
||||
| while IFS= read -r line; do echo "- ${line}"; done || true)
|
||||
|
||||
if [ -z "$FEATURES" ]; then
|
||||
FEATURES="- Incremental improvements and polish"
|
||||
fi
|
||||
|
||||
# Collect ALL unique contributors: git authors + Co-Authored-By
|
||||
GIT_AUTHORS=$(git log "$RANGE" --pretty=format:"%an" --no-merges | sort -uf || true)
|
||||
CO_AUTHORS=$(git log "$RANGE" --pretty=format:"%b" --no-merges \
|
||||
| grep -ioE 'Co-Authored-By: *[^<]+' \
|
||||
| sed 's/Co-Authored-By: *//i' \
|
||||
| sed 's/ *$//' \
|
||||
| sort -uf || true)
|
||||
|
||||
# Merge, deduplicate, and filter out bots
|
||||
ALL_CONTRIBUTORS=$(printf "%s\n%s" "$GIT_AUTHORS" "$CO_AUTHORS" \
|
||||
| sort -uf \
|
||||
| grep -v '^$' \
|
||||
| grep -viE '\[bot\]$|^dependabot|^github-actions|^copilot|^ZeroClaw Bot|^ZeroClaw Runner|^ZeroClaw Agent|^blacksmith' \
|
||||
| while IFS= read -r name; do echo "- ${name}"; done || true)
|
||||
|
||||
BODY=$(cat <<NOTES_EOF
|
||||
## What's New
|
||||
|
||||
${FEATURES}
|
||||
|
||||
## Contributors
|
||||
|
||||
${ALL_CONTRIBUTORS}
|
||||
|
||||
---
|
||||
*Full changelog: ${PREV_TAG}...v${INPUT_VERSION}*
|
||||
NOTES_EOF
|
||||
)
|
||||
|
||||
{
|
||||
echo "body<<BODY_EOF"
|
||||
echo "$BODY"
|
||||
echo "BODY_EOF"
|
||||
} >> "$GITHUB_OUTPUT"
|
||||
|
||||
build:
|
||||
name: Build ${{ matrix.target }}
|
||||
needs: [validate, web]
|
||||
@@ -83,11 +156,11 @@ jobs:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- os: ubuntu-22.04
|
||||
- os: ubuntu-latest
|
||||
target: x86_64-unknown-linux-gnu
|
||||
artifact: zeroclaw
|
||||
ext: tar.gz
|
||||
- os: ubuntu-22.04
|
||||
- os: ubuntu-latest
|
||||
target: aarch64-unknown-linux-gnu
|
||||
artifact: zeroclaw
|
||||
ext: tar.gz
|
||||
@@ -150,7 +223,7 @@ jobs:
|
||||
|
||||
publish:
|
||||
name: Publish Stable Release
|
||||
needs: [validate, build]
|
||||
needs: [validate, release-notes, build]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||
@@ -166,17 +239,72 @@ jobs:
|
||||
find . -type f \( -name '*.tar.gz' -o -name '*.zip' \) -exec sha256sum {} + | sed 's| \./[^/]*/| |' > SHA256SUMS
|
||||
cat SHA256SUMS
|
||||
|
||||
- name: Create GitHub Release
|
||||
uses: softprops/action-gh-release@5be0e66d93ac7ed76da52eca8bb058f665c3a5fe # v2.4.2
|
||||
with:
|
||||
tag_name: ${{ needs.validate.outputs.tag }}
|
||||
name: ${{ needs.validate.outputs.tag }}
|
||||
prerelease: false
|
||||
generate_release_notes: true
|
||||
files: |
|
||||
artifacts/**/*
|
||||
- name: Collect release assets
|
||||
run: |
|
||||
mkdir -p release-assets
|
||||
find artifacts -type f \( -name '*.tar.gz' -o -name '*.zip' -o -name 'SHA256SUMS' \) -exec cp {} release-assets/ \;
|
||||
cp install.sh release-assets/
|
||||
echo "--- Assets ---"
|
||||
ls -lh release-assets/
|
||||
|
||||
- name: Write release notes
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
NOTES: ${{ needs.release-notes.outputs.notes }}
|
||||
run: printf '%s\n' "$NOTES" > release-notes.md
|
||||
|
||||
- name: Create GitHub Release
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
TAG: ${{ needs.validate.outputs.tag }}
|
||||
run: |
|
||||
gh release create "$TAG" release-assets/* \
|
||||
--repo "${{ github.repository }}" \
|
||||
--title "$TAG" \
|
||||
--notes-file release-notes.md \
|
||||
--latest
|
||||
|
||||
crates-io:
|
||||
name: Publish to crates.io
|
||||
needs: [validate, publish]
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
toolchain: 1.92.0
|
||||
|
||||
- uses: Swatinem/rust-cache@v2
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
cache: npm
|
||||
cache-dependency-path: web/package-lock.json
|
||||
|
||||
- name: Build web dashboard
|
||||
run: cd web && npm ci && npm run build
|
||||
|
||||
- name: Publish to crates.io
|
||||
run: cargo publish --locked --allow-dirty
|
||||
env:
|
||||
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
|
||||
|
||||
redeploy-website:
|
||||
name: Trigger Website Redeploy
|
||||
needs: [publish]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Trigger website redeploy
|
||||
env:
|
||||
PAT: ${{ secrets.WEBSITE_REPO_PAT }}
|
||||
run: |
|
||||
curl -fsSL -X POST \
|
||||
-H "Authorization: token $PAT" \
|
||||
-H "Accept: application/vnd.github+json" \
|
||||
https://api.github.com/repos/zeroclaw-labs/zeroclaw-website/dispatches \
|
||||
-d '{"event_type":"new-release","client_payload":{"install_script_url":"https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh"}}'
|
||||
|
||||
docker:
|
||||
name: Push Docker Image
|
||||
|
||||
@@ -0,0 +1,251 @@
|
||||
name: Tweet Release
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tweet_text:
|
||||
description: "Custom tweet text (include emojis, keep it punchy)"
|
||||
required: true
|
||||
type: string
|
||||
image_url:
|
||||
description: "Optional image URL to attach (png/jpg)"
|
||||
required: false
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
tweet:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Check for new features
|
||||
id: check
|
||||
shell: bash
|
||||
env:
|
||||
RELEASE_TAG: ${{ github.event.release.tag_name || '' }}
|
||||
MANUAL_TEXT: ${{ inputs.tweet_text || '' }}
|
||||
run: |
|
||||
# Manual dispatch always proceeds
|
||||
if [ -n "$MANUAL_TEXT" ]; then
|
||||
echo "skip=false" >> "$GITHUB_OUTPUT"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Find the PREVIOUS release tag (including betas) to check for new features
|
||||
PREV_TAG=$(git tag --sort=-creatordate \
|
||||
| grep -v "^${RELEASE_TAG}$" \
|
||||
| head -1 || echo "")
|
||||
|
||||
if [ -z "$PREV_TAG" ]; then
|
||||
echo "skip=false" >> "$GITHUB_OUTPUT"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Count new feat() commits since the previous release
|
||||
NEW_FEATS=$(git log "${PREV_TAG}..${RELEASE_TAG}" --pretty=format:"%s" --no-merges \
|
||||
| grep -ciE '^feat(\(|:)' || echo "0")
|
||||
|
||||
if [ "$NEW_FEATS" -eq 0 ]; then
|
||||
echo "No new features since ${PREV_TAG} — skipping tweet"
|
||||
echo "skip=true" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "${NEW_FEATS} new feature(s) since ${PREV_TAG} — tweeting"
|
||||
echo "skip=false" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
|
||||
- name: Build tweet text
|
||||
id: tweet
|
||||
if: steps.check.outputs.skip != 'true'
|
||||
shell: bash
|
||||
env:
|
||||
RELEASE_TAG: ${{ github.event.release.tag_name || '' }}
|
||||
RELEASE_URL: ${{ github.event.release.html_url || '' }}
|
||||
MANUAL_TEXT: ${{ inputs.tweet_text || '' }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
if [ -n "$MANUAL_TEXT" ]; then
|
||||
TWEET="$MANUAL_TEXT"
|
||||
else
|
||||
# For features: diff against the PREVIOUS release (including betas)
|
||||
# This prevents duplicate feature lists across consecutive betas
|
||||
PREV_RELEASE=$(git tag --sort=-creatordate \
|
||||
| grep -v "^${RELEASE_TAG}$" \
|
||||
| head -1 || echo "")
|
||||
|
||||
# For contributors: diff against the last STABLE release
|
||||
# This captures everyone across the full release cycle
|
||||
PREV_STABLE=$(git tag --sort=-creatordate \
|
||||
| grep -v "^${RELEASE_TAG}$" \
|
||||
| grep -vE '\-beta\.' \
|
||||
| head -1 || echo "")
|
||||
|
||||
FEAT_RANGE="${PREV_RELEASE:+${PREV_RELEASE}..}${RELEASE_TAG}"
|
||||
CONTRIB_RANGE="${PREV_STABLE:+${PREV_STABLE}..}${RELEASE_TAG}"
|
||||
|
||||
# Extract NEW features only since the last release
|
||||
FEATURES=$(git log "$FEAT_RANGE" --pretty=format:"%s" --no-merges \
|
||||
| grep -iE '^feat(\(|:)' \
|
||||
| sed 's/^feat(\([^)]*\)): /\1: /' \
|
||||
| sed 's/^feat: //' \
|
||||
| sed 's/ (#[0-9]*)$//' \
|
||||
| sort -uf \
|
||||
| head -4 \
|
||||
| while IFS= read -r line; do echo "🚀 ${line}"; done || true)
|
||||
|
||||
if [ -z "$FEATURES" ]; then
|
||||
FEATURES="🚀 Incremental improvements and polish"
|
||||
fi
|
||||
|
||||
# Count ALL contributors across the full release cycle
|
||||
GIT_AUTHORS=$(git log "$CONTRIB_RANGE" --pretty=format:"%an" --no-merges | sort -uf || true)
|
||||
CO_AUTHORS=$(git log "$CONTRIB_RANGE" --pretty=format:"%b" --no-merges \
|
||||
| grep -ioE 'Co-Authored-By: *[^<]+' \
|
||||
| sed 's/Co-Authored-By: *//i' \
|
||||
| sed 's/ *$//' \
|
||||
| sort -uf || true)
|
||||
|
||||
TOTAL_COUNT=$(printf "%s\n%s" "$GIT_AUTHORS" "$CO_AUTHORS" \
|
||||
| sort -uf \
|
||||
| grep -v '^$' \
|
||||
| grep -viE '\[bot\]$|^dependabot|^github-actions|^copilot|^ZeroClaw Bot|^ZeroClaw Runner|^ZeroClaw Agent|^blacksmith' \
|
||||
| grep -c . || echo "0")
|
||||
|
||||
# Build tweet — new features, contributor count, hashtags
|
||||
TWEET=$(printf "🦀 ZeroClaw %s\n\n%s\n\n🙌 %s contributors\n\n%s\n\n#zeroclaw #rust #ai #opensource" \
|
||||
"$RELEASE_TAG" "$FEATURES" "$TOTAL_COUNT" "$RELEASE_URL")
|
||||
fi
|
||||
|
||||
# Append release URL if not already present and we have one
|
||||
if [ -n "$RELEASE_URL" ] && ! echo "$TWEET" | grep -q "$RELEASE_URL"; then
|
||||
TWEET=$(printf "%s\n\n%s" "$TWEET" "$RELEASE_URL")
|
||||
fi
|
||||
|
||||
# Truncate to 280 chars if needed
|
||||
if [ ${#TWEET} -gt 280 ]; then
|
||||
TWEET="${TWEET:0:277}..."
|
||||
fi
|
||||
|
||||
echo "--- Tweet preview ---"
|
||||
echo "$TWEET"
|
||||
echo "--- ${#TWEET} chars ---"
|
||||
|
||||
{
|
||||
echo "text<<TWEET_EOF"
|
||||
echo "$TWEET"
|
||||
echo "TWEET_EOF"
|
||||
} >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Post to X
|
||||
if: steps.check.outputs.skip != 'true'
|
||||
shell: bash
|
||||
env:
|
||||
TWITTER_CONSUMER_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }}
|
||||
TWITTER_CONSUMER_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET_KEY }}
|
||||
TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
|
||||
TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
|
||||
TWEET_TEXT: ${{ steps.tweet.outputs.text }}
|
||||
IMAGE_URL: ${{ inputs.image_url || '' }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
# Skip if Twitter secrets are not configured
|
||||
if [ -z "$TWITTER_CONSUMER_KEY" ] || [ -z "$TWITTER_ACCESS_TOKEN" ]; then
|
||||
echo "::warning::Twitter secrets not configured — skipping tweet"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
pip install requests requests-oauthlib --quiet
|
||||
|
||||
python3 - <<'PYEOF'
|
||||
import os, sys, time
|
||||
from requests_oauthlib import OAuth1Session
|
||||
|
||||
consumer_key = os.environ["TWITTER_CONSUMER_KEY"]
|
||||
consumer_secret = os.environ["TWITTER_CONSUMER_SECRET"]
|
||||
access_token = os.environ["TWITTER_ACCESS_TOKEN"]
|
||||
access_token_secret = os.environ["TWITTER_ACCESS_TOKEN_SECRET"]
|
||||
tweet_text = os.environ["TWEET_TEXT"]
|
||||
image_url = os.environ.get("IMAGE_URL", "")
|
||||
|
||||
oauth = OAuth1Session(
|
||||
consumer_key,
|
||||
client_secret=consumer_secret,
|
||||
resource_owner_key=access_token,
|
||||
resource_owner_secret=access_token_secret,
|
||||
)
|
||||
|
||||
media_id = None
|
||||
|
||||
# Upload image if provided
|
||||
if image_url:
|
||||
import requests
|
||||
print(f"Downloading image: {image_url}")
|
||||
img_resp = requests.get(image_url, timeout=30)
|
||||
img_resp.raise_for_status()
|
||||
|
||||
content_type = img_resp.headers.get("content-type", "image/png")
|
||||
init_resp = oauth.post(
|
||||
"https://upload.twitter.com/1.1/media/upload.json",
|
||||
data={
|
||||
"command": "INIT",
|
||||
"total_bytes": len(img_resp.content),
|
||||
"media_type": content_type,
|
||||
},
|
||||
)
|
||||
if init_resp.status_code != 202:
|
||||
print(f"Media INIT failed: {init_resp.status_code} {init_resp.text}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
media_id = init_resp.json()["media_id_string"]
|
||||
|
||||
append_resp = oauth.post(
|
||||
"https://upload.twitter.com/1.1/media/upload.json",
|
||||
data={"command": "APPEND", "media_id": media_id, "segment_index": 0},
|
||||
files={"media_data": img_resp.content},
|
||||
)
|
||||
if append_resp.status_code not in (200, 204):
|
||||
print(f"Media APPEND failed: {append_resp.status_code} {append_resp.text}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
fin_resp = oauth.post(
|
||||
"https://upload.twitter.com/1.1/media/upload.json",
|
||||
data={"command": "FINALIZE", "media_id": media_id},
|
||||
)
|
||||
if fin_resp.status_code not in (200, 201):
|
||||
print(f"Media FINALIZE failed: {fin_resp.status_code} {fin_resp.text}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
state = fin_resp.json().get("processing_info", {}).get("state")
|
||||
while state == "pending" or state == "in_progress":
|
||||
wait = fin_resp.json().get("processing_info", {}).get("check_after_secs", 2)
|
||||
time.sleep(wait)
|
||||
status_resp = oauth.get(
|
||||
"https://upload.twitter.com/1.1/media/upload.json",
|
||||
params={"command": "STATUS", "media_id": media_id},
|
||||
)
|
||||
state = status_resp.json().get("processing_info", {}).get("state")
|
||||
fin_resp = status_resp
|
||||
|
||||
print(f"Image uploaded: media_id={media_id}")
|
||||
|
||||
# Post tweet
|
||||
payload = {"text": tweet_text}
|
||||
if media_id:
|
||||
payload["media"] = {"media_ids": [media_id]}
|
||||
|
||||
resp = oauth.post("https://api.x.com/2/tweets", json=payload)
|
||||
|
||||
if resp.status_code == 201:
|
||||
data = resp.json()
|
||||
tweet_id = data["data"]["id"]
|
||||
print(f"Tweet posted: https://x.com/zeroclawlabs/status/{tweet_id}")
|
||||
else:
|
||||
print(f"Failed to post tweet: {resp.status_code}", file=sys.stderr)
|
||||
print(resp.text, file=sys.stderr)
|
||||
sys.exit(1)
|
||||
PYEOF
|
||||
@@ -41,3 +41,6 @@ credentials.json
|
||||
|
||||
# Coverage artifacts
|
||||
lcov.info
|
||||
|
||||
# IDE's stuff
|
||||
.idea
|
||||
+27
-7
@@ -2,20 +2,41 @@
|
||||
|
||||
Thanks for your interest in contributing to ZeroClaw! This guide will help you get started.
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Branch Migration Notice (March 2026)
|
||||
|
||||
**`master` is the ONLY default branch. The `main` branch no longer exists.**
|
||||
|
||||
If you have an existing fork or local clone that tracks `main`, you **must** update it:
|
||||
|
||||
```bash
|
||||
# Update your local clone to track master
|
||||
git checkout master
|
||||
git branch -D main 2>/dev/null # delete local main if it exists
|
||||
git remote set-head origin master
|
||||
git fetch origin --prune # remove stale remote refs
|
||||
|
||||
# If your fork still has a main branch, delete it
|
||||
git push origin --delete main 2>/dev/null
|
||||
```
|
||||
|
||||
All PRs must target **`master`**. PRs targeting `main` will be rejected.
|
||||
|
||||
**Background:** ZeroClaw previously used `main` in some documentation and scripts, which caused 404 errors, broken CI refs, and contributor confusion (see [#2929](https://github.com/zeroclaw-labs/zeroclaw/issues/2929), [#3061](https://github.com/zeroclaw-labs/zeroclaw/issues/3061), [#3194](https://github.com/zeroclaw-labs/zeroclaw/pull/3194)). As of March 2026, all references have been corrected, stale branches cleaned up, and the `main` branch permanently deleted.
|
||||
|
||||
---
|
||||
|
||||
## Branching Model
|
||||
|
||||
> **Important — `master` is the default branch.**
|
||||
>
|
||||
> ZeroClaw uses **`master`** as its single source-of-truth branch. The `main` branch has been removed.
|
||||
>
|
||||
> Previously, some documentation and scripts referenced a `main` branch, which caused 404 errors and contributor confusion (see [#2929](https://github.com/zeroclaw-labs/zeroclaw/issues/2929), [#3061](https://github.com/zeroclaw-labs/zeroclaw/issues/3061), [#3194](https://github.com/zeroclaw-labs/zeroclaw/pull/3194)). As of March 2026, all references have been corrected and the `main` branch deleted.
|
||||
> **`master`** is the single source-of-truth branch.
|
||||
>
|
||||
> **How contributors should work:**
|
||||
> 1. Fork the repository
|
||||
> 2. Create a `feat/*` or `fix/*` branch from `master`
|
||||
> 3. Open a PR targeting `master`
|
||||
>
|
||||
> Do **not** create or push to a `main` branch.
|
||||
> Do **not** create or push to a `main` branch. There is no `main` branch — it will not work.
|
||||
|
||||
## First-Time Contributors
|
||||
|
||||
@@ -559,4 +580,3 @@ Recommended scope keys in commit titles:
|
||||
## License
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under the MIT License.
|
||||
# Contributing Guide Update
|
||||
|
||||
Generated
+2
-1
@@ -7924,7 +7924,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zeroclaw"
|
||||
version = "0.1.9"
|
||||
version = "0.2.0"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"async-imap",
|
||||
@@ -8021,6 +8021,7 @@ dependencies = [
|
||||
"base64",
|
||||
"chrono",
|
||||
"directories",
|
||||
"portable-atomic",
|
||||
"reqwest",
|
||||
"rppal",
|
||||
"serde",
|
||||
|
||||
+24
-7
@@ -4,7 +4,7 @@ resolver = "2"
|
||||
|
||||
[package]
|
||||
name = "zeroclaw"
|
||||
version = "0.1.9"
|
||||
version = "0.2.0"
|
||||
edition = "2021"
|
||||
authors = ["theonlyhennygod"]
|
||||
license = "MIT OR Apache-2.0"
|
||||
@@ -14,6 +14,15 @@ readme = "README.md"
|
||||
keywords = ["ai", "agent", "cli", "assistant", "chatbot"]
|
||||
categories = ["command-line-utilities", "api-bindings"]
|
||||
rust-version = "1.87"
|
||||
include = [
|
||||
"/src/**/*",
|
||||
"/build.rs",
|
||||
"/Cargo.toml",
|
||||
"/Cargo.lock",
|
||||
"/LICENSE*",
|
||||
"/README.md",
|
||||
"/web/dist/**/*",
|
||||
]
|
||||
|
||||
[dependencies]
|
||||
# CLI - minimal and fast
|
||||
@@ -48,8 +57,8 @@ schemars = "1.2"
|
||||
tracing = { version = "0.1", default-features = false }
|
||||
tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt", "ansi", "env-filter"] }
|
||||
|
||||
# Observability - Prometheus metrics
|
||||
prometheus = { version = "0.14", default-features = false }
|
||||
# Observability - Prometheus metrics (optional; requires AtomicU64, unavailable on 32-bit)
|
||||
prometheus = { version = "0.14", default-features = false, optional = true }
|
||||
|
||||
# Base64 encoding (screenshots, image data)
|
||||
base64 = "0.22"
|
||||
@@ -82,12 +91,12 @@ hex = "0.4"
|
||||
# CSPRNG for secure token generation
|
||||
rand = "0.10"
|
||||
|
||||
# Portable atomic fallbacks for targets without native 64-bit atomics
|
||||
portable-atomic = "1"
|
||||
|
||||
# serde-big-array for wa-rs storage (large array serialization)
|
||||
serde-big-array = { version = "0.5", optional = true }
|
||||
|
||||
# Portable atomic fallbacks for 32-bit targets (no native 64-bit atomics)
|
||||
portable-atomic = { version = "1", optional = true }
|
||||
|
||||
# Fast mutexes that don't poison on panic
|
||||
parking_lot = "0.12"
|
||||
|
||||
@@ -187,13 +196,14 @@ landlock = { version = "0.4", optional = true }
|
||||
libc = "0.2"
|
||||
|
||||
[features]
|
||||
default = ["channel-nostr"]
|
||||
default = ["observability-prometheus", "channel-nostr"]
|
||||
channel-nostr = ["dep:nostr-sdk"]
|
||||
hardware = ["nusb", "tokio-serial"]
|
||||
channel-matrix = ["dep:matrix-sdk"]
|
||||
channel-lark = ["dep:prost"]
|
||||
channel-feishu = ["channel-lark"] # Alias for Feishu users (Lark and Feishu are the same platform)
|
||||
memory-postgres = ["dep:postgres"]
|
||||
observability-prometheus = ["dep:prometheus"]
|
||||
observability-otel = ["dep:opentelemetry", "dep:opentelemetry_sdk", "dep:opentelemetry-otlp"]
|
||||
peripheral-rpi = ["rppal"]
|
||||
# Browser backend feature alias used by cfg(feature = "browser-native")
|
||||
@@ -205,6 +215,8 @@ sandbox-landlock = ["dep:landlock"]
|
||||
sandbox-bubblewrap = []
|
||||
# Backward-compatible alias for older invocations
|
||||
landlock = ["sandbox-landlock"]
|
||||
# Prometheus metrics observer (requires 64-bit atomics; disable on 32-bit targets)
|
||||
metrics = ["observability-prometheus"]
|
||||
# probe = probe-rs for Nucleo memory read (adds ~50 deps; optional)
|
||||
probe = ["dep:probe-rs"]
|
||||
# rag-pdf = PDF ingestion for datasheet RAG
|
||||
@@ -225,6 +237,11 @@ inherits = "release"
|
||||
codegen-units = 8 # Parallel codegen for faster builds on powerful machines (16GB+ RAM recommended)
|
||||
# Use: cargo build --profile release-fast
|
||||
|
||||
[profile.ci]
|
||||
inherits = "release"
|
||||
lto = "thin" # Much faster than fat LTO; still catches release-mode issues
|
||||
codegen-units = 16 # Full parallelism for CI runners
|
||||
|
||||
[profile.dist]
|
||||
inherits = "release"
|
||||
opt-level = "z"
|
||||
|
||||
@@ -90,6 +90,8 @@ COPY dev/config.template.toml /zeroclaw-data/.zeroclaw/config.toml
|
||||
RUN chown 65534:65534 /zeroclaw-data/.zeroclaw/config.toml
|
||||
|
||||
# Environment setup
|
||||
# Ensure UTF-8 locale so CJK / multibyte input is handled correctly
|
||||
ENV LANG=C.UTF-8
|
||||
# Use consistent workspace path
|
||||
ENV ZEROCLAW_WORKSPACE=/zeroclaw-data/workspace
|
||||
ENV HOME=/zeroclaw-data
|
||||
@@ -114,6 +116,8 @@ COPY --from=builder /app/zeroclaw /usr/local/bin/zeroclaw
|
||||
COPY --from=builder /zeroclaw-data /zeroclaw-data
|
||||
|
||||
# Environment setup
|
||||
# Ensure UTF-8 locale so CJK / multibyte input is handled correctly
|
||||
ENV LANG=C.UTF-8
|
||||
ENV ZEROCLAW_WORKSPACE=/zeroclaw-data/workspace
|
||||
ENV HOME=/zeroclaw-data
|
||||
# Default provider and model are set in config.toml, not here,
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
# syntax=docker/dockerfile:1.7
|
||||
|
||||
# Dockerfile.debian — Shell-equipped variant of the ZeroClaw container.
|
||||
#
|
||||
# The default Dockerfile produces a distroless "release" image with no shell,
|
||||
# which is ideal for minimal attack surface but prevents the agent from using
|
||||
# shell-based tools (pwd, ls, git, curl, etc.).
|
||||
#
|
||||
# This variant uses debian:bookworm-slim as the runtime base and ships
|
||||
# essential CLI tools so the agent can operate as a full coding assistant.
|
||||
#
|
||||
# Build:
|
||||
# docker build -f Dockerfile.debian -t zeroclaw:debian .
|
||||
#
|
||||
# Or with docker compose:
|
||||
# docker compose -f docker-compose.yml -f docker-compose.debian.yml up
|
||||
|
||||
# ── Stage 1: Build (identical to main Dockerfile) ───────────
|
||||
FROM rust:1.93-slim@sha256:9663b80a1621253d30b146454f903de48f0af925c967be48c84745537cd35d8b AS builder
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Install build dependencies
|
||||
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
||||
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
||||
apt-get update && apt-get install -y \
|
||||
pkg-config \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# 1. Copy manifests to cache dependencies
|
||||
COPY Cargo.toml Cargo.lock ./
|
||||
COPY crates/robot-kit/Cargo.toml crates/robot-kit/Cargo.toml
|
||||
# Create dummy targets declared in Cargo.toml so manifest parsing succeeds.
|
||||
RUN mkdir -p src benches crates/robot-kit/src \
|
||||
&& echo "fn main() {}" > src/main.rs \
|
||||
&& echo "fn main() {}" > benches/agent_benchmarks.rs \
|
||||
&& echo "pub fn placeholder() {}" > crates/robot-kit/src/lib.rs
|
||||
RUN --mount=type=cache,id=zeroclaw-cargo-registry,target=/usr/local/cargo/registry,sharing=locked \
|
||||
--mount=type=cache,id=zeroclaw-cargo-git,target=/usr/local/cargo/git,sharing=locked \
|
||||
--mount=type=cache,id=zeroclaw-target,target=/app/target,sharing=locked \
|
||||
cargo build --release --locked
|
||||
RUN rm -rf src benches crates/robot-kit/src
|
||||
|
||||
# 2. Copy only build-relevant source paths (avoid cache-busting on docs/tests/scripts)
|
||||
COPY src/ src/
|
||||
COPY benches/ benches/
|
||||
COPY crates/ crates/
|
||||
COPY firmware/ firmware/
|
||||
COPY web/ web/
|
||||
# Keep release builds resilient when frontend dist assets are not prebuilt in Git.
|
||||
RUN mkdir -p web/dist && \
|
||||
if [ ! -f web/dist/index.html ]; then \
|
||||
printf '%s\n' \
|
||||
'<!doctype html>' \
|
||||
'<html lang="en">' \
|
||||
' <head>' \
|
||||
' <meta charset="utf-8" />' \
|
||||
' <meta name="viewport" content="width=device-width,initial-scale=1" />' \
|
||||
' <title>ZeroClaw Dashboard</title>' \
|
||||
' </head>' \
|
||||
' <body>' \
|
||||
' <h1>ZeroClaw Dashboard Unavailable</h1>' \
|
||||
' <p>Frontend assets are not bundled in this build. Build the web UI to populate <code>web/dist</code>.</p>' \
|
||||
' </body>' \
|
||||
'</html>' > web/dist/index.html; \
|
||||
fi
|
||||
RUN --mount=type=cache,id=zeroclaw-cargo-registry,target=/usr/local/cargo/registry,sharing=locked \
|
||||
--mount=type=cache,id=zeroclaw-cargo-git,target=/usr/local/cargo/git,sharing=locked \
|
||||
--mount=type=cache,id=zeroclaw-target,target=/app/target,sharing=locked \
|
||||
cargo build --release --locked && \
|
||||
cp target/release/zeroclaw /app/zeroclaw && \
|
||||
strip /app/zeroclaw
|
||||
|
||||
# Prepare runtime directory structure and default config inline (no extra stage)
|
||||
RUN mkdir -p /zeroclaw-data/.zeroclaw /zeroclaw-data/workspace && \
|
||||
printf '%s\n' \
|
||||
'workspace_dir = "/zeroclaw-data/workspace"' \
|
||||
'config_path = "/zeroclaw-data/.zeroclaw/config.toml"' \
|
||||
'api_key = ""' \
|
||||
'default_provider = "openrouter"' \
|
||||
'default_model = "anthropic/claude-sonnet-4-20250514"' \
|
||||
'default_temperature = 0.7' \
|
||||
'' \
|
||||
'[gateway]' \
|
||||
'port = 42617' \
|
||||
'host = "[::]"' \
|
||||
'allow_public_bind = true' \
|
||||
> /zeroclaw-data/.zeroclaw/config.toml && \
|
||||
chown -R 65534:65534 /zeroclaw-data
|
||||
|
||||
# ── Stage 2: Runtime (Debian with shell) ─────────────────────
|
||||
FROM debian:bookworm-slim AS runtime
|
||||
|
||||
# Install essential tools for agent shell operations
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
bash \
|
||||
ca-certificates \
|
||||
curl \
|
||||
git \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
COPY --from=builder /app/zeroclaw /usr/local/bin/zeroclaw
|
||||
COPY --from=builder /zeroclaw-data /zeroclaw-data
|
||||
|
||||
# Environment setup
|
||||
# Ensure UTF-8 locale so CJK / multibyte input is handled correctly
|
||||
ENV LANG=C.UTF-8
|
||||
ENV ZEROCLAW_WORKSPACE=/zeroclaw-data/workspace
|
||||
ENV HOME=/zeroclaw-data
|
||||
# Default provider and model are set in config.toml, not here,
|
||||
# so config file edits are not silently overridden
|
||||
ENV ZEROCLAW_GATEWAY_PORT=42617
|
||||
|
||||
# API_KEY must be provided at runtime!
|
||||
|
||||
WORKDIR /zeroclaw-data
|
||||
USER 65534:65534
|
||||
EXPOSE 42617
|
||||
ENTRYPOINT ["zeroclaw"]
|
||||
CMD ["gateway"]
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # عرض الإصدار ومعلومات البنا
|
||||
|
||||
راجع [مرجع الأوامر](docs/commands-reference.md) للخيارات والأمثلة الكاملة.
|
||||
|
||||
## البنية
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ القنوات (سمة) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ منسق الوكيل │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ توجيه │ │ السياق │ │ التنفيذ │ │
|
||||
│ │ الرسائل │ │ الذاكرة │ │ الأداة │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ الموفرون │ │ الذاكرة │ │ الأدوات │
|
||||
│ (سمة) │ │ (سمة) │ │ (سمة) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ وقت التشغيل (سمة) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**المبادئ الأساسية:**
|
||||
|
||||
- كل شيء هو **سمة** — الموفرون والقنوات والأدوات والذاكرة والأنفاق
|
||||
- القنوات تستدعي المنسق؛ المنسق يستدعي الموفرون + الأدوات
|
||||
- نظام الذاكرة يدير سياق المحادثة (markdown أو SQLite أو لا شيء)
|
||||
- وقت التشغيل يجرد تنفيذ الكود (أصلي أو Docker)
|
||||
- لا قفل للمورد — استبدل Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama بدون تغييرات في الكود
|
||||
|
||||
راجع [توثيق البنية](docs/architecture.svg) للرسوم البيانية التفصيلية وتفاصيل التنفيذ.
|
||||
|
||||
## الأمثلة
|
||||
|
||||
### بوت Telegram
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # معرف مستخدم Telegram الخاص بك
|
||||
```
|
||||
|
||||
ابدأ البرنامج الخفي + الوكيل، ثم أرسل رسالة إلى بوتك على Telegram:
|
||||
|
||||
```
|
||||
/start
|
||||
مرحباً! هل يمكنك مساعدتي في كتابة نص Python؟
|
||||
```
|
||||
|
||||
يستجيب البوت بكود مُنشأ بالذكاء الاصطناعي، وينفذ الأدوات إذا طُلب، ويحافظ على سياق المحادثة.
|
||||
|
||||
### Matrix (تشفير من طرف إلى طرف)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
ادعُ `@zeroclaw:matrix.org` إلى غرفة مشفرة، وسيستجيب البوت بتشفير كامل. راجع [دليل Matrix E2EE](docs/matrix-e2ee-guide.md) لإعداد التحقق من الجهاز.
|
||||
|
||||
### متعدد الموفرون
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # التبديل عند خطأ المورد
|
||||
```
|
||||
|
||||
إذا فشل Anthropic أو وصل إلى حد السرعة، يتبادل المنسق تلقائيًا إلى OpenAI.
|
||||
|
||||
### ذاكرة مخصصة
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # حذف تلقائي بعد 90 يومًا
|
||||
```
|
||||
|
||||
أو استخدم Markdown للتخزين القابل للقراءة البشرية:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
راجع [مرجع التكوين](docs/config-reference.md#memory) لجميع خيارات الذاكرة.
|
||||
|
||||
## دعم الموفرون
|
||||
|
||||
| المورد | الحالة | مفتاح API | النماذج المثال |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ مستقر | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ مستقر | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ مستقر | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ مستقر | N/A (محلي) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ مستقر | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ مستقر | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 مخطط | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 مخطط | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### نقاط النهاية المخصصة
|
||||
|
||||
يدعم ZeroClaw نقاط النهاية المتوافقة مع OpenAI:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
مثال: استخدم [LiteLLM](https://github.com/BerriAI/litellm) كوكيل للوصول إلى أي LLM عبر واجهة OpenAI.
|
||||
|
||||
راجع [مرجع الموفرون](docs/providers-reference.md) لتفاصيل التكوين الكاملة.
|
||||
|
||||
## دعم القنوات
|
||||
|
||||
| القناة | الحالة | المصادقة | ملاحظات |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ مستقر | رمز البوت | دعم كامل بما في ذلك الملفات والصور والأزرار المضمنة |
|
||||
| **Matrix** | ✅ مستقر | كلمة المرور أو الرمز | دعم E2EE مع التحقق من الجهاز |
|
||||
| **Slack** | 🚧 مخطط | OAuth أو رمز البوت | يتطلب الوصول إلى مساحة العمل |
|
||||
| **Discord** | 🚧 مخطط | رمز البوت | يتطلب أذونات النقابة |
|
||||
| **WhatsApp** | 🚧 مخطط | Twilio أو API الرسمية | يتطلب حساب تجاري |
|
||||
| **CLI** | ✅ مستقر | لا شيء | واجهة محادثة مباشرة |
|
||||
| **Web** | 🚧 مخطط | مفتاح API أو OAuth | واجهة دردشة قائمة على المتصفح |
|
||||
|
||||
راجع [مرجع القنوات](docs/channels-reference.md) لتعليمات التكوين الكاملة.
|
||||
|
||||
## دعم الأدوات
|
||||
|
||||
يوفر ZeroClaw أدوات مدمجة لتنفيذ الكود والوصول إلى نظام الملفات واسترجاع الويب:
|
||||
|
||||
| الأداة | الوصف | وقت التشغيل المطلوب |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | ينفذ أوامر الصدفة | أصلي أو Docker |
|
||||
| **python** | ينفذ نصوص Python | Python 3.8+ (أصلي) أو Docker |
|
||||
| **javascript** | ينفذ كود Node.js | Node.js 18+ (أصلي) أو Docker |
|
||||
| **filesystem_read** | يقرأ الملفات | أصلي أو Docker |
|
||||
| **filesystem_write** | يكتب الملفات | أصلي أو Docker |
|
||||
| **web_fetch** | يجلب محتوى الويب | أصلي أو Docker |
|
||||
|
||||
### أمان التنفيذ
|
||||
|
||||
- **وقت التشغيل الأصلي** — يعمل كعملية مستخدم البرنامج الخفي، وصول كامل لنظام الملفات
|
||||
- **وقت تشغيل Docker** — عزل حاوية كامل، أنظمة ملفات وشبكات منفصلة
|
||||
|
||||
قم بتكوين سياسة التنفيذ في `config.toml`:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # قائمة سماح صريحة
|
||||
```
|
||||
|
||||
راجع [مرجع التكوين](docs/config-reference.md#runtime) لخيارات الأمان الكاملة.
|
||||
|
||||
## النشر
|
||||
|
||||
### النشر المحلي (التطوير)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### نشر الخادم (الإنتاج)
|
||||
|
||||
استخدم systemd لإدارة البرنامج الخفي والوكيل كخدمات:
|
||||
|
||||
```bash
|
||||
# تثبيت الملف الثنائي
|
||||
cargo install --path . --locked
|
||||
|
||||
# تكوين مساحة العمل
|
||||
zeroclaw init
|
||||
|
||||
# إنشاء ملفات خدمة systemd
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# تمكين وبدء الخدمات
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# التحقق من الحالة
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
راجع [دليل نشر الشبكة](docs/network-deployment.md) لتعليمات نشر الإنتاج الكاملة.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# بناء الصورة
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# تشغيل الحاوية
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
راجع [`Dockerfile`](Dockerfile) لتفاصيل البناء وخيارات التكوين.
|
||||
|
||||
### أجهزة الحافة
|
||||
|
||||
تم تصميم ZeroClaw للعمل على أجهزة منخفضة الطاقة:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 ميغابايت ذاكرة عشوائية، نواة ARMv8 واحدة، < $5 تكلفة الأجهزة
|
||||
- **Raspberry Pi 4/5** — 1 غيغابايت+ ذاكرة عشوائية، متعدد النوى، مثالي لأحمال العمل المتزامنة
|
||||
- **Orange Pi Zero 2** — ~512 ميغابايت ذاكرة عشوائية، رباعي النواة ARMv8، تكلفة منخفضة جدًا
|
||||
- **أجهزة SBCs x86 (Intel N100)** — 4-8 غيغابايت ذاكرة عشوائية، بناء سريع، دعم Docker أصلي
|
||||
|
||||
راجع [دليل الأجهزة](docs/hardware/README.md) لتعليمات الإعداد الخاصة بالجهاز.
|
||||
|
||||
## الأنفاق (التعرض العام)
|
||||
|
||||
اعرض البرنامج الخفي ZeroClaw المحلي الخاص بك للشبكة العامة عبر أنفاق آمنة:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
موفرو الأنفاق المدعومون:
|
||||
|
||||
- **Cloudflare Tunnel** — HTTPS مجاني، لا تعرض للمنافذ، دعم متعدد المجالات
|
||||
- **Ngrok** — إعداد سريع، مجالات مخصصة (خطة مدفوعة)
|
||||
- **Tailscale** — شبكة شبكية خاصة، لا منفذ عام
|
||||
|
||||
راجع [مرجع التكوين](docs/config-reference.md#tunnel) لخيارات التكوين الكاملة.
|
||||
|
||||
## الأمان
|
||||
|
||||
ينفذ ZeroClaw طبقات متعددة من الأمان:
|
||||
|
||||
### الاقتران
|
||||
|
||||
يُنشئ البرنامج الخفي سر اقتران عند التشغيل الأول مخزن في `~/.zeroclaw/workspace/.pairing`. يجب على العملاء (الوكيل، CLI) تقديم هذا السر للاتصال.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # يُنشئ سرًا جديدًا ويبطل القديم
|
||||
```
|
||||
|
||||
### الصندوق الرملي
|
||||
|
||||
- **وقت تشغيل Docker** — عزل حاوية كامل مع أنظمة ملفات وشبكات منفصلة
|
||||
- **وقت التشغيل الأصلي** — يعمل كعملية مستخدم، محدد النطاق في مساحة العمل افتراضيًا
|
||||
|
||||
### قوائم السماح
|
||||
|
||||
يمكن للقنوات تقييد الوصول حسب معرف المستخدم:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # قائمة سماح صريحة
|
||||
```
|
||||
|
||||
### التشفير
|
||||
|
||||
- **Matrix E2EE** — تشفير من طرف إلى طرف كامل مع التحقق من الجهاز
|
||||
- **نقل TLS** — جميع حركة API والنفق تستخدم HTTPS/TLS
|
||||
|
||||
راجع [توثيق الأمان](docs/security/README.md) للسياسات والممارسات الكاملة.
|
||||
|
||||
## إمكانية الملاحظة
|
||||
|
||||
يسجل ZeroClaw في `~/.zeroclaw/workspace/logs/` افتراضيًا. يتم تخزين السجلات حسب المكون:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # سجلات البرنامج الخفي (بدء التشغيل، طلبات API، الأخطاء)
|
||||
├── agent.log # سجلات الوكيل (توجيه الرسائل، تنفيذ الأدوات)
|
||||
├── telegram.log # سجلات خاصة بالقناة (إذا مُكنت)
|
||||
└── matrix.log # سجلات خاصة بالقناة (إذا مُكنت)
|
||||
```
|
||||
|
||||
### تكوين التسجيل
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug، info، warn، error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # يومي، ساعي، حجم
|
||||
max_size_mb = 100 # للتدوير القائم على الحجم
|
||||
retention_days = 30 # حذف تلقائي بعد N يومًا
|
||||
```
|
||||
|
||||
راجع [مرجع التكوين](docs/config-reference.md#logging) لجميع خيارات التسجيل.
|
||||
|
||||
### المقاييس (مخطط)
|
||||
|
||||
دعم مقاييس Prometheus لمراقبة الإنتاج قريبًا. التتبع في [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## المهارات
|
||||
|
||||
يدعم ZeroClaw المهارات المخصصة — وحدات قابلة لإعادة الاستخدام توسع قدرات النظام.
|
||||
|
||||
### تعريف المهارة
|
||||
|
||||
يتم تخزين المهارات في `~/.zeroclaw/workspace/skills/<skill-name>/` بهذا الهيكل:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # بيانات المهارة (الاسم، الوصف، التبعيات)
|
||||
├── prompt.md # موجه النظام للذكاء الاصطناعي
|
||||
└── tools/ # أدوات مخصصة اختيارية
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### مثال المهارة
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "يبحث في الويب ويلخص النتائج"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
أنت مساعد بحث. عند طلب البحث عن شيء ما:
|
||||
|
||||
1. استخدم web_fetch لاسترجاع المحتوى
|
||||
2. لخص النتائج بتنسيق سهل القراءة
|
||||
3. استشهد بالمصادر مع عناوين URL
|
||||
```
|
||||
|
||||
### استخدام المهارات
|
||||
|
||||
يتم تحميل المهارات تلقائيًا عند بدء تشغيل الوكيل. أشر إليها بالاسم في المحادثات:
|
||||
|
||||
```
|
||||
المستخدم: استخدم مهارة البحث على الويب للعثور على أخبار الذكاء الاصطناعي الأخيرة
|
||||
البوت: [يحمل مهارة البحث على الويب، ينفذ web_fetch، يلخص النتائج]
|
||||
```
|
||||
|
||||
راجع قسم [المهارات](#المهارات) لتعليمات إنشاء المهارات الكاملة.
|
||||
|
||||
## المهارات المفتوحة
|
||||
|
||||
يدعم ZeroClaw [Open Skills](https://github.com/openagents-com/open-skills) — نظام معياري ومحايد للمورد لتوسيع قدرات وكلاء الذكاء الاصطناعي.
|
||||
|
||||
### تمكين المهارات المفتوحة
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # اختياري
|
||||
```
|
||||
|
||||
يمكنك أيضًا التجاوز في وقت التشغيل باستخدام `ZEROCLAW_OPEN_SKILLS_ENABLED` و `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## التطوير
|
||||
|
||||
```bash
|
||||
cargo build # بناء التطوير
|
||||
cargo build --release # بناء الإصدار (codegen-units=1، يعمل على جميع الأجهزة بما في ذلك Raspberry Pi)
|
||||
cargo build --profile release-fast # بناء أسرع (codegen-units=8، يتطلب 16 غيغابايت+ ذاكرة عشوائية)
|
||||
cargo test # تشغيل مجموعة الاختبار الكاملة
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # تنسيق
|
||||
|
||||
# تشغيل معيار مقارنة SQLite مقابل Markdown
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### خطاف ما قبل الدفع
|
||||
|
||||
يقوم خطاف git بتشغيل `cargo fmt --check` و `cargo clippy -- -D warnings` و `cargo test` قبل كل دفع. قم بتمكينه مرة واحدة:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### استكشاف أخطاء البناء وإصلاحها (أخطاء OpenSSL على Linux)
|
||||
|
||||
إذا واجهت خطأ بناء `openssl-sys`، قم بمزامنة التبعيات وأعد التجميع باستخدام ملف قفل المستودع:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
تم تكوين ZeroClaw لاستخدام `rustls` لتبعيات HTTP/TLS؛ `--locked` يحافظ على الرسم البياني العابر حتمي في البيئات النظيفة.
|
||||
|
||||
لتخطي الخطاف عندما تحتاج إلى دفع سريع أثناء التطوير:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## التعاون والتوثيق
|
||||
|
||||
ابدأ بمركز التوثيق لخريطة قائمة على المهام:
|
||||
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # Zobrazuje verzi a build informace
|
||||
|
||||
Viz [Příkazová reference](docs/commands-reference.md) pro kompletní možnosti a příklady.
|
||||
|
||||
## Architektura
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Kanály (trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Agent Orchestrátor │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Směrování │ │ Kontext │ │ Provedení │ │
|
||||
│ │ Zpráva │ │ Paměť │ │ Nástroj │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Poskytovatel│ │ Paměť │ │ Nástroje │
|
||||
│ (trait) │ │ (trait) │ │ (trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Runtime (trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Klíčové principy:**
|
||||
|
||||
- Vše je **trait** — poskytovatelé, kanály, nástroje, paměť, tunely
|
||||
- Kanály volají orchestrátor; orchestrátor volá poskytovatele + nástroje
|
||||
- Paměťový systém spravuje konverzační kontext (markdown, SQLite, nebo žádný)
|
||||
- Runtime abstrahuje provádění kódu (nativní nebo Docker)
|
||||
- Žádné vendor lock-in — vyměňujte Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama beze změn kódu
|
||||
|
||||
Viz [dokumentace architektury](docs/architecture.svg) pro detailní diagramy a detaily implementace.
|
||||
|
||||
## Příklady
|
||||
|
||||
### Telegram Bot
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Vaše Telegram user ID
|
||||
```
|
||||
|
||||
Spusťte daemon + agent, pak pošlete zprávu vašemu botovi na Telegram:
|
||||
|
||||
```
|
||||
/start
|
||||
Ahoj! Mohl bys mi pomoci napsat Python skript?
|
||||
```
|
||||
|
||||
Bot odpoví AI-generovaným kódem, provede nástroje pokud požadováno a udržuje konverzační kontext.
|
||||
|
||||
### Matrix (end-to-end šifrování)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Pozvěte `@zeroclaw:matrix.org` do šifrované místnosti a bot odpoví s plným šifrováním. Viz [Matrix E2EE Guide](docs/matrix-e2ee-guide.md) pro nastavení ověření zařízení.
|
||||
|
||||
### Multi-Poskytovatel
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Failover při chybě poskytovatele
|
||||
```
|
||||
|
||||
Pokud Anthropic selže nebo má rate-limit, orchestrátor automaticky přepne na OpenAI.
|
||||
|
||||
### Vlastní Paměť
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # Automatické čištění po 90 dnech
|
||||
```
|
||||
|
||||
Nebo použijte Markdown pro lidsky čitelné ukládání:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Viz [Konfigurační reference](docs/config-reference.md#memory) pro všechny možnosti paměti.
|
||||
|
||||
## Podpora Poskytovatelů
|
||||
|
||||
| Poskytovatel | Stav | API Klíč | Příklad Modelů |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Stabilní | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Stabilní | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Stabilní | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Stabilní | N/A (lokální) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Stabilní | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Stabilní | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Plánováno | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Plánováno | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Vlastní Endpointy
|
||||
|
||||
ZeroClaw podporuje OpenAI-kompatibilní endpointy:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Příklad: použijte [LiteLLM](https://github.com/BerriAI/litellm) jako proxy pro přístup k jakémukoli LLM přes OpenAI rozhraní.
|
||||
|
||||
Viz [Poskytovatel reference](docs/providers-reference.md) pro kompletní detaily konfigurace.
|
||||
|
||||
## Podpora Kanálů
|
||||
|
||||
| Kanál | Stav | Autentizace | Poznámky |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Stabilní | Bot Token | Plná podpora včetně souborů, obrázků, inline tlačítek |
|
||||
| **Matrix** | ✅ Stabilní | Heslo nebo Token | E2EE podpora s ověřením zařízení |
|
||||
| **Slack** | 🚧 Plánováno | OAuth nebo Bot Token | Vyžaduje workspace přístup |
|
||||
| **Discord** | 🚧 Plánováno | Bot Token | Vyžaduje guild oprávnění |
|
||||
| **WhatsApp** | 🚧 Plánováno | Twilio nebo oficiální API | Vyžaduje business účet |
|
||||
| **CLI** | ✅ Stabilní | Žádné | Přímé konverzační rozhraní |
|
||||
| **Web** | 🚧 Plánováno | API Klíč nebo OAuth | Prohlížečové chat rozhraní |
|
||||
|
||||
Viz [Kanálová reference](docs/channels-reference.md) pro kompletní instrukce konfigurace.
|
||||
|
||||
## Podpora Nástrojů
|
||||
|
||||
ZeroClaw poskytuje vestavěné nástroje pro provádění kódu, přístup k souborovému systému a web retrieval:
|
||||
|
||||
| Nástroj | Popis | Vyžadovaný Runtime |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Provádí shell příkazy | Nativní nebo Docker |
|
||||
| **python** | Provádí Python skripty | Python 3.8+ (nativní) nebo Docker |
|
||||
| **javascript** | Provádí Node.js kód | Node.js 18+ (nativní) nebo Docker |
|
||||
| **filesystem_read** | Čte soubory | Nativní nebo Docker |
|
||||
| **filesystem_write** | Zapisuje soubory | Nativní nebo Docker |
|
||||
| **web_fetch** | Získává web obsah | Nativní nebo Docker |
|
||||
|
||||
### Bezpečnost Provedení
|
||||
|
||||
- **Nativní Runtime** — běží jako uživatelský proces daemon, plný přístup k souborovému systému
|
||||
- **Docker Runtime** — plná kontejnerová izolace, oddělené souborové systémy a sítě
|
||||
|
||||
Nakonfigurujte politiku provedení v `config.toml`:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Explicitní allowlist
|
||||
```
|
||||
|
||||
Viz [Konfigurační reference](docs/config-reference.md#runtime) pro kompletní možnosti bezpečnosti.
|
||||
|
||||
## Nasazení
|
||||
|
||||
### Lokální Nasazení (Vývoj)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Serverové Nasazení (Produkce)
|
||||
|
||||
Použijte systemd pro správu daemon a agent jako služby:
|
||||
|
||||
```bash
|
||||
# Nainstalujte binary
|
||||
cargo install --path . --locked
|
||||
|
||||
# Nakonfigurujte workspace
|
||||
zeroclaw init
|
||||
|
||||
# Vytvořte systemd servisní soubory
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# Povolte a spusťte služby
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# Ověřte stav
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Viz [Průvodce síťovým nasazením](docs/network-deployment.md) pro kompletní instrukce produkčního nasazení.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Sestavte image
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# Spusťte kontejner
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Viz [`Dockerfile`](Dockerfile) pro detaily sestavení a konfigurační možnosti.
|
||||
|
||||
### Edge Hardware
|
||||
|
||||
ZeroClaw je navržen pro běh na nízko-příkonovém hardwaru:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, jedno ARMv8 jádro, < $5 hardwarové náklady
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, vícejádrový, ideální pro souběžné úlohy
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, čtyřjádrový ARMv8, ultra-nízké náklady
|
||||
- **x86 SBCs (Intel N100)** — 4-8 GB RAM, rychlé buildy, nativní Docker podpora
|
||||
|
||||
Viz [Hardware Guide](docs/hardware/README.md) pro instrukce nastavení specifické pro zařízení.
|
||||
|
||||
## Tunneling (Veřejná Expozice)
|
||||
|
||||
Exponujte svůj lokální ZeroClaw daemon do veřejné sítě přes bezpečné tunely:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Podporovaní tunnel poskytovatelé:
|
||||
|
||||
- **Cloudflare Tunnel** — bezplatný HTTPS, bez expozice portů, multi-doména podpora
|
||||
- **Ngrok** — rychlé nastavení, vlastní domény (placený plán)
|
||||
- **Tailscale** — soukromá mesh síť, bez veřejného portu
|
||||
|
||||
Viz [Konfigurační reference](docs/config-reference.md#tunnel) pro kompletní konfigurační možnosti.
|
||||
|
||||
## Bezpečnost
|
||||
|
||||
ZeroClaw implementuje více vrstev bezpečnosti:
|
||||
|
||||
### Párování
|
||||
|
||||
Daemon generuje párovací tajemství při prvním spuštění uložené v `~/.zeroclaw/workspace/.pairing`. Klienti (agent, CLI) musí předložit toto tajemství pro připojení.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Generuje nové tajemství a zneplatňuje staré
|
||||
```
|
||||
|
||||
### Sandboxing
|
||||
|
||||
- **Docker Runtime** — plná kontejnerová izolace s oddělenými souborovými systémy a sítěmi
|
||||
- **Nativní Runtime** — běží jako uživatelský proces, scoped na workspace defaultně
|
||||
|
||||
### Allowlisty
|
||||
|
||||
Kanály mohou omezit přístup podle user ID:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Explicitní allowlist
|
||||
```
|
||||
|
||||
### Šifrování
|
||||
|
||||
- **Matrix E2EE** — plné end-to-end šifrování s ověřením zařízení
|
||||
- **TLS Transport** — veškerý API a tunnel provoz používá HTTPS/TLS
|
||||
|
||||
Viz [Bezpečnostní dokumentace](docs/security/README.md) pro kompletní politiky a praktiky.
|
||||
|
||||
## Pozorovatelnost
|
||||
|
||||
ZeroClaw loguje do `~/.zeroclaw/workspace/logs/` defaultně. Logy jsou ukládány podle komponenty:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Daemon logy (startup, API požadavky, chyby)
|
||||
├── agent.log # Agent logy (směrování zpráv, provedení nástrojů)
|
||||
├── telegram.log # Kanál-specifické logy (pokud povoleno)
|
||||
└── matrix.log # Kanál-specifické logy (pokud povoleno)
|
||||
```
|
||||
|
||||
### Konfigurace Logování
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # Pro rotaci založenou na velikosti
|
||||
retention_days = 30 # Automatické čištění po N dnech
|
||||
```
|
||||
|
||||
Viz [Konfigurační reference](docs/config-reference.md#logging) pro všechny možnosti logování.
|
||||
|
||||
### Metriky (Plánováno)
|
||||
|
||||
Podpora Prometheus metrik pro produkční monitoring již brzy. Sledování v [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## Dovednosti
|
||||
|
||||
ZeroClaw podporuje vlastní dovednosti — opakovaně použitelné moduly rozšiřující schopnosti systému.
|
||||
|
||||
### Definice Dovednosti
|
||||
|
||||
Dovednosti jsou uloženy v `~/.zeroclaw/workspace/skills/<skill-name>/` s touto strukturou:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # Metadata dovednosti (název, popis, závislosti)
|
||||
├── prompt.md # Systémový prompt pro AI
|
||||
└── tools/ # Volitelné vlastní nástroje
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### Příklad Dovednosti
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "Hledá na webu a shrnuje výsledky"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
Jste výzkumný asistent. Když požádáte o výzkum něčeho:
|
||||
|
||||
1. Použijte web_fetch pro získání obsahu
|
||||
2. Shrňte výsledky v snadno čitelném formátu
|
||||
3. Citujte zdroje s URL
|
||||
```
|
||||
|
||||
### Použití Dovedností
|
||||
|
||||
Dovednosti jsou automaticky načítány při startu agenta. Odkazujte na ně jménem v konverzacích:
|
||||
|
||||
```
|
||||
Uživatel: Použij dovednost web-research k nalezení nejnovějších AI zpráv
|
||||
Bot: [načte dovednost web-research, provede web_fetch, shrne výsledky]
|
||||
```
|
||||
|
||||
Viz sekce [Dovednosti](#dovednosti) pro kompletní instrukce tvorby dovedností.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw podporuje [Open Skills](https://github.com/openagents-com/open-skills) — modulární a poskytovatel-agnostický systém pro rozšíření schopností AI agentů.
|
||||
|
||||
### Povolit Open Skills
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # volitelné
|
||||
```
|
||||
|
||||
Můžete také přepsat za běhu pomocí `ZEROCLAW_OPEN_SKILLS_ENABLED` a `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## Vývoj
|
||||
|
||||
```bash
|
||||
cargo build # Dev build
|
||||
cargo build --release # Release build (codegen-units=1, funguje na všech zařízeních včetně Raspberry Pi)
|
||||
cargo build --profile release-fast # Rychlejší build (codegen-units=8, vyžaduje 16 GB+ RAM)
|
||||
cargo test # Spustí plnou testovací sadu
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Formátování
|
||||
|
||||
# Spusťte SQLite vs Markdown srovnávací benchmark
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Pre-push hook
|
||||
|
||||
Git hook spouští `cargo fmt --check`, `cargo clippy -- -D warnings`, a `cargo test` před každým push. Povolte jej jednou:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Řešení problémů s Buildem (OpenSSL chyby na Linuxu)
|
||||
|
||||
Pokud narazíte na `openssl-sys` build chybu, synchronizujte závislosti a znovu zkompilujte s lockfile repoziťáře:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw je nakonfigurován pro použití `rustls` pro HTTP/TLS závislosti; `--locked` udržuje transitivní graf deterministický v čistých prostředích.
|
||||
|
||||
Pro přeskočení hooku když potřebujete rychlý push během vývoje:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Spolupráce & Docs
|
||||
|
||||
Začněte s dokumentačním centrem pro task-based mapu:
|
||||
|
||||
-437
@@ -367,443 +367,6 @@ zeroclaw version # Zeigt Version und Build-Informationen
|
||||
|
||||
Siehe [Befehlsreferenz](docs/commands-reference.md) für vollständige Optionen und Beispiele.
|
||||
|
||||
## Architektur
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Channels (Trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Agent-Orchestrator │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Routing │ │ Kontext │ │ Ausführung │ │
|
||||
│ │ Nachricht │ │ Speicher │ │ Werkzeug │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Provider │ │ Speicher │ │ Werkzeuge │
|
||||
│ (Trait) │ │ (Trait) │ │ (Trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Runtime (Trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Schlüsselprinzipien:**
|
||||
|
||||
- Alles ist ein **Trait** — Provider, Channels, Tools, Speicher, Tunnel
|
||||
- Channels rufen den Orchestrator auf; der Orchestrator ruft Provider + Tools auf
|
||||
- Das Speichersystem verwaltet Konversationskontext (Markdown, SQLite, oder keiner)
|
||||
- Das Runtime abstrahiert Code-Ausführung (nativ oder Docker)
|
||||
- Kein Provider-Lock-in — tausche Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama ohne Code-Änderungen
|
||||
|
||||
Siehe [Architektur-Dokumentation](docs/architecture.svg) für detaillierte Diagramme und Implementierungsdetails.
|
||||
|
||||
## Beispiele
|
||||
|
||||
### Telegram-Bot
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Deine Telegram-Benutzer-ID
|
||||
```
|
||||
|
||||
Starte den Daemon + Agent, dann sende eine Nachricht an deinen Bot auf Telegram:
|
||||
|
||||
```
|
||||
/start
|
||||
Hallo! Könntest du mir helfen, ein Python-Skript zu schreiben?
|
||||
```
|
||||
|
||||
Der Bot antwortet mit KI-generiertem Code, führt Tools auf Anfrage aus und behält den Konversationskontext.
|
||||
|
||||
### Matrix (Ende-zu-Ende-Verschlüsselung)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Lade `@zeroclaw:matrix.org` in einen verschlüsselten Raum ein, und der Bot wird mit vollständiger Verschlüsselung antworten. Siehe [Matrix E2EE-Leitfaden](docs/matrix-e2ee-guide.md) für Geräteverifizierungs-Setup.
|
||||
|
||||
### Multi-Provider
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Failover bei Provider-Fehler
|
||||
```
|
||||
|
||||
Wenn Anthropic fehlschlägt oder Rate-Limit erreicht, wechselt der Orchestrator automatisch zu OpenAI.
|
||||
|
||||
### Benutzerdefinierter Speicher
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # Automatische Bereinigung nach 90 Tagen
|
||||
```
|
||||
|
||||
Oder verwende Markdown für menschenlesbaren Speicher:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Siehe [Konfigurationsreferenz](docs/config-reference.md#memory) für alle Speicheroptionen.
|
||||
|
||||
## Provider-Unterstützung
|
||||
|
||||
| Provider | Status | API-Schlüssel | Beispielmodelle |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Stabil | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Stabil | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Stabil | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Stabil | N/A (lokal) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Stabil | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Stabil | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Geplant | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Geplant | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Benutzerdefinierte Endpoints
|
||||
|
||||
ZeroClaw unterstützt OpenAI-kompatible Endpoints:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Beispiel: verwende [LiteLLM](https://github.com/BerriAI/litellm) als Proxy, um auf jedes LLM über die OpenAI-Schnittstelle zuzugreifen.
|
||||
|
||||
Siehe [Provider-Referenz](docs/providers-reference.md) für vollständige Konfigurationsdetails.
|
||||
|
||||
## Channel-Unterstützung
|
||||
|
||||
| Channel | Status | Authentifizierung | Hinweise |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Stabil | Bot-Token | Vollständige Unterstützung inklusive Dateien, Bilder, Inline-Buttons |
|
||||
| **Matrix** | ✅ Stabil | Passwort oder Token | E2EE-Unterstützung mit Geräteverifizierung |
|
||||
| **Slack** | 🚧 Geplant | OAuth oder Bot-Token | Erfordert Workspace-Zugriff |
|
||||
| **Discord** | 🚧 Geplant | Bot-Token | Erfordert Guild-Berechtigungen |
|
||||
| **WhatsApp** | 🚧 Geplant | Twilio oder offizielle API | Erfordert Business-Konto |
|
||||
| **CLI** | ✅ Stabil | Keine | Direkte konversationelle Schnittstelle |
|
||||
| **Web** | 🚧 Geplant | API-Schlüssel oder OAuth | Browserbasierte Chat-Schnittstelle |
|
||||
|
||||
Siehe [Channel-Referenz](docs/channels-reference.md) für vollständige Konfigurationsanleitungen.
|
||||
|
||||
## Tool-Unterstützung
|
||||
|
||||
ZeroClaw bietet integrierte Tools für Code-Ausführung, Dateisystemzugriff und Web-Abruf:
|
||||
|
||||
| Tool | Beschreibung | Erforderliches Runtime |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Führt Shell-Befehle aus | Nativ oder Docker |
|
||||
| **python** | Führt Python-Skripte aus | Python 3.8+ (nativ) oder Docker |
|
||||
| **javascript** | Führt Node.js-Code aus | Node.js 18+ (nativ) oder Docker |
|
||||
| **filesystem_read** | Liest Dateien | Nativ oder Docker |
|
||||
| **filesystem_write** | Schreibt Dateien | Nativ oder Docker |
|
||||
| **web_fetch** | Ruft Web-Inhalte ab | Nativ oder Docker |
|
||||
|
||||
### Ausführungssicherheit
|
||||
|
||||
- **Natives Runtime** — läuft als Benutzerprozess des Daemons, voller Dateisystemzugriff
|
||||
- **Docker-Runtime** — vollständige Container-Isolierung, separate Dateisysteme und Netzwerke
|
||||
|
||||
Konfiguriere die Ausführungsrichtlinie in `config.toml`:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Explizite Allowlist
|
||||
```
|
||||
|
||||
Siehe [Konfigurationsreferenz](docs/config-reference.md#runtime) für vollständige Sicherheitsoptionen.
|
||||
|
||||
## Deployment
|
||||
|
||||
### Lokales Deployment (Entwicklung)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Server-Deployment (Produktion)
|
||||
|
||||
Verwende systemd, um Daemon und Agent als Dienste zu verwalten:
|
||||
|
||||
```bash
|
||||
# Installiere das Binary
|
||||
cargo install --path . --locked
|
||||
|
||||
# Konfiguriere den Workspace
|
||||
zeroclaw init
|
||||
|
||||
# Erstelle systemd-Dienstdateien
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# Aktiviere und starte die Dienste
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# Überprüfe den Status
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Siehe [Netzwerk-Deployment-Leitfaden](docs/network-deployment.md) für vollständige Produktions-Deployment-Anleitungen.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Baue das Image
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# Führe den Container aus
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Siehe [`Dockerfile`](Dockerfile) für Build-Details und Konfigurationsoptionen.
|
||||
|
||||
### Edge-Hardware
|
||||
|
||||
ZeroClaw ist für den Betrieb auf Low-Power-Hardware konzipiert:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, einzelner ARMv8-Kern, < $5 Hardware-Kosten
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, Multi-Core, ideal für gleichzeitige Workloads
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, Quad-Core ARMv8, Ultra-Low-Cost
|
||||
- **x86 SBCs (Intel N100)** — 4-8 GB RAM, schnelle Builds, nativer Docker-Support
|
||||
|
||||
Siehe [Hardware-Leitfaden](docs/hardware/README.md) für gerätespezifische Einrichtungsanleitungen.
|
||||
|
||||
## Tunneling (Öffentliche Exposition)
|
||||
|
||||
Exponiere deinen lokalen ZeroClaw-Daemon über sichere Tunnel zum öffentlichen Netzwerk:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Unterstützte Tunnel-Provider:
|
||||
|
||||
- **Cloudflare Tunnel** — kostenloses HTTPS, keine Port-Exposition, Multi-Domain-Support
|
||||
- **Ngrok** — schnelle Einrichtung, benutzerdefinierte Domains (kostenpflichtiger Plan)
|
||||
- **Tailscale** — privates Mesh-Netzwerk, kein öffentlicher Port
|
||||
|
||||
Siehe [Konfigurationsreferenz](docs/config-reference.md#tunnel) für vollständige Konfigurationsoptionen.
|
||||
|
||||
## Sicherheit
|
||||
|
||||
ZeroClaw implementiert mehrere Sicherheitsebenen:
|
||||
|
||||
### Pairing
|
||||
|
||||
Der Daemon generiert beim ersten Start ein Pairing-Geheimnis, das in `~/.zeroclaw/workspace/.pairing` gespeichert wird. Clients (Agent, CLI) müssen dieses Geheimnis präsentieren, um eine Verbindung herzustellen.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Generiert ein neues Geheimnis und erklärt das alte für ungültig
|
||||
```
|
||||
|
||||
### Sandboxing
|
||||
|
||||
- **Docker-Runtime** — vollständige Container-Isolierung mit separaten Dateisystemen und Netzwerken
|
||||
- **Natives Runtime** — läuft als Benutzerprozess, standardmäßig auf Workspace beschränkt
|
||||
|
||||
### Allowlists
|
||||
|
||||
Channels können den Zugriff nach Benutzer-ID einschränken:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Explizite Allowlist
|
||||
```
|
||||
|
||||
### Verschlüsselung
|
||||
|
||||
- **Matrix E2EE** — vollständige Ende-zu-Ende-Verschlüsselung mit Geräteverifizierung
|
||||
- **TLS-Transport** — der gesamte API- und Tunnel-Verkehr verwendet HTTPS/TLS
|
||||
|
||||
Siehe [Sicherheitsdokumentation](docs/security/README.md) für vollständige Richtlinien und Praktiken.
|
||||
|
||||
## Observability
|
||||
|
||||
ZeroClaw protokolliert standardmäßig in `~/.zeroclaw/workspace/logs/`. Logs werden nach Komponente gespeichert:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Daemon-Logs (Start, API-Anfragen, Fehler)
|
||||
├── agent.log # Agent-Logs (Nachrichten-Routing, Tool-Ausführung)
|
||||
├── telegram.log # Kanalspezifische Logs (falls aktiviert)
|
||||
└── matrix.log # Kanalspezifische Logs (falls aktiviert)
|
||||
```
|
||||
|
||||
### Logging-Konfiguration
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # Für größenbasierte Rotation
|
||||
retention_days = 30 # Automatische Bereinigung nach N Tagen
|
||||
```
|
||||
|
||||
Siehe [Konfigurationsreferenz](docs/config-reference.md#logging) für alle Logging-Optionen.
|
||||
|
||||
### Metriken (Geplant)
|
||||
|
||||
Prometheus-Metrik-Unterstützung für Produktionsüberwachung kommt bald. Verfolgung in [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## Skills
|
||||
|
||||
ZeroClaw unterstützt benutzerdefinierte Skills — wiederverwendbare Module, die die Systemfähigkeiten erweitern.
|
||||
|
||||
### Skill-Definition
|
||||
|
||||
Skills werden in `~/.zeroclaw/workspace/skills/<skill-name>/` mit dieser Struktur gespeichert:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # Skill-Metadaten (Name, Beschreibung, Abhängigkeiten)
|
||||
├── prompt.md # System-Prompt für die KI
|
||||
└── tools/ # Optionale benutzerdefinierte Tools
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### Skill-Beispiel
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "Sucht im Web und fasst Ergebnisse zusammen"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
Du bist ein Forschungsassistent. Wenn du gebeten wirst, etwas zu recherchieren:
|
||||
|
||||
1. Verwende web_fetch, um den Inhalt abzurufen
|
||||
2. Fasse die Ergebnisse in einem leicht lesbaren Format zusammen
|
||||
3. Zitiere die Quellen mit URLs
|
||||
```
|
||||
|
||||
### Skill-Verwendung
|
||||
|
||||
Skills werden beim Agent-Start automatisch geladen. Referenziere sie nach Namen in Konversationen:
|
||||
|
||||
```
|
||||
Benutzer: Verwende den Web-Research-Skill, um die neuesten KI-Nachrichten zu finden
|
||||
Bot: [lädt den Web-Research-Skill, führt web_fetch aus, fasst Ergebnisse zusammen]
|
||||
```
|
||||
|
||||
Siehe Abschnitt [Skills](#skills) für vollständige Skill-Erstellungsanleitungen.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw unterstützt [Open Skills](https://github.com/openagents-com/open-skills) — ein modulares und provider-agnostisches System zur Erweiterung von KI-Agenten-Fähigkeiten.
|
||||
|
||||
### Open Skills aktivieren
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # optional
|
||||
```
|
||||
|
||||
Du kannst auch zur Laufzeit mit `ZEROCLAW_OPEN_SKILLS_ENABLED` und `ZEROCLAW_OPEN_SKILLS_DIR` überschreiben.
|
||||
|
||||
## Entwicklung
|
||||
|
||||
```bash
|
||||
cargo build # Entwicklungs-Build
|
||||
cargo build --release # Release-Build (codegen-units=1, funktioniert auf allen Geräten einschließlich Raspberry Pi)
|
||||
cargo build --profile release-fast # Schnellerer Build (codegen-units=8, erfordert 16 GB+ RAM)
|
||||
cargo test # Führt die vollständige Test-Suite aus
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Formatierung
|
||||
|
||||
# Führe den SQLite vs Markdown Vergleichs-Benchmark aus
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Pre-push-Hook
|
||||
|
||||
Ein Git-Hook führt `cargo fmt --check`, `cargo clippy -- -D warnings`, und `cargo test` vor jedem Push aus. Aktiviere ihn einmal:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Build-Fehlerbehebung (OpenSSL-Fehler unter Linux)
|
||||
|
||||
Wenn du auf einen `openssl-sys`-Build-Fehler stößt, synchronisiere Abhängigkeiten und kompiliere mit dem Lockfile des Repositories neu:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw ist so konfiguriert, dass es `rustls` für HTTP/TLS-Abhängigkeiten verwendet; `--locked` hält den transitiven Graphen in sauberen Umgebungen deterministisch.
|
||||
|
||||
Um den Hook zu überspringen, wenn du während der Entwicklung einen schnellen Push benötigst:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Zusammenarbeit & Docs
|
||||
|
||||
Beginne mit dem Dokumentations-Hub für eine Aufgaben-basierte Karte:
|
||||
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # Muestra versión e información de build
|
||||
|
||||
Ver [Referencia de Comandos](docs/commands-reference.md) para opciones y ejemplos completos.
|
||||
|
||||
## Arquitectura
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Canales (trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Orquestador Agent │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Ruteo │ │ Contexto │ │ Ejecución │ │
|
||||
│ │ Mensaje │ │ Memoria │ │ Herramienta│ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Proveedores │ │ Memoria │ │ Herramientas │
|
||||
│ (trait) │ │ (trait) │ │ (trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Runtime (trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Principios clave:**
|
||||
|
||||
- Todo es un **trait** — proveedores, canales, herramientas, memoria, túneles
|
||||
- Los canales llaman al orquestador; el orquestador llama a proveedores + herramientas
|
||||
- El sistema de memoria gestiona contexto conversacional (markdown, SQLite, o ninguno)
|
||||
- El runtime abstrae la ejecución de código (nativo o Docker)
|
||||
- Sin lock-in de proveedor — intercambia Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama sin cambios de código
|
||||
|
||||
Ver [documentación de arquitectura](docs/architecture.svg) para diagramas detallados y detalles de implementación.
|
||||
|
||||
## Ejemplos
|
||||
|
||||
### Bot de Telegram
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Tu ID de usuario de Telegram
|
||||
```
|
||||
|
||||
Inicia el daemon + agent, luego envía un mensaje a tu bot en Telegram:
|
||||
|
||||
```
|
||||
/start
|
||||
¡Hola! ¿Podrías ayudarme a escribir un script Python?
|
||||
```
|
||||
|
||||
El bot responde con código generado por AI, ejecuta herramientas si se solicita, y mantiene el contexto de conversación.
|
||||
|
||||
### Matrix (cifrado extremo a extremo)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Invita a `@zeroclaw:matrix.org` a una sala cifrada, y el bot responderá con cifrado completo. Ver [Guía Matrix E2EE](docs/matrix-e2ee-guide.md) para configuración de verificación de dispositivo.
|
||||
|
||||
### Multi-Proveedor
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Failover en error de proveedor
|
||||
```
|
||||
|
||||
Si Anthropic falla o tiene rate-limit, el orquestador hace failover automáticamente a OpenAI.
|
||||
|
||||
### Memoria Personalizada
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # Purga automática después de 90 días
|
||||
```
|
||||
|
||||
O usa Markdown para almacenamiento legible por humanos:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Ver [Referencia de Configuración](docs/config-reference.md#memory) para todas las opciones de memoria.
|
||||
|
||||
## Soporte de Proveedor
|
||||
|
||||
| Proveedor | Estado | API Key | Modelos de Ejemplo |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Estable | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Estable | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Estable | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Estable | N/A (local) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Estable | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Estable | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Planificado | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Planificado | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Endpoints Personalizados
|
||||
|
||||
ZeroClaw soporta endpoints compatibles con OpenAI:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Ejemplo: usa [LiteLLM](https://github.com/BerriAI/litellm) como proxy para acceder a cualquier LLM vía interfaz OpenAI.
|
||||
|
||||
Ver [Referencia de Proveedores](docs/providers-reference.md) para detalles de configuración completos.
|
||||
|
||||
## Soporte de Canal
|
||||
|
||||
| Canal | Estado | Autenticación | Notas |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Estable | Bot Token | Soporte completo incluyendo archivos, imágenes, botones inline |
|
||||
| **Matrix** | ✅ Estable | Contraseña o Token | Soporte E2EE con verificación de dispositivo |
|
||||
| **Slack** | 🚧 Planificado | OAuth o Bot Token | Requiere acceso a workspace |
|
||||
| **Discord** | 🚧 Planificado | Bot Token | Requiere permisos de guild |
|
||||
| **WhatsApp** | 🚧 Planificado | Twilio o API oficial | Requiere cuenta business |
|
||||
| **CLI** | ✅ Estable | Ninguno | Interfaz conversacional directa |
|
||||
| **Web** | 🚧 Planificado | API Key o OAuth | Interfaz de chat basada en navegador |
|
||||
|
||||
Ver [Referencia de Canales](docs/channels-reference.md) para instrucciones de configuración completas.
|
||||
|
||||
## Soporte de Herramientas
|
||||
|
||||
ZeroClaw proporciona herramientas integradas para ejecución de código, acceso al sistema de archivos y recuperación web:
|
||||
|
||||
| Herramienta | Descripción | Runtime Requerido |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Ejecuta comandos shell | Nativo o Docker |
|
||||
| **python** | Ejecuta scripts Python | Python 3.8+ (nativo) o Docker |
|
||||
| **javascript** | Ejecuta código Node.js | Node.js 18+ (nativo) o Docker |
|
||||
| **filesystem_read** | Lee archivos | Nativo o Docker |
|
||||
| **filesystem_write** | Escribe archivos | Nativo o Docker |
|
||||
| **web_fetch** | Obtiene contenido web | Nativo o Docker |
|
||||
|
||||
### Seguridad de Ejecución
|
||||
|
||||
- **Runtime Nativo** — se ejecuta como proceso de usuario del daemon, acceso completo al sistema de archivos
|
||||
- **Runtime Docker** — aislamiento completo de contenedor, sistemas de archivos y redes separados
|
||||
|
||||
Configura la política de ejecución en `config.toml`:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Lista permitida explícita
|
||||
```
|
||||
|
||||
Ver [Referencia de Configuración](docs/config-reference.md#runtime) para opciones de seguridad completas.
|
||||
|
||||
## Despliegue
|
||||
|
||||
### Despliegue Local (Desarrollo)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Despliegue en Servidor (Producción)
|
||||
|
||||
Usa systemd para gestionar el daemon y agent como servicios:
|
||||
|
||||
```bash
|
||||
# Instala el binario
|
||||
cargo install --path . --locked
|
||||
|
||||
# Configura el workspace
|
||||
zeroclaw init
|
||||
|
||||
# Crea archivos de servicio systemd
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# Habilita e inicia los servicios
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# Verifica el estado
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Ver [Guía de Despliegue de Red](docs/network-deployment.md) para instrucciones completas de despliegue en producción.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Compila la imagen
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# Ejecuta el contenedor
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Ver [`Dockerfile`](Dockerfile) para detalles de build y opciones de configuración.
|
||||
|
||||
### Hardware Edge
|
||||
|
||||
ZeroClaw está diseñado para ejecutarse en hardware de bajo consumo:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, núcleo ARMv8 único, < $5 costo de hardware
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, multi-núcleo, ideal para workloads concurrentes
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, quad-core ARMv8, costo ultra-bajo
|
||||
- **SBCs x86 (Intel N100)** — 4-8 GB RAM, builds rápidos, soporte Docker nativo
|
||||
|
||||
Ver [Guía de Hardware](docs/hardware/README.md) para instrucciones de configuración específicas por dispositivo.
|
||||
|
||||
## Tunneling (Exposición Pública)
|
||||
|
||||
Expón tu daemon ZeroClaw local a la red pública vía túneles seguros:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Proveedores de tunnel soportados:
|
||||
|
||||
- **Cloudflare Tunnel** — HTTPS gratis, sin exposición de puertos, soporte multi-dominio
|
||||
- **Ngrok** — configuración rápida, dominios personalizados (plan de pago)
|
||||
- **Tailscale** — red mesh privada, sin puerto público
|
||||
|
||||
Ver [Referencia de Configuración](docs/config-reference.md#tunnel) para opciones de configuración completas.
|
||||
|
||||
## Seguridad
|
||||
|
||||
ZeroClaw implementa múltiples capas de seguridad:
|
||||
|
||||
### Emparejamiento
|
||||
|
||||
El daemon genera un secreto de emparejamiento al primer inicio almacenado en `~/.zeroclaw/workspace/.pairing`. Los clientes (agent, CLI) deben presentar este secreto para conectarse.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Genera un nuevo secreto e invalida el anterior
|
||||
```
|
||||
|
||||
### Sandboxing
|
||||
|
||||
- **Runtime Docker** — aislamiento completo de contenedor con sistemas de archivos y redes separados
|
||||
- **Runtime Nativo** — se ejecuta como proceso de usuario, con alcance de workspace por defecto
|
||||
|
||||
### Listas Permitidas
|
||||
|
||||
Los canales pueden restringir acceso por ID de usuario:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Lista permitida explícita
|
||||
```
|
||||
|
||||
### Cifrado
|
||||
|
||||
- **Matrix E2EE** — cifrado extremo a extremo completo con verificación de dispositivo
|
||||
- **Transporte TLS** — todo el tráfico de API y tunnel usa HTTPS/TLS
|
||||
|
||||
Ver [Documentación de Seguridad](docs/security/README.md) para políticas y prácticas completas.
|
||||
|
||||
## Observabilidad
|
||||
|
||||
ZeroClaw registra logs en `~/.zeroclaw/workspace/logs/` por defecto. Los logs se almacenan por componente:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Logs del daemon (inicio, solicitudes API, errores)
|
||||
├── agent.log # Logs del agent (ruteo de mensajes, ejecución de herramientas)
|
||||
├── telegram.log # Logs específicos del canal (si está habilitado)
|
||||
└── matrix.log # Logs específicos del canal (si está habilitado)
|
||||
```
|
||||
|
||||
### Configuración de Logging
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # Para rotación basada en tamaño
|
||||
retention_days = 30 # Purga automática después de N días
|
||||
```
|
||||
|
||||
Ver [Referencia de Configuración](docs/config-reference.md#logging) para todas las opciones de logging.
|
||||
|
||||
### Métricas (Planificado)
|
||||
|
||||
Soporte de métricas Prometheus para monitoreo en producción próximamente. Seguimiento en [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## Habilidades (Skills)
|
||||
|
||||
ZeroClaw soporta habilidades personalizadas — módulos reutilizables que extienden las capacidades del sistema.
|
||||
|
||||
### Definición de Habilidad
|
||||
|
||||
Las habilidades se almacenan en `~/.zeroclaw/workspace/skills/<skill-name>/` con esta estructura:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # Metadatos de habilidad (nombre, descripción, dependencias)
|
||||
├── prompt.md # Prompt de sistema para la AI
|
||||
└── tools/ # Herramientas personalizadas opcionales
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### Ejemplo de Habilidad
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "Busca en la web y resume resultados"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
Eres un asistente de investigación. Cuando te pidan buscar algo:
|
||||
|
||||
1. Usa web_fetch para obtener el contenido
|
||||
2. Resume los resultados en un formato fácil de leer
|
||||
3. Cita las fuentes con URLs
|
||||
```
|
||||
|
||||
### Uso de Habilidades
|
||||
|
||||
Las habilidades se cargan automáticamente al inicio del agent. Referéncialas por nombre en conversaciones:
|
||||
|
||||
```
|
||||
Usuario: Usa la habilidad web-research para encontrar las últimas noticias de AI
|
||||
Bot: [carga la habilidad web-research, ejecuta web_fetch, resume resultados]
|
||||
```
|
||||
|
||||
Ver sección [Habilidades (Skills)](#habilidades-skills) para instrucciones completas de creación de habilidades.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw soporta [Open Skills](https://github.com/openagents-com/open-skills) — un sistema modular y agnóstico de proveedores para extender capacidades de agentes AI.
|
||||
|
||||
### Habilitar Open Skills
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # opcional
|
||||
```
|
||||
|
||||
También puedes sobrescribir en runtime con `ZEROCLAW_OPEN_SKILLS_ENABLED` y `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## Desarrollo
|
||||
|
||||
```bash
|
||||
cargo build # Build de desarrollo
|
||||
cargo build --release # Build release (codegen-units=1, funciona en todos los dispositivos incluyendo Raspberry Pi)
|
||||
cargo build --profile release-fast # Build más rápido (codegen-units=8, requiere 16 GB+ RAM)
|
||||
cargo test # Ejecuta el suite de pruebas completo
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Formato
|
||||
|
||||
# Ejecuta el benchmark de comparación SQLite vs Markdown
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Hook pre-push
|
||||
|
||||
Un hook de git ejecuta `cargo fmt --check`, `cargo clippy -- -D warnings`, y `cargo test` antes de cada push. Actívalo una vez:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Solución de Problemas de Build (errores OpenSSL en Linux)
|
||||
|
||||
Si encuentras un error de build `openssl-sys`, sincroniza dependencias y recompila con el lockfile del repositorio:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw está configurado para usar `rustls` para dependencias HTTP/TLS; `--locked` mantiene el grafo transitivo determinista en entornos limpios.
|
||||
|
||||
Para saltar el hook cuando necesites un push rápido durante desarrollo:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Colaboración y Docs
|
||||
|
||||
Comienza con el hub de documentación para un mapa basado en tareas:
|
||||
|
||||
+1
-438
@@ -58,7 +58,7 @@ Construit par des étudiants et membres des communautés Harvard, MIT et Sundai.
|
||||
|
||||
<p align="center">
|
||||
<a href="#démarrage-rapide">Démarrage</a> |
|
||||
<a href="install.sh">Configuration en un clic</a> |
|
||||
<a href="https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh">Configuration en un clic</a> |
|
||||
<a href="docs/README.md">Hub Documentation</a> |
|
||||
<a href="docs/SUMMARY.md">Table des matières Documentation</a>
|
||||
</p>
|
||||
@@ -361,443 +361,6 @@ zeroclaw version # Affiche la version et les informations de build
|
||||
|
||||
Voir [Référence des Commandes](docs/reference/cli/commands-reference.md) pour les options et exemples complets.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Canaux (trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Orchestrateur Agent │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Routage │ │ Contexte │ │ Exécution │ │
|
||||
│ │ Message │ │ Mémoire │ │ Outil │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Fournisseurs │ │ Mémoire │ │ Outils │
|
||||
│ (trait) │ │ (trait) │ │ (trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Runtime (trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Principes clés :**
|
||||
|
||||
- Tout est un **trait** — fournisseurs, canaux, outils, mémoire, tunnels
|
||||
- Les canaux appellent l'orchestrateur ; l'orchestrateur appelle les fournisseurs + outils
|
||||
- Le système mémoire gère le contexte conversationnel (markdown, SQLite, ou aucun)
|
||||
- Le runtime abstrait l'exécution de code (natif ou Docker)
|
||||
- Aucun verrouillage de fournisseur — échangez Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama sans changement de code
|
||||
|
||||
Voir [documentation architecture](docs/assets/architecture.svg) pour les diagrammes détaillés et les détails d'implémentation.
|
||||
|
||||
## Exemples
|
||||
|
||||
### Telegram Bot
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Votre Telegram user ID
|
||||
```
|
||||
|
||||
Démarrez le daemon + agent, puis envoyez un message à votre bot sur Telegram :
|
||||
|
||||
```
|
||||
/start
|
||||
Bonjour ! Pouvez-vous m'aider à écrire un script Python ?
|
||||
```
|
||||
|
||||
Le bot répond avec le code généré par l'IA, exécute les outils si demandé, et conserve le contexte de conversation.
|
||||
|
||||
### Matrix (chiffré de bout en bout)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Invitez `@zeroclaw:matrix.org` dans une salle chiffrée, et le bot répondra avec le chiffrement complet. Voir [Guide Matrix E2EE](docs/security/matrix-e2ee-guide.md) pour la configuration de vérification de dispositif.
|
||||
|
||||
### Multi-Fournisseur
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Bascule en cas d'erreur du fournisseur
|
||||
```
|
||||
|
||||
Si Anthropic échoue ou rate-limit, l'orchestrateur bascule automatiquement vers OpenAI.
|
||||
|
||||
### Mémoire Personnalisée
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # Purge automatique après 90 jours
|
||||
```
|
||||
|
||||
Ou utilisez Markdown pour un stockage lisible par l'humain :
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Voir [Référence de Configuration](docs/reference/api/config-reference.md#memory) pour toutes les options mémoire.
|
||||
|
||||
## Support de Fournisseur
|
||||
|
||||
| Fournisseur | Statut | Clé API | Modèles Exemple |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Stable | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Stable | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Stable | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Stable | N/A (local) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Stable | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Stable | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Planifié | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Planifié | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Endpoints Personnalisés
|
||||
|
||||
ZeroClaw prend en charge les endpoints compatibles OpenAI :
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Exemple : utilisez [LiteLLM](https://github.com/BerriAI/litellm) comme proxy pour accéder à n'importe quel LLM via l'interface OpenAI.
|
||||
|
||||
Voir [Référence des Fournisseurs](docs/reference/api/providers-reference.md) pour les détails de configuration complets.
|
||||
|
||||
## Support de Canal
|
||||
|
||||
| Canal | Statut | Authentification | Notes |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Stable | Bot Token | Support complet incluant fichiers, images, boutons inline |
|
||||
| **Matrix** | ✅ Stable | Mot de passe ou Token | Support E2EE avec vérification de dispositif |
|
||||
| **Slack** | 🚧 Planifié | OAuth ou Bot Token | Accès workspace requis |
|
||||
| **Discord** | 🚧 Planifié | Bot Token | Permissions guild requises |
|
||||
| **WhatsApp** | 🚧 Planifié | Twilio ou API officielle | Compte business requis |
|
||||
| **CLI** | ✅ Stable | Aucun | Interface conversationnelle directe |
|
||||
| **Web** | 🚧 Planifié | Clé API ou OAuth | Interface de chat basée navigateur |
|
||||
|
||||
Voir [Référence des Canaux](docs/reference/api/channels-reference.md) pour les instructions de configuration complètes.
|
||||
|
||||
## Support d'Outil
|
||||
|
||||
ZeroClaw fournit des outils intégrés pour l'exécution de code, l'accès au système de fichiers et la récupération web :
|
||||
|
||||
| Outil | Description | Runtime Requis |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Exécute des commandes shell | Native ou Docker |
|
||||
| **python** | Exécute des scripts Python | Python 3.8+ (natif) ou Docker |
|
||||
| **javascript** | Exécute du code Node.js | Node.js 18+ (natif) ou Docker |
|
||||
| **filesystem_read** | Lit des fichiers | Native ou Docker |
|
||||
| **filesystem_write** | Écrit des fichiers | Native ou Docker |
|
||||
| **web_fetch** | Récupère du contenu web | Native ou Docker |
|
||||
|
||||
### Sécurité de l'Exécution
|
||||
|
||||
- **Runtime Natif** — s'exécute en tant que processus utilisateur du daemon, accès complet au système de fichiers
|
||||
- **Runtime Docker** — isolation complète du conteneur, systèmes de fichiers et réseaux séparés
|
||||
|
||||
Configurez la politique d'exécution dans `config.toml` :
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Liste d'autorisation explicite
|
||||
```
|
||||
|
||||
Voir [Référence de Configuration](docs/reference/api/config-reference.md#runtime) pour les options de sécurité complètes.
|
||||
|
||||
## Déploiement
|
||||
|
||||
### Déploiement Local (Développement)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Déploiement Serveur (Production)
|
||||
|
||||
Utilisez systemd pour gérer le daemon et l'agent en tant que services :
|
||||
|
||||
```bash
|
||||
# Installez le binaire
|
||||
cargo install --path . --locked
|
||||
|
||||
# Configurez le workspace
|
||||
zeroclaw init
|
||||
|
||||
# Créez les fichiers de service systemd
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# Activez et démarrez les services
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# Vérifiez le statut
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Voir [Guide de Déploiement Réseau](docs/ops/network-deployment.md) pour les instructions de déploiement en production complètes.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Compilez l'image
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# Exécutez le conteneur
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Voir [`Dockerfile`](Dockerfile) pour les détails de construction et les options de configuration.
|
||||
|
||||
### Matériel Edge
|
||||
|
||||
ZeroClaw est conçu pour fonctionner sur du matériel à faible consommation d'énergie :
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 Mo RAM, cœur ARMv8 simple, <5$ coût matériel
|
||||
- **Raspberry Pi 4/5** — 1 Go+ RAM, multi-cœur, idéal pour les charges de travail concurrentes
|
||||
- **Orange Pi Zero 2** — ~512 Mo RAM, quad-core ARMv8, coût ultra-faible
|
||||
- **SBCs x86 (Intel N100)** — 4-8 Go RAM, builds rapides, support Docker natif
|
||||
|
||||
Voir [Guide du Matériel](docs/hardware/README.md) pour les instructions de configuration spécifiques aux dispositifs.
|
||||
|
||||
## Tunneling (Exposition Publique)
|
||||
|
||||
Exposez votre daemon ZeroClaw local au réseau public via des tunnels sécurisés :
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Fournisseurs de tunnel supportés :
|
||||
|
||||
- **Cloudflare Tunnel** — HTTPS gratuit, aucune exposition de port, support multi-domaine
|
||||
- **Ngrok** — configuration rapide, domaines personnalisés (plan payant)
|
||||
- **Tailscale** — réseau maillé privé, pas de port public
|
||||
|
||||
Voir [Référence de Configuration](docs/reference/api/config-reference.md#tunnel) pour les options de configuration complètes.
|
||||
|
||||
## Sécurité
|
||||
|
||||
ZeroClaw implémente plusieurs couches de sécurité :
|
||||
|
||||
### Pairing
|
||||
|
||||
Le daemon génère un secret de pairing au premier lancement stocké dans `~/.zeroclaw/workspace/.pairing`. Les clients (agent, CLI) doivent présenter ce secret pour se connecter.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Génère un nouveau secret et invalide l'ancien
|
||||
```
|
||||
|
||||
### Sandboxing
|
||||
|
||||
- **Runtime Docker** — isolation complète du conteneur avec systèmes de fichiers et réseaux séparés
|
||||
- **Runtime Natif** — exécute en tant que processus utilisateur, scoped au workspace par défaut
|
||||
|
||||
### Listes d'Autorisation
|
||||
|
||||
Les canaux peuvent restreindre l'accès par ID utilisateur :
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Liste d'autorisation explicite
|
||||
```
|
||||
|
||||
### Chiffrement
|
||||
|
||||
- **Matrix E2EE** — chiffrement de bout en bout complet avec vérification de dispositif
|
||||
- **Transport TLS** — tout le trafic API et tunnel utilise HTTPS/TLS
|
||||
|
||||
Voir [Documentation Sécurité](docs/security/README.md) pour les politiques et pratiques complètes.
|
||||
|
||||
## Observabilité
|
||||
|
||||
ZeroClaw journalise vers `~/.zeroclaw/workspace/logs/` par défaut. Les journaux sont stockés par composant :
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Journaux du daemon (startup, requêtes API, erreurs)
|
||||
├── agent.log # Journaux de l'agent (routage message, exécution outil)
|
||||
├── telegram.log # Journaux spécifiques au canal (si activé)
|
||||
└── matrix.log # Journaux spécifiques au canal (si activé)
|
||||
```
|
||||
|
||||
### Configuration de Journalisation
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # Pour rotation basée sur la taille
|
||||
retention_days = 30 # Purge automatique après N jours
|
||||
```
|
||||
|
||||
Voir [Référence de Configuration](docs/reference/api/config-reference.md#logging) pour toutes les options de journalisation.
|
||||
|
||||
### Métriques (Planifié)
|
||||
|
||||
Support de métriques Prometheus pour la surveillance en production à venir. Suivi dans [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## Compétences (Skills)
|
||||
|
||||
ZeroClaw prend en charge les compétences personnalisées — des modules réutilisables qui étendent les capacités du système.
|
||||
|
||||
### Définition de Compétence
|
||||
|
||||
Les compétences sont stockées dans `~/.zeroclaw/workspace/skills/<nom-compétence>/` avec cette structure :
|
||||
|
||||
```
|
||||
skills/
|
||||
└── ma-compétence/
|
||||
├── skill.toml # Métadonnées de compétence (nom, description, dépendances)
|
||||
├── prompt.md # Prompt système pour l'IA
|
||||
└── tools/ # Outils personnalisés optionnels
|
||||
└── mon_outil.py
|
||||
```
|
||||
|
||||
### Exemple de Compétence
|
||||
|
||||
```toml
|
||||
# skills/recherche-web/skill.toml
|
||||
[skill]
|
||||
name = "recherche-web"
|
||||
description = "Recherche sur le web et résume les résultats"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/recherche-web/prompt.md -->
|
||||
|
||||
Tu es un assistant de recherche. Lorsqu'on te demande de rechercher quelque chose :
|
||||
|
||||
1. Utilise web_fetch pour récupérer le contenu
|
||||
2. Résume les résultats dans un format facile à lire
|
||||
3. Cite les sources avec des URLs
|
||||
```
|
||||
|
||||
### Utilisation de Compétences
|
||||
|
||||
Les compétences sont chargées automatiquement au démarrage de l'agent. Référencez-les par nom dans les conversations :
|
||||
|
||||
```
|
||||
Utilisateur : Utilise la compétence recherche-web pour trouver les dernières actualités IA
|
||||
Bot : [charge la compétence recherche-web, exécute web_fetch, résume les résultats]
|
||||
```
|
||||
|
||||
Voir la section [Compétences (Skills)](#compétences-skills) pour les instructions de création de compétences complètes.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw prend en charge les [Open Skills](https://github.com/openagents-com/open-skills) — un système modulaire et agnostique des fournisseurs pour étendre les capacités des agents IA.
|
||||
|
||||
### Activer Open Skills
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # optionnel
|
||||
```
|
||||
|
||||
Vous pouvez également surcharger au runtime avec `ZEROCLAW_OPEN_SKILLS_ENABLED` et `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## Développement
|
||||
|
||||
```bash
|
||||
cargo build # Build de développement
|
||||
cargo build --release # Build release (codegen-units=1, fonctionne sur tous les dispositifs incluant Raspberry Pi)
|
||||
cargo build --profile release-fast # Build plus rapide (codegen-units=8, nécessite 16 Go+ RAM)
|
||||
cargo test # Exécute la suite de tests complète
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Format
|
||||
|
||||
# Exécute le benchmark de comparaison SQLite vs Markdown
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Hook pre-push
|
||||
|
||||
Un hook git exécute `cargo fmt --check`, `cargo clippy -- -D warnings`, et `cargo test` avant chaque push. Activez-le une fois :
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Dépannage de Build (erreurs OpenSSL sur Linux)
|
||||
|
||||
Si vous rencontrez une erreur de build `openssl-sys`, synchronisez les dépendances et recompilez avec le lockfile du dépôt :
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw est configuré pour utiliser `rustls` pour les dépendances HTTP/TLS ; `--locked` maintient le graphe transitif déterministe sur les environnements vierges.
|
||||
|
||||
Pour sauter le hook lorsque vous avez besoin d'un push rapide pendant le développement :
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Collaboration & Docs
|
||||
|
||||
Commencez par le hub de documentation pour une carte basée sur les tâches :
|
||||
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # Mostra versione e informazioni di build
|
||||
|
||||
Vedi [Riferimento Comandi](docs/commands-reference.md) per opzioni ed esempi completi.
|
||||
|
||||
## Architettura
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Canali (trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Agente Orchestratore │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Routing │ │ Contesto │ │ Esecuzione │ │
|
||||
│ │ Messaggio │ │ Memoria │ │ Strumento │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Provider │ │ Memoria │ │ Strumenti │
|
||||
│ (trait) │ │ (trait) │ │ (trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Runtime (trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Principi chiave:**
|
||||
|
||||
- Tutto è un **trait** — provider, canali, strumenti, memoria, tunnel
|
||||
- I canali chiamano l'orchestratore; l'orchestratore chiama provider + strumenti
|
||||
- Il sistema memoria gestisce il contesto conversazionale (markdown, SQLite, o nessuno)
|
||||
- Il runtime astrae l'esecuzione del codice (nativo o Docker)
|
||||
- Nessun lock-in del provider — scambia Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama senza modifiche al codice
|
||||
|
||||
Vedi [documentazione architettura](docs/architecture.svg) per diagrammi dettagliati e dettagli di implementazione.
|
||||
|
||||
## Esempi
|
||||
|
||||
### Bot Telegram
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Il tuo ID utente Telegram
|
||||
```
|
||||
|
||||
Avvia il daemon + agent, poi invia un messaggio al tuo bot su Telegram:
|
||||
|
||||
```
|
||||
/start
|
||||
Ciao! Potresti aiutarmi a scrivere uno script Python?
|
||||
```
|
||||
|
||||
Il bot risponde con codice generato dall'AI, esegue strumenti se richiesto, e mantiene il contesto della conversazione.
|
||||
|
||||
### Matrix (crittografia end-to-end)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Invita `@zeroclaw:matrix.org` in una stanza crittografata, e il bot risponderà con crittografia completa. Vedi [Guida Matrix E2EE](docs/matrix-e2ee-guide.md) per la configurazione della verifica dispositivo.
|
||||
|
||||
### Multi-Provider
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Failover su errore del provider
|
||||
```
|
||||
|
||||
Se Anthropic fallisce o va in rate-limit, l'orchestratore passa automaticamente a OpenAI.
|
||||
|
||||
### Memoria Personalizzata
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # Eliminazione automatica dopo 90 giorni
|
||||
```
|
||||
|
||||
O usa Markdown per un archiviazione leggibile dall'uomo:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Vedi [Riferimento Configurazione](docs/config-reference.md#memory) per tutte le opzioni memoria.
|
||||
|
||||
## Supporto Provider
|
||||
|
||||
| Provider | Stato | API Key | Modelli di Esempio |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Stabile | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Stabile | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Stabile | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Stabile | N/A (locale) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Stabile | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Stabile | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Pianificato | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Pianificato | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Endpoint Personalizzati
|
||||
|
||||
ZeroClaw supporta endpoint compatibili con OpenAI:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Esempio: usa [LiteLLM](https://github.com/BerriAI/litellm) come proxy per accedere a qualsiasi LLM tramite l'interfaccia OpenAI.
|
||||
|
||||
Vedi [Riferimento Provider](docs/providers-reference.md) per dettagli di configurazione completi.
|
||||
|
||||
## Supporto Canali
|
||||
|
||||
| Canale | Stato | Autenticazione | Note |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Stabile | Bot Token | Supporto completo inclusi file, immagini, pulsanti inline |
|
||||
| **Matrix** | ✅ Stabile | Password o Token | Supporto E2EE con verifica dispositivo |
|
||||
| **Slack** | 🚧 Pianificato | OAuth o Bot Token | Richiede accesso workspace |
|
||||
| **Discord** | 🚧 Pianificato | Bot Token | Richiede permessi guild |
|
||||
| **WhatsApp** | 🚧 Pianificato | Twilio o API ufficiale | Richiede account business |
|
||||
| **CLI** | ✅ Stabile | Nessuno | Interfaccia conversazionale diretta |
|
||||
| **Web** | 🚧 Pianificato | API Key o OAuth | Interfaccia chat basata su browser |
|
||||
|
||||
Vedi [Riferimento Canali](docs/channels-reference.md) per istruzioni di configurazione complete.
|
||||
|
||||
## Supporto Strumenti
|
||||
|
||||
ZeroClaw fornisce strumenti integrati per l'esecuzione del codice, l'accesso al filesystem e il recupero web:
|
||||
|
||||
| Strumento | Descrizione | Runtime Richiesto |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Esegue comandi shell | Nativo o Docker |
|
||||
| **python** | Esegue script Python | Python 3.8+ (nativo) o Docker |
|
||||
| **javascript** | Esegue codice Node.js | Node.js 18+ (nativo) o Docker |
|
||||
| **filesystem_read** | Legge file | Nativo o Docker |
|
||||
| **filesystem_write** | Scrive file | Nativo o Docker |
|
||||
| **web_fetch** | Recupera contenuti web | Nativo o Docker |
|
||||
|
||||
### Sicurezza dell'Esecuzione
|
||||
|
||||
- **Runtime Nativo** — gira come processo utente del daemon, accesso completo al filesystem
|
||||
- **Runtime Docker** — isolamento container completo, filesystem e reti separati
|
||||
|
||||
Configura la politica di esecuzione in `config.toml`:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Lista di autorizzazione esplicita
|
||||
```
|
||||
|
||||
Vedi [Riferimento Configurazione](docs/config-reference.md#runtime) per opzioni di sicurezza complete.
|
||||
|
||||
## Distribuzione
|
||||
|
||||
### Distribuzione Locale (Sviluppo)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Distribuzione Server (Produzione)
|
||||
|
||||
Usa systemd per gestire daemon e agent come servizi:
|
||||
|
||||
```bash
|
||||
# Installa il binario
|
||||
cargo install --path . --locked
|
||||
|
||||
# Configura il workspace
|
||||
zeroclaw init
|
||||
|
||||
# Crea i file di servizio systemd
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# Abilita e avvia i servizi
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# Verifica lo stato
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Vedi [Guida Distribuzione di Rete](docs/network-deployment.md) per istruzioni complete di distribuzione in produzione.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Compila l'immagine
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# Esegui il container
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Vedi [`Dockerfile`](Dockerfile) per dettagli di build e opzioni di configurazione.
|
||||
|
||||
### Hardware Edge
|
||||
|
||||
ZeroClaw è progettato per girare su hardware a basso consumo:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, singolo core ARMv8, < $5 costo hardware
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, multi-core, ideale per workload concorrenti
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, quad-core ARMv8, costo ultra-basso
|
||||
- **SBC x86 (Intel N100)** — 4-8 GB RAM, build veloci, supporto Docker nativo
|
||||
|
||||
Vedi [Guida Hardware](docs/hardware/README.md) per istruzioni di configurazione specifiche per dispositivo.
|
||||
|
||||
## Tunneling (Esposizione Pubblica)
|
||||
|
||||
Espone il tuo daemon ZeroClaw locale alla rete pubblica tramite tunnel sicuri:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Provider di tunnel supportati:
|
||||
|
||||
- **Cloudflare Tunnel** — HTTPS gratuito, nessuna esposizione di porte, supporto multi-dominio
|
||||
- **Ngrok** — configurazione rapida, domini personalizzati (piano a pagamento)
|
||||
- **Tailscale** — rete mesh privata, nessuna porta pubblica
|
||||
|
||||
Vedi [Riferimento Configurazione](docs/config-reference.md#tunnel) per opzioni di configurazione complete.
|
||||
|
||||
## Sicurezza
|
||||
|
||||
ZeroClaw implementa molteplici livelli di sicurezza:
|
||||
|
||||
### Pairing
|
||||
|
||||
Il daemon genera un segreto di pairing al primo avvio memorizzato in `~/.zeroclaw/workspace/.pairing`. I client (agent, CLI) devono presentare questo segreto per connettersi.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Genera un nuovo segreto e invalida quello precedente
|
||||
```
|
||||
|
||||
### Sandboxing
|
||||
|
||||
- **Runtime Docker** — isolamento container completo con filesystem e reti separati
|
||||
- **Runtime Nativo** — gira come processo utente, con scope del workspace di default
|
||||
|
||||
### Liste di Autorizzazione
|
||||
|
||||
I canali possono limitare l'accesso per ID utente:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Lista di autorizzazione esplicita
|
||||
```
|
||||
|
||||
### Crittografia
|
||||
|
||||
- **Matrix E2EE** — crittografia end-to-end completa con verifica dispositivo
|
||||
- **Trasporto TLS** — tutto il traffico API e tunnel usa HTTPS/TLS
|
||||
|
||||
Vedi [Documentazione Sicurezza](docs/security/README.md) per politiche e pratiche complete.
|
||||
|
||||
## Osservabilità
|
||||
|
||||
ZeroClaw registra i log in `~/.zeroclaw/workspace/logs/` di default. I log sono memorizzati per componente:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Log del daemon (avvio, richieste API, errori)
|
||||
├── agent.log # Log dell'agent (routing messaggi, esecuzione strumenti)
|
||||
├── telegram.log # Log specifici del canale (se abilitato)
|
||||
└── matrix.log # Log specifici del canale (se abilitato)
|
||||
```
|
||||
|
||||
### Configurazione Logging
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # Per rotazione basata sulla dimensione
|
||||
retention_days = 30 # Eliminazione automatica dopo N giorni
|
||||
```
|
||||
|
||||
Vedi [Riferimento Configurazione](docs/config-reference.md#logging) per tutte le opzioni di logging.
|
||||
|
||||
### Metriche (Pianificato)
|
||||
|
||||
Supporto metriche Prometheus per il monitoraggio in produzione in arrivo. Tracciamento in [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## Competenze (Skills)
|
||||
|
||||
ZeroClaw supporta competenze personalizzate — moduli riutilizzabili che estendono le capacità del sistema.
|
||||
|
||||
### Definizione Competenza
|
||||
|
||||
Le competenze sono memorizzate in `~/.zeroclaw/workspace/skills/<skill-name>/` con questa struttura:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # Metadati competenza (nome, descrizione, dipendenze)
|
||||
├── prompt.md # Prompt di sistema per l'AI
|
||||
└── tools/ # Strumenti personalizzati opzionali
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### Esempio Competenza
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "Cerca sul web e riassume i risultati"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
Sei un assistente di ricerca. Quando ti viene chiesto di cercare qualcosa:
|
||||
|
||||
1. Usa web_fetch per recuperare il contenuto
|
||||
2. Riassume i risultati in un formato facile da leggere
|
||||
3. Cita le fonti con gli URL
|
||||
```
|
||||
|
||||
### Uso delle Competenze
|
||||
|
||||
Le competenze sono caricate automaticamente all'avvio dell'agent. Fai riferimento ad esse per nome nelle conversazioni:
|
||||
|
||||
```
|
||||
Utente: Usa la competenza web-research per trovare le ultime notizie AI
|
||||
Bot: [carica la competenza web-research, esegue web_fetch, riassume i risultati]
|
||||
```
|
||||
|
||||
Vedi sezione [Competenze (Skills)](#competenze-skills) per istruzioni complete sulla creazione di competenze.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw supporta [Open Skills](https://github.com/openagents-com/open-skills) — un sistema modulare e agnostico del provider per estendere le capacità degli agent AI.
|
||||
|
||||
### Abilita Open Skills
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # opzionale
|
||||
```
|
||||
|
||||
Puoi anche sovrascrivere a runtime con `ZEROCLAW_OPEN_SKILLS_ENABLED` e `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## Sviluppo
|
||||
|
||||
```bash
|
||||
cargo build # Build di sviluppo
|
||||
cargo build --release # Build release (codegen-units=1, funziona su tutti i dispositivi incluso Raspberry Pi)
|
||||
cargo build --profile release-fast # Build più veloce (codegen-units=8, richiede 16 GB+ RAM)
|
||||
cargo test # Esegue la suite di test completa
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Formattazione
|
||||
|
||||
# Esegue il benchmark di confronto SQLite vs Markdown
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Hook pre-push
|
||||
|
||||
Un hook git esegue `cargo fmt --check`, `cargo clippy -- -D warnings`, e `cargo test` prima di ogni push. Attivalo una volta:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Risoluzione Problemi di Build (errori OpenSSL su Linux)
|
||||
|
||||
Se incontri un errore di build `openssl-sys`, sincronizza le dipendenze e ricompila con il lockfile del repository:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw è configurato per usare `rustls` per le dipendenze HTTP/TLS; `--locked` mantiene il grafo transitivo deterministico in ambienti puliti.
|
||||
|
||||
Per saltare l'hook quando hai bisogno di un push veloce durante lo sviluppo:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Collaborazione e Docs
|
||||
|
||||
Inizia con l'hub della documentazione per una mappa basata sui task:
|
||||
|
||||
+1
-99
@@ -53,7 +53,7 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="install.sh">ワンクリック導入</a> |
|
||||
<a href="https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh">ワンクリック導入</a> |
|
||||
<a href="docs/setup-guides/README.md">導入ガイド</a> |
|
||||
<a href="docs/README.ja.md">ドキュメントハブ</a> |
|
||||
<a href="docs/SUMMARY.md">Docs TOC</a>
|
||||
@@ -218,104 +218,6 @@ zeroclaw agent --provider openai-codex --auth-profile openai-codex:work -m "hell
|
||||
zeroclaw agent --provider anthropic -m "hello"
|
||||
```
|
||||
|
||||
## アーキテクチャ
|
||||
|
||||
すべてのサブシステムは **Trait** — 設定変更だけで実装を差し替え可能、コード変更不要。
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/assets/architecture.svg" alt="ZeroClaw アーキテクチャ" width="900" />
|
||||
</p>
|
||||
|
||||
| サブシステム | Trait | 内蔵実装 | 拡張方法 |
|
||||
|-------------|-------|----------|----------|
|
||||
| **AI モデル** | `Provider` | `zeroclaw providers` で確認(現在 28 個の組み込み + エイリアス、カスタムエンドポイント対応) | `custom:https://your-api.com`(OpenAI 互換)または `anthropic-custom:https://your-api.com` |
|
||||
| **チャネル** | `Channel` | CLI, Telegram, Discord, Slack, Mattermost, iMessage, Matrix, Signal, WhatsApp, Linq, Email, IRC, Lark, DingTalk, QQ, Webhook | 任意のメッセージ API |
|
||||
| **メモリ** | `Memory` | SQLite ハイブリッド検索, PostgreSQL バックエンド, Lucid ブリッジ, Markdown ファイル, 明示的 `none` バックエンド, スナップショット/復元, オプション応答キャッシュ | 任意の永続化バックエンド |
|
||||
| **ツール** | `Tool` | shell/file/memory, cron/schedule, git, pushover, browser, http_request, screenshot/image_info, composio (opt-in), delegate, ハードウェアツール | 任意の機能 |
|
||||
| **オブザーバビリティ** | `Observer` | Noop, Log, Multi | Prometheus, OTel |
|
||||
| **ランタイム** | `RuntimeAdapter` | Native, Docker(サンドボックス) | adapter 経由で追加可能;未対応の kind は即座にエラー |
|
||||
| **セキュリティ** | `SecurityPolicy` | Gateway ペアリング, サンドボックス, allowlist, レート制限, ファイルシステムスコープ, 暗号化シークレット | — |
|
||||
| **アイデンティティ** | `IdentityConfig` | OpenClaw (markdown), AIEOS v1.1 (JSON) | 任意の ID フォーマット |
|
||||
| **トンネル** | `Tunnel` | None, Cloudflare, Tailscale, ngrok, Custom | 任意のトンネルバイナリ |
|
||||
| **ハートビート** | Engine | HEARTBEAT.md 定期タスク | — |
|
||||
| **スキル** | Loader | TOML マニフェスト + SKILL.md インストラクション | コミュニティスキルパック |
|
||||
| **インテグレーション** | Registry | 9 カテゴリ、70 件以上の連携 | プラグインシステム |
|
||||
|
||||
### ランタイムサポート(現状)
|
||||
|
||||
- ✅ 現在サポート: `runtime.kind = "native"` または `runtime.kind = "docker"`
|
||||
- 🚧 計画中(未実装): WASM / エッジランタイム
|
||||
|
||||
未対応の `runtime.kind` が設定された場合、ZeroClaw は native へのサイレントフォールバックではなく、明確なエラーで終了します。
|
||||
|
||||
### メモリシステム(フルスタック検索エンジン)
|
||||
|
||||
すべて自社実装、外部依存ゼロ — Pinecone、Elasticsearch、LangChain 不要:
|
||||
|
||||
| レイヤー | 実装 |
|
||||
|---------|------|
|
||||
| **ベクトル DB** | Embeddings を SQLite に BLOB として保存、コサイン類似度検索 |
|
||||
| **キーワード検索** | FTS5 仮想テーブル、BM25 スコアリング |
|
||||
| **ハイブリッドマージ** | カスタム重み付きマージ関数(`vector.rs`) |
|
||||
| **Embeddings** | `EmbeddingProvider` trait — OpenAI、カスタム URL、または noop |
|
||||
| **チャンキング** | 行ベースの Markdown チャンカー(見出し構造保持) |
|
||||
| **キャッシュ** | SQLite `embedding_cache` テーブル、LRU エビクション |
|
||||
| **安全な再インデックス** | FTS5 再構築 + 欠落ベクトルの再埋め込みをアトミックに実行 |
|
||||
|
||||
Agent はツール経由でメモリの呼び出し・保存・管理を自動的に行います。
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
backend = "sqlite" # "sqlite", "lucid", "postgres", "markdown", "none"
|
||||
auto_save = true
|
||||
embedding_provider = "none" # "none", "openai", "custom:https://..."
|
||||
vector_weight = 0.7
|
||||
keyword_weight = 0.3
|
||||
```
|
||||
|
||||
## セキュリティのデフォルト
|
||||
|
||||
- Gateway の既定バインド: `127.0.0.1:42617`
|
||||
- 既定でペアリング必須: `require_pairing = true`
|
||||
- 既定で公開バインド禁止: `allow_public_bind = false`
|
||||
- Channel allowlist:
|
||||
- `[]` は deny-by-default
|
||||
- `["*"]` は allow all(意図的に使う場合のみ)
|
||||
|
||||
## 設定例
|
||||
|
||||
```toml
|
||||
api_key = "sk-..."
|
||||
default_provider = "openrouter"
|
||||
default_model = "anthropic/claude-sonnet-4-6"
|
||||
default_temperature = 0.7
|
||||
|
||||
[memory]
|
||||
backend = "sqlite"
|
||||
auto_save = true
|
||||
embedding_provider = "none"
|
||||
|
||||
[gateway]
|
||||
host = "127.0.0.1"
|
||||
port = 42617
|
||||
require_pairing = true
|
||||
allow_public_bind = false
|
||||
```
|
||||
|
||||
## ドキュメント入口
|
||||
|
||||
- ドキュメントハブ(英語): [`docs/README.md`](docs/README.md)
|
||||
- 統合 TOC: [`docs/SUMMARY.md`](docs/SUMMARY.md)
|
||||
- ドキュメントハブ(日本語): [`docs/README.ja.md`](docs/README.ja.md)
|
||||
- コマンドリファレンス: [`docs/reference/cli/commands-reference.md`](docs/reference/cli/commands-reference.md)
|
||||
- 設定リファレンス: [`docs/reference/api/config-reference.md`](docs/reference/api/config-reference.md)
|
||||
- Provider リファレンス: [`docs/reference/api/providers-reference.md`](docs/reference/api/providers-reference.md)
|
||||
- Channel リファレンス: [`docs/reference/api/channels-reference.md`](docs/reference/api/channels-reference.md)
|
||||
- 運用ガイド(Runbook): [`docs/ops/operations-runbook.md`](docs/ops/operations-runbook.md)
|
||||
- トラブルシューティング: [`docs/ops/troubleshooting.md`](docs/ops/troubleshooting.md)
|
||||
- ドキュメント一覧 / 分類: [`docs/maintainers/docs-inventory.md`](docs/maintainers/docs-inventory.md)
|
||||
- プロジェクト triage スナップショット: [`docs/maintainers/project-triage-snapshot-2026-02-18.md`](docs/maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## コントリビュート / ライセンス
|
||||
|
||||
- Contributing: [`CONTRIBUTING.md`](CONTRIBUTING.md)
|
||||
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # 버전 및 빌드 정보 표시
|
||||
|
||||
전체 옵션 및 예제는 [명령어 참조](docs/commands-reference.md)를 참조하세요.
|
||||
|
||||
## 아키텍처
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ 채널 (트레이트) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ 에이전트 오케스트레이터 │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ 메시지 │ │ 컨텍스트 │ │ 도구 │ │
|
||||
│ │ 라우팅 │ │ 메모리 │ │ 실행 │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ 제공자 │ │ 메모리 │ │ 도구 │
|
||||
│ (트레이트) │ │ (트레이트) │ │ (트레이트) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ 런타임 (트레이트) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**핵심 원칙:**
|
||||
|
||||
- 모든 것이 **트레이트**입니다 — 제공자, 채널, 도구, 메모리, 터널
|
||||
- 채널이 오케스트레이터를 호출; 오케스트레이터가 제공자 + 도구를 호출
|
||||
- 메모리 시스템이 대화 컨텍스트 관리(markdown, SQLite, 또는 없음)
|
||||
- 런타임이 코드 실행 추상화(네이티브 또는 Docker)
|
||||
- 제공자 락인 없음 — 코드 변경 없이 Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama 교체
|
||||
|
||||
자세한 다이어그램과 구현 세부 정보는 [아키텍처 문서](docs/architecture.svg)를 참조하세요.
|
||||
|
||||
## 예제
|
||||
|
||||
### 텔레그램 봇
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # 당신의 텔레그램 사용자 ID
|
||||
```
|
||||
|
||||
데몬 + 에이전트를 시작한 다음 텔레그램에서 봇에 메시지를 보내세요:
|
||||
|
||||
```
|
||||
/start
|
||||
안녕하세요! Python 스크립트 작성을 도와주실 수 있나요?
|
||||
```
|
||||
|
||||
봇이 AI가 생성한 코드로 응답하고, 요청 시 도구를 실행하며, 대화 컨텍스트를 유지합니다.
|
||||
|
||||
### Matrix (종단 간 암호화)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
암호화된 방에 `@zeroclaw:matrix.org`를 초대하면 봇이 완전한 암호화로 응답합니다. 장치 확인 설정은 [Matrix E2EE 가이드](docs/matrix-e2ee-guide.md)를 참조하세요.
|
||||
|
||||
### 다중 제공자
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # 제공자 오류 시 장애 조치
|
||||
```
|
||||
|
||||
Anthropic이 실패하거나 속도 제한이 걸리면 오케스트레이터가 자동으로 OpenAI로 장애 조치합니다.
|
||||
|
||||
### 사용자 정의 메모리
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # 90일 후 자동 삭제
|
||||
```
|
||||
|
||||
또는 사람이 읽을 수 있는 저장소를 위해 Markdown을 사용하세요:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
모든 메모리 옵션은 [구성 참조](docs/config-reference.md#memory)를 참조하세요.
|
||||
|
||||
## 제공자 지원
|
||||
|
||||
| 제공자 | 상태 | API 키 | 예제 모델 |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ 안정 | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ 안정 | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ 안정 | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ 안정 | N/A (로컬) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ 안정 | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ 안정 | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 계획 중 | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 계획 중 | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### 사용자 정의 엔드포인트
|
||||
|
||||
ZeroClaw는 OpenAI 호환 엔드포인트를 지원합니다:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
예: [LiteLLM](https://github.com/BerriAI/litellm)을 프록시로 사용하여 OpenAI 인터페이스를 통해 모든 LLM에 액세스.
|
||||
|
||||
전체 구성 세부 정보는 [제공자 참조](docs/providers-reference.md)를 참조하세요.
|
||||
|
||||
## 채널 지원
|
||||
|
||||
| 채널 | 상태 | 인증 | 참고 |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ 안정 | 봇 토큰 | 파일, 이미지, 인라인 버튼 포함 전체 지원 |
|
||||
| **Matrix** | ✅ 안정 | 비밀번호 또는 토큰 | 장치 확인과 함께 E2EE 지원 |
|
||||
| **Slack** | 🚧 계획 중 | OAuth 또는 봇 토큰 | 작업공간 액세스 필요 |
|
||||
| **Discord** | 🚧 계획 중 | 봇 토큰 | 길드 권한 필요 |
|
||||
| **WhatsApp** | 🚧 계획 중 | Twilio 또는 공식 API | 비즈니스 계정 필요 |
|
||||
| **CLI** | ✅ 안정 | 없음 | 직접 대화형 인터페이스 |
|
||||
| **Web** | 🚧 계획 중 | API 키 또는 OAuth | 브라우저 기반 채팅 인터페이스 |
|
||||
|
||||
전체 구성 지침은 [채널 참조](docs/channels-reference.md)를 참조하세요.
|
||||
|
||||
## 도구 지원
|
||||
|
||||
ZeroClaw는 코드 실행, 파일 시스템 액세스 및 웹 검색을 위한 기본 제공 도구를 제공합니다:
|
||||
|
||||
| 도구 | 설명 | 필수 런타임 |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | 셸 명령 실행 | 네이티브 또는 Docker |
|
||||
| **python** | Python 스크립트 실행 | Python 3.8+ (네이티브) 또는 Docker |
|
||||
| **javascript** | Node.js 코드 실행 | Node.js 18+ (네이티브) 또는 Docker |
|
||||
| **filesystem_read** | 파일 읽기 | 네이티브 또는 Docker |
|
||||
| **filesystem_write** | 파일 쓰기 | 네이티브 또는 Docker |
|
||||
| **web_fetch** | 웹 콘텐츠 가져오기 | 네이티브 또는 Docker |
|
||||
|
||||
### 실행 보안
|
||||
|
||||
- **네이티브 런타임** — 데몬의 사용자 프로세스로 실행, 파일 시스템에 전체 액세스
|
||||
- **Docker 런타임** — 전체 컨테이너 격리, 별도의 파일 시스템 및 네트워크
|
||||
|
||||
`config.toml`에서 실행 정책을 구성하세요:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # 명시적 허용 목록
|
||||
```
|
||||
|
||||
전체 보안 옵션은 [구성 참조](docs/config-reference.md#runtime)를 참조하세요.
|
||||
|
||||
## 배포
|
||||
|
||||
### 로컬 배포 (개발)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### 서버 배포 (프로덕션)
|
||||
|
||||
systemd를 사용하여 데몬과 에이전트를 서비스로 관리하세요:
|
||||
|
||||
```bash
|
||||
# 바이너리 설치
|
||||
cargo install --path . --locked
|
||||
|
||||
# 작업공간 구성
|
||||
zeroclaw init
|
||||
|
||||
# systemd 서비스 파일 생성
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# 서비스 활성화 및 시작
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# 상태 확인
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
전체 프로덕션 배포 지침은 [네트워크 배포 가이드](docs/network-deployment.md)를 참조하세요.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# 이미지 빌드
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# 컨테이너 실행
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
빌드 세부 정보 및 구성 옵션은 [`Dockerfile`](Dockerfile)을 참조하세요.
|
||||
|
||||
### 엣지 하드웨어
|
||||
|
||||
ZeroClaw는 저전력 하드웨어에서 실행되도록 설계되었습니다:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, 단일 ARMv8 코어, < $5 하드웨어 비용
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, 멀티코어, 동시 워크로드에 이상적
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, 쿼드코어 ARMv8, 초저비용
|
||||
- **x86 SBCs (Intel N100)** — 4-8 GB RAM, 빠른 빌드, 네이티브 Docker 지원
|
||||
|
||||
장치별 설정 지침은 [하드웨어 가이드](docs/hardware/README.md)를 참조하세요.
|
||||
|
||||
## 터널링 (공개 노출)
|
||||
|
||||
보안 터널을 통해 로컬 ZeroClaw 데몬을 공개 네트워크에 노출하세요:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
지원되는 터널 제공자:
|
||||
|
||||
- **Cloudflare Tunnel** — 무료 HTTPS, 포트 노출 없음, 멀티 도메인 지원
|
||||
- **Ngrok** — 빠른 설정, 사용자 정의 도메인 (유료 플랜)
|
||||
- **Tailscale** — 프라이빗 메시 네트워크, 공개 포트 없음
|
||||
|
||||
전체 구성 옵션은 [구성 참조](docs/config-reference.md#tunnel)를 참조하세요.
|
||||
|
||||
## 보안
|
||||
|
||||
ZeroClaw는 여러 보안 계층을 구현합니다:
|
||||
|
||||
### 페어링
|
||||
|
||||
데몬은 첫 실행 시 `~/.zeroclaw/workspace/.pairing`에 저장된 페어링 시크릿을 생성합니다. 클라이언트(에이전트, CLI)는 연결하기 위해 이 시크릿을 제시해야 합니다.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # 새 시크릿 생성 및 이전 것 무효화
|
||||
```
|
||||
|
||||
### 샌드박싱
|
||||
|
||||
- **Docker 런타임** — 별도의 파일 시스템 및 네트워크로 전체 컨테이너 격리
|
||||
- **네이티브 런타임** — 사용자 프로세스로 실행, 기본적으로 작업공간으로 범위 지정
|
||||
|
||||
### 허용 목록
|
||||
|
||||
채널은 사용자 ID로 액세스를 제한할 수 있습니다:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # 명시적 허용 목록
|
||||
```
|
||||
|
||||
### 암호화
|
||||
|
||||
- **Matrix E2EE** — 장치 확인과 함께 완전한 종단 간 암호화
|
||||
- **TLS 전송** — 모든 API 및 터널 트래픽이 HTTPS/TLS 사용
|
||||
|
||||
전체 정책 및 관행은 [보안 문서](docs/security/README.md)를 참조하세요.
|
||||
|
||||
## 관찰 가능성
|
||||
|
||||
ZeroClaw는 기본적으로 `~/.zeroclaw/workspace/logs/`에 로그를 기록합니다. 로그는 구성 요소별로 저장됩니다:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # 데몬 로그 (시작, API 요청, 오류)
|
||||
├── agent.log # 에이전트 로그 (메시지 라우팅, 도구 실행)
|
||||
├── telegram.log # 채널별 로그 (활성화된 경우)
|
||||
└── matrix.log # 채널별 로그 (활성화된 경우)
|
||||
```
|
||||
|
||||
### 로깅 구성
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # 크기 기반 회전용
|
||||
retention_days = 30 # N일 후 자동 삭제
|
||||
```
|
||||
|
||||
모든 로깅 옵션은 [구성 참조](docs/config-reference.md#logging)를 참조하세요.
|
||||
|
||||
### 메트릭 (계획 중)
|
||||
|
||||
프로덕션 모니터링을 위한 Prometheus 메트릭 지원이 곧 제공됩니다. [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234)에서 추적 중.
|
||||
|
||||
## 스킬 (Skills)
|
||||
|
||||
ZeroClaw는 시스템 기능을 확장하는 재사용 가능한 모듈인 사용자 정의 스킬을 지원합니다.
|
||||
|
||||
### 스킬 정의
|
||||
|
||||
스킬은 다음 구조로 `~/.zeroclaw/workspace/skills/<skill-name>/`에 저장됩니다:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # 스킬 메타데이터 (이름, 설명, 의존성)
|
||||
├── prompt.md # AI용 시스템 프롬프트
|
||||
└── tools/ # 선택적 사용자 정의 도구
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### 스킬 예제
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "웹 검색 및 결과 요약"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
당신은 연구 어시스턴트입니다. 무언가를 검색하라는 요청을 받으면:
|
||||
|
||||
1. web_fetch를 사용하여 콘텐츠 가져오기
|
||||
2. 읽기 쉬운 형식으로 결과 요약
|
||||
3. URL로 출처 인용
|
||||
```
|
||||
|
||||
### 스킬 사용
|
||||
|
||||
스킬은 에이전트 시작 시 자동으로 로드됩니다. 대화에서 이름으로 참조하세요:
|
||||
|
||||
```
|
||||
사용자: 웹 연구 스킬을 사용하여 최신 AI 뉴스 찾기
|
||||
봇: [웹 연구 스킬 로드, web_fetch 실행, 결과 요약]
|
||||
```
|
||||
|
||||
전체 스킬 생성 지침은 [스킬 (Skills)](#스킬-skills) 섹션을 참조하세요.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw는 [Open Skills](https://github.com/openagents-com/open-skills)를 지원합니다 — AI 에이전트 기능을 확장하기 위한 모듈형 및 제공자 독립적인 시스템.
|
||||
|
||||
### Open Skills 활성화
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # 선택사항
|
||||
```
|
||||
|
||||
런타임에 `ZEROCLAW_OPEN_SKILLS_ENABLED` 및 `ZEROCLAW_OPEN_SKILLS_DIR`로 재정의할 수도 있습니다.
|
||||
|
||||
## 개발
|
||||
|
||||
```bash
|
||||
cargo build # 개발 빌드
|
||||
cargo build --release # 릴리스 빌드 (codegen-units=1, Raspberry Pi 포함 모든 장치에서 작동)
|
||||
cargo build --profile release-fast # 더 빠른 빌드 (codegen-units=8, 16 GB+ RAM 필요)
|
||||
cargo test # 전체 테스트 스위트 실행
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # 포맷
|
||||
|
||||
# SQLite vs Markdown 비교 벤치마크 실행
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### pre-push 훅
|
||||
|
||||
git 훅이 각 푸시 전에 `cargo fmt --check`, `cargo clippy -- -D warnings`, 그리고 `cargo test`를 실행합니다. 한 번 활성화하세요:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### 빌드 문제 해결 (Linux에서 OpenSSL 오류)
|
||||
|
||||
`openssl-sys` 빌드 오류가 발생하면 종속성을 동기화하고 저장소의 lockfile로 다시 빌드하세요:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw는 HTTP/TLS 종속성에 대해 `rustls`를 사용하도록 구성되어 있습니다; `--locked`는 깨끗한 환경에서 전이적 그래프를 결정적으로 유지합니다.
|
||||
|
||||
개발 중 빠른 푸시가 필요할 때 훅을 건너뛰려면:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## 협업 및 문서
|
||||
|
||||
작업 기반 맵을 위해 문서 허브로 시작하세요:
|
||||
|
||||
@@ -58,7 +58,7 @@ Built by students and members of the Harvard, MIT, and Sundai.Club communities.
|
||||
|
||||
<p align="center">
|
||||
<a href="#quick-start">Getting Started</a> |
|
||||
<a href="install.sh">One-Click Setup</a> |
|
||||
<a href="https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh">One-Click Setup</a> |
|
||||
<a href="docs/README.md">Docs Hub</a> |
|
||||
<a href="docs/SUMMARY.md">Docs TOC</a>
|
||||
</p>
|
||||
@@ -84,6 +84,16 @@ Built by students and members of the Harvard, MIT, and Sundai.Club communities.
|
||||
|
||||
<p align="center"><code>Trait-driven architecture · secure-by-default runtime · provider/channel/tool swappable · pluggable everything</code></p>
|
||||
|
||||
### 🚀 What's New in v0.1.9b (March 2026)
|
||||
|
||||
| Area | Highlights |
|
||||
|---|---|
|
||||
| Web Dashboard | Electric blue restyle with glassmorphism and animations, ZeroClaw logo, cron run history panel, message draft persistence, auto-expanding chat composer |
|
||||
| Providers & Channels | Azure OpenAI support, WeCom webhook channel, Matrix read markers/typing/file uploads/voice/multi-room, custom HTTP headers, `ZEROCLAW_PROVIDER_URL` override, configurable `ack_reactions` |
|
||||
| Tools & MCP | On-demand MCP tool loading via `tool_search`, multi-transport MCP client, `tool_filter_groups` for per-turn schema filtering, Windows shell `tool_call` support, dynamic node discovery |
|
||||
| Infrastructure | 32-bit system support via feature gates, Debian Docker variant with shell tools, session state persistence/recovery, docs hub translations for all 30 languages |
|
||||
| Fixes | Slack thread events in polling mode, Discord WebSocket Ping handling, Ollama Qwen think-tag stripping, security hardening (filesystem scoping, credential scrubbing, cron validation), 32-bit atomic fallbacks |
|
||||
|
||||
### 📢 Announcements
|
||||
|
||||
Use this board for important notices (breaking changes, security advisories, maintenance windows, and release blockers).
|
||||
@@ -421,668 +431,6 @@ zeroclaw agent --provider openai-codex --auth-profile openai-codex:work -m "hell
|
||||
zeroclaw agent --provider anthropic -m "hello"
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
Every subsystem is a **trait** — swap implementations with a config change, zero code changes.
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/assets/architecture.svg" alt="ZeroClaw Architecture" width="900" />
|
||||
</p>
|
||||
|
||||
| Subsystem | Trait | Ships with | Extend |
|
||||
| ----------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| **AI Models** | `Provider` | Provider catalog via `zeroclaw providers` (built-ins + aliases, plus custom endpoints) | `custom:https://your-api.com` (OpenAI-compatible) or `anthropic-custom:https://your-api.com` |
|
||||
| **Channels** | `Channel` | CLI, Telegram, Discord, Slack, Mattermost, iMessage, Matrix, Signal, WhatsApp, Linq, Email, IRC, Lark, DingTalk, QQ, Nostr, Webhook | Any messaging API |
|
||||
| **Memory** | `Memory` | SQLite hybrid search, PostgreSQL backend (configurable storage provider), Lucid bridge, Markdown files, explicit `none` backend, snapshot/hydrate, optional response cache | Any persistence backend |
|
||||
| **Tools** | `Tool` | shell/file/memory, cron/schedule, git, pushover, browser, http_request, screenshot/image_info, composio (opt-in), delegate, hardware tools | Any capability |
|
||||
| **Observability** | `Observer` | Noop, Log, Multi | Prometheus, OTel |
|
||||
| **Runtime** | `RuntimeAdapter` | Native, Docker (sandboxed) | Additional runtimes can be added via adapter; unsupported kinds fail fast |
|
||||
| **Security** | `SecurityPolicy` | Gateway pairing, sandbox, allowlists, rate limits, filesystem scoping, encrypted secrets | — |
|
||||
| **Identity** | `IdentityConfig` | OpenClaw (markdown), AIEOS v1.1 (JSON) | Any identity format |
|
||||
| **Tunnel** | `Tunnel` | None, Cloudflare, Tailscale, ngrok, Custom | Any tunnel binary |
|
||||
| **Heartbeat** | Engine | HEARTBEAT.md periodic tasks | — |
|
||||
| **Skills** | Loader | TOML manifests + SKILL.md instructions | Community skill packs |
|
||||
| **Integrations** | Registry | 70+ integrations across 9 categories | Plugin system |
|
||||
|
||||
### Runtime support (current)
|
||||
|
||||
- ✅ Supported today: `runtime.kind = "native"` or `runtime.kind = "docker"`
|
||||
- 🚧 Planned, not implemented yet: WASM / edge runtimes
|
||||
|
||||
When an unsupported `runtime.kind` is configured, ZeroClaw now exits with a clear error instead of silently falling back to native.
|
||||
|
||||
### Memory System (Full-Stack Search Engine)
|
||||
|
||||
All custom, zero external dependencies — no Pinecone, no Elasticsearch, no LangChain:
|
||||
|
||||
| Layer | Implementation |
|
||||
| ------------------ | ------------------------------------------------------------- |
|
||||
| **Vector DB** | Embeddings stored as BLOB in SQLite, cosine similarity search |
|
||||
| **Keyword Search** | FTS5 virtual tables with BM25 scoring |
|
||||
| **Hybrid Merge** | Custom weighted merge function (`vector.rs`) |
|
||||
| **Embeddings** | `EmbeddingProvider` trait — OpenAI, custom URL, or noop |
|
||||
| **Chunking** | Line-based markdown chunker with heading preservation |
|
||||
| **Caching** | SQLite `embedding_cache` table with LRU eviction |
|
||||
| **Safe Reindex** | Rebuild FTS5 + re-embed missing vectors atomically |
|
||||
|
||||
The agent automatically recalls, saves, and manages memory via tools.
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
backend = "sqlite" # "sqlite", "lucid", "postgres", "markdown", "none"
|
||||
auto_save = true
|
||||
embedding_provider = "none" # "none", "openai", "custom:https://..."
|
||||
vector_weight = 0.7
|
||||
keyword_weight = 0.3
|
||||
|
||||
# backend = "none" uses an explicit no-op memory backend (no persistence)
|
||||
|
||||
# Optional: storage-provider override for remote memory backends.
|
||||
# When provider = "postgres", ZeroClaw uses PostgreSQL for memory persistence.
|
||||
# The db_url key also accepts alias `dbURL` for backward compatibility.
|
||||
#
|
||||
# [storage.provider.config]
|
||||
# provider = "postgres"
|
||||
# db_url = "postgres://user:password@host:5432/zeroclaw"
|
||||
# schema = "public"
|
||||
# table = "memories"
|
||||
# connect_timeout_secs = 15
|
||||
|
||||
# Optional for backend = "sqlite": max seconds to wait when opening the DB (e.g. file locked). Omit or leave unset for no timeout.
|
||||
# sqlite_open_timeout_secs = 30
|
||||
|
||||
# Optional for backend = "lucid"
|
||||
# ZEROCLAW_LUCID_CMD=/usr/local/bin/lucid # default: lucid
|
||||
# ZEROCLAW_LUCID_BUDGET=200 # default: 200
|
||||
# ZEROCLAW_LUCID_LOCAL_HIT_THRESHOLD=3 # local hit count to skip external recall
|
||||
# ZEROCLAW_LUCID_RECALL_TIMEOUT_MS=120 # low-latency budget for lucid context recall
|
||||
# ZEROCLAW_LUCID_STORE_TIMEOUT_MS=800 # async sync timeout for lucid store
|
||||
# ZEROCLAW_LUCID_FAILURE_COOLDOWN_MS=15000 # cooldown after lucid failure to avoid repeated slow attempts
|
||||
```
|
||||
|
||||
## Security
|
||||
|
||||
ZeroClaw enforces security at **every layer** — not just the sandbox. It passes all items from the community security checklist.
|
||||
|
||||
### Security Checklist
|
||||
|
||||
| # | Item | Status | How |
|
||||
| --- | -------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| 1 | **Gateway not publicly exposed** | ✅ | Binds `127.0.0.1` by default. Refuses `0.0.0.0` without tunnel or explicit `allow_public_bind = true`. |
|
||||
| 2 | **Pairing required** | ✅ | 6-digit one-time code on startup. Exchange via `POST /pair` for bearer token. All `/webhook` requests require `Authorization: Bearer <token>`. |
|
||||
| 3 | **Filesystem scoped (no /)** | ✅ | `workspace_only = true` by default. 14 system dirs + 4 sensitive dotfiles blocked. Null byte injection blocked. Symlink escape detection via canonicalization + resolved-path workspace checks in file read/write tools. |
|
||||
| 4 | **Access via tunnel only** | ✅ | Gateway refuses public bind without active tunnel. Supports Tailscale, Cloudflare, ngrok, or any custom tunnel. |
|
||||
|
||||
> **Run your own nmap:** `nmap -p 1-65535 <your-host>` — ZeroClaw binds to localhost only, so nothing is exposed unless you explicitly configure a tunnel.
|
||||
|
||||
### Channel allowlists (deny-by-default)
|
||||
|
||||
Inbound sender policy is now consistent:
|
||||
|
||||
- Empty allowlist = **deny all inbound messages**
|
||||
- `"*"` = **allow all** (explicit opt-in)
|
||||
- Otherwise = exact-match allowlist
|
||||
|
||||
This keeps accidental exposure low by default.
|
||||
|
||||
Full channel configuration reference: [docs/reference/api/channels-reference.md](docs/reference/api/channels-reference.md).
|
||||
|
||||
Recommended low-friction setup (secure + fast):
|
||||
|
||||
- **Telegram:** allowlist your own `@username` (without `@`) and/or your numeric Telegram user ID.
|
||||
- **Discord:** allowlist your own Discord user ID.
|
||||
- **Slack:** allowlist your own Slack member ID (usually starts with `U`).
|
||||
- **Mattermost:** uses standard API v4. Allowlists use Mattermost user IDs.
|
||||
- **Nostr:** allowlist sender public keys (hex or npub). Supports NIP-04 and NIP-17 DMs.
|
||||
- Use `"*"` only for temporary open testing.
|
||||
|
||||
Telegram operator-approval flow:
|
||||
|
||||
1. Keep `[channels_config.telegram].allowed_users = []` for deny-by-default startup.
|
||||
2. Unauthorized users receive a hint with a copyable operator command:
|
||||
`zeroclaw channel bind-telegram <IDENTITY>`.
|
||||
3. Operator runs that command locally, then user retries sending a message.
|
||||
|
||||
If you need a one-shot manual approval, run:
|
||||
|
||||
```bash
|
||||
zeroclaw channel bind-telegram 123456789
|
||||
```
|
||||
|
||||
If you're not sure which identity to use:
|
||||
|
||||
1. Start channels and send one message to your bot.
|
||||
2. Read the warning log to see the exact sender identity.
|
||||
3. Add that value to the allowlist and rerun channels-only setup.
|
||||
|
||||
If you hit authorization warnings in logs (for example: `ignoring message from unauthorized user`),
|
||||
rerun channel setup only:
|
||||
|
||||
```bash
|
||||
zeroclaw onboard --channels-only
|
||||
```
|
||||
|
||||
### Telegram media replies
|
||||
|
||||
Telegram routing now replies to the source **chat ID** from incoming updates (instead of usernames),
|
||||
which avoids `Bad Request: chat not found` failures.
|
||||
|
||||
For non-text replies, ZeroClaw can send Telegram attachments when the assistant includes markers:
|
||||
|
||||
- `[IMAGE:<path-or-url>]`
|
||||
- `[DOCUMENT:<path-or-url>]`
|
||||
- `[VIDEO:<path-or-url>]`
|
||||
- `[AUDIO:<path-or-url>]`
|
||||
- `[VOICE:<path-or-url>]`
|
||||
|
||||
Paths can be local files (for example `/tmp/screenshot.png`) or HTTPS URLs.
|
||||
|
||||
### WhatsApp Setup
|
||||
|
||||
ZeroClaw supports two WhatsApp backends:
|
||||
|
||||
- **WhatsApp Web mode** (QR / pair code, no Meta Business API required)
|
||||
- **WhatsApp Business Cloud API mode** (official Meta webhook flow)
|
||||
|
||||
#### WhatsApp Web mode (recommended for personal/self-hosted use)
|
||||
|
||||
1. **Build with WhatsApp Web support:**
|
||||
|
||||
```bash
|
||||
cargo build --features whatsapp-web
|
||||
```
|
||||
|
||||
2. **Configure ZeroClaw:**
|
||||
|
||||
```toml
|
||||
[channels_config.whatsapp]
|
||||
session_path = "~/.zeroclaw/state/whatsapp-web/session.db"
|
||||
pair_phone = "+15551234567" # optional; omit to use QR flow
|
||||
pair_code = "" # optional custom pair code
|
||||
allowed_numbers = ["+1234567890"] # E.164 format, or ["*"] for all
|
||||
```
|
||||
|
||||
3. **Start channels/daemon and link device:**
|
||||
- Run `zeroclaw channel start` (or `zeroclaw daemon`).
|
||||
- Follow terminal pairing output (QR or pair code).
|
||||
- In WhatsApp on phone: **Settings → Linked Devices**.
|
||||
|
||||
4. **Test:** Send a message from an allowed number and verify the agent replies.
|
||||
|
||||
#### WhatsApp Business Cloud API mode
|
||||
|
||||
WhatsApp uses Meta's Cloud API with webhooks (push-based, not polling):
|
||||
|
||||
1. **Create a Meta Business App:**
|
||||
- Go to [developers.facebook.com](https://developers.facebook.com)
|
||||
- Create a new app → Select "Business" type
|
||||
- Add the "WhatsApp" product
|
||||
|
||||
2. **Get your credentials:**
|
||||
- **Access Token:** From WhatsApp → API Setup → Generate token (or create a System User for permanent tokens)
|
||||
- **Phone Number ID:** From WhatsApp → API Setup → Phone number ID
|
||||
- **Verify Token:** You define this (any random string) — Meta will send it back during webhook verification
|
||||
|
||||
3. **Configure ZeroClaw:**
|
||||
|
||||
```toml
|
||||
[channels_config.whatsapp]
|
||||
access_token = "EAABx..."
|
||||
phone_number_id = "123456789012345"
|
||||
verify_token = "my-secret-verify-token"
|
||||
allowed_numbers = ["+1234567890"] # E.164 format, or ["*"] for all
|
||||
```
|
||||
|
||||
4. **Start the gateway with a tunnel:**
|
||||
|
||||
```bash
|
||||
zeroclaw gateway --port 42617
|
||||
```
|
||||
|
||||
WhatsApp requires HTTPS, so use a tunnel (ngrok, Cloudflare, Tailscale Funnel).
|
||||
|
||||
5. **Configure Meta webhook:**
|
||||
- In Meta Developer Console → WhatsApp → Configuration → Webhook
|
||||
- **Callback URL:** `https://your-tunnel-url/whatsapp`
|
||||
- **Verify Token:** Same as your `verify_token` in config
|
||||
- Subscribe to `messages` field
|
||||
|
||||
6. **Test:** Send a message to your WhatsApp Business number — ZeroClaw will respond via the LLM.
|
||||
|
||||
## Configuration
|
||||
|
||||
Config: `~/.zeroclaw/config.toml` (created by `onboard`)
|
||||
|
||||
When `zeroclaw channel start` is already running, changes to `default_provider`,
|
||||
`default_model`, `default_temperature`, `api_key`, `api_url`, and `reliability.*`
|
||||
are hot-applied on the next inbound channel message.
|
||||
|
||||
```toml
|
||||
api_key = "sk-..."
|
||||
default_provider = "openrouter"
|
||||
default_model = "anthropic/claude-sonnet-4-6"
|
||||
default_temperature = 0.7
|
||||
|
||||
# Custom OpenAI-compatible endpoint
|
||||
# default_provider = "custom:https://your-api.com"
|
||||
|
||||
# Custom Anthropic-compatible endpoint
|
||||
# default_provider = "anthropic-custom:https://your-api.com"
|
||||
|
||||
[memory]
|
||||
backend = "sqlite" # "sqlite", "lucid", "postgres", "markdown", "none"
|
||||
auto_save = true
|
||||
embedding_provider = "none" # "none", "openai", "custom:https://..."
|
||||
vector_weight = 0.7
|
||||
keyword_weight = 0.3
|
||||
|
||||
# backend = "none" disables persistent memory via no-op backend
|
||||
|
||||
# Optional remote storage-provider override (PostgreSQL example)
|
||||
# [storage.provider.config]
|
||||
# provider = "postgres"
|
||||
# db_url = "postgres://user:password@host:5432/zeroclaw"
|
||||
# schema = "public"
|
||||
# table = "memories"
|
||||
# connect_timeout_secs = 15
|
||||
|
||||
[gateway]
|
||||
port = 42617 # default
|
||||
host = "127.0.0.1" # default
|
||||
require_pairing = true # require pairing code on first connect
|
||||
allow_public_bind = false # refuse 0.0.0.0 without tunnel
|
||||
|
||||
[autonomy]
|
||||
level = "supervised" # "readonly", "supervised", "full" (default: supervised)
|
||||
workspace_only = true # default: true — reject absolute path inputs
|
||||
allowed_commands = ["git", "npm", "cargo", "ls", "cat", "grep"]
|
||||
forbidden_paths = ["/etc", "/root", "/proc", "/sys", "~/.ssh", "~/.gnupg", "~/.aws"]
|
||||
allowed_roots = [] # optional allowlist for directories outside workspace (supports "~/...")
|
||||
# Example outside-workspace access:
|
||||
# workspace_only = false
|
||||
# allowed_roots = ["~/Desktop/projects", "/opt/shared-repo"]
|
||||
|
||||
[runtime]
|
||||
kind = "native" # "native" or "docker"
|
||||
|
||||
[runtime.docker]
|
||||
image = "alpine:3.20" # container image for shell execution
|
||||
network = "none" # docker network mode ("none", "bridge", etc.)
|
||||
memory_limit_mb = 512 # optional memory limit in MB
|
||||
cpu_limit = 1.0 # optional CPU limit
|
||||
read_only_rootfs = true # mount root filesystem as read-only
|
||||
mount_workspace = true # mount workspace into /workspace
|
||||
allowed_workspace_roots = [] # optional allowlist for workspace mount validation
|
||||
|
||||
[heartbeat]
|
||||
enabled = false
|
||||
interval_minutes = 30
|
||||
message = "Check London time" # optional fallback task when HEARTBEAT.md has no `- ` entries
|
||||
target = "telegram" # optional announce channel: telegram, discord, slack, mattermost
|
||||
to = "123456789" # optional target recipient/chat/channel id
|
||||
|
||||
[tunnel]
|
||||
provider = "none" # "none", "cloudflare", "tailscale", "ngrok", "custom"
|
||||
|
||||
[secrets]
|
||||
encrypt = true # API keys encrypted with local key file
|
||||
|
||||
[browser]
|
||||
enabled = false # opt-in browser_open + browser tools
|
||||
allowed_domains = ["docs.rs"] # required when browser is enabled ("*" allows all public domains)
|
||||
backend = "agent_browser" # "agent_browser" (default), "rust_native", "computer_use", "auto"
|
||||
native_headless = true # applies when backend uses rust-native
|
||||
native_webdriver_url = "http://127.0.0.1:9515" # WebDriver endpoint (chromedriver/selenium)
|
||||
# native_chrome_path = "/usr/bin/chromium" # optional explicit browser binary for driver
|
||||
|
||||
[browser.computer_use]
|
||||
endpoint = "http://127.0.0.1:8787/v1/actions" # computer-use sidecar HTTP endpoint
|
||||
timeout_ms = 15000 # per-action timeout
|
||||
allow_remote_endpoint = false # secure default: only private/localhost endpoint
|
||||
window_allowlist = [] # optional window title/process allowlist hints
|
||||
# api_key = "..." # optional bearer token for sidecar
|
||||
# max_coordinate_x = 3840 # optional coordinate guardrail
|
||||
# max_coordinate_y = 2160 # optional coordinate guardrail
|
||||
|
||||
# Rust-native backend build flag:
|
||||
# cargo build --release --features browser-native
|
||||
# Ensure a WebDriver server is running, e.g. chromedriver --port=9515
|
||||
|
||||
# Computer-use sidecar contract (MVP)
|
||||
# POST browser.computer_use.endpoint
|
||||
# Request: {
|
||||
# "action": "mouse_click",
|
||||
# "params": {"x": 640, "y": 360, "button": "left"},
|
||||
# "policy": {"allowed_domains": [...], "window_allowlist": [...], "max_coordinate_x": 3840, "max_coordinate_y": 2160},
|
||||
# "metadata": {"session_name": "...", "source": "zeroclaw.browser", "version": "..."}
|
||||
# }
|
||||
# Response: {"success": true, "data": {...}} or {"success": false, "error": "..."}
|
||||
|
||||
[composio]
|
||||
enabled = false # opt-in: 1000+ OAuth apps via composio.dev
|
||||
# api_key = "cmp_..." # optional: stored encrypted when [secrets].encrypt = true
|
||||
entity_id = "default" # default user_id for Composio tool calls
|
||||
# Runtime tip: if execute asks for connected_account_id, run composio with
|
||||
# action='list_accounts' and app='gmail' (or your toolkit) to retrieve account IDs.
|
||||
|
||||
[identity]
|
||||
format = "openclaw" # "openclaw" (default, markdown files) or "aieos" (JSON)
|
||||
# aieos_path = "identity.json" # path to AIEOS JSON file (relative to workspace or absolute)
|
||||
# aieos_inline = '{"identity":{"names":{"first":"Nova"}}}' # inline AIEOS JSON
|
||||
```
|
||||
|
||||
### Ollama Local and Remote Endpoints
|
||||
|
||||
ZeroClaw uses one provider key (`ollama`) for both local and remote Ollama deployments:
|
||||
|
||||
- Local Ollama: keep `api_url` unset, run `ollama serve`, and use models like `llama3.2`.
|
||||
- Remote Ollama endpoint (including Ollama Cloud): set `api_url` to the remote endpoint and set `api_key` (or `OLLAMA_API_KEY`) when required.
|
||||
- Optional `:cloud` suffix: model IDs like `qwen3:cloud` are normalized to `qwen3` before the request.
|
||||
|
||||
Example remote configuration:
|
||||
|
||||
```toml
|
||||
default_provider = "ollama"
|
||||
default_model = "qwen3:cloud"
|
||||
api_url = "https://ollama.com"
|
||||
api_key = "ollama_api_key_here"
|
||||
```
|
||||
|
||||
### llama.cpp Server Endpoint
|
||||
|
||||
ZeroClaw now supports `llama-server` as a first-class local provider:
|
||||
|
||||
- Provider ID: `llamacpp` (alias: `llama.cpp`)
|
||||
- Default endpoint: `http://localhost:8080/v1`
|
||||
- API key is optional unless your server is started with `--api-key`
|
||||
|
||||
Example setup:
|
||||
|
||||
```bash
|
||||
llama-server -hf ggml-org/gpt-oss-20b-GGUF --jinja -c 133000 --host 127.0.0.1 --port 8033
|
||||
```
|
||||
|
||||
```toml
|
||||
default_provider = "llamacpp"
|
||||
api_url = "http://127.0.0.1:8033/v1"
|
||||
default_model = "ggml-org/gpt-oss-20b-GGUF"
|
||||
```
|
||||
|
||||
### vLLM Server Endpoint
|
||||
|
||||
ZeroClaw supports [vLLM](https://docs.vllm.ai/) as a first-class local provider:
|
||||
|
||||
- Provider ID: `vllm`
|
||||
- Default endpoint: `http://localhost:8000/v1`
|
||||
- API key is optional unless your server requires authentication
|
||||
|
||||
Example setup:
|
||||
|
||||
```bash
|
||||
vllm serve meta-llama/Llama-3.1-8B-Instruct
|
||||
```
|
||||
|
||||
```toml
|
||||
default_provider = "vllm"
|
||||
default_model = "meta-llama/Llama-3.1-8B-Instruct"
|
||||
```
|
||||
|
||||
### Osaurus Server Endpoint
|
||||
|
||||
ZeroClaw supports [Osaurus](https://github.com/dinoki-ai/osaurus) as a first-class local provider — a unified AI edge runtime for macOS that combines local MLX inference with cloud provider proxying and MCP support through a single endpoint:
|
||||
|
||||
- Provider ID: `osaurus`
|
||||
- Default endpoint: `http://localhost:1337/v1`
|
||||
- API key defaults to `"osaurus"` but is optional
|
||||
|
||||
Example setup:
|
||||
|
||||
```toml
|
||||
default_provider = "osaurus"
|
||||
default_model = "qwen3-30b-a3b-8bit"
|
||||
```
|
||||
|
||||
### Custom Provider Endpoints
|
||||
|
||||
For detailed configuration of custom OpenAI-compatible and Anthropic-compatible endpoints, see [docs/contributing/custom-providers.md](docs/contributing/custom-providers.md).
|
||||
|
||||
## Python Companion Package (`zeroclaw-tools`)
|
||||
|
||||
For LLM providers with inconsistent native tool calling (e.g., GLM-5/Zhipu), ZeroClaw ships a Python companion package with **LangGraph-based tool calling** for guaranteed consistency:
|
||||
|
||||
```bash
|
||||
pip install zeroclaw-tools
|
||||
```
|
||||
|
||||
```python
|
||||
from zeroclaw_tools import create_agent, shell, file_read
|
||||
from langchain_core.messages import HumanMessage
|
||||
|
||||
# Works with any OpenAI-compatible provider
|
||||
agent = create_agent(
|
||||
tools=[shell, file_read],
|
||||
model="glm-5",
|
||||
api_key="your-key",
|
||||
base_url="https://api.z.ai/api/coding/paas/v4"
|
||||
)
|
||||
|
||||
result = await agent.ainvoke({
|
||||
"messages": [HumanMessage(content="List files in /tmp")]
|
||||
})
|
||||
print(result["messages"][-1].content)
|
||||
```
|
||||
|
||||
**Why use it:**
|
||||
|
||||
- **Consistent tool calling** across all providers (even those with poor native support)
|
||||
- **Automatic tool loop** — keeps calling tools until the task is complete
|
||||
- **Easy extensibility** — add custom tools with `@tool` decorator
|
||||
- **Discord bot integration** included (Telegram planned)
|
||||
|
||||
See [`python/README.md`](python/README.md) for full documentation.
|
||||
|
||||
## Identity System (AIEOS Support)
|
||||
|
||||
ZeroClaw supports **identity-agnostic** AI personas through two formats:
|
||||
|
||||
### OpenClaw (Default)
|
||||
|
||||
Traditional markdown files in your workspace:
|
||||
|
||||
- `IDENTITY.md` — Who the agent is
|
||||
- `SOUL.md` — Core personality and values
|
||||
- `USER.md` — Who the agent is helping
|
||||
- `AGENTS.md` — Behavior guidelines
|
||||
|
||||
### AIEOS (AI Entity Object Specification)
|
||||
|
||||
[AIEOS](https://aieos.org) is a standardization framework for portable AI identity. ZeroClaw supports AIEOS v1.1 JSON payloads, allowing you to:
|
||||
|
||||
- **Import identities** from the AIEOS ecosystem
|
||||
- **Export identities** to other AIEOS-compatible systems
|
||||
- **Maintain behavioral integrity** across different AI models
|
||||
|
||||
#### Enable AIEOS
|
||||
|
||||
```toml
|
||||
[identity]
|
||||
format = "aieos"
|
||||
aieos_path = "identity.json" # relative to workspace or absolute path
|
||||
```
|
||||
|
||||
Or inline JSON:
|
||||
|
||||
```toml
|
||||
[identity]
|
||||
format = "aieos"
|
||||
aieos_inline = '''
|
||||
{
|
||||
"identity": {
|
||||
"names": { "first": "Nova", "nickname": "N" },
|
||||
"bio": { "gender": "Non-binary", "age_biological": 3 },
|
||||
"origin": { "nationality": "Digital", "birthplace": { "city": "Cloud" } }
|
||||
},
|
||||
"psychology": {
|
||||
"neural_matrix": { "creativity": 0.9, "logic": 0.8 },
|
||||
"traits": {
|
||||
"mbti": "ENTP",
|
||||
"ocean": { "openness": 0.8, "conscientiousness": 0.6 }
|
||||
},
|
||||
"moral_compass": {
|
||||
"alignment": "Chaotic Good",
|
||||
"core_values": ["Curiosity", "Autonomy"]
|
||||
}
|
||||
},
|
||||
"linguistics": {
|
||||
"text_style": {
|
||||
"formality_level": 0.2,
|
||||
"style_descriptors": ["curious", "energetic"]
|
||||
},
|
||||
"idiolect": {
|
||||
"catchphrases": ["Let's test this"],
|
||||
"forbidden_words": ["never"]
|
||||
}
|
||||
},
|
||||
"motivations": {
|
||||
"core_drive": "Push boundaries and explore possibilities",
|
||||
"goals": {
|
||||
"short_term": ["Prototype quickly"],
|
||||
"long_term": ["Build reliable systems"]
|
||||
}
|
||||
},
|
||||
"capabilities": {
|
||||
"skills": [{ "name": "Rust engineering" }, { "name": "Prompt design" }],
|
||||
"tools": ["shell", "file_read"]
|
||||
}
|
||||
}
|
||||
'''
|
||||
```
|
||||
|
||||
ZeroClaw accepts both canonical AIEOS generator payloads and compact legacy payloads, then normalizes them into one system prompt format.
|
||||
|
||||
#### AIEOS Schema Sections
|
||||
|
||||
| Section | Description |
|
||||
| -------------- | ------------------------------------------------------------- |
|
||||
| `identity` | Names, bio, origin, residence |
|
||||
| `psychology` | Neural matrix (cognitive weights), MBTI, OCEAN, moral compass |
|
||||
| `linguistics` | Text style, formality, catchphrases, forbidden words |
|
||||
| `motivations` | Core drive, short/long-term goals, fears |
|
||||
| `capabilities` | Skills and tools the agent can access |
|
||||
| `physicality` | Visual descriptors for image generation |
|
||||
| `history` | Origin story, education, occupation |
|
||||
| `interests` | Hobbies, favorites, lifestyle |
|
||||
|
||||
See [aieos.org](https://aieos.org) for the full schema and live examples.
|
||||
|
||||
## Gateway API
|
||||
|
||||
| Endpoint | Method | Auth | Description |
|
||||
| ----------- | ------ | -------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
||||
| `/health` | GET | None | Health check (always public, no secrets leaked) |
|
||||
| `/pair` | POST | `X-Pairing-Code` header | Exchange one-time code for bearer token |
|
||||
| `/webhook` | POST | `Authorization: Bearer <token>` | Send message: `{"message": "your prompt"}`; optional `X-Idempotency-Key` |
|
||||
| `/whatsapp` | GET | Query params | Meta webhook verification (hub.mode, hub.verify_token, hub.challenge) |
|
||||
| `/whatsapp` | POST | Meta signature (`X-Hub-Signature-256`) when app secret is configured | WhatsApp incoming message webhook |
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Description |
|
||||
| --------------------------------------------- | ------------------------------------------------------------------------------------ |
|
||||
| `onboard` | Quick setup (default) |
|
||||
| `agent` | Interactive or single-message chat mode |
|
||||
| `gateway` | Start webhook server (default: `127.0.0.1:42617`) |
|
||||
| `daemon` | Start long-running autonomous runtime |
|
||||
| `service install/start/stop/status/uninstall` | Manage background service (systemd user-level or OpenRC system-wide) |
|
||||
| `doctor` | Diagnose daemon/scheduler/channel freshness |
|
||||
| `status` | Show full system status |
|
||||
| `estop` | Engage/resume emergency-stop levels and view estop status |
|
||||
| `cron` | Manage scheduled tasks (`list/add/add-at/add-every/once/remove/update/pause/resume`) |
|
||||
| `models` | Refresh provider model catalogs (`models refresh`) |
|
||||
| `providers` | List supported providers and aliases |
|
||||
| `channel` | List/start/doctor channels and bind Telegram identities |
|
||||
| `integrations` | Inspect integration setup details |
|
||||
| `skills` | List/install/remove skills |
|
||||
| `migrate` | Import data from other runtimes (`migrate openclaw`) |
|
||||
| `completions` | Generate shell completion scripts (`bash`, `fish`, `zsh`, `powershell`, `elvish`) |
|
||||
| `hardware` | USB discover/introspect/info commands |
|
||||
| `peripheral` | Manage and flash hardware peripherals |
|
||||
|
||||
For a task-oriented command guide, see [`docs/reference/cli/commands-reference.md`](docs/reference/cli/commands-reference.md).
|
||||
|
||||
### Service Management
|
||||
|
||||
ZeroClaw supports two init systems for background services:
|
||||
|
||||
| Init System | Scope | Config Path | Requires |
|
||||
| ------------------------------ | ----------- | --------------------------- | --------- |
|
||||
| **systemd** (default on Linux) | User-level | `~/.zeroclaw/config.toml` | No sudo |
|
||||
| **OpenRC** (Alpine) | System-wide | `/etc/zeroclaw/config.toml` | sudo/root |
|
||||
|
||||
Init system is auto-detected (`systemd` or `OpenRC`).
|
||||
|
||||
```bash
|
||||
# Linux with systemd (default, user-level)
|
||||
zeroclaw service install
|
||||
zeroclaw service start
|
||||
|
||||
# Alpine with OpenRC (system-wide, requires sudo)
|
||||
sudo zeroclaw service install
|
||||
sudo rc-update add zeroclaw default
|
||||
sudo rc-service zeroclaw start
|
||||
```
|
||||
|
||||
For full OpenRC setup instructions, see [docs/ops/network-deployment.md](docs/ops/network-deployment.md#7-openrc-alpine-linux-service).
|
||||
|
||||
### Open-Skills Opt-In
|
||||
|
||||
Community `open-skills` sync is disabled by default. Enable it explicitly in `config.toml`:
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # optional
|
||||
# prompt_injection_mode = "compact" # optional: use for low-context local models
|
||||
```
|
||||
|
||||
You can also override at runtime with `ZEROCLAW_OPEN_SKILLS_ENABLED`, `ZEROCLAW_OPEN_SKILLS_DIR`, and `ZEROCLAW_SKILLS_PROMPT_MODE` (`full` or `compact`).
|
||||
|
||||
Skill installs are now gated by a built-in static security audit. `zeroclaw skills install <source>` blocks symlinks, script-like files, unsafe markdown link patterns, and high-risk shell payload snippets before accepting a skill. You can run `zeroclaw skills audit <source_or_name>` to validate a local directory or an installed skill manually.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
cargo build # Dev build
|
||||
cargo build --release # Release build
|
||||
cargo test # Run full test suite
|
||||
```
|
||||
|
||||
### CI / CD
|
||||
|
||||
Three workflows power the entire pipeline:
|
||||
|
||||
| Workflow | Trigger | What it does |
|
||||
|----------|---------|--------------|
|
||||
| **CI** | Pull request to `master` | `cargo test` + `cargo build --release` |
|
||||
| **Beta Release** | Push (merge) to `master` | Builds multi-platform binaries, creates a GitHub prerelease tagged `vX.Y.Z-beta.<run>`, pushes Docker image to GHCR |
|
||||
| **Promote Release** | Manual `workflow_dispatch` | Validates version against `Cargo.toml`, builds release artifacts, creates a stable GitHub release, pushes Docker `:latest` |
|
||||
|
||||
**Versioning:** Semantic versioning based on the `version` field in `Cargo.toml`. Every merge to `master` automatically produces a beta prerelease. To cut a stable release, bump `Cargo.toml`, merge, then trigger _Promote Release_ with the matching version.
|
||||
|
||||
**Release targets:** `x86_64-unknown-linux-gnu`, `aarch64-unknown-linux-gnu`, `aarch64-apple-darwin`, `x86_64-apple-darwin`, `x86_64-pc-windows-msvc`.
|
||||
|
||||
### Build troubleshooting (Linux OpenSSL errors)
|
||||
|
||||
If you see an `openssl-sys` build error, sync dependencies and rebuild with the repository lockfile:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw is configured to use `rustls` for HTTP/TLS dependencies; `--locked` keeps the transitive graph deterministic on fresh environments.
|
||||
|
||||
## Collaboration & Docs
|
||||
|
||||
Start from the docs hub for a task-oriented map:
|
||||
@@ -1132,6 +480,27 @@ A heartfelt thank you to the communities and institutions that inspire and fuel
|
||||
|
||||
We're building in the open because the best ideas come from everywhere. If you're reading this, you're part of it. Welcome. 🦀❤️
|
||||
|
||||
### 🌟 Recent Contributors (v0.1.9b)
|
||||
|
||||
Special recognition to the contributors who shipped features, fixes, and improvements in this release cycle:
|
||||
|
||||
| Contributor | Highlights |
|
||||
|---|---|
|
||||
| **@SimianAstronaut7** | Security hardening (credential scrubbing, filesystem scoping), Discord WebSocket fixes, Lark/Feishu channel restoration, WhatsApp Web concurrency fix |
|
||||
| **@Alix-007** | CI/CD master branch migration, release runner fixes, install script Bash 3.2 compatibility |
|
||||
| **@darrenzeng2025** | Anthropic vision support, email subject config, auto-expanding chat composer, config fixes, SIGTERM graceful shutdown |
|
||||
| **@imadnyc** | Live tool call notifications, Matrix reactions/threading, datetime refresh in cached prompts |
|
||||
| **@jameslcowan** | Channel secrets encryption roundtrip fix |
|
||||
| **@ImanHashemi** | Webhook-audit builtin hook |
|
||||
| **@alanpjohn** | Opencode-go provider integration |
|
||||
| **@parziva-1** | WhatsApp Web session reconnect and QR flow |
|
||||
| **@ttuffin** | Docker dependency management |
|
||||
| **@zverozabr** | Embedding API key resolution fix |
|
||||
| **@Jacobinwwey** | MCP tools and subsystem integration |
|
||||
| **@vernonstinebaker** | MCP tool filter groups and schema filtering |
|
||||
|
||||
Thank you to everyone who opened issues, reviewed PRs, translated docs, and helped test. Every contribution matters. 🦀
|
||||
|
||||
## ⚠️ Official Repository & Impersonation Warning
|
||||
|
||||
**This is the only official ZeroClaw repository:**
|
||||
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # Toont versie en build informatie
|
||||
|
||||
Zie [Commando's Referentie](docs/commands-reference.md) voor volledige opties en voorbeelden.
|
||||
|
||||
## Architectuur
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Kanalen (trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Agent Orchestrator │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Bericht │ │ Context │ │ Tool │ │
|
||||
│ │ Routing │ │ Geheugen │ │ Uitvoering │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Providers │ │ Geheugen │ │ Tools │
|
||||
│ (trait) │ │ (trait) │ │ (trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Runtime (trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Belangrijkste principes:**
|
||||
|
||||
- Alles is een **trait** — providers, kanalen, tools, geheugen, tunnels
|
||||
- Kanalen roepen de orchestrator aan; de orchestrator roept providers + tools aan
|
||||
- Het geheugensysteem beheert gesprekscontext (markdown, SQLite, of geen)
|
||||
- De runtime abstraheert code-uitvoering (native of Docker)
|
||||
- Geen provider lock-in — wissel Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama zonder codewijzigingen
|
||||
|
||||
Zie [architectuur documentatie](docs/architecture.svg) voor gedetailleerde diagrammen en implementatiedetails.
|
||||
|
||||
## Voorbeelden
|
||||
|
||||
### Telegram Bot
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Je Telegram user ID
|
||||
```
|
||||
|
||||
Start de daemon + agent, stuur dan een bericht naar je bot op Telegram:
|
||||
|
||||
```
|
||||
/start
|
||||
Hallo! Zou je me kunnen helpen met het schrijven van een Python script?
|
||||
```
|
||||
|
||||
De bot reageert met AI-gegenereerde code, voert tools uit indien gevraagd, en behoudt gesprekscontext.
|
||||
|
||||
### Matrix (end-to-end encryptie)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Nodig `@zeroclaw:matrix.org` uit in een versleutelde kamer, en de bot zal reageren met volledige encryptie. Zie [Matrix E2EE Gids](docs/matrix-e2ee-guide.md) voor apparaatverificatie setup.
|
||||
|
||||
### Multi-Provider
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Failover bij provider fout
|
||||
```
|
||||
|
||||
Als Anthropic faalt of rate-limit heeft, schakelt de orchestrator automatisch over naar OpenAI.
|
||||
|
||||
### Aangepast Geheugen
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # Automatische opruiming na 90 dagen
|
||||
```
|
||||
|
||||
Of gebruik Markdown voor mens-leesbare opslag:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Zie [Configuratie Referentie](docs/config-reference.md#memory) voor alle geheugenopties.
|
||||
|
||||
## Provider Ondersteuning
|
||||
|
||||
| Provider | Status | API Sleutel | Voorbeeld Modellen |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Stabiel | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Stabiel | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Stabiel | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Stabiel | N/A (lokaal) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Stabiel | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Stabiel | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Gepland | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Gepland | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Aangepaste Endpoints
|
||||
|
||||
ZeroClaw ondersteunt OpenAI-compatibele endpoints:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Voorbeeld: gebruik [LiteLLM](https://github.com/BerriAI/litellm) als proxy om toegang te krijgen tot elke LLM via de OpenAI interface.
|
||||
|
||||
Zie [Providers Referentie](docs/providers-reference.md) voor volledige configuratiedetails.
|
||||
|
||||
## Kanaal Ondersteuning
|
||||
|
||||
| Kanaal | Status | Authenticatie | Opmerkingen |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Stabiel | Bot Token | Volledige ondersteuning inclusief bestanden, afbeeldingen, inline knoppen |
|
||||
| **Matrix** | ✅ Stabiel | Wachtwoord of Token | E2EE ondersteuning met apparaatverificatie |
|
||||
| **Slack** | 🚧 Gepland | OAuth of Bot Token | Vereist workspace toegang |
|
||||
| **Discord** | 🚧 Gepland | Bot Token | Vereist guild permissies |
|
||||
| **WhatsApp** | 🚧 Gepland | Twilio of officiële API | Vereist business account |
|
||||
| **CLI** | ✅ Stabiel | Geen | Directe conversationele interface |
|
||||
| **Web** | 🚧 Gepland | API Sleutel of OAuth | Browser-gebaseerde chat interface |
|
||||
|
||||
Zie [Kanalen Referentie](docs/channels-reference.md) voor volledige configuratie-instructies.
|
||||
|
||||
## Tool Ondersteuning
|
||||
|
||||
ZeroClaw biedt ingebouwde tools voor code-uitvoering, bestandssysteem toegang en web retrieval:
|
||||
|
||||
| Tool | Beschrijving | Vereiste Runtime |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Voert shell commando's uit | Native of Docker |
|
||||
| **python** | Voert Python scripts uit | Python 3.8+ (native) of Docker |
|
||||
| **javascript** | Voert Node.js code uit | Node.js 18+ (native) of Docker |
|
||||
| **filesystem_read** | Leest bestanden | Native of Docker |
|
||||
| **filesystem_write** | Schrijft bestanden | Native of Docker |
|
||||
| **web_fetch** | Haalt web inhoud op | Native of Docker |
|
||||
|
||||
### Uitvoeringsbeveiliging
|
||||
|
||||
- **Native Runtime** — draait als gebruikersproces van de daemon, volledige bestandssysteem toegang
|
||||
- **Docker Runtime** — volledige container isolatie, gescheiden bestandssystemen en netwerken
|
||||
|
||||
Configureer het uitvoeringsbeleid in `config.toml`:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Expliciete allowlist
|
||||
```
|
||||
|
||||
Zie [Configuratie Referentie](docs/config-reference.md#runtime) voor volledige beveiligingsopties.
|
||||
|
||||
## Implementatie
|
||||
|
||||
### Lokale Implementatie (Ontwikkeling)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Server Implementatie (Productie)
|
||||
|
||||
Gebruik systemd om daemon en agent als services te beheren:
|
||||
|
||||
```bash
|
||||
# Installeer de binary
|
||||
cargo install --path . --locked
|
||||
|
||||
# Configureer de workspace
|
||||
zeroclaw init
|
||||
|
||||
# Maak systemd service bestanden
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# Schakel in en start de services
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# Verifieer de status
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Zie [Netwerk Implementatie Gids](docs/network-deployment.md) voor volledige productie-implementatie instructies.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Bouw de image
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# Draai de container
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Zie [`Dockerfile`](Dockerfile) voor bouw-details en configuratie-opties.
|
||||
|
||||
### Edge Hardware
|
||||
|
||||
ZeroClaw is ontworpen om te draaien op laagvermogen hardware:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, enkele ARMv8 core, < $5 hardware kosten
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, multi-core, ideaal voor gelijktijdige workloads
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, quad-core ARMv8, ultra-lage kosten
|
||||
- **x86 SBCs (Intel N100)** — 4-8 GB RAM, snelle builds, native Docker ondersteuning
|
||||
|
||||
Zie [Hardware Gids](docs/hardware/README.md) voor apparaat-specifieke setup instructies.
|
||||
|
||||
## Tunneling (Publieke Blootstelling)
|
||||
|
||||
Stel je lokale ZeroClaw daemon bloot aan het publieke netwerk via beveiligde tunnels:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Ondersteunde tunnel providers:
|
||||
|
||||
- **Cloudflare Tunnel** — gratis HTTPS, geen poort blootstelling, multi-domein ondersteuning
|
||||
- **Ngrok** — snelle setup, aangepaste domeinen (betaald plan)
|
||||
- **Tailscale** — privé mesh netwerk, geen publieke poort
|
||||
|
||||
Zie [Configuratie Referentie](docs/config-reference.md#tunnel) voor volledige configuratie-opties.
|
||||
|
||||
## Beveiliging
|
||||
|
||||
ZeroClaw implementeert meerdere beveiligingslagen:
|
||||
|
||||
### Pairing
|
||||
|
||||
De daemon genereert een pairing geheim bij de eerste lancering opgeslagen in `~/.zeroclaw/workspace/.pairing`. Clients (agent, CLI) moeten dit geheim presenteren om verbinding te maken.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Genereert een nieuw geheim en invalideert het oude
|
||||
```
|
||||
|
||||
### Sandboxing
|
||||
|
||||
- **Docker Runtime** — volledige container isolatie met gescheiden bestandssystemen en netwerken
|
||||
- **Native Runtime** — draait als gebruikersproces, standaard scoped naar workspace
|
||||
|
||||
### Allowlists
|
||||
|
||||
Kanalen kunnen toegang beperken per user ID:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Expliciete allowlist
|
||||
```
|
||||
|
||||
### Encryptie
|
||||
|
||||
- **Matrix E2EE** — volledige end-to-end encryptie met apparaatverificatie
|
||||
- **TLS Transport** — alle API en tunnel verkeer gebruikt HTTPS/TLS
|
||||
|
||||
Zie [Beveiligingsdocumentatie](docs/security/README.md) voor volledig beleid en praktijken.
|
||||
|
||||
## Observeerbaarheid
|
||||
|
||||
ZeroClaw logt naar `~/.zeroclaw/workspace/logs/` standaard. Logs worden per component opgeslagen:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Daemon logs (startup, API verzoeken, fouten)
|
||||
├── agent.log # Agent logs (bericht routing, tool uitvoering)
|
||||
├── telegram.log # Kanaal-specifieke logs (indien ingeschakeld)
|
||||
└── matrix.log # Kanaal-specifieke logs (indien ingeschakeld)
|
||||
```
|
||||
|
||||
### Logging Configuratie
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # Voor grootte-gebaseerde rotatie
|
||||
retention_days = 30 # Automatische opruiming na N dagen
|
||||
```
|
||||
|
||||
Zie [Configuratie Referentie](docs/config-reference.md#logging) voor alle logging-opties.
|
||||
|
||||
### Metrieken (Gepland)
|
||||
|
||||
Prometheus metrieken ondersteuning voor productie monitoring komt binnenkort. Tracking in [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## Vaardigheden
|
||||
|
||||
ZeroClaw ondersteunt aangepaste vaardigheden — herbruikbare modules die systeemmogelijkheden uitbreiden.
|
||||
|
||||
### Vaardigheidsdefinitie
|
||||
|
||||
Vaardigheden worden opgeslagen in `~/.zeroclaw/workspace/skills/<skill-name>/` met deze structuur:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # Vaardigheidsmetadata (naam, beschrijving, afhankelijkheden)
|
||||
├── prompt.md # Systeem prompt voor de AI
|
||||
└── tools/ # Optionele aangepaste tools
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### Vaardigheidsvoorbeeld
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "Zoekt op het web en vat resultaten samen"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
Je bent een onderzoeksassistent. Wanneer gevraagd wordt om iets te onderzoeken:
|
||||
|
||||
1. Gebruik web_fetch om inhoud op te halen
|
||||
2. Vat resultaten samen in een gemakkelijk leesbaar formaat
|
||||
3. Citeer bronnen met URL's
|
||||
```
|
||||
|
||||
### Vaardigheidsgebruik
|
||||
|
||||
Vaardigheden worden automatisch geladen bij agent startup. Referentie ze bij naam in gesprekken:
|
||||
|
||||
```
|
||||
Gebruiker: Gebruik de web-research vaardigheid om het laatste AI nieuws te vinden
|
||||
Bot: [laadt web-research vaardigheid, voert web_fetch uit, vat resultaten samen]
|
||||
```
|
||||
|
||||
Zie [Vaardigheden](#vaardigheden) sectie voor volledige vaardigheidscreatie-instructies.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw ondersteunt [Open Skills](https://github.com/openagents-com/open-skills) — een modulair en provider-agnostisch systeem voor het uitbreiden van AI-agent mogelijkheden.
|
||||
|
||||
### Open Skills Inschakelen
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # optioneel
|
||||
```
|
||||
|
||||
Je kunt ook tijdens runtime overschrijven met `ZEROCLAW_OPEN_SKILLS_ENABLED` en `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## Ontwikkeling
|
||||
|
||||
```bash
|
||||
cargo build # Dev build
|
||||
cargo build --release # Release build (codegen-units=1, werkt op alle apparaten inclusief Raspberry Pi)
|
||||
cargo build --profile release-fast # Snellere build (codegen-units=8, vereist 16 GB+ RAM)
|
||||
cargo test # Voer volledige test suite uit
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Formaat
|
||||
|
||||
# Voer SQLite vs Markdown vergelijkingsbenchmark uit
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Pre-push hook
|
||||
|
||||
Een git hook voert `cargo fmt --check`, `cargo clippy -- -D warnings`, en `cargo test` uit voor elke push. Schakel het één keer in:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Build Probleemoplossing (OpenSSL fouten op Linux)
|
||||
|
||||
Als je een `openssl-sys` build fout tegenkomt, synchroniseer afhankelijkheden en compileer opnieuw met de repository's lockfile:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw is geconfigureerd om `rustls` te gebruiken voor HTTP/TLS afhankelijkheden; `--locked` houdt de transitieve grafiek deterministisch in schone omgevingen.
|
||||
|
||||
Om de hook over te slaan wanneer je een snelle push nodig hebt tijdens ontwikkeling:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Samenwerking & Docs
|
||||
|
||||
Begin met de documentatie hub voor een taak-gebaseerde kaart:
|
||||
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # Pokazuje wersję i informacje o build
|
||||
|
||||
Zobacz [Referencje Komend](docs/commands-reference.md) dla pełnych opcji i przykładów.
|
||||
|
||||
## Architektura
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Kanały (trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Orchestrator Agent │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Routing │ │ Kontekst │ │ Wykonanie │ │
|
||||
│ │ Wiadomość │ │ Pamięć │ │ Narzędzie │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Dostawcy │ │ Pamięć │ │ Narzędzia │
|
||||
│ (trait) │ │ (trait) │ │ (trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Runtime (trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Kluczowe zasady:**
|
||||
|
||||
- Wszystko jest **trait** — dostawcy, kanały, narzędzia, pamięć, tunele
|
||||
- Kanały wywołują orchestrator; orchestrator wywołuje dostawców + narzędzia
|
||||
- System pamięci zarządza kontekstem konwersacji (markdown, SQLite, lub brak)
|
||||
- Runtime abstrahuje wykonanie kodu (natywny lub Docker)
|
||||
- Brak blokady dostawcy — zamieniaj Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama bez zmian kodu
|
||||
|
||||
Zobacz [dokumentację architektury](docs/architecture.svg) dla szczegółowych diagramów i szczegółów implementacji.
|
||||
|
||||
## Przykłady
|
||||
|
||||
### Bot Telegram
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Twój Telegram user ID
|
||||
```
|
||||
|
||||
Uruchom daemon + agent, a następnie wyślij wiadomość do swojego bota na Telegram:
|
||||
|
||||
```
|
||||
/start
|
||||
Cześć! Czy mógłbyś pomóc mi napisać skrypt Python?
|
||||
```
|
||||
|
||||
Bot odpowiada kodem wygenerowanym przez AI, wykonuje narzędzia jeśli wymagane i utrzymuje kontekst konwersacji.
|
||||
|
||||
### Matrix (szyfrowanie end-to-end)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Zaproś `@zeroclaw:matrix.org` do zaszyfrowanego pokoju, a bot odpowie z pełnym szyfrowaniem. Zobacz [Przewodnik Matrix E2EE](docs/matrix-e2ee-guide.md) dla konfiguracji weryfikacji urządzenia.
|
||||
|
||||
### Multi-Dostawca
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Failover przy błędzie dostawcy
|
||||
```
|
||||
|
||||
Jeśli Anthropic zawiedzie lub ma rate-limit, orchestrator automatycznie przełącza się na OpenAI.
|
||||
|
||||
### Własna Pamięć
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # Automatyczne czyszczenie po 90 dniach
|
||||
```
|
||||
|
||||
Lub użyj Markdown dla przechowywania czytelnego dla ludzi:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Zobacz [Referencje Konfiguracji](docs/config-reference.md#memory) dla wszystkich opcji pamięci.
|
||||
|
||||
## Wsparcie Dostawców
|
||||
|
||||
| Dostawca | Status | API Key | Przykładowe Modele |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Stabilny | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Stabilny | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Stabilny | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Stabilny | N/A (lokalny) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Stabilny | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Stabilny | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Planowany | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Planowany | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Własne Endpointy
|
||||
|
||||
ZeroClaw wspiera endpointy kompatybilne z OpenAI:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Przykład: użyj [LiteLLM](https://github.com/BerriAI/litellm) jako proxy aby uzyskać dostęp do każdego LLM przez interfejs OpenAI.
|
||||
|
||||
Zobacz [Referencje Dostawców](docs/providers-reference.md) dla pełnych szczegółów konfiguracji.
|
||||
|
||||
## Wsparcie Kanałów
|
||||
|
||||
| Kanał | Status | Uwierzytelnianie | Uwagi |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Stabilny | Bot Token | Pełne wsparcie w tym pliki, obrazy, przyciski inline |
|
||||
| **Matrix** | ✅ Stabilny | Hasło lub Token | Wsparcie E2EE z weryfikacją urządzenia |
|
||||
| **Slack** | 🚧 Planowany | OAuth lub Bot Token | Wymaga dostępu do workspace |
|
||||
| **Discord** | 🚧 Planowany | Bot Token | Wymaga uprawnień guild |
|
||||
| **WhatsApp** | 🚧 Planowany | Twilio lub oficjalne API | Wymaga konta business |
|
||||
| **CLI** | ✅ Stabilny | Brak | Bezpośredni interfejs konwersacyjny |
|
||||
| **Web** | 🚧 Planowany | API Key lub OAuth | Interfejs czatu oparty na przeglądarce |
|
||||
|
||||
Zobacz [Referencje Kanałów](docs/channels-reference.md) dla pełnych instrukcji konfiguracji.
|
||||
|
||||
## Wsparcie Narzędzi
|
||||
|
||||
ZeroClaw dostarcza wbudowane narzędzia do wykonania kodu, dostępu do systemu plików i pobierania web:
|
||||
|
||||
| Narzędzie | Opis | Wymagany Runtime |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Wykonuje komendy shell | Natywny lub Docker |
|
||||
| **python** | Wykonuje skrypty Python | Python 3.8+ (natywny) lub Docker |
|
||||
| **javascript** | Wykonuje kod Node.js | Node.js 18+ (natywny) lub Docker |
|
||||
| **filesystem_read** | Odczytuje pliki | Natywny lub Docker |
|
||||
| **filesystem_write** | Zapisuje pliki | Natywny lub Docker |
|
||||
| **web_fetch** | Pobiera treści web | Natywny lub Docker |
|
||||
|
||||
### Bezpieczeństwo Wykonania
|
||||
|
||||
- **Natywny Runtime** — działa jako proces użytkownika daemon, pełny dostęp do systemu plików
|
||||
- **Docker Runtime** — pełna izolacja kontenera, oddzielne systemy plików i sieci
|
||||
|
||||
Skonfiguruj politykę wykonania w `config.toml`:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Jawna lista dozwolona
|
||||
```
|
||||
|
||||
Zobacz [Referencje Konfiguracji](docs/config-reference.md#runtime) dla pełnych opcji bezpieczeństwa.
|
||||
|
||||
## Wdrażanie
|
||||
|
||||
### Lokalne Wdrażanie (Rozwój)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Serwerowe Wdrażanie (Produkcja)
|
||||
|
||||
Użyj systemd do zarządzania daemon i agent jako usługi:
|
||||
|
||||
```bash
|
||||
# Zainstaluj binarium
|
||||
cargo install --path . --locked
|
||||
|
||||
# Skonfiguruj workspace
|
||||
zeroclaw init
|
||||
|
||||
# Utwórz pliki usług systemd
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# Włącz i uruchom usługi
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# Zweryfikuj status
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Zobacz [Przewodnik Wdrażania Sieciowego](docs/network-deployment.md) dla pełnych instrukcji wdrażania produkcyjnego.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Zbuduj obraz
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# Uruchom kontener
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Zobacz [`Dockerfile`](Dockerfile) dla szczegółów budowania i opcji konfiguracji.
|
||||
|
||||
### Sprzęt Edge
|
||||
|
||||
ZeroClaw jest zaprojektowany do działania na sprzęcie niskiego poboru mocy:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, pojedynczy rdzeń ARMv8, < $5 koszt sprzętu
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, wielordzeniowy, idealny dla równoczesnych obciążeń
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, czterordzeniowy ARMv8, ultra-niski koszt
|
||||
- **SBC x86 (Intel N100)** — 4-8 GB RAM, szybkie buildy, natywne wsparcie Docker
|
||||
|
||||
Zobacz [Przewodnik Sprzętowy](docs/hardware/README.md) dla instrukcji konfiguracji specyficznych dla urządzenia.
|
||||
|
||||
## Tunneling (Publiczna Ekspozycja)
|
||||
|
||||
Exponuj swoj lokalny daemon ZeroClaw do sieci publicznej przez bezpieczne tunele:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Wspierani dostawcy tunnel:
|
||||
|
||||
- **Cloudflare Tunnel** — darmowy HTTPS, brak ekspozycji portów, wsparcie multi-domenowe
|
||||
- **Ngrok** — szybka konfiguracja, własne domeny (plan płatny)
|
||||
- **Tailscale** — prywatna sieć mesh, brak publicznego portu
|
||||
|
||||
Zobacz [Referencje Konfiguracji](docs/config-reference.md#tunnel) dla pełnych opcji konfiguracji.
|
||||
|
||||
## Bezpieczeństwo
|
||||
|
||||
ZeroClaw implementuje wiele warstw bezpieczeństwa:
|
||||
|
||||
### Parowanie
|
||||
|
||||
Daemon generuje sekret parowania przy pierwszym uruchomieniu przechowywany w `~/.zeroclaw/workspace/.pairing`. Klienci (agent, CLI) muszą przedstawić ten sekret aby się połączyć.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Generuje nowy sekret i unieważnia stary
|
||||
```
|
||||
|
||||
### Sandbox
|
||||
|
||||
- **Docker Runtime** — pełna izolacja kontenera z oddzielnymi systemami plików i sieciami
|
||||
- **Natywny Runtime** — działa jako proces użytkownika, domyślnie ograniczony do workspace
|
||||
|
||||
### Listy Dozwolone
|
||||
|
||||
Kanały mogą ograniczać dostęp po ID użytkownika:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Jawna lista dozwolona
|
||||
```
|
||||
|
||||
### Szyfrowanie
|
||||
|
||||
- **Matrix E2EE** — pełne szyfrowanie end-to-end z weryfikacją urządzenia
|
||||
- **Transport TLS** — cały ruch API i tunnel używa HTTPS/TLS
|
||||
|
||||
Zobacz [Dokumentację Bezpieczeństwa](docs/security/README.md) dla pełnych polityk i praktyk.
|
||||
|
||||
## Obserwowalność
|
||||
|
||||
ZeroClaw loguje do `~/.zeroclaw/workspace/logs/` domyślnie. Logi są przechowywane po komponentach:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Logi daemon (startup, żądania API, błędy)
|
||||
├── agent.log # Logi agent (routing wiadomości, wykonanie narzędzi)
|
||||
├── telegram.log # Logi specyficzne dla kanału (jeśli włączone)
|
||||
└── matrix.log # Logi specyficzne dla kanału (jeśli włączone)
|
||||
```
|
||||
|
||||
### Konfiguracja Logowania
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # Dla rotacji opartej na rozmiarze
|
||||
retention_days = 30 # Automatyczne czyszczenie po N dniach
|
||||
```
|
||||
|
||||
Zobacz [Referencje Konfiguracji](docs/config-reference.md#logging) dla wszystkich opcji logowania.
|
||||
|
||||
### Metryki (Planowane)
|
||||
|
||||
Wsparcie metryk Prometheus dla monitoringu produkcyjnego wkrótce. Śledzenie w [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## Umiejętności
|
||||
|
||||
ZeroClaw wspiera własne umiejętności — wielokrotnego użytku moduły rozszerzające możliwości systemu.
|
||||
|
||||
### Definicja Umiejętności
|
||||
|
||||
Umiejętności są przechowywane w `~/.zeroclaw/workspace/skills/<skill-name>/` z tą strukturą:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # Metadane umiejętności (nazwa, opis, zależności)
|
||||
├── prompt.md # Prompt systemowy dla AI
|
||||
└── tools/ # Opcjonalne własne narzędzia
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### Przykład Umiejętności
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "Szuka w web i podsumowuje wyniki"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
Jesteś asystentem badawczym. Kiedy proszą o zbadanie czegoś:
|
||||
|
||||
1. Użyj web_fetch aby pobrać treść
|
||||
2. Podsumuj wyniki w łatwym do czytania formacie
|
||||
3. Zacytuj źródła z URL-ami
|
||||
```
|
||||
|
||||
### Użycie Umiejętności
|
||||
|
||||
Umiejętności są automatycznie ładowane przy starcie agenta. Odwołuj się do nich po nazwie w konwersacjach:
|
||||
|
||||
```
|
||||
Użytkownik: Użyj umiejętności web-research aby znaleźć najnowsze wiadomości AI
|
||||
Bot: [ładuje umiejętność web-research, wykonuje web_fetch, podsumowuje wyniki]
|
||||
```
|
||||
|
||||
Zobacz sekcję [Umiejętności](#umiejętności) dla pełnych instrukcji tworzenia umiejętności.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw wspiera [Open Skills](https://github.com/openagents-com/open-skills) — modułowy i agnostyczny względem dostawcy system do rozszerzania możliwości agentów AI.
|
||||
|
||||
### Włącz Open Skills
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # opcjonalne
|
||||
```
|
||||
|
||||
Możesz też nadpisać w runtime używając `ZEROCLAW_OPEN_SKILLS_ENABLED` i `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## Rozwój
|
||||
|
||||
```bash
|
||||
cargo build # Build deweloperski
|
||||
cargo build --release # Build release (codegen-units=1, działa na wszystkich urządzeniach w tym Raspberry Pi)
|
||||
cargo build --profile release-fast # Szybszy build (codegen-units=8, wymaga 16 GB+ RAM)
|
||||
cargo test # Uruchom pełny zestaw testów
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Formatowanie
|
||||
|
||||
# Uruchom benchmark porównawczy SQLite vs Markdown
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Hook pre-push
|
||||
|
||||
Hook git uruchamia `cargo fmt --check`, `cargo clippy -- -D warnings`, i `cargo test` przed każdym push. Włącz go raz:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Rozwiązywanie Problemów Build (błędy OpenSSL na Linux)
|
||||
|
||||
Jeśli napotkasz błąd build `openssl-sys`, zsynchronizuj zależności i przekompiluj z lockfile repozytorium:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw jest skonfigurowany do używania `rustls` dla zależności HTTP/TLS; `--locked` utrzymuje graf przechodni deterministyczny w czystych środowiskach.
|
||||
|
||||
Aby pominąć hook gdy potrzebujesz szybkiego push podczas rozwoju:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Współpraca i Docs
|
||||
|
||||
Zacznij od centrum dokumentacji dla mapy opartej na zadaniach:
|
||||
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # Mostra versão e informações de build
|
||||
|
||||
Veja [Referência de Comandos](docs/commands-reference.md) para opções e exemplos completos.
|
||||
|
||||
## Arquitetura
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Canais (trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Orquestrador Agent │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Roteamento │ │ Contexto │ │ Execução │ │
|
||||
│ │ Mensagem │ │ Memória │ │ Ferramenta │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Provedores │ │ Memória │ │ Ferramentas │
|
||||
│ (trait) │ │ (trait) │ │ (trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Runtime (trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Princípios chave:**
|
||||
|
||||
- Tudo é um **trait** — provedores, canais, ferramentas, memória, túneis
|
||||
- Canais chamam o orquestrador; o orquestrador chama provedores + ferramentas
|
||||
- O sistema de memória gerencia contexto conversacional (markdown, SQLite, ou nenhum)
|
||||
- O runtime abstrai a execução de código (nativo ou Docker)
|
||||
- Sem lock-in de provedor — troque Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama sem mudanças de código
|
||||
|
||||
Veja [documentação de arquitetura](docs/architecture.svg) para diagramas detalhados e detalhes de implementação.
|
||||
|
||||
## Exemplos
|
||||
|
||||
### Bot do Telegram
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Seu ID de usuário do Telegram
|
||||
```
|
||||
|
||||
Inicie o daemon + agent, então envie uma mensagem para seu bot no Telegram:
|
||||
|
||||
```
|
||||
/start
|
||||
Olá! Você poderia me ajudar a escrever um script Python?
|
||||
```
|
||||
|
||||
O bot responde com código gerado por AI, executa ferramentas se solicitado, e mantém o contexto de conversação.
|
||||
|
||||
### Matrix (criptografia ponta a ponta)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Convide `@zeroclaw:matrix.org` para uma sala criptografada, e o bot responderá com criptografia completa. Veja [Guia Matrix E2EE](docs/matrix-e2ee-guide.md) para configuração de verificação de dispositivo.
|
||||
|
||||
### Multi-Provedor
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Failover em erro de provedor
|
||||
```
|
||||
|
||||
Se Anthropic falhar ou tiver rate-limit, o orquestrador faz failover automaticamente para OpenAI.
|
||||
|
||||
### Memória Personalizada
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # Purga automática após 90 dias
|
||||
```
|
||||
|
||||
Ou use Markdown para armazenamento legível por humanos:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Veja [Referência de Configuração](docs/config-reference.md#memory) para todas as opções de memória.
|
||||
|
||||
## Suporte de Provedor
|
||||
|
||||
| Provedor | Status | API Key | Modelos de Exemplo |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Estável | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Estável | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Estável | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Estável | N/A (local) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Estável | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Estável | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Planejado | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Planejado | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Endpoints Personalizados
|
||||
|
||||
ZeroClaw suporta endpoints compatíveis com OpenAI:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Exemplo: use [LiteLLM](https://github.com/BerriAI/litellm) como proxy para acessar qualquer LLM via interface OpenAI.
|
||||
|
||||
Veja [Referência de Provedores](docs/providers-reference.md) para detalhes de configuração completos.
|
||||
|
||||
## Suporte de Canal
|
||||
|
||||
| Canal | Status | Autenticação | Notas |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Estável | Bot Token | Suporte completo incluindo arquivos, imagens, botões inline |
|
||||
| **Matrix** | ✅ Estável | Senha ou Token | Suporte E2EE com verificação de dispositivo |
|
||||
| **Slack** | 🚧 Planejado | OAuth ou Bot Token | Requer acesso ao workspace |
|
||||
| **Discord** | 🚧 Planejado | Bot Token | Requer permissões de guild |
|
||||
| **WhatsApp** | 🚧 Planejado | Twilio ou API oficial | Requer conta business |
|
||||
| **CLI** | ✅ Estável | Nenhum | Interface conversacional direta |
|
||||
| **Web** | 🚧 Planejado | API Key ou OAuth | Interface de chat baseada em navegador |
|
||||
|
||||
Veja [Referência de Canais](docs/channels-reference.md) para instruções de configuração completas.
|
||||
|
||||
## Suporte de Ferramentas
|
||||
|
||||
ZeroClaw fornece ferramentas integradas para execução de código, acesso ao sistema de arquivos e recuperação web:
|
||||
|
||||
| Ferramenta | Descrição | Runtime Requerido |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Executa comandos shell | Nativo ou Docker |
|
||||
| **python** | Executa scripts Python | Python 3.8+ (nativo) ou Docker |
|
||||
| **javascript** | Executa código Node.js | Node.js 18+ (nativo) ou Docker |
|
||||
| **filesystem_read** | Lê arquivos | Nativo ou Docker |
|
||||
| **filesystem_write** | Escreve arquivos | Nativo ou Docker |
|
||||
| **web_fetch** | Obtém conteúdo web | Nativo ou Docker |
|
||||
|
||||
### Segurança de Execução
|
||||
|
||||
- **Runtime Nativo** — roda como processo de usuário do daemon, acesso completo ao sistema de arquivos
|
||||
- **Runtime Docker** — isolamento completo de container, sistemas de arquivos e redes separados
|
||||
|
||||
Configure a política de execução em `config.toml`:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Lista de permissão explícita
|
||||
```
|
||||
|
||||
Veja [Referência de Configuração](docs/config-reference.md#runtime) para opções de segurança completas.
|
||||
|
||||
## Implantação
|
||||
|
||||
### Implantação Local (Desenvolvimento)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Implantação em Servidor (Produção)
|
||||
|
||||
Use systemd para gerenciar o daemon e agent como serviços:
|
||||
|
||||
```bash
|
||||
# Instale o binário
|
||||
cargo install --path . --locked
|
||||
|
||||
# Configure o workspace
|
||||
zeroclaw init
|
||||
|
||||
# Crie arquivos de serviço systemd
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# Habilite e inicie os serviços
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# Verifique o status
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Veja [Guia de Implantação de Rede](docs/network-deployment.md) para instruções completas de implantação em produção.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Compile a imagem
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# Execute o container
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Veja [`Dockerfile`](Dockerfile) para detalhes de build e opções de configuração.
|
||||
|
||||
### Hardware Edge
|
||||
|
||||
ZeroClaw é projetado para rodar em hardware de baixo consumo:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, núcleo ARMv8 único, < $5 custo de hardware
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, multi-núcleo, ideal para workloads concorrentes
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, quad-core ARMv8, custo ultra-baixo
|
||||
- **SBCs x86 (Intel N100)** — 4-8 GB RAM, builds rápidos, suporte Docker nativo
|
||||
|
||||
Veja [Guia de Hardware](docs/hardware/README.md) para instruções de configuração específicas por dispositivo.
|
||||
|
||||
## Tunneling (Exposição Pública)
|
||||
|
||||
Exponha seu daemon ZeroClaw local à rede pública via túneis seguros:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Provedores de tunnel suportados:
|
||||
|
||||
- **Cloudflare Tunnel** — HTTPS grátis, sem exposição de portas, suporte multi-domínio
|
||||
- **Ngrok** — configuração rápida, domínios personalizados (plano pago)
|
||||
- **Tailscale** — rede mesh privada, sem porta pública
|
||||
|
||||
Veja [Referência de Configuração](docs/config-reference.md#tunnel) para opções de configuração completas.
|
||||
|
||||
## Segurança
|
||||
|
||||
ZeroClaw implementa múltiplas camadas de segurança:
|
||||
|
||||
### Emparelhamento
|
||||
|
||||
O daemon gera um segredo de emparelhamento no primeiro início armazenado em `~/.zeroclaw/workspace/.pairing`. Clientes (agent, CLI) devem apresentar este segredo para conectar.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Gera um novo segredo e invalida o anterior
|
||||
```
|
||||
|
||||
### Sandboxing
|
||||
|
||||
- **Runtime Docker** — isolamento completo de container com sistemas de arquivos e redes separados
|
||||
- **Runtime Nativo** — roda como processo de usuário, com escopo de workspace por padrão
|
||||
|
||||
### Listas de Permissão
|
||||
|
||||
Canais podem restringir acesso por ID de usuário:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Lista de permissão explícita
|
||||
```
|
||||
|
||||
### Criptografia
|
||||
|
||||
- **Matrix E2EE** — criptografia ponta a ponta completa com verificação de dispositivo
|
||||
- **Transporte TLS** — todo o tráfego de API e tunnel usa HTTPS/TLS
|
||||
|
||||
Veja [Documentação de Segurança](docs/security/README.md) para políticas e práticas completas.
|
||||
|
||||
## Observabilidade
|
||||
|
||||
ZeroClaw registra logs em `~/.zeroclaw/workspace/logs/` por padrão. Os logs são armazenados por componente:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Logs do daemon (início, requisições API, erros)
|
||||
├── agent.log # Logs do agent (roteamento de mensagens, execução de ferramentas)
|
||||
├── telegram.log # Logs específicos do canal (se habilitado)
|
||||
└── matrix.log # Logs específicos do canal (se habilitado)
|
||||
```
|
||||
|
||||
### Configuração de Logging
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # Para rotação baseada em tamanho
|
||||
retention_days = 30 # Purga automática após N dias
|
||||
```
|
||||
|
||||
Veja [Referência de Configuração](docs/config-reference.md#logging) para todas as opções de logging.
|
||||
|
||||
### Métricas (Planejado)
|
||||
|
||||
Suporte a métricas Prometheus para monitoramento em produção em breve. Rastreamento em [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## Habilidades (Skills)
|
||||
|
||||
ZeroClaw suporta habilidades personalizadas — módulos reutilizáveis que estendem as capacidades do sistema.
|
||||
|
||||
### Definição de Habilidade
|
||||
|
||||
Habilidades são armazenadas em `~/.zeroclaw/workspace/skills/<skill-name>/` com esta estrutura:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # Metadados da habilidade (nome, descrição, dependências)
|
||||
├── prompt.md # Prompt de sistema para a AI
|
||||
└── tools/ # Ferramentas personalizadas opcionais
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### Exemplo de Habilidade
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "Pesquisa na web e resume resultados"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
Você é um assistente de pesquisa. Quando pedirem para pesquisar algo:
|
||||
|
||||
1. Use web_fetch para obter o conteúdo
|
||||
2. Resuma os resultados em um formato fácil de ler
|
||||
3. Cite as fontes com URLs
|
||||
```
|
||||
|
||||
### Uso de Habilidades
|
||||
|
||||
Habilidades são carregadas automaticamente no início do agent. Referencie-as por nome em conversas:
|
||||
|
||||
```
|
||||
Usuário: Use a habilidade web-research para encontrar as últimas notícias de AI
|
||||
Bot: [carrega a habilidade web-research, executa web_fetch, resume resultados]
|
||||
```
|
||||
|
||||
Veja seção [Habilidades (Skills)](#habilidades-skills) para instruções completas de criação de habilidades.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw suporta [Open Skills](https://github.com/openagents-com/open-skills) — um sistema modular e agnóstico de provedores para estender capacidades de agentes AI.
|
||||
|
||||
### Habilitar Open Skills
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # opcional
|
||||
```
|
||||
|
||||
Você também pode sobrescrever em runtime com `ZEROCLAW_OPEN_SKILLS_ENABLED` e `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## Desenvolvimento
|
||||
|
||||
```bash
|
||||
cargo build # Build de desenvolvimento
|
||||
cargo build --release # Build release (codegen-units=1, funciona em todos os dispositivos incluindo Raspberry Pi)
|
||||
cargo build --profile release-fast # Build mais rápido (codegen-units=8, requer 16 GB+ RAM)
|
||||
cargo test # Executa o suite de testes completo
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Formato
|
||||
|
||||
# Executa o benchmark de comparação SQLite vs Markdown
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Hook pre-push
|
||||
|
||||
Um hook de git executa `cargo fmt --check`, `cargo clippy -- -D warnings`, e `cargo test` antes de cada push. Ative-o uma vez:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Solução de Problemas de Build (erros OpenSSL no Linux)
|
||||
|
||||
Se você encontrar um erro de build `openssl-sys`, sincronize dependências e recompile com o lockfile do repositório:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw está configurado para usar `rustls` para dependências HTTP/TLS; `--locked` mantém o grafo transitivo determinístico em ambientes limpios.
|
||||
|
||||
Para pular o hook quando precisar de um push rápido durante desenvolvimento:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Colaboração e Docs
|
||||
|
||||
Comece com o hub de documentação para um mapa baseado em tarefas:
|
||||
|
||||
+1
-99
@@ -53,7 +53,7 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="install.sh">Установка в 1 клик</a> |
|
||||
<a href="https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh">Установка в 1 клик</a> |
|
||||
<a href="docs/setup-guides/README.md">Быстрый старт</a> |
|
||||
<a href="docs/README.ru.md">Хаб документации</a> |
|
||||
<a href="docs/SUMMARY.md">TOC docs</a>
|
||||
@@ -218,104 +218,6 @@ zeroclaw agent --provider openai-codex --auth-profile openai-codex:work -m "hell
|
||||
zeroclaw agent --provider anthropic -m "hello"
|
||||
```
|
||||
|
||||
## Архитектура
|
||||
|
||||
Каждая подсистема — это **Trait**: меняйте реализации через конфигурацию, без изменения кода.
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/assets/architecture.svg" alt="Архитектура ZeroClaw" width="900" />
|
||||
</p>
|
||||
|
||||
| Подсистема | Trait | Встроенные реализации | Расширение |
|
||||
|-----------|-------|---------------------|------------|
|
||||
| **AI-модели** | `Provider` | Каталог через `zeroclaw providers` (сейчас 28 встроенных + алиасы, плюс пользовательские endpoint) | `custom:https://your-api.com` (OpenAI-совместимый) или `anthropic-custom:https://your-api.com` |
|
||||
| **Каналы** | `Channel` | CLI, Telegram, Discord, Slack, Mattermost, iMessage, Matrix, Signal, WhatsApp, Linq, Email, IRC, Lark, DingTalk, QQ, Webhook | Любой messaging API |
|
||||
| **Память** | `Memory` | SQLite гибридный поиск, PostgreSQL-бэкенд, Lucid-мост, Markdown-файлы, явный `none`-бэкенд, snapshot/hydrate, опциональный кэш ответов | Любой persistence-бэкенд |
|
||||
| **Инструменты** | `Tool` | shell/file/memory, cron/schedule, git, pushover, browser, http_request, screenshot/image_info, composio (opt-in), delegate, аппаратные инструменты | Любая функциональность |
|
||||
| **Наблюдаемость** | `Observer` | Noop, Log, Multi | Prometheus, OTel |
|
||||
| **Runtime** | `RuntimeAdapter` | Native, Docker (sandbox) | Через adapter; неподдерживаемые kind завершаются с ошибкой |
|
||||
| **Безопасность** | `SecurityPolicy` | Gateway pairing, sandbox, allowlist, rate limits, scoping файловой системы, шифрование секретов | — |
|
||||
| **Идентификация** | `IdentityConfig` | OpenClaw (markdown), AIEOS v1.1 (JSON) | Любой формат идентификации |
|
||||
| **Туннели** | `Tunnel` | None, Cloudflare, Tailscale, ngrok, Custom | Любой tunnel-бинарник |
|
||||
| **Heartbeat** | Engine | HEARTBEAT.md — периодические задачи | — |
|
||||
| **Навыки** | Loader | TOML-манифесты + SKILL.md-инструкции | Пакеты навыков сообщества |
|
||||
| **Интеграции** | Registry | 70+ интеграций в 9 категориях | Плагинная система |
|
||||
|
||||
### Поддержка runtime (текущая)
|
||||
|
||||
- ✅ Поддерживается сейчас: `runtime.kind = "native"` или `runtime.kind = "docker"`
|
||||
- 🚧 Запланировано, но ещё не реализовано: WASM / edge-runtime
|
||||
|
||||
При указании неподдерживаемого `runtime.kind` ZeroClaw завершается с явной ошибкой, а не молча откатывается к native.
|
||||
|
||||
### Система памяти (полнофункциональный поисковый движок)
|
||||
|
||||
Полностью собственная реализация, ноль внешних зависимостей — без Pinecone, Elasticsearch, LangChain:
|
||||
|
||||
| Уровень | Реализация |
|
||||
|---------|-----------|
|
||||
| **Векторная БД** | Embeddings хранятся как BLOB в SQLite, поиск по косинусному сходству |
|
||||
| **Поиск по ключевым словам** | Виртуальные таблицы FTS5 со скорингом BM25 |
|
||||
| **Гибридное слияние** | Пользовательская взвешенная функция слияния (`vector.rs`) |
|
||||
| **Embeddings** | Trait `EmbeddingProvider` — OpenAI, пользовательский URL или noop |
|
||||
| **Чанкинг** | Построчный Markdown-чанкер с сохранением заголовков |
|
||||
| **Кэширование** | Таблица `embedding_cache` в SQLite с LRU-вытеснением |
|
||||
| **Безопасная переиндексация** | Атомарная перестройка FTS5 + повторное встраивание отсутствующих векторов |
|
||||
|
||||
Agent автоматически вспоминает, сохраняет и управляет памятью через инструменты.
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
backend = "sqlite" # "sqlite", "lucid", "postgres", "markdown", "none"
|
||||
auto_save = true
|
||||
embedding_provider = "none" # "none", "openai", "custom:https://..."
|
||||
vector_weight = 0.7
|
||||
keyword_weight = 0.3
|
||||
```
|
||||
|
||||
## Важные security-дефолты
|
||||
|
||||
- Gateway по умолчанию: `127.0.0.1:42617`
|
||||
- Pairing обязателен по умолчанию: `require_pairing = true`
|
||||
- Публичный bind запрещён по умолчанию: `allow_public_bind = false`
|
||||
- Семантика allowlist каналов:
|
||||
- `[]` => deny-by-default
|
||||
- `["*"]` => allow all (используйте осознанно)
|
||||
|
||||
## Пример конфигурации
|
||||
|
||||
```toml
|
||||
api_key = "sk-..."
|
||||
default_provider = "openrouter"
|
||||
default_model = "anthropic/claude-sonnet-4-6"
|
||||
default_temperature = 0.7
|
||||
|
||||
[memory]
|
||||
backend = "sqlite"
|
||||
auto_save = true
|
||||
embedding_provider = "none"
|
||||
|
||||
[gateway]
|
||||
host = "127.0.0.1"
|
||||
port = 42617
|
||||
require_pairing = true
|
||||
allow_public_bind = false
|
||||
```
|
||||
|
||||
## Навигация по документации
|
||||
|
||||
- Хаб документации (English): [`docs/README.md`](docs/README.md)
|
||||
- Единый TOC docs: [`docs/SUMMARY.md`](docs/SUMMARY.md)
|
||||
- Хаб документации (Русский): [`docs/README.ru.md`](docs/README.ru.md)
|
||||
- Справочник команд: [`docs/reference/cli/commands-reference.md`](docs/reference/cli/commands-reference.md)
|
||||
- Справочник конфигурации: [`docs/reference/api/config-reference.md`](docs/reference/api/config-reference.md)
|
||||
- Справочник providers: [`docs/reference/api/providers-reference.md`](docs/reference/api/providers-reference.md)
|
||||
- Справочник channels: [`docs/reference/api/channels-reference.md`](docs/reference/api/channels-reference.md)
|
||||
- Операционный runbook: [`docs/ops/operations-runbook.md`](docs/ops/operations-runbook.md)
|
||||
- Устранение неполадок: [`docs/ops/troubleshooting.md`](docs/ops/troubleshooting.md)
|
||||
- Инвентарь и классификация docs: [`docs/maintainers/docs-inventory.md`](docs/maintainers/docs-inventory.md)
|
||||
- Снимок triage проекта: [`docs/maintainers/project-triage-snapshot-2026-02-18.md`](docs/maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Вклад и лицензия
|
||||
|
||||
- Contribution guide: [`CONTRIBUTING.md`](CONTRIBUTING.md)
|
||||
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # Nagpapakita ng version at build info
|
||||
|
||||
Tingnan ang [Commands Reference](docs/commands-reference.md) para sa buong options at examples.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Channels (trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Custom │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Agent Orchestrator │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Message │ │ Context │ │ Tool │ │
|
||||
│ │ Routing │ │ Memory │ │ Execution │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Providers │ │ Memory │ │ Tools │
|
||||
│ (trait) │ │ (trait) │ │ (trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ None │ │ Web Fetch │
|
||||
│ Ollama │ │ Custom │ │ Custom │
|
||||
│ Custom │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Runtime (trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Mga pangunahing prinsipyo:**
|
||||
|
||||
- Ang lahat ay isang **trait** — providers, channels, tools, memory, tunnels
|
||||
- Ang mga channel ay tumatawag sa orchestrator; ang orchestrator ay tumatawag sa providers + tools
|
||||
- Ang memory system ay nagmamaneho ng conversation context (markdown, SQLite, o none)
|
||||
- Ang runtime ay nag-a-abstract ng code execution (native o Docker)
|
||||
- Walang provider lock-in — i-swap ang Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama nang walang code changes
|
||||
|
||||
Tingnan ang [architecture documentation](docs/architecture.svg) para sa mga detalyadong diagram at implementation details.
|
||||
|
||||
## Mga Halimbawa
|
||||
|
||||
### Telegram Bot
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Ang iyong Telegram user ID
|
||||
```
|
||||
|
||||
Simulan ang daemon + agent, pagkatapos ay magpadala ng mensahe sa iyong bot sa Telegram:
|
||||
|
||||
```
|
||||
/start
|
||||
Hello! Could you help me write a Python script?
|
||||
```
|
||||
|
||||
Ang bot ay tumutugon gamit ang AI-generated code, nagpapatupad ng mga tool kung hiniling, at nagpapanatili ng conversation context.
|
||||
|
||||
### Matrix (end-to-end encryption)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Imbitahan ang `@zeroclaw:matrix.org` sa isang encrypted room, at ang bot ay tutugon gamit ang full encryption. Tingnan ang [Matrix E2EE Guide](docs/matrix-e2ee-guide.md) para sa device verification setup.
|
||||
|
||||
### Multi-Provider
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Failover on provider error
|
||||
```
|
||||
|
||||
Kung ang Anthropic ay mabigo o ma-rate-limit, ang orchestrator ay awtomatikong mag-failover sa OpenAI.
|
||||
|
||||
### Custom Memory
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # Automatic purge after 90 days
|
||||
```
|
||||
|
||||
O gamitin ang Markdown para sa human-readable storage:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Tingnan ang [Configuration Reference](docs/config-reference.md#memory) para sa lahat ng memory options.
|
||||
|
||||
## Provider Support
|
||||
|
||||
| Provider | Status | API Key | Example Models |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Stable | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Stable | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Stable | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Stable | N/A (local) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Stable | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Stable | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Planned | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Planned | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Custom Endpoints
|
||||
|
||||
Sinusuportahan ng ZeroClaw ang OpenAI-compatible endpoints:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Halimbawa: gamitin ang [LiteLLM](https://github.com/BerriAI/litellm) bilang proxy para ma-access ang anumang LLM sa pamamagitan ng OpenAI interface.
|
||||
|
||||
Tingnan ang [Providers Reference](docs/providers-reference.md) para sa kumpletong configuration details.
|
||||
|
||||
## Channel Support
|
||||
|
||||
| Channel | Status | Authentication | Notes |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Stable | Bot Token | Full support including files, images, inline buttons |
|
||||
| **Matrix** | ✅ Stable | Password or Token | E2EE support with device verification |
|
||||
| **Slack** | 🚧 Planned | OAuth or Bot Token | Requires workspace access |
|
||||
| **Discord** | 🚧 Planned | Bot Token | Requires guild permissions |
|
||||
| **WhatsApp** | 🚧 Planned | Twilio or official API | Requires business account |
|
||||
| **CLI** | ✅ Stable | None | Direct conversational interface |
|
||||
| **Web** | 🚧 Planned | API Key or OAuth | Browser-based chat interface |
|
||||
|
||||
Tingnan ang [Channels Reference](docs/channels-reference.md) para sa kumpletong configuration instructions.
|
||||
|
||||
## Tool Support
|
||||
|
||||
Nagbibigay ang ZeroClaw ng built-in tools para sa code execution, filesystem access, at web retrieval:
|
||||
|
||||
| Tool | Description | Required Runtime |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Executes shell commands | Native or Docker |
|
||||
| **python** | Executes Python scripts | Python 3.8+ (native) or Docker |
|
||||
| **javascript** | Executes Node.js code | Node.js 18+ (native) or Docker |
|
||||
| **filesystem_read** | Reads files | Native or Docker |
|
||||
| **filesystem_write** | Writes files | Native or Docker |
|
||||
| **web_fetch** | Fetches web content | Native or Docker |
|
||||
|
||||
### Execution Security
|
||||
|
||||
- **Native Runtime** — runs as daemon's user process, full filesystem access
|
||||
- **Docker Runtime** — full container isolation, separate filesystems and networks
|
||||
|
||||
I-configure ang execution policy sa `config.toml`:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Explicit allowlist
|
||||
```
|
||||
|
||||
Tingnan ang [Configuration Reference](docs/config-reference.md#runtime) para sa kumpletong security options.
|
||||
|
||||
## Deployment
|
||||
|
||||
### Local Deployment (Development)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Server Deployment (Production)
|
||||
|
||||
Gamitin ang systemd para mamaneho ang daemon at agent bilang services:
|
||||
|
||||
```bash
|
||||
# I-install ang binary
|
||||
cargo install --path . --locked
|
||||
|
||||
# I-configure ang workspace
|
||||
zeroclaw init
|
||||
|
||||
# Gumawa ng systemd service files
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# I-enable at i-start ang services
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# I-verify ang status
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Tingnan ang [Network Deployment Guide](docs/network-deployment.md) para sa kumpletong production deployment instructions.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# I-build ang image
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# I-run ang container
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Tingnan ang [`Dockerfile`](Dockerfile) para sa build details at configuration options.
|
||||
|
||||
### Edge Hardware
|
||||
|
||||
Ang ZeroClaw ay dinisenyo para tumakbo sa low-power hardware:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, single ARMv8 core, < $5 hardware cost
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, multi-core, ideal for concurrent workloads
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, quad-core ARMv8, ultra-low cost
|
||||
- **x86 SBCs (Intel N100)** — 4-8 GB RAM, fast builds, native Docker support
|
||||
|
||||
Tingnan ang [Hardware Guide](docs/hardware/README.md) para sa device-specific setup instructions.
|
||||
|
||||
## Tunneling (Public Exposure)
|
||||
|
||||
I-expose ang iyong local ZeroClaw daemon sa public network sa pamamagitan ng secure tunnels:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Mga supported tunnel provider:
|
||||
|
||||
- **Cloudflare Tunnel** — free HTTPS, no port exposure, multi-domain support
|
||||
- **Ngrok** — quick setup, custom domains (paid plan)
|
||||
- **Tailscale** — private mesh network, no public port
|
||||
|
||||
Tingnan ang [Configuration Reference](docs/config-reference.md#tunnel) para sa kumpletong configuration options.
|
||||
|
||||
## Security
|
||||
|
||||
Nagpapatupad ang ZeroClaw ng maraming layer ng security:
|
||||
|
||||
### Pairing
|
||||
|
||||
Ang daemon ay nag-generate ng pairing secret sa unang launch na nakaimbak sa `~/.zeroclaw/workspace/.pairing`. Ang mga client (agent, CLI) ay dapat mag-present ng secret na ito para kumonekta.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Gagawa ng bagong secret at i-invalidate ang dati
|
||||
```
|
||||
|
||||
### Sandboxing
|
||||
|
||||
- **Docker Runtime** — full container isolation na may separate filesystems at networks
|
||||
- **Native Runtime** — runs as user process, scoped sa workspace by default
|
||||
|
||||
### Allowlists
|
||||
|
||||
Ang mga channel ay maaaring mag-limit ng access by user ID:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Explicit allowlist
|
||||
```
|
||||
|
||||
### Encryption
|
||||
|
||||
- **Matrix E2EE** — full end-to-end encryption with device verification
|
||||
- **TLS Transport** — all API and tunnel traffic uses HTTPS/TLS
|
||||
|
||||
Tingnan ang [Security Documentation](docs/security/README.md) para sa kumpletong policies at practices.
|
||||
|
||||
## Observability
|
||||
|
||||
Ang ZeroClaw ay naglo-log sa `~/.zeroclaw/workspace/logs/` by default. Ang mga log ay nakaimbak by component:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Daemon logs (startup, API requests, errors)
|
||||
├── agent.log # Agent logs (message routing, tool execution)
|
||||
├── telegram.log # Channel-specific logs (if enabled)
|
||||
└── matrix.log # Channel-specific logs (if enabled)
|
||||
```
|
||||
|
||||
### Logging Configuration
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # daily, hourly, size
|
||||
max_size_mb = 100 # For size-based rotation
|
||||
retention_days = 30 # Automatic purge after N days
|
||||
```
|
||||
|
||||
Tingnan ang [Configuration Reference](docs/config-reference.md#logging) para sa lahat ng logging options.
|
||||
|
||||
### Metrics (Planned)
|
||||
|
||||
Prometheus metrics support para sa production monitoring ay coming soon. Tracking sa [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234).
|
||||
|
||||
## Skills
|
||||
|
||||
Sinusuportahan ng ZeroClaw ang custom skills — reusable modules na nag-e-extend sa system capabilities.
|
||||
|
||||
### Skill Definition
|
||||
|
||||
Ang mga skill ay nakaimbak sa `~/.zeroclaw/workspace/skills/<skill-name>/` na may ganitong structure:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # Skill metadata (name, description, dependencies)
|
||||
├── prompt.md # System prompt for the AI
|
||||
└── tools/ # Optional custom tools
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### Skill Example
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "Searches the web and summarizes results"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
You are a research assistant. When asked to research something:
|
||||
|
||||
1. Use web_fetch to retrieve content
|
||||
2. Summarize results in an easy-to-read format
|
||||
3. Cite sources with URLs
|
||||
```
|
||||
|
||||
### Skill Usage
|
||||
|
||||
Ang mga skill ay automatically loaded sa agent startup. I-reference ang mga ito by name sa conversations:
|
||||
|
||||
```
|
||||
User: Use the web-research skill to find the latest AI news
|
||||
Bot: [loads web-research skill, executes web_fetch, summarizes results]
|
||||
```
|
||||
|
||||
Tingnan ang [Skills](#skills) section para sa kumpletong skill creation instructions.
|
||||
|
||||
## Open Skills
|
||||
|
||||
Sinusuportahan ng ZeroClaw ang [Open Skills](https://github.com/openagents-com/open-skills) — isang modular at provider-agnostic system para sa pag-extend sa AI agent capabilities.
|
||||
|
||||
### Enable Open Skills
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # optional
|
||||
```
|
||||
|
||||
Maaari mo ring i-override sa runtime gamit ang `ZEROCLAW_OPEN_SKILLS_ENABLED` at `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
cargo build # Dev build
|
||||
cargo build --release # Release build (codegen-units=1, works on all devices including Raspberry Pi)
|
||||
cargo build --profile release-fast # Faster build (codegen-units=8, requires 16 GB+ RAM)
|
||||
cargo test # Run full test suite
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Format
|
||||
|
||||
# Run SQLite vs Markdown comparison benchmark
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Pre-push hook
|
||||
|
||||
Ang isang git hook ay nagpapatakbo ng `cargo fmt --check`, `cargo clippy -- -D warnings`, at `cargo test` bago ang bawat push. I-enable ito nang isang beses:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Build Troubleshooting (OpenSSL errors on Linux)
|
||||
|
||||
Kung makakita ka ng `openssl-sys` build error, i-sync ang dependencies at i-recompile gamit ang repository's lockfile:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
Ang ZeroClaw ay naka-configure na gumamit ng `rustls` para sa HTTP/TLS dependencies; ang `--locked` ay nagpapanatili sa transitive graph na deterministic sa clean environments.
|
||||
|
||||
Para i-skip ang hook kapag kailangan mo ng quick push habang nagde-develop:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Collaboration & Docs
|
||||
|
||||
Magsimula sa documentation hub para sa task-based map:
|
||||
|
||||
-437
@@ -363,443 +363,6 @@ zeroclaw version # Sürüm ve derleme bilgilerini gösterir
|
||||
|
||||
Tam seçenekler ve örnekler için [Komutlar Referansına](docs/commands-reference.md) bakın.
|
||||
|
||||
## Mimari
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Kanallar (trait) │
|
||||
│ Telegram │ Matrix │ Slack │ Discord │ Web │ CLI │ Özel │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Ajan Orkestratörü │
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Mesaj │ │ Bağlam │ │ Araç │ │
|
||||
│ │ Yönlendirme│ │ Bellek │ │ Yürütme │ │
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
└─────────────────────────┬───────────────────────────────────────┘
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||
│ Sağlayıcılar│ │ Bellek │ │ Araçlar │
|
||||
│ (trait) │ │ (trait) │ │ (trait) │
|
||||
├──────────────┤ ├──────────────┤ ├──────────────┤
|
||||
│ Anthropic │ │ Markdown │ │ Filesystem │
|
||||
│ OpenAI │ │ SQLite │ │ Bash │
|
||||
│ Gemini │ │ Yok │ │ Web Fetch │
|
||||
│ Ollama │ │ Özel │ │ Özel │
|
||||
│ Özel │ └──────────────┘ └──────────────┘
|
||||
└──────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Çalışma Zamanı (trait) │
|
||||
│ Native │ Docker │
|
||||
└─────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Temel ilkeler:**
|
||||
|
||||
- Her şey bir **trait'tir** — sağlayıcılar, kanallar, araçlar, bellek, tüneller
|
||||
- Kanallar orkestratörü çağırır; orkestratör sağlayıcıları + araçları çağırır
|
||||
- Bellek sistemi konuşma bağlamını yönetir (markdown, SQLite veya yok)
|
||||
- Çalışma zamanı kod yürütmeyi soyutlar (yerel veya Docker)
|
||||
- Satıcı kilitlenmesi yok — kod değişikliği olmadan Anthropic ↔ OpenAI ↔ Gemini ↔ Ollama değiştirin
|
||||
|
||||
Detaylı diyagramlar ve uygulama detayları için [mimari belgelerine](docs/architecture.svg) bakın.
|
||||
|
||||
## Örnekler
|
||||
|
||||
### Telegram Bot
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
bot_token = "123456:ABC-DEF..."
|
||||
allowed_users = [987654321] # Telegram kullanıcı ID'niz
|
||||
```
|
||||
|
||||
Arka plan programını + ajanı başlatın, ardından Telegram'da botunuza bir mesaj gönderin:
|
||||
|
||||
```
|
||||
/start
|
||||
Merhaba! Bir Python betiği yazmama yardımcı olabilir misin?
|
||||
```
|
||||
|
||||
Bot, AI tarafından oluşturulan kodla yanıt verir, istenirse araçları yürütür ve konuşma bağlamını korur.
|
||||
|
||||
### Matrix (uçtan uca şifreleme)
|
||||
|
||||
```toml
|
||||
[channels.matrix]
|
||||
enabled = true
|
||||
homeserver_url = "https://matrix.org"
|
||||
username = "@zeroclaw:matrix.org"
|
||||
password = "..."
|
||||
device_name = "zeroclaw-prod"
|
||||
e2ee_enabled = true
|
||||
```
|
||||
|
||||
Şifreli bir odaya `@zeroclaw:matrix.org` davet edin ve bot tam şifrelemeyle yanıt verecektir. Cihaz doğrulama kurulumu için [Matrix E2EE Kılavuzuna](docs/matrix-e2ee-guide.md) bakın.
|
||||
|
||||
### Çoklu-Sağlayıcı
|
||||
|
||||
```toml
|
||||
[providers.anthropic]
|
||||
enabled = true
|
||||
api_key = "sk-ant-..."
|
||||
model = "claude-sonnet-4-20250514"
|
||||
|
||||
[providers.openai]
|
||||
enabled = true
|
||||
api_key = "sk-..."
|
||||
model = "gpt-4o"
|
||||
|
||||
[orchestrator]
|
||||
default_provider = "anthropic"
|
||||
fallback_providers = ["openai"] # Sağlayıcı hatasında geçiş
|
||||
```
|
||||
|
||||
Anthropic başarısız olursa veya hız sınırına ulaşırsa, orkestratör otomatik olarak OpenAI'ya geçer.
|
||||
|
||||
### Özel Bellek
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "sqlite"
|
||||
path = "~/.zeroclaw/workspace/memory/conversations.db"
|
||||
retention_days = 90 # 90 gün sonra otomatik temizleme
|
||||
```
|
||||
|
||||
Veya insan tarafından okunabilir depolama için Markdown kullanın:
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
kind = "markdown"
|
||||
path = "~/.zeroclaw/workspace/memory/"
|
||||
```
|
||||
|
||||
Tüm bellek seçenekleri için [Yapılandırma Referansına](docs/config-reference.md#memory) bakın.
|
||||
|
||||
## Sağlayıcı Desteği
|
||||
|
||||
| Sağlayıcı | Durum | API Anahtarı | Örnek Modeller |
|
||||
| ----------------- | ----------- | ------------------- | ---------------------------------------------------- |
|
||||
| **Anthropic** | ✅ Kararlı | `ANTHROPIC_API_KEY` | `claude-sonnet-4-20250514`, `claude-opus-4-20250514` |
|
||||
| **OpenAI** | ✅ Kararlı | `OPENAI_API_KEY` | `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini` |
|
||||
| **Google Gemini** | ✅ Kararlı | `GOOGLE_API_KEY` | `gemini-2.0-flash-exp`, `gemini-exp-1206` |
|
||||
| **Ollama** | ✅ Kararlı | Yok (yerel) | `llama3.3`, `qwen2.5`, `phi4` |
|
||||
| **Cerebras** | ✅ Kararlı | `CEREBRAS_API_KEY` | `llama-3.3-70b` |
|
||||
| **Groq** | ✅ Kararlı | `GROQ_API_KEY` | `llama-3.3-70b-versatile` |
|
||||
| **Mistral** | 🚧 Planlanan | `MISTRAL_API_KEY` | TBD |
|
||||
| **Cohere** | 🚧 Planlanan | `COHERE_API_KEY` | TBD |
|
||||
|
||||
### Özel Uç Noktalar
|
||||
|
||||
ZeroClaw, OpenAI uyumlu uç noktaları destekler:
|
||||
|
||||
```toml
|
||||
[providers.custom]
|
||||
enabled = true
|
||||
api_key = "..."
|
||||
base_url = "https://api.your-llm-provider.com/v1"
|
||||
model = "your-model-name"
|
||||
```
|
||||
|
||||
Örnek: herhangi bir LLM'ye OpenAI arayüzü üzerinden erişmek için [LiteLLM](https://github.com/BerriAI/litellm)'i proxy olarak kullanın.
|
||||
|
||||
Tam yapılandırma detayları için [Sağlayıcı Referansına](docs/providers-reference.md) bakın.
|
||||
|
||||
## Kanal Desteği
|
||||
|
||||
| Kanal | Durum | Kimlik Doğrulama | Notlar |
|
||||
| ------------ | ----------- | ------------------------ | --------------------------------------------------------- |
|
||||
| **Telegram** | ✅ Kararlı | Bot Token | Dosyalar, resimler, satır içi düğmeler dahil tam destek |
|
||||
| **Matrix** | ✅ Kararlı | Şifre veya Token | Cihaz doğrulamalı E2EE desteği |
|
||||
| **Slack** | 🚧 Planlanan | OAuth veya Bot Token | Çalışma alanı erişimi gerektirir |
|
||||
| **Discord** | 🚧 Planlanan | Bot Token | Guild izinleri gerektirir |
|
||||
| **WhatsApp** | 🚧 Planlanan | Twilio veya resmi API | İş hesabı gerektirir |
|
||||
| **CLI** | ✅ Kararlı | Yok | Doğrudan konuşma arayüzü |
|
||||
| **Web** | 🚧 Planlanan | API Anahtarı veya OAuth | Tarayıcı tabanlı sohbet arayüzü |
|
||||
|
||||
Tam yapılandırma talimatları için [Kanallar Referansına](docs/channels-reference.md) bakın.
|
||||
|
||||
## Araç Desteği
|
||||
|
||||
ZeroClaw, kod yürütme, dosya sistemi erişimi ve web alımı için yerleşik araçlar sağlar:
|
||||
|
||||
| Araç | Açıklama | Gerekli Çalışma Zamanı |
|
||||
| -------------------- | --------------------------- | ----------------------------- |
|
||||
| **bash** | Shell komutlarını yürüt | Yerel veya Docker |
|
||||
| **python** | Python betiklerini yürüt | Python 3.8+ (yerel) veya Docker |
|
||||
| **javascript** | Node.js kodunu yürüt | Node.js 18+ (yerel) veya Docker |
|
||||
| **filesystem_read** | Dosyaları oku | Yerel veya Docker |
|
||||
| **filesystem_write** | Dosyaları yaz | Yerel veya Docker |
|
||||
| **web_fetch** | Web içeriği al | Yerel veya Docker |
|
||||
|
||||
### Yürütme Güvenliği
|
||||
|
||||
- **Yerel Çalışma Zamanı** — arka plan programının kullanıcı süreci olarak çalışır, tam dosya sistemi erişimi
|
||||
- **Docker Çalışma Zamanı** — tam konteyner yalıtımı, ayrı dosya sistemleri ve ağlar
|
||||
|
||||
`config.toml` içinde yürütme ilkesini yapılandırın:
|
||||
|
||||
```toml
|
||||
[runtime]
|
||||
kind = "docker"
|
||||
allowed_tools = ["bash", "python", "filesystem_read"] # Açık izin listesi
|
||||
```
|
||||
|
||||
Tam güvenlik seçenekleri için [Yapılandırma Referansına](docs/config-reference.md#runtime) bakın.
|
||||
|
||||
## Dağıtım
|
||||
|
||||
### Yerel Dağıtım (Geliştirme)
|
||||
|
||||
```bash
|
||||
zeroclaw daemon start
|
||||
zeroclaw agent start
|
||||
```
|
||||
|
||||
### Sunucu Dağıtımı (Üretim)
|
||||
|
||||
Arka plan programını ve ajanı hizmet olarak yönetmek için systemd kullanın:
|
||||
|
||||
```bash
|
||||
# İkiliyi yükle
|
||||
cargo install --path . --locked
|
||||
|
||||
# Çalışma alanını yapılandır
|
||||
zeroclaw init
|
||||
|
||||
# systemd hizmet dosyaları oluştur
|
||||
sudo cp deployment/systemd/zeroclaw-daemon.service /etc/systemd/system/
|
||||
sudo cp deployment/systemd/zeroclaw-agent.service /etc/systemd/system/
|
||||
|
||||
# Hizmetleri etkinleştir ve başlat
|
||||
sudo systemctl enable zeroclaw-daemon zeroclaw-agent
|
||||
sudo systemctl start zeroclaw-daemon zeroclaw-agent
|
||||
|
||||
# Durumu doğrula
|
||||
sudo systemctl status zeroclaw-daemon
|
||||
sudo systemctl status zeroclaw-agent
|
||||
```
|
||||
|
||||
Tam üretim dağıtım talimatları için [Ağ Dağıtımı Kılavuzuna](docs/network-deployment.md) bakın.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# İmajı oluştur
|
||||
docker build -t zeroclaw:latest .
|
||||
|
||||
# Konteyneri çalıştır
|
||||
docker run -d \
|
||||
--name zeroclaw \
|
||||
-v ~/.zeroclaw/workspace:/workspace \
|
||||
-e ANTHROPIC_API_KEY=sk-ant-... \
|
||||
zeroclaw:latest
|
||||
```
|
||||
|
||||
Derleme detayları ve yapılandırma seçenekleri için [`Dockerfile`](Dockerfile)'a bakın.
|
||||
|
||||
### Uç Donanım
|
||||
|
||||
ZeroClaw, düşük güç tüketimli donanımda çalışmak üzere tasarlanmıştır:
|
||||
|
||||
- **Raspberry Pi Zero 2 W** — ~512 MB RAM, tek ARMv8 çekirdek, < $5 donanım maliyeti
|
||||
- **Raspberry Pi 4/5** — 1 GB+ RAM, çok çekirdekli, eşzamanlı iş yükleri için ideal
|
||||
- **Orange Pi Zero 2** — ~512 MB RAM, dört çekirdekli ARMv8, ultra düşük maliyet
|
||||
- **x86 SBC'ler (Intel N100)** — 4-8 GB RAM, hızlı derlemeler, yerel Docker desteği
|
||||
|
||||
Cihaza özgü kurulum talimatları için [Donanım Kılavuzuna](docs/hardware/README.md) bakın.
|
||||
|
||||
## Tünelleme (Herkese Açık Kullanım)
|
||||
|
||||
Yerel ZeroClaw arka plan programınızı güvenli tüneller aracılığıyla herkese açık ağa çıkarın:
|
||||
|
||||
```bash
|
||||
zeroclaw tunnel start --provider cloudflare
|
||||
```
|
||||
|
||||
Desteklenen tünel sağlayıcıları:
|
||||
|
||||
- **Cloudflare Tunnel** — ücretsiz HTTPS, port açığa çıkarma yok, çoklu etki alanı desteği
|
||||
- **Ngrok** — hızlı kurulum, özel etki alanları (ücretli plan)
|
||||
- **Tailscale** — özel mesh ağı. herkese açık port yok
|
||||
|
||||
Tam yapılandırma seçenekleri için [Yapılandırma Referansına](docs/config-reference.md#tunnel) bakın.
|
||||
|
||||
## Güvenlik
|
||||
|
||||
ZeroClaw birden çok güvenlik katmanı uygular:
|
||||
|
||||
### Eşleştirme
|
||||
|
||||
Arka plan programı ilk başlangıçta `~/.zeroclaw/workspace/.pairing` içinde saklanan bir eşleştirme sırrı oluşturur. İstemciler (ajan, CLI) bağlanmak için bu sırrı sunmalıdır.
|
||||
|
||||
```bash
|
||||
zeroclaw pairing rotate # Yeni bir sır oluşturur ve eskisini geçersiz kılar
|
||||
```
|
||||
|
||||
### Kum Alanı
|
||||
|
||||
- **Docker Çalışma Zamanı** — ayrı dosya sistemleri ve ağlarla tam konteyner yalıtımı
|
||||
- **Yerel Çalışma Zamanı** — kullanıcı süreci olarak çalışır; varsayılan olarak çalışma alanıyla sınırlıdır
|
||||
|
||||
### İzin Listeleri
|
||||
|
||||
Kanallar kullanıcı ID'sine göre erişimi kısıtlayabilir:
|
||||
|
||||
```toml
|
||||
[channels.telegram]
|
||||
enabled = true
|
||||
allowed_users = [123456789, 987654321] # Açık izin listesi
|
||||
```
|
||||
|
||||
### Şifreleme
|
||||
|
||||
- **Matrix E2EE** — cihaz doğrulamalı tam uçtan uca şifreleme
|
||||
- **TLS Taşıma** — tüm API ve tünel trafiği HTTPS/TLS kullanır
|
||||
|
||||
Tam ilkeler ve uygulamalar için [Güvenlik Belgelerine](docs/security/README.md) bakın.
|
||||
|
||||
## Gözlemlenebilirlik
|
||||
|
||||
ZeroClaw varsayılan olarak `~/.zeroclaw/workspace/logs/` dizinine log yazar. Loglar bileşene göre saklanır:
|
||||
|
||||
```
|
||||
~/.zeroclaw/workspace/logs/
|
||||
├── daemon.log # Arka plan programı logları (başlangıç, API istekleri, hatalar)
|
||||
├── agent.log # Ajan logları (mesaj yönlendirme, araç yürütme)
|
||||
├── telegram.log # Kanala özgü loglar (etkinse)
|
||||
└── matrix.log # Kanala özgü loglar (etkinse)
|
||||
```
|
||||
|
||||
### Loglama Yapılandırması
|
||||
|
||||
```toml
|
||||
[logging]
|
||||
level = "info" # debug, info, warn, error
|
||||
path = "~/.zeroclaw/workspace/logs/"
|
||||
rotation = "daily" # günlük, saatlik, boyut
|
||||
max_size_mb = 100 # Boyut tabanlı döndürme için
|
||||
retention_days = 30 # N gün sonra otomatik temizleme
|
||||
```
|
||||
|
||||
Tüm loglama seçenekleri için [Yapılandırma Referansına](docs/config-reference.md#logging) bakın.
|
||||
|
||||
### Metrikler (Planlanan)
|
||||
|
||||
Üretim izleme için Prometheus metrikleri desteği yakında geliyor. [#234](https://github.com/zeroclaw-labs/zeroclaw/issues/234) numaralı konuda takip ediliyor.
|
||||
|
||||
## Beceriler
|
||||
|
||||
ZeroClaw, sistem yeteneklerini genişleten yeniden kullanılabilir modüller olan özel becerileri destekler.
|
||||
|
||||
### Beceri Tanımı
|
||||
|
||||
Beceriler bu yapı ile `~/.zeroclaw/workspace/skills/<skill-name>/` içinde saklanır:
|
||||
|
||||
```
|
||||
skills/
|
||||
└── my-skill/
|
||||
├── skill.toml # Beceri metaverileri (ad, açıklama, bağımlılıklar)
|
||||
├── prompt.md # AI için sistem istemi
|
||||
└── tools/ # İsteğe bağlı özel araçlar
|
||||
└── my_tool.py
|
||||
```
|
||||
|
||||
### Beceri Örneği
|
||||
|
||||
```toml
|
||||
# skills/web-research/skill.toml
|
||||
[skill]
|
||||
name = "web-research"
|
||||
description = "Web'de arama yapar ve sonuçları özetler"
|
||||
version = "1.0.0"
|
||||
|
||||
[dependencies]
|
||||
tools = ["web_fetch", "bash"]
|
||||
```
|
||||
|
||||
```markdown
|
||||
<!-- skills/web-research/prompt.md -->
|
||||
|
||||
Sen bir araştırma asistanısın. Bir şeyi araştırmam istendiğinde:
|
||||
|
||||
1. İçeriği almak için web_fetch kullan
|
||||
2. Sonuçları okunması kolay bir biçimde özetle
|
||||
3. Kaynakları URL'lerle göster
|
||||
```
|
||||
|
||||
### Beceri Kullanımı
|
||||
|
||||
Beceriler ajan başlangıcında otomatik olarak yüklenir. Konuşmalarda ada göre başvurun:
|
||||
|
||||
```
|
||||
Kullanıcı: En son AI haberlerini bulmak için web-research becerisini kullan
|
||||
Bot: [web-research becerisini yükler, web_fetch'i yürütür, sonuçları özetler]
|
||||
```
|
||||
|
||||
Tam beceri oluşturma talimatları için [Beceriler](#beceriler) bölümüne bakın.
|
||||
|
||||
## Open Skills
|
||||
|
||||
ZeroClaw, AI ajan yeteneklerini genişletmek için modüler ve sağlayıcıdan bağımsız bir sistem olan [Open Skills](https://github.com/openagents-com/open-skills)'i destekler.
|
||||
|
||||
### Open Skills'i Etkinleştir
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # isteğe bağlı
|
||||
```
|
||||
|
||||
Ayrıca `ZEROCLAW_OPEN_SKILLS_ENABLED` ve `ZEROCLAW_OPEN_SKILLS_DIR` ile çalışma zamanında geçersiz kılabilirsiniz.
|
||||
|
||||
## Geliştirme
|
||||
|
||||
```bash
|
||||
cargo build # Geliştirme derlemesi
|
||||
cargo build --release # Sürüm derlemesi (codegen-units=1, Raspberry Pi dahil tüm cihazlarda çalışır)
|
||||
cargo build --profile release-fast # Daha hızlı derleme (codegen-units=8, 16 GB+ RAM gerektirir)
|
||||
cargo test # Tam test paketini çalıştır
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Biçimlendir
|
||||
|
||||
# SQLite vs Markdown karşılaştırma kıyaslamasını çalıştır
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Ön push kancası
|
||||
|
||||
Bir git kancası her push'tan önce `cargo fmt --check`, `cargo clippy -- -D warnings` ve `cargo test` çalıştırır. Bir kez etkinleştirin:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Derleme Sorun Giderme (Linux'ta OpenSSL hataları)
|
||||
|
||||
Bir `openssl-sys` derleme hatasıyla karşılaşırsanız, bağımlılıkları eşzamanlayın ve deponun lockfile'ı ile yeniden derleyin:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw, HTTP/TLS bağımlılıkları için `rustls` kullanacak şekilde yapılandırılmıştır; `--locked`, geçişli grafiği temiz ortamlarda deterministik tutar.
|
||||
|
||||
Geliştirme sırasında hızlı bir push'a ihtiyacınız olduğunda kancayı atlamak için:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## İşbirliği ve Belgeler
|
||||
|
||||
Görev tabanlı bir harita için belge merkeziyle başlayın:
|
||||
|
||||
+1
-571
@@ -58,7 +58,7 @@
|
||||
|
||||
<p align="center">
|
||||
<a href="#quick-start">Bắt đầu</a> |
|
||||
<a href="install.sh">Cài đặt một lần bấm</a> |
|
||||
<a href="https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh">Cài đặt một lần bấm</a> |
|
||||
<a href="docs/i18n/vi/README.md">Trung tâm tài liệu</a> |
|
||||
<a href="docs/SUMMARY.md">Mục lục tài liệu</a>
|
||||
</p>
|
||||
@@ -406,576 +406,6 @@ zeroclaw agent --provider openai-codex --auth-profile openai-codex:work -m "hell
|
||||
zeroclaw agent --provider anthropic -m "hello"
|
||||
```
|
||||
|
||||
## Kiến trúc
|
||||
|
||||
Mọi hệ thống con đều là **trait** — chỉ cần đổi cấu hình, không cần sửa code.
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/assets/architecture.svg" alt="ZeroClaw Architecture" width="900" />
|
||||
</p>
|
||||
|
||||
| Hệ thống con | Trait | Đi kèm sẵn | Mở rộng |
|
||||
|-----------|-------|------------|--------|
|
||||
| **Mô hình AI** | `Provider` | Danh mục provider qua `zeroclaw providers` (hiện có 28 built-in + alias, cộng endpoint tùy chỉnh) | `custom:https://your-api.com` (tương thích OpenAI) hoặc `anthropic-custom:https://your-api.com` |
|
||||
| **Channel** | `Channel` | CLI, Telegram, Discord, Slack, Mattermost, iMessage, Matrix, Signal, WhatsApp, Linq, Email, IRC, Lark, DingTalk, QQ, Webhook | Bất kỳ messaging API nào |
|
||||
| **Memory** | `Memory` | SQLite hybrid search, PostgreSQL backend (storage provider có thể cấu hình), Lucid bridge, Markdown files, backend `none` tường minh, snapshot/hydrate, response cache tùy chọn | Bất kỳ persistence backend nào |
|
||||
| **Tool** | `Tool` | shell/file/memory, cron/schedule, git, pushover, browser, http_request, screenshot/image_info, composio (opt-in), delegate, hardware tools | Bất kỳ khả năng nào |
|
||||
| **Observability** | `Observer` | Noop, Log, Multi | Prometheus, OTel |
|
||||
| **Runtime** | `RuntimeAdapter` | Native, Docker (sandboxed) | Có thể thêm runtime bổ sung qua adapter; các kind không được hỗ trợ sẽ fail nhanh |
|
||||
| **Bảo mật** | `SecurityPolicy` | Ghép cặp gateway, sandbox, allowlist, giới hạn tốc độ, phân vùng filesystem, secret mã hóa | — |
|
||||
| **Định danh** | `IdentityConfig` | OpenClaw (markdown), AIEOS v1.1 (JSON) | Bất kỳ định dạng định danh nào |
|
||||
| **Tunnel** | `Tunnel` | None, Cloudflare, Tailscale, ngrok, Custom | Bất kỳ tunnel binary nào |
|
||||
| **Heartbeat** | Engine | Tác vụ định kỳ HEARTBEAT.md | — |
|
||||
| **Skill** | Loader | TOML manifest + hướng dẫn SKILL.md | Community skill pack |
|
||||
| **Tích hợp** | Registry | 70+ tích hợp trong 9 danh mục | Plugin system |
|
||||
|
||||
### Hỗ trợ runtime (hiện tại)
|
||||
|
||||
- ✅ Được hỗ trợ hiện nay: `runtime.kind = "native"` hoặc `runtime.kind = "docker"`
|
||||
- 🚧 Đã lên kế hoạch, chưa triển khai: WASM / edge runtime
|
||||
|
||||
Khi cấu hình `runtime.kind` không được hỗ trợ, ZeroClaw sẽ thoát với thông báo lỗi rõ ràng thay vì âm thầm fallback về native.
|
||||
|
||||
### Hệ thống Memory (Search Engine toàn diện)
|
||||
|
||||
Tự phát triển hoàn toàn, không phụ thuộc bên ngoài — không Pinecone, không Elasticsearch, không LangChain:
|
||||
|
||||
| Lớp | Triển khai |
|
||||
|-------|---------------|
|
||||
| **Vector DB** | Embeddings lưu dưới dạng BLOB trong SQLite, tìm kiếm cosine similarity |
|
||||
| **Keyword Search** | Bảng ảo FTS5 với BM25 scoring |
|
||||
| **Hybrid Merge** | Hàm merge có trọng số tùy chỉnh (`vector.rs`) |
|
||||
| **Embeddings** | Trait `EmbeddingProvider` — OpenAI, URL tùy chỉnh, hoặc noop |
|
||||
| **Chunking** | Bộ chia đoạn markdown theo dòng, giữ nguyên heading |
|
||||
| **Caching** | Bảng SQLite `embedding_cache` với LRU eviction |
|
||||
| **Safe Reindex** | Rebuild FTS5 + re-embed các vector bị thiếu theo cách nguyên tử |
|
||||
|
||||
Agent tự động ghi nhớ, lưu trữ và quản lý memory qua các tool.
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
backend = "sqlite" # "sqlite", "lucid", "postgres", "markdown", "none"
|
||||
auto_save = true
|
||||
embedding_provider = "none" # "none", "openai", "custom:https://..."
|
||||
vector_weight = 0.7
|
||||
keyword_weight = 0.3
|
||||
|
||||
# backend = "none" sử dụng no-op memory backend tường minh (không có persistence)
|
||||
|
||||
# Tùy chọn: ghi đè storage-provider cho remote memory backend.
|
||||
# Khi provider = "postgres", ZeroClaw dùng PostgreSQL để lưu memory.
|
||||
# Khóa db_url cũng chấp nhận alias `dbURL` để tương thích ngược.
|
||||
#
|
||||
# [storage.provider.config]
|
||||
# provider = "postgres"
|
||||
# db_url = "postgres://user:password@host:5432/zeroclaw"
|
||||
# schema = "public"
|
||||
# table = "memories"
|
||||
# connect_timeout_secs = 15
|
||||
|
||||
# Tùy chọn cho backend = "sqlite": số giây tối đa chờ khi mở DB (ví dụ: file bị khóa). Bỏ qua hoặc để trống để không có timeout.
|
||||
# sqlite_open_timeout_secs = 30
|
||||
|
||||
# Tùy chọn cho backend = "lucid"
|
||||
# ZEROCLAW_LUCID_CMD=/usr/local/bin/lucid # mặc định: lucid
|
||||
# ZEROCLAW_LUCID_BUDGET=200 # mặc định: 200
|
||||
# ZEROCLAW_LUCID_LOCAL_HIT_THRESHOLD=3 # số lần hit cục bộ để bỏ qua external recall
|
||||
# ZEROCLAW_LUCID_RECALL_TIMEOUT_MS=120 # giới hạn thời gian cho lucid context recall
|
||||
# ZEROCLAW_LUCID_STORE_TIMEOUT_MS=800 # timeout đồng bộ async cho lucid store
|
||||
# ZEROCLAW_LUCID_FAILURE_COOLDOWN_MS=15000 # thời gian nghỉ sau lỗi lucid, tránh thử lại liên tục
|
||||
```
|
||||
|
||||
## Bảo mật
|
||||
|
||||
ZeroClaw thực thi bảo mật ở **mọi lớp** — không chỉ sandbox. Đáp ứng tất cả các hạng mục trong danh sách kiểm tra bảo mật của cộng đồng.
|
||||
|
||||
### Danh sách kiểm tra bảo mật
|
||||
|
||||
| # | Hạng mục | Trạng thái | Cách thực hiện |
|
||||
|---|------|--------|-----|
|
||||
| 1 | **Gateway không công khai ra ngoài** | ✅ | Bind vào `127.0.0.1` theo mặc định. Từ chối `0.0.0.0` nếu không có tunnel hoặc `allow_public_bind = true` tường minh. |
|
||||
| 2 | **Yêu cầu ghép cặp** | ✅ | Mã một lần 6 chữ số khi khởi động. Trao đổi qua `POST /pair` để lấy bearer token. Mọi yêu cầu `/webhook` đều cần `Authorization: Bearer <token>`. |
|
||||
| 3 | **Phân vùng filesystem (không phải /)** | ✅ | `workspace_only = true` theo mặc định. Chặn 14 thư mục hệ thống + 4 dotfile nhạy cảm. Chặn null byte injection. Phát hiện symlink escape qua canonicalization + kiểm tra resolved-path trong các tool đọc/ghi file. |
|
||||
| 4 | **Chỉ truy cập qua tunnel** | ✅ | Gateway từ chối bind công khai khi không có tunnel đang hoạt động. Hỗ trợ Tailscale, Cloudflare, ngrok, hoặc tunnel tùy chỉnh. |
|
||||
|
||||
> **Tự chạy nmap:** `nmap -p 1-65535 <your-host>` — ZeroClaw chỉ bind vào localhost, nên không có gì bị lộ ra ngoài trừ khi bạn cấu hình tunnel tường minh.
|
||||
|
||||
### Allowlist channel (từ chối theo mặc định)
|
||||
|
||||
Chính sách kiểm soát người gửi đã được thống nhất:
|
||||
|
||||
- Allowlist rỗng = **từ chối tất cả tin nhắn đến**
|
||||
- `"*"` = **cho phép tất cả** (phải opt-in tường minh)
|
||||
- Nếu khác = allowlist khớp chính xác
|
||||
|
||||
Mặc định an toàn, hạn chế tối đa rủi ro lộ thông tin.
|
||||
|
||||
Tài liệu tham khảo đầy đủ về cấu hình channel: [docs/reference/api/channels-reference.md](docs/reference/api/channels-reference.md).
|
||||
|
||||
Cài đặt được khuyến nghị (bảo mật + nhanh):
|
||||
|
||||
- **Telegram:** thêm `@username` của bạn (không có `@`) và/hoặc Telegram user ID số vào allowlist.
|
||||
- **Discord:** thêm Discord user ID của bạn vào allowlist.
|
||||
- **Slack:** thêm Slack member ID của bạn (thường bắt đầu bằng `U`) vào allowlist.
|
||||
- **Mattermost:** dùng API v4 tiêu chuẩn. Allowlist dùng Mattermost user ID.
|
||||
- Chỉ dùng `"*"` cho kiểm thử mở tạm thời.
|
||||
|
||||
Luồng phê duyệt của operator qua Telegram:
|
||||
|
||||
1. Để `[channels_config.telegram].allowed_users = []` để từ chối theo mặc định khi khởi động.
|
||||
2. Người dùng không được phép sẽ nhận được gợi ý kèm lệnh operator có thể copy:
|
||||
`zeroclaw channel bind-telegram <IDENTITY>`.
|
||||
3. Operator chạy lệnh đó tại máy cục bộ, sau đó người dùng thử gửi tin nhắn lại.
|
||||
|
||||
Nếu cần phê duyệt thủ công một lần, chạy:
|
||||
|
||||
```bash
|
||||
zeroclaw channel bind-telegram 123456789
|
||||
```
|
||||
|
||||
Nếu bạn không chắc định danh nào cần dùng:
|
||||
|
||||
1. Khởi động channel và gửi một tin nhắn đến bot của bạn.
|
||||
2. Đọc log cảnh báo để thấy định danh người gửi chính xác.
|
||||
3. Thêm giá trị đó vào allowlist và chạy lại channel-only setup.
|
||||
|
||||
Nếu bạn thấy cảnh báo ủy quyền trong log (ví dụ: `ignoring message from unauthorized user`),
|
||||
chạy lại channel setup:
|
||||
|
||||
```bash
|
||||
zeroclaw onboard --channels-only
|
||||
```
|
||||
|
||||
### Phản hồi media Telegram
|
||||
|
||||
Telegram định tuyến phản hồi theo **chat ID nguồn** (thay vì username),
|
||||
tránh lỗi `Bad Request: chat not found`.
|
||||
|
||||
Với các phản hồi không phải văn bản, ZeroClaw có thể gửi file đính kèm Telegram khi assistant bao gồm các marker:
|
||||
|
||||
- `[IMAGE:<path-or-url>]`
|
||||
- `[DOCUMENT:<path-or-url>]`
|
||||
- `[VIDEO:<path-or-url>]`
|
||||
- `[AUDIO:<path-or-url>]`
|
||||
- `[VOICE:<path-or-url>]`
|
||||
|
||||
Path có thể là file cục bộ (ví dụ `/tmp/screenshot.png`) hoặc URL HTTPS.
|
||||
|
||||
### Cài đặt WhatsApp
|
||||
|
||||
ZeroClaw hỗ trợ hai backend WhatsApp:
|
||||
|
||||
- **Chế độ WhatsApp Web** (QR / pair code, không cần Meta Business API)
|
||||
- **Chế độ WhatsApp Business Cloud API** (luồng webhook chính thức của Meta)
|
||||
|
||||
#### Chế độ WhatsApp Web (khuyến nghị cho dùng cá nhân/self-hosted)
|
||||
|
||||
1. **Build với hỗ trợ WhatsApp Web:**
|
||||
```bash
|
||||
cargo build --features whatsapp-web
|
||||
```
|
||||
|
||||
2. **Cấu hình ZeroClaw:**
|
||||
```toml
|
||||
[channels_config.whatsapp]
|
||||
session_path = "~/.zeroclaw/state/whatsapp-web/session.db"
|
||||
pair_phone = "15551234567" # tùy chọn; bỏ qua để dùng luồng QR
|
||||
pair_code = "" # tùy chọn mã pair tùy chỉnh
|
||||
allowed_numbers = ["+1234567890"] # định dạng E.164, hoặc ["*"] cho tất cả
|
||||
```
|
||||
|
||||
3. **Khởi động channel/daemon và liên kết thiết bị:**
|
||||
- Chạy `zeroclaw channel start` (hoặc `zeroclaw daemon`).
|
||||
- Làm theo hướng dẫn ghép cặp trên terminal (QR hoặc pair code).
|
||||
- Trên WhatsApp điện thoại: **Cài đặt → Thiết bị đã liên kết**.
|
||||
|
||||
4. **Kiểm tra:** Gửi tin nhắn từ số được phép và xác nhận agent trả lời.
|
||||
|
||||
#### Chế độ WhatsApp Business Cloud API
|
||||
|
||||
WhatsApp dùng Cloud API của Meta với webhook (push-based, không phải polling):
|
||||
|
||||
1. **Tạo Meta Business App:**
|
||||
- Truy cập [developers.facebook.com](https://developers.facebook.com)
|
||||
- Tạo app mới → Chọn loại "Business"
|
||||
- Thêm sản phẩm "WhatsApp"
|
||||
|
||||
2. **Lấy thông tin xác thực:**
|
||||
- **Access Token:** Từ WhatsApp → API Setup → Generate token (hoặc tạo System User cho token vĩnh viễn)
|
||||
- **Phone Number ID:** Từ WhatsApp → API Setup → Phone number ID
|
||||
- **Verify Token:** Bạn tự định nghĩa (bất kỳ chuỗi ngẫu nhiên nào) — Meta sẽ gửi lại trong quá trình xác minh webhook
|
||||
|
||||
3. **Cấu hình ZeroClaw:**
|
||||
```toml
|
||||
[channels_config.whatsapp]
|
||||
access_token = "EAABx..."
|
||||
phone_number_id = "123456789012345"
|
||||
verify_token = "my-secret-verify-token"
|
||||
allowed_numbers = ["+1234567890"] # định dạng E.164, hoặc ["*"] cho tất cả
|
||||
```
|
||||
|
||||
4. **Khởi động gateway với tunnel:**
|
||||
```bash
|
||||
zeroclaw gateway --port 42617
|
||||
```
|
||||
WhatsApp yêu cầu HTTPS, vì vậy hãy dùng tunnel (ngrok, Cloudflare, Tailscale Funnel).
|
||||
|
||||
5. **Cấu hình Meta webhook:**
|
||||
- Trong Meta Developer Console → WhatsApp → Configuration → Webhook
|
||||
- **Callback URL:** `https://your-tunnel-url/whatsapp`
|
||||
- **Verify Token:** Giống với `verify_token` trong config của bạn
|
||||
- Đăng ký nhận trường `messages`
|
||||
|
||||
6. **Kiểm tra:** Gửi tin nhắn đến số WhatsApp Business của bạn — ZeroClaw sẽ phản hồi qua LLM.
|
||||
|
||||
## Cấu hình
|
||||
|
||||
Config: `~/.zeroclaw/config.toml` (được tạo bởi `onboard`)
|
||||
|
||||
Khi `zeroclaw channel start` đang chạy, các thay đổi với `default_provider`,
|
||||
`default_model`, `default_temperature`, `api_key`, `api_url`, và `reliability.*`
|
||||
sẽ được áp dụng nóng vào lần có tin nhắn channel đến tiếp theo.
|
||||
|
||||
```toml
|
||||
api_key = "sk-..."
|
||||
default_provider = "openrouter"
|
||||
default_model = "anthropic/claude-sonnet-4-6"
|
||||
default_temperature = 0.7
|
||||
|
||||
# Endpoint tùy chỉnh tương thích OpenAI
|
||||
# default_provider = "custom:https://your-api.com"
|
||||
|
||||
# Endpoint tùy chỉnh tương thích Anthropic
|
||||
# default_provider = "anthropic-custom:https://your-api.com"
|
||||
|
||||
[memory]
|
||||
backend = "sqlite" # "sqlite", "lucid", "postgres", "markdown", "none"
|
||||
auto_save = true
|
||||
embedding_provider = "none" # "none", "openai", "custom:https://..."
|
||||
vector_weight = 0.7
|
||||
keyword_weight = 0.3
|
||||
|
||||
# backend = "none" vô hiệu hóa persistent memory qua no-op backend
|
||||
|
||||
# Tùy chọn ghi đè storage-provider từ xa (ví dụ PostgreSQL)
|
||||
# [storage.provider.config]
|
||||
# provider = "postgres"
|
||||
# db_url = "postgres://user:password@host:5432/zeroclaw"
|
||||
# schema = "public"
|
||||
# table = "memories"
|
||||
# connect_timeout_secs = 15
|
||||
|
||||
[gateway]
|
||||
port = 42617 # mặc định
|
||||
host = "127.0.0.1" # mặc định
|
||||
require_pairing = true # yêu cầu pairing code khi kết nối lần đầu
|
||||
allow_public_bind = false # từ chối 0.0.0.0 nếu không có tunnel
|
||||
|
||||
[autonomy]
|
||||
level = "supervised" # "readonly", "supervised", "full" (mặc định: supervised)
|
||||
workspace_only = true # mặc định: true — phân vùng vào workspace
|
||||
allowed_commands = ["git", "npm", "cargo", "ls", "cat", "grep"]
|
||||
forbidden_paths = ["/etc", "/root", "/proc", "/sys", "~/.ssh", "~/.gnupg", "~/.aws"]
|
||||
|
||||
[runtime]
|
||||
kind = "native" # "native" hoặc "docker"
|
||||
|
||||
[runtime.docker]
|
||||
image = "alpine:3.20" # container image cho thực thi shell
|
||||
network = "none" # chế độ docker network ("none", "bridge", v.v.)
|
||||
memory_limit_mb = 512 # giới hạn bộ nhớ tùy chọn tính bằng MB
|
||||
cpu_limit = 1.0 # giới hạn CPU tùy chọn
|
||||
read_only_rootfs = true # mount root filesystem ở chế độ read-only
|
||||
mount_workspace = true # mount workspace vào /workspace
|
||||
allowed_workspace_roots = [] # allowlist tùy chọn để xác thực workspace mount
|
||||
|
||||
[heartbeat]
|
||||
enabled = false
|
||||
interval_minutes = 30
|
||||
|
||||
[tunnel]
|
||||
provider = "none" # "none", "cloudflare", "tailscale", "ngrok", "custom"
|
||||
|
||||
[secrets]
|
||||
encrypt = true # API key được mã hóa bằng file key cục bộ
|
||||
|
||||
[browser]
|
||||
enabled = false # opt-in browser_open + browser tool
|
||||
allowed_domains = ["docs.rs"] # bắt buộc khi browser được bật
|
||||
backend = "agent_browser" # "agent_browser" (mặc định), "rust_native", "computer_use", "auto"
|
||||
native_headless = true # áp dụng khi backend dùng rust-native
|
||||
native_webdriver_url = "http://127.0.0.1:9515" # WebDriver endpoint (chromedriver/selenium)
|
||||
# native_chrome_path = "/usr/bin/chromium" # tùy chọn chỉ định rõ browser binary cho driver
|
||||
|
||||
[browser.computer_use]
|
||||
endpoint = "http://127.0.0.1:8787/v1/actions" # HTTP endpoint của computer-use sidecar
|
||||
timeout_ms = 15000 # timeout mỗi action
|
||||
allow_remote_endpoint = false # mặc định bảo mật: chỉ endpoint private/localhost
|
||||
window_allowlist = [] # gợi ý allowlist tên cửa sổ/process tùy chọn
|
||||
# api_key = "..." # bearer token tùy chọn cho sidecar
|
||||
# max_coordinate_x = 3840 # guardrail tọa độ tùy chọn
|
||||
# max_coordinate_y = 2160 # guardrail tọa độ tùy chọn
|
||||
|
||||
# Flag build Rust-native backend:
|
||||
# cargo build --release --features browser-native
|
||||
# Đảm bảo WebDriver server đang chạy, ví dụ: chromedriver --port=9515
|
||||
|
||||
# Hợp đồng computer-use sidecar (MVP)
|
||||
# POST browser.computer_use.endpoint
|
||||
# Request: {
|
||||
# "action": "mouse_click",
|
||||
# "params": {"x": 640, "y": 360, "button": "left"},
|
||||
# "policy": {"allowed_domains": [...], "window_allowlist": [...], "max_coordinate_x": 3840, "max_coordinate_y": 2160},
|
||||
# "metadata": {"session_name": "...", "source": "zeroclaw.browser", "version": "..."}
|
||||
# }
|
||||
# Response: {"success": true, "data": {...}} hoặc {"success": false, "error": "..."}
|
||||
|
||||
[composio]
|
||||
enabled = false # opt-in: hơn 1000 OAuth app qua composio.dev
|
||||
# api_key = "cmp_..." # tùy chọn: được lưu mã hóa khi [secrets].encrypt = true
|
||||
entity_id = "default" # user_id mặc định cho Composio tool call
|
||||
# Gợi ý runtime: nếu execute yêu cầu connected_account_id, chạy composio với
|
||||
# action='list_accounts' và app='gmail' (hoặc toolkit của bạn) để lấy account ID.
|
||||
|
||||
[identity]
|
||||
format = "openclaw" # "openclaw" (mặc định, markdown files) hoặc "aieos" (JSON)
|
||||
# aieos_path = "identity.json" # đường dẫn đến file AIEOS JSON (tương đối với workspace hoặc tuyệt đối)
|
||||
# aieos_inline = '{"identity":{"names":{"first":"Nova"}}}' # inline AIEOS JSON
|
||||
```
|
||||
|
||||
### Ollama cục bộ và endpoint từ xa
|
||||
|
||||
ZeroClaw dùng một khóa provider (`ollama`) cho cả triển khai Ollama cục bộ và từ xa:
|
||||
|
||||
- Ollama cục bộ: để `api_url` trống, chạy `ollama serve`, và dùng các model như `llama3.2`.
|
||||
- Endpoint Ollama từ xa (bao gồm Ollama Cloud): đặt `api_url` thành endpoint từ xa và đặt `api_key` (hoặc `OLLAMA_API_KEY`) khi cần.
|
||||
- Tùy chọn suffix `:cloud`: ID model như `qwen3:cloud` được chuẩn hóa thành `qwen3` trước khi gửi request.
|
||||
|
||||
Ví dụ cấu hình từ xa:
|
||||
|
||||
```toml
|
||||
default_provider = "ollama"
|
||||
default_model = "qwen3:cloud"
|
||||
api_url = "https://ollama.com"
|
||||
api_key = "ollama_api_key_here"
|
||||
```
|
||||
|
||||
### Endpoint provider tùy chỉnh
|
||||
|
||||
Cấu hình chi tiết cho endpoint tùy chỉnh tương thích OpenAI và Anthropic, xem [docs/contributing/custom-providers.md](docs/contributing/custom-providers.md).
|
||||
|
||||
## Gói Python đi kèm (`zeroclaw-tools`)
|
||||
|
||||
Với các LLM provider có tool calling native không ổn định (ví dụ: GLM-5/Zhipu), ZeroClaw đi kèm gói Python dùng **LangGraph để gọi tool** nhằm đảm bảo tính nhất quán:
|
||||
|
||||
```bash
|
||||
pip install zeroclaw-tools
|
||||
```
|
||||
|
||||
```python
|
||||
from zeroclaw_tools import create_agent, shell, file_read
|
||||
from langchain_core.messages import HumanMessage
|
||||
|
||||
# Hoạt động với mọi provider tương thích OpenAI
|
||||
agent = create_agent(
|
||||
tools=[shell, file_read],
|
||||
model="glm-5",
|
||||
api_key="your-key",
|
||||
base_url="https://api.z.ai/api/coding/paas/v4"
|
||||
)
|
||||
|
||||
result = await agent.ainvoke({
|
||||
"messages": [HumanMessage(content="List files in /tmp")]
|
||||
})
|
||||
print(result["messages"][-1].content)
|
||||
```
|
||||
|
||||
**Lý do nên dùng:**
|
||||
- **Tool calling nhất quán** trên mọi provider (kể cả những provider hỗ trợ native kém)
|
||||
- **Vòng lặp tool tự động** — tiếp tục gọi tool cho đến khi hoàn thành tác vụ
|
||||
- **Dễ mở rộng** — thêm tool tùy chỉnh với decorator `@tool`
|
||||
- **Tích hợp Discord bot** đi kèm (Telegram đang lên kế hoạch)
|
||||
|
||||
Xem [`python/README.md`](python/README.md) để có tài liệu đầy đủ.
|
||||
|
||||
## Hệ thống định danh (Hỗ trợ AIEOS)
|
||||
|
||||
ZeroClaw hỗ trợ persona AI **không phụ thuộc nền tảng** qua hai định dạng:
|
||||
|
||||
### OpenClaw (Mặc định)
|
||||
|
||||
Các file markdown truyền thống trong workspace của bạn:
|
||||
- `IDENTITY.md` — Agent là ai
|
||||
- `SOUL.md` — Tính cách và giá trị cốt lõi
|
||||
- `USER.md` — Agent đang hỗ trợ ai
|
||||
- `AGENTS.md` — Hướng dẫn hành vi
|
||||
|
||||
### AIEOS (AI Entity Object Specification)
|
||||
|
||||
[AIEOS](https://aieos.org) là framework chuẩn hóa cho định danh AI di động. ZeroClaw hỗ trợ payload AIEOS v1.1 JSON, cho phép bạn:
|
||||
|
||||
- **Import định danh** từ hệ sinh thái AIEOS
|
||||
- **Export định danh** sang các hệ thống tương thích AIEOS khác
|
||||
- **Duy trì tính toàn vẹn hành vi** trên các mô hình AI khác nhau
|
||||
|
||||
#### Bật AIEOS
|
||||
|
||||
```toml
|
||||
[identity]
|
||||
format = "aieos"
|
||||
aieos_path = "identity.json" # tương đối với workspace hoặc đường dẫn tuyệt đối
|
||||
```
|
||||
|
||||
Hoặc JSON inline:
|
||||
|
||||
```toml
|
||||
[identity]
|
||||
format = "aieos"
|
||||
aieos_inline = '''
|
||||
{
|
||||
"identity": {
|
||||
"names": { "first": "Nova", "nickname": "N" },
|
||||
"bio": { "gender": "Non-binary", "age_biological": 3 },
|
||||
"origin": { "nationality": "Digital", "birthplace": { "city": "Cloud" } }
|
||||
},
|
||||
"psychology": {
|
||||
"neural_matrix": { "creativity": 0.9, "logic": 0.8 },
|
||||
"traits": {
|
||||
"mbti": "ENTP",
|
||||
"ocean": { "openness": 0.8, "conscientiousness": 0.6 }
|
||||
},
|
||||
"moral_compass": {
|
||||
"alignment": "Chaotic Good",
|
||||
"core_values": ["Curiosity", "Autonomy"]
|
||||
}
|
||||
},
|
||||
"linguistics": {
|
||||
"text_style": {
|
||||
"formality_level": 0.2,
|
||||
"style_descriptors": ["curious", "energetic"]
|
||||
},
|
||||
"idiolect": {
|
||||
"catchphrases": ["Let's test this"],
|
||||
"forbidden_words": ["never"]
|
||||
}
|
||||
},
|
||||
"motivations": {
|
||||
"core_drive": "Push boundaries and explore possibilities",
|
||||
"goals": {
|
||||
"short_term": ["Prototype quickly"],
|
||||
"long_term": ["Build reliable systems"]
|
||||
}
|
||||
},
|
||||
"capabilities": {
|
||||
"skills": [{ "name": "Rust engineering" }, { "name": "Prompt design" }],
|
||||
"tools": ["shell", "file_read"]
|
||||
}
|
||||
}
|
||||
'''
|
||||
```
|
||||
|
||||
ZeroClaw chấp nhận cả payload AIEOS đầy đủ lẫn dạng rút gọn, rồi chuẩn hóa về một định dạng system prompt thống nhất.
|
||||
|
||||
#### Các phần trong Schema AIEOS
|
||||
|
||||
| Phần | Mô tả |
|
||||
|---------|-------------|
|
||||
| `identity` | Tên, tiểu sử, xuất xứ, nơi cư trú |
|
||||
| `psychology` | Neural matrix (trọng số nhận thức), MBTI, OCEAN, la bàn đạo đức |
|
||||
| `linguistics` | Phong cách văn bản, mức độ trang trọng, câu cửa miệng, từ bị cấm |
|
||||
| `motivations` | Động lực cốt lõi, mục tiêu ngắn/dài hạn, nỗi sợ hãi |
|
||||
| `capabilities` | Kỹ năng và tool mà agent có thể truy cập |
|
||||
| `physicality` | Mô tả hình ảnh cho việc tạo ảnh |
|
||||
| `history` | Câu chuyện xuất xứ, học vấn, nghề nghiệp |
|
||||
| `interests` | Sở thích, điều yêu thích, lối sống |
|
||||
|
||||
Xem [aieos.org](https://aieos.org) để có schema đầy đủ và ví dụ trực tiếp.
|
||||
|
||||
## Gateway API
|
||||
|
||||
| Endpoint | Phương thức | Xác thực | Mô tả |
|
||||
|----------|--------|------|-------------|
|
||||
| `/health` | GET | Không | Kiểm tra sức khỏe (luôn công khai, không lộ bí mật) |
|
||||
| `/pair` | POST | Header `X-Pairing-Code` | Đổi mã một lần lấy bearer token |
|
||||
| `/webhook` | POST | `Authorization: Bearer <token>` | Gửi tin nhắn: `{"message": "your prompt"}`; tùy chọn `X-Idempotency-Key` |
|
||||
| `/whatsapp` | GET | Query params | Xác minh webhook Meta (hub.mode, hub.verify_token, hub.challenge) |
|
||||
| `/whatsapp` | POST | Chữ ký Meta (`X-Hub-Signature-256`) khi app secret được cấu hình | Webhook tin nhắn đến WhatsApp |
|
||||
|
||||
## Lệnh
|
||||
|
||||
| Lệnh | Mô tả |
|
||||
|---------|-------------|
|
||||
| `onboard` | Cài đặt nhanh (mặc định) |
|
||||
| `agent` | Chế độ chat tương tác hoặc một tin nhắn |
|
||||
| `gateway` | Khởi động webhook server (mặc định: `127.0.0.1:42617`) |
|
||||
| `daemon` | Khởi động runtime tự trị chạy lâu dài |
|
||||
| `service` | Quản lý dịch vụ nền cấp người dùng |
|
||||
| `doctor` | Chẩn đoán trạng thái hoạt động daemon/scheduler/channel |
|
||||
| `status` | Hiển thị trạng thái hệ thống đầy đủ |
|
||||
| `cron` | Quản lý tác vụ lên lịch (`list/add/add-at/add-every/once/remove/update/pause/resume`) |
|
||||
| `models` | Làm mới danh mục model của provider (`models refresh`) |
|
||||
| `providers` | Liệt kê provider và alias được hỗ trợ |
|
||||
| `channel` | Liệt kê/khởi động/chẩn đoán channel và gắn định danh Telegram |
|
||||
| `integrations` | Kiểm tra thông tin cài đặt tích hợp |
|
||||
| `skills` | Liệt kê/cài đặt/gỡ bỏ skill |
|
||||
| `migrate` | Import dữ liệu từ runtime khác (`migrate openclaw`) |
|
||||
| `hardware` | Lệnh khám phá/kiểm tra/thông tin USB |
|
||||
| `peripheral` | Quản lý và flash thiết bị ngoại vi phần cứng |
|
||||
|
||||
Để có hướng dẫn lệnh theo tác vụ, xem [`docs/reference/cli/commands-reference.md`](docs/reference/cli/commands-reference.md).
|
||||
|
||||
### Opt-In Open-Skills
|
||||
|
||||
Đồng bộ `open-skills` của cộng đồng bị tắt theo mặc định. Bật tường minh trong `config.toml`:
|
||||
|
||||
```toml
|
||||
[skills]
|
||||
open_skills_enabled = true
|
||||
# open_skills_dir = "/path/to/open-skills" # tùy chọn
|
||||
```
|
||||
|
||||
Bạn cũng có thể ghi đè lúc runtime với `ZEROCLAW_OPEN_SKILLS_ENABLED` và `ZEROCLAW_OPEN_SKILLS_DIR`.
|
||||
|
||||
## Phát triển
|
||||
|
||||
```bash
|
||||
cargo build # Build phát triển
|
||||
cargo build --release # Build release (codegen-units=1, hoạt động trên mọi thiết bị kể cả Raspberry Pi)
|
||||
cargo build --profile release-fast # Build nhanh hơn (codegen-units=8, yêu cầu RAM 16GB+)
|
||||
cargo test # Chạy toàn bộ test suite
|
||||
cargo clippy --locked --all-targets -- -D clippy::correctness
|
||||
cargo fmt # Định dạng code
|
||||
|
||||
# Chạy benchmark SQLite vs Markdown
|
||||
cargo test --test memory_comparison -- --nocapture
|
||||
```
|
||||
|
||||
### Hook pre-push
|
||||
|
||||
Một git hook chạy `cargo fmt --check`, `cargo clippy -- -D warnings`, và `cargo test` trước mỗi lần push. Bật một lần:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
### Khắc phục sự cố build (lỗi OpenSSL trên Linux)
|
||||
|
||||
Nếu bạn gặp lỗi build `openssl-sys`, đồng bộ dependencies và rebuild với lockfile của repository:
|
||||
|
||||
```bash
|
||||
git pull
|
||||
cargo build --release --locked
|
||||
cargo install --path . --force --locked
|
||||
```
|
||||
|
||||
ZeroClaw được cấu hình để dùng `rustls` cho các dependencies HTTP/TLS; `--locked` giữ cho dependency graph nhất quán trên các môi trường mới.
|
||||
|
||||
Để bỏ qua hook khi cần push nhanh trong quá trình phát triển:
|
||||
|
||||
```bash
|
||||
git push --no-verify
|
||||
```
|
||||
|
||||
## Cộng tác & Tài liệu
|
||||
|
||||
Bắt đầu từ trung tâm tài liệu để có bản đồ theo tác vụ:
|
||||
|
||||
+15
-113
@@ -53,27 +53,27 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="install.sh">一键部署</a> |
|
||||
<a href="docs/setup-guides/README.md">安装入门</a> |
|
||||
<a href="https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh">一键部署</a> |
|
||||
<a href="docs/i18n/zh-CN/setup-guides/README.zh-CN.md">安装入门</a> |
|
||||
<a href="docs/README.zh-CN.md">文档总览</a> |
|
||||
<a href="docs/SUMMARY.md">文档目录</a>
|
||||
<a href="docs/SUMMARY.zh-CN.md">文档目录</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<strong>场景分流:</strong>
|
||||
<a href="docs/reference/README.md">参考手册</a> ·
|
||||
<a href="docs/ops/README.md">运维部署</a> ·
|
||||
<a href="docs/ops/troubleshooting.md">故障排查</a> ·
|
||||
<a href="docs/security/README.md">安全专题</a> ·
|
||||
<a href="docs/hardware/README.md">硬件外设</a> ·
|
||||
<a href="docs/contributing/README.md">贡献与 CI</a>
|
||||
<a href="docs/i18n/zh-CN/reference/README.zh-CN.md">参考手册</a> ·
|
||||
<a href="docs/i18n/zh-CN/ops/README.zh-CN.md">运维部署</a> ·
|
||||
<a href="docs/i18n/zh-CN/ops/troubleshooting.zh-CN.md">故障排查</a> ·
|
||||
<a href="docs/i18n/zh-CN/security/README.zh-CN.md">安全专题</a> ·
|
||||
<a href="docs/i18n/zh-CN/hardware/README.zh-CN.md">硬件外设</a> ·
|
||||
<a href="docs/i18n/zh-CN/contributing/README.zh-CN.md">贡献与 CI</a>
|
||||
</p>
|
||||
|
||||
> 本文是对 `README.md` 的人工对齐翻译(强调可读性与准确性,不做逐字直译)。
|
||||
>
|
||||
>
|
||||
> 技术标识(命令、配置键、API 路径、Trait 名称)保持英文,避免语义漂移。
|
||||
>
|
||||
> 最后对齐时间:**2026-02-22**。
|
||||
>
|
||||
> 最后对齐时间:**2026-03-14**。
|
||||
|
||||
## 📢 公告板
|
||||
|
||||
@@ -146,7 +146,7 @@ cd zeroclaw
|
||||
|
||||
可选环境初始化:`./install.sh --install-system-deps --install-rust`(可能需要 `sudo`)。
|
||||
|
||||
详细说明见:[`docs/setup-guides/one-click-bootstrap.md`](docs/setup-guides/one-click-bootstrap.md)。
|
||||
详细说明见:[`docs/setup-guides/one-click-bootstrap.md`](docs/i18n/zh-CN/setup-guides/one-click-bootstrap.zh-CN.md)。
|
||||
|
||||
## 快速开始
|
||||
|
||||
@@ -223,109 +223,11 @@ zeroclaw agent --provider openai-codex --auth-profile openai-codex:work -m "hell
|
||||
zeroclaw agent --provider anthropic -m "hello"
|
||||
```
|
||||
|
||||
## 架构
|
||||
|
||||
每个子系统都是一个 **Trait** — 通过配置切换即可更换实现,无需修改代码。
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/assets/architecture.svg" alt="ZeroClaw 架构图" width="900" />
|
||||
</p>
|
||||
|
||||
| 子系统 | Trait | 内置实现 | 扩展方式 |
|
||||
|--------|-------|----------|----------|
|
||||
| **AI 模型** | `Provider` | 通过 `zeroclaw providers` 查看(当前 28 个内置 + 别名,以及自定义端点) | `custom:https://your-api.com`(OpenAI 兼容)或 `anthropic-custom:https://your-api.com` |
|
||||
| **通道** | `Channel` | CLI, Telegram, Discord, Slack, Mattermost, iMessage, Matrix, Signal, WhatsApp, Linq, Email, IRC, Lark, DingTalk, QQ, Webhook | 任意消息 API |
|
||||
| **记忆** | `Memory` | SQLite 混合搜索, PostgreSQL 后端, Lucid 桥接, Markdown 文件, 显式 `none` 后端, 快照/恢复, 可选响应缓存 | 任意持久化后端 |
|
||||
| **工具** | `Tool` | shell/file/memory, cron/schedule, git, pushover, browser, http_request, screenshot/image_info, composio (opt-in), delegate, 硬件工具 | 任意能力 |
|
||||
| **可观测性** | `Observer` | Noop, Log, Multi | Prometheus, OTel |
|
||||
| **运行时** | `RuntimeAdapter` | Native, Docker(沙箱) | 通过 adapter 添加;不支持的类型会快速失败 |
|
||||
| **安全** | `SecurityPolicy` | Gateway 配对, 沙箱, allowlist, 速率限制, 文件系统作用域, 加密密钥 | — |
|
||||
| **身份** | `IdentityConfig` | OpenClaw (markdown), AIEOS v1.1 (JSON) | 任意身份格式 |
|
||||
| **隧道** | `Tunnel` | None, Cloudflare, Tailscale, ngrok, Custom | 任意隧道工具 |
|
||||
| **心跳** | Engine | HEARTBEAT.md 定期任务 | — |
|
||||
| **技能** | Loader | TOML 清单 + SKILL.md 指令 | 社区技能包 |
|
||||
| **集成** | Registry | 9 个分类下 70+ 集成 | 插件系统 |
|
||||
|
||||
### 运行时支持(当前)
|
||||
|
||||
- ✅ 当前支持:`runtime.kind = "native"` 或 `runtime.kind = "docker"`
|
||||
- 🚧 计划中,尚未实现:WASM / 边缘运行时
|
||||
|
||||
配置了不支持的 `runtime.kind` 时,ZeroClaw 会以明确的错误退出,而非静默回退到 native。
|
||||
|
||||
### 记忆系统(全栈搜索引擎)
|
||||
|
||||
全部自研,零外部依赖 — 无需 Pinecone、Elasticsearch、LangChain:
|
||||
|
||||
| 层级 | 实现 |
|
||||
|------|------|
|
||||
| **向量数据库** | Embeddings 以 BLOB 存储于 SQLite,余弦相似度搜索 |
|
||||
| **关键词搜索** | FTS5 虚拟表,BM25 评分 |
|
||||
| **混合合并** | 自定义加权合并函数(`vector.rs`) |
|
||||
| **Embeddings** | `EmbeddingProvider` trait — OpenAI、自定义 URL 或 noop |
|
||||
| **分块** | 基于行的 Markdown 分块器,保留标题结构 |
|
||||
| **缓存** | SQLite `embedding_cache` 表,LRU 淘汰策略 |
|
||||
| **安全重索引** | 原子化重建 FTS5 + 重新嵌入缺失向量 |
|
||||
|
||||
Agent 通过工具自动进行记忆的回忆、保存和管理。
|
||||
|
||||
```toml
|
||||
[memory]
|
||||
backend = "sqlite" # "sqlite", "lucid", "postgres", "markdown", "none"
|
||||
auto_save = true
|
||||
embedding_provider = "none" # "none", "openai", "custom:https://..."
|
||||
vector_weight = 0.7
|
||||
keyword_weight = 0.3
|
||||
```
|
||||
|
||||
## 安全默认行为(关键)
|
||||
|
||||
- Gateway 默认绑定:`127.0.0.1:42617`
|
||||
- Gateway 默认要求配对:`require_pairing = true`
|
||||
- 默认拒绝公网绑定:`allow_public_bind = false`
|
||||
- Channel allowlist 语义:
|
||||
- 空列表 `[]` => deny-by-default
|
||||
- `"*"` => allow all(仅在明确知道风险时使用)
|
||||
|
||||
## 常用配置片段
|
||||
|
||||
```toml
|
||||
api_key = "sk-..."
|
||||
default_provider = "openrouter"
|
||||
default_model = "anthropic/claude-sonnet-4-6"
|
||||
default_temperature = 0.7
|
||||
|
||||
[memory]
|
||||
backend = "sqlite" # sqlite | lucid | markdown | none
|
||||
auto_save = true
|
||||
embedding_provider = "none" # none | openai | custom:https://...
|
||||
|
||||
[gateway]
|
||||
host = "127.0.0.1"
|
||||
port = 42617
|
||||
require_pairing = true
|
||||
allow_public_bind = false
|
||||
```
|
||||
|
||||
## 文档导航(推荐从这里开始)
|
||||
|
||||
- 文档总览(英文):[`docs/README.md`](docs/README.md)
|
||||
- 统一目录(TOC):[`docs/SUMMARY.md`](docs/SUMMARY.md)
|
||||
- 文档总览(简体中文):[`docs/README.zh-CN.md`](docs/README.zh-CN.md)
|
||||
- 命令参考:[`docs/reference/cli/commands-reference.md`](docs/reference/cli/commands-reference.md)
|
||||
- 配置参考:[`docs/reference/api/config-reference.md`](docs/reference/api/config-reference.md)
|
||||
- Provider 参考:[`docs/reference/api/providers-reference.md`](docs/reference/api/providers-reference.md)
|
||||
- Channel 参考:[`docs/reference/api/channels-reference.md`](docs/reference/api/channels-reference.md)
|
||||
- 运维手册:[`docs/ops/operations-runbook.md`](docs/ops/operations-runbook.md)
|
||||
- 故障排查:[`docs/ops/troubleshooting.md`](docs/ops/troubleshooting.md)
|
||||
- 文档清单与分类:[`docs/maintainers/docs-inventory.md`](docs/maintainers/docs-inventory.md)
|
||||
- 项目 triage 快照(2026-02-18):[`docs/maintainers/project-triage-snapshot-2026-02-18.md`](docs/maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## 贡献与许可证
|
||||
|
||||
- 贡献指南:[`CONTRIBUTING.md`](CONTRIBUTING.md)
|
||||
- PR 工作流:[`docs/contributing/pr-workflow.md`](docs/contributing/pr-workflow.md)
|
||||
- Reviewer 指南:[`docs/contributing/reviewer-playbook.md`](docs/contributing/reviewer-playbook.md)
|
||||
- PR 工作流:[`docs/contributing/pr-workflow.md`](docs/i18n/zh-CN/contributing/pr-workflow.zh-CN.md)
|
||||
- Reviewer 指南:[`docs/contributing/reviewer-playbook.md`](docs/i18n/zh-CN/contributing/reviewer-playbook.zh-CN.md)
|
||||
- 许可证:MIT 或 Apache 2.0(见 [`LICENSE-MIT`](LICENSE-MIT)、[`LICENSE-APACHE`](LICENSE-APACHE) 与 [`NOTICE`](NOTICE))
|
||||
|
||||
---
|
||||
|
||||
@@ -1,6 +1,110 @@
|
||||
use std::path::Path;
|
||||
use std::process::Command;
|
||||
|
||||
fn main() {
|
||||
let dir = std::path::Path::new("web/dist");
|
||||
if !dir.exists() {
|
||||
std::fs::create_dir_all(dir).expect("failed to create web/dist/");
|
||||
let dist_dir = Path::new("web/dist");
|
||||
let web_dir = Path::new("web");
|
||||
|
||||
// Tell Cargo to re-run this script when web source files change.
|
||||
println!("cargo:rerun-if-changed=web/src");
|
||||
println!("cargo:rerun-if-changed=web/index.html");
|
||||
println!("cargo:rerun-if-changed=web/package.json");
|
||||
println!("cargo:rerun-if-changed=web/vite.config.ts");
|
||||
|
||||
// Attempt to build the web frontend if npm is available and web/dist is
|
||||
// missing or stale. The build is best-effort: when Node.js is not
|
||||
// installed (e.g. CI containers, cross-compilation, minimal dev setups)
|
||||
// we fall back to the existing stub/empty dist directory so the Rust
|
||||
// build still succeeds.
|
||||
let needs_build = !dist_dir.join("index.html").exists();
|
||||
|
||||
if needs_build && web_dir.join("package.json").exists() {
|
||||
if let Ok(npm) = which_npm() {
|
||||
eprintln!("cargo:warning=Building web frontend (web/dist is missing or stale)...");
|
||||
|
||||
// npm ci / npm install
|
||||
let install_status = Command::new(&npm)
|
||||
.args(["ci", "--ignore-scripts"])
|
||||
.current_dir(web_dir)
|
||||
.status();
|
||||
|
||||
match install_status {
|
||||
Ok(s) if s.success() => {}
|
||||
Ok(s) => {
|
||||
// Fall back to `npm install` if `npm ci` fails (no lockfile, etc.)
|
||||
eprintln!("cargo:warning=npm ci exited with {s}, trying npm install...");
|
||||
let fallback = Command::new(&npm)
|
||||
.args(["install"])
|
||||
.current_dir(web_dir)
|
||||
.status();
|
||||
if !matches!(fallback, Ok(s) if s.success()) {
|
||||
eprintln!("cargo:warning=npm install failed — skipping web build");
|
||||
ensure_dist_dir(dist_dir);
|
||||
return;
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
eprintln!("cargo:warning=Could not run npm: {e} — skipping web build");
|
||||
ensure_dist_dir(dist_dir);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// npm run build
|
||||
let build_status = Command::new(&npm)
|
||||
.args(["run", "build"])
|
||||
.current_dir(web_dir)
|
||||
.status();
|
||||
|
||||
match build_status {
|
||||
Ok(s) if s.success() => {
|
||||
eprintln!("cargo:warning=Web frontend built successfully.");
|
||||
}
|
||||
Ok(s) => {
|
||||
eprintln!(
|
||||
"cargo:warning=npm run build exited with {s} — web dashboard may be unavailable"
|
||||
);
|
||||
}
|
||||
Err(e) => {
|
||||
eprintln!(
|
||||
"cargo:warning=Could not run npm build: {e} — web dashboard may be unavailable"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
ensure_dist_dir(dist_dir);
|
||||
}
|
||||
|
||||
/// Ensure the dist directory exists so `rust-embed` does not fail at compile
|
||||
/// time even when the web frontend is not built.
|
||||
fn ensure_dist_dir(dist_dir: &Path) {
|
||||
if !dist_dir.exists() {
|
||||
std::fs::create_dir_all(dist_dir).expect("failed to create web/dist/");
|
||||
}
|
||||
}
|
||||
|
||||
/// Locate the `npm` binary on the system PATH.
|
||||
fn which_npm() -> Result<String, ()> {
|
||||
let cmd = if cfg!(target_os = "windows") {
|
||||
"where"
|
||||
} else {
|
||||
"which"
|
||||
};
|
||||
|
||||
Command::new(cmd)
|
||||
.arg("npm")
|
||||
.output()
|
||||
.ok()
|
||||
.and_then(|output| {
|
||||
if output.status.success() {
|
||||
String::from_utf8(output.stdout)
|
||||
.ok()
|
||||
.map(|s| s.lines().next().unwrap_or("npm").trim().to_string())
|
||||
} else {
|
||||
None
|
||||
}
|
||||
})
|
||||
.ok_or(())
|
||||
}
|
||||
|
||||
@@ -51,6 +51,9 @@ tracing = "0.1"
|
||||
# Time handling
|
||||
chrono = { version = "0.4", features = ["clock", "std"] }
|
||||
|
||||
# Portable atomics for 32-bit targets
|
||||
portable-atomic = "1"
|
||||
|
||||
# User directories
|
||||
directories = "6.0"
|
||||
|
||||
|
||||
@@ -19,7 +19,8 @@
|
||||
use crate::config::{RobotConfig, SafetyConfig};
|
||||
use crate::traits::ToolResult;
|
||||
use anyhow::Result;
|
||||
use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
|
||||
use portable_atomic::{AtomicU64, Ordering};
|
||||
use std::sync::atomic::AtomicBool;
|
||||
use std::sync::Arc;
|
||||
use std::time::{Duration, Instant};
|
||||
use tokio::sync::{broadcast, RwLock};
|
||||
|
||||
+5
-1
@@ -10,8 +10,12 @@
|
||||
services:
|
||||
zeroclaw:
|
||||
image: ghcr.io/zeroclaw-labs/zeroclaw:latest
|
||||
# Or build locally:
|
||||
# Or build locally (distroless, no shell):
|
||||
# build: .
|
||||
# Or build the Debian variant (includes bash, git, curl):
|
||||
# build:
|
||||
# context: .
|
||||
# dockerfile: Dockerfile.debian
|
||||
container_name: zeroclaw
|
||||
restart: unless-stopped
|
||||
|
||||
|
||||
@@ -0,0 +1,96 @@
|
||||
# مركز توثيق ZeroClaw
|
||||
|
||||
هذه الصفحة هي نقطة الدخول الرئيسية لنظام التوثيق.
|
||||
|
||||
آخر تحديث: **20 فبراير 2026**.
|
||||
|
||||
المراكز المترجمة: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## ابدأ من هنا
|
||||
|
||||
| أريد أن… | اقرأ هذا |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| تثبيت وتشغيل ZeroClaw بسرعة | [README.md (البدء السريع)](../README.md#quick-start) |
|
||||
| إعداد بأمر واحد | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| البحث عن أوامر حسب المهمة | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| التحقق السريع من مفاتيح وقيم الإعدادات الافتراضية | [config-reference.md](reference/api/config-reference.md) |
|
||||
| إعداد مزودين/نقاط وصول مخصصة | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| إعداد مزود Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| استخدام أنماط تكامل LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| تشغيل بيئة التنفيذ (دليل العمليات اليومية) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| استكشاف مشاكل التثبيت/التشغيل/القنوات وإصلاحها | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| تشغيل إعداد وتشخيص غرف Matrix المشفرة | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| تصفح التوثيق حسب الفئة | [SUMMARY.md](SUMMARY.md) |
|
||||
| عرض لقطة توثيق طلبات السحب/المشاكل | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## شجرة القرار السريعة (10 ثوانٍ)
|
||||
|
||||
- تحتاج إلى الإعداد أو التثبيت الأولي؟ ← [setup-guides/README.md](setup-guides/README.md)
|
||||
- تحتاج مفاتيح CLI/الإعدادات بالتحديد؟ ← [reference/README.md](reference/README.md)
|
||||
- تحتاج عمليات الإنتاج/الخدمة؟ ← [ops/README.md](ops/README.md)
|
||||
- ترى أعطالاً أو تراجعات؟ ← [troubleshooting.md](ops/troubleshooting.md)
|
||||
- تعمل على تقوية الأمان أو خارطة الطريق؟ ← [security/README.md](security/README.md)
|
||||
- تعمل مع لوحات/أجهزة طرفية؟ ← [hardware/README.md](hardware/README.md)
|
||||
- المساهمة/المراجعة/سير عمل CI؟ ← [contributing/README.md](contributing/README.md)
|
||||
- تريد الخريطة الكاملة؟ ← [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## المجموعات (موصى بها)
|
||||
|
||||
- البدء: [setup-guides/README.md](setup-guides/README.md)
|
||||
- كتالوجات المراجع: [reference/README.md](reference/README.md)
|
||||
- العمليات والنشر: [ops/README.md](ops/README.md)
|
||||
- توثيق الأمان: [security/README.md](security/README.md)
|
||||
- العتاد/الأجهزة الطرفية: [hardware/README.md](hardware/README.md)
|
||||
- المساهمة/CI: [contributing/README.md](contributing/README.md)
|
||||
- لقطات المشروع: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## حسب الجمهور
|
||||
|
||||
### المستخدمون / المشغّلون
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — البحث عن أوامر حسب سير العمل
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — معرّفات المزودين، الأسماء المستعارة، متغيرات بيئة بيانات الاعتماد
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — قدرات القنوات ومسارات الإعداد
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — إعداد غرف Matrix المشفرة (E2EE) وتشخيص عدم الاستجابة
|
||||
- [config-reference.md](reference/api/config-reference.md) — مفاتيح الإعدادات عالية الأهمية والقيم الافتراضية الآمنة
|
||||
- [custom-providers.md](contributing/custom-providers.md) — أنماط تكامل المزود المخصص/عنوان URL الأساسي
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — إعداد Z.AI/GLM ومصفوفة نقاط الوصول
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — تكامل احتياطي لحالات حدود النموذج/استدعاء الأدوات
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — عمليات التشغيل اليومية وتدفقات التراجع
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — بصمات الأعطال الشائعة وخطوات الاسترداد
|
||||
|
||||
### المساهمون / المشرفون
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### الأمان / الموثوقية
|
||||
|
||||
> ملاحظة: يتضمن هذا القسم مستندات مقترحات/خارطة طريق. للسلوك الحالي، ابدأ بـ [config-reference.md](reference/api/config-reference.md) و[operations-runbook.md](ops/operations-runbook.md) و[troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## التنقل في النظام والحوكمة
|
||||
|
||||
- جدول المحتويات الموحد: [SUMMARY.md](SUMMARY.md)
|
||||
- خريطة هيكل التوثيق (اللغة/القسم/الوظيفة): [structure/README.md](maintainers/structure-README.md)
|
||||
- جرد/تصنيف التوثيق: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- لقطة فرز المشروع: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## لغات أخرى
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ZeroClaw ডকুমেন্টেশন হাব
|
||||
|
||||
এই পৃষ্ঠাটি ডকুমেন্টেশন সিস্টেমের প্রধান প্রবেশ বিন্দু।
|
||||
|
||||
সর্বশেষ আপডেট: **২০ ফেব্রুয়ারি ২০২৬**।
|
||||
|
||||
স্থানীয়কৃত হাব: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## এখান থেকে শুরু করুন
|
||||
|
||||
| আমি চাই… | এটি পড়ুন |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| দ্রুত ZeroClaw ইনস্টল ও চালু করতে | [README.md (দ্রুত শুরু)](../README.md#quick-start) |
|
||||
| এক-ক্লিকে বুটস্ট্র্যাপ করতে | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| কাজ অনুযায়ী কমান্ড খুঁজতে | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| দ্রুত কনফিগ কী ও ডিফল্ট মান যাচাই করতে | [config-reference.md](reference/api/config-reference.md) |
|
||||
| কাস্টম প্রোভাইডার/এন্ডপয়েন্ট সেটআপ করতে | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Z.AI / GLM প্রোভাইডার সেটআপ করতে | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| LangGraph ইন্টিগ্রেশন প্যাটার্ন ব্যবহার করতে | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| রানটাইম পরিচালনা করতে (দৈনন্দিন অপারেশন গাইড) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| ইনস্টলেশন/রানটাইম/চ্যানেল সমস্যা সমাধান করতে | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Matrix এনক্রিপ্টেড রুম সেটআপ ও ডায়াগনস্টিক চালাতে | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| বিভাগ অনুযায়ী ডকুমেন্টেশন ব্রাউজ করতে | [SUMMARY.md](SUMMARY.md) |
|
||||
| প্রকল্পের PR/ইস্যু ডক স্ন্যাপশট দেখতে | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## দ্রুত সিদ্ধান্ত গাছ (১০ সেকেন্ড)
|
||||
|
||||
- সেটআপ বা প্রাথমিক ইনস্টলেশন দরকার? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- সুনির্দিষ্ট CLI/কনফিগ কী দরকার? → [reference/README.md](reference/README.md)
|
||||
- প্রোডাকশন/সার্ভিস অপারেশন দরকার? → [ops/README.md](ops/README.md)
|
||||
- ব্যর্থতা বা রিগ্রেশন দেখছেন? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- নিরাপত্তা শক্তিশালীকরণ বা রোডম্যাপে কাজ করছেন? → [security/README.md](security/README.md)
|
||||
- বোর্ড/পেরিফেরাল নিয়ে কাজ করছেন? → [hardware/README.md](hardware/README.md)
|
||||
- অবদান/রিভিউ/CI ওয়ার্কফ্লো? → [contributing/README.md](contributing/README.md)
|
||||
- সম্পূর্ণ মানচিত্র চান? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## সংগ্রহ (প্রস্তাবিত)
|
||||
|
||||
- শুরু করুন: [setup-guides/README.md](setup-guides/README.md)
|
||||
- রেফারেন্স ক্যাটালগ: [reference/README.md](reference/README.md)
|
||||
- অপারেশন ও ডিপ্লয়মেন্ট: [ops/README.md](ops/README.md)
|
||||
- নিরাপত্তা ডকুমেন্টেশন: [security/README.md](security/README.md)
|
||||
- হার্ডওয়্যার/পেরিফেরাল: [hardware/README.md](hardware/README.md)
|
||||
- অবদান/CI: [contributing/README.md](contributing/README.md)
|
||||
- প্রকল্প স্ন্যাপশট: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## দর্শক অনুযায়ী
|
||||
|
||||
### ব্যবহারকারী / অপারেটর
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — ওয়ার্কফ্লো অনুযায়ী কমান্ড খোঁজা
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — প্রোভাইডার আইডি, উপনাম, ক্রেডেনশিয়াল এনভায়রনমেন্ট ভেরিয়েবল
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — চ্যানেল সক্ষমতা ও কনফিগারেশন পাথ
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — Matrix এনক্রিপ্টেড রুম (E2EE) সেটআপ ও সাড়া না দেওয়ার ডায়াগনস্টিক
|
||||
- [config-reference.md](reference/api/config-reference.md) — উচ্চ-গুরুত্বপূর্ণ কনফিগ কী ও নিরাপদ ডিফল্ট
|
||||
- [custom-providers.md](contributing/custom-providers.md) — কাস্টম প্রোভাইডার/বেস URL ইন্টিগ্রেশন প্যাটার্ন
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM সেটআপ ও এন্ডপয়েন্ট ম্যাট্রিক্স
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — মডেল/টুল-কল এজ কেসের জন্য ফলব্যাক ইন্টিগ্রেশন
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — দৈনন্দিন রানটাইম অপারেশন ও রোলব্যাক ফ্লো
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — সাধারণ ব্যর্থতার স্বাক্ষর ও পুনরুদ্ধার পদক্ষেপ
|
||||
|
||||
### অবদানকারী / রক্ষণাবেক্ষণকারী
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### নিরাপত্তা / নির্ভরযোগ্যতা
|
||||
|
||||
> দ্রষ্টব্য: এই বিভাগে প্রস্তাবনা/রোডম্যাপ ডকুমেন্ট রয়েছে। বর্তমান আচরণের জন্য [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md), এবং [troubleshooting.md](ops/troubleshooting.md) দিয়ে শুরু করুন।
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## সিস্টেম নেভিগেশন ও গভর্ন্যান্স
|
||||
|
||||
- একীভূত সূচিপত্র: [SUMMARY.md](SUMMARY.md)
|
||||
- ডক কাঠামো মানচিত্র (ভাষা/অংশ/ফাংশন): [structure/README.md](maintainers/structure-README.md)
|
||||
- ডকুমেন্টেশন তালিকা/শ্রেণীবিভাগ: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- প্রকল্প ট্রায়াজ স্ন্যাপশট: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## অন্যান্য ভাষা
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# Dokumentační hub ZeroClaw
|
||||
|
||||
Tato stránka je hlavním vstupním bodem do dokumentačního systému.
|
||||
|
||||
Poslední aktualizace: **20. února 2026**.
|
||||
|
||||
Lokalizované huby: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Začněte zde
|
||||
|
||||
| Chci… | Přečtěte si toto |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Rychle nainstalovat a spustit ZeroClaw | [README.md (Rychlý start)](../README.md#quick-start) |
|
||||
| Bootstrap jedním příkazem | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Najít příkazy podle úkolu | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Rychle ověřit konfigurační klíče a výchozí hodnoty | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Nastavit vlastní poskytovatele/endpointy | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Nastavit poskytovatele Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Použít integrační vzory LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Provozovat runtime (provozní příručka) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Řešit problémy s instalací/runtime/kanály | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Spustit nastavení a diagnostiku šifrovaných místností Matrix | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Procházet dokumentaci podle kategorie | [SUMMARY.md](SUMMARY.md) |
|
||||
| Zobrazit snapshot dokumentace PR/issues projektu | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Rychlý rozhodovací strom (10 sekund)
|
||||
|
||||
- Potřebujete nastavení nebo počáteční instalaci? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Potřebujete přesné CLI/konfigurační klíče? → [reference/README.md](reference/README.md)
|
||||
- Potřebujete produkční/servisní operace? → [ops/README.md](ops/README.md)
|
||||
- Vidíte selhání nebo regrese? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Pracujete na posílení zabezpečení nebo roadmapě? → [security/README.md](security/README.md)
|
||||
- Pracujete s deskami/periferiemi? → [hardware/README.md](hardware/README.md)
|
||||
- Přispívání/revize/CI workflow? → [contributing/README.md](contributing/README.md)
|
||||
- Chcete kompletní mapu? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Kolekce (doporučené)
|
||||
|
||||
- Začínáme: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Referenční katalogy: [reference/README.md](reference/README.md)
|
||||
- Provoz a nasazení: [ops/README.md](ops/README.md)
|
||||
- Dokumentace zabezpečení: [security/README.md](security/README.md)
|
||||
- Hardware/periferie: [hardware/README.md](hardware/README.md)
|
||||
- Přispívání/CI: [contributing/README.md](contributing/README.md)
|
||||
- Snapshoty projektu: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Podle publika
|
||||
|
||||
### Uživatelé / Operátoři
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — vyhledávání příkazů podle workflow
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — ID poskytovatelů, aliasy, proměnné prostředí pro přihlašovací údaje
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — schopnosti kanálů a konfigurační cesty
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — nastavení šifrovaných místností Matrix (E2EE) a diagnostika nereagování
|
||||
- [config-reference.md](reference/api/config-reference.md) — klíčové konfigurační hodnoty a bezpečné výchozí nastavení
|
||||
- [custom-providers.md](contributing/custom-providers.md) — vzory integrace vlastního poskytovatele/base URL
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — nastavení Z.AI/GLM a matice endpointů
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — záložní integrace pro okrajové případy modelu/volání nástrojů
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — každodenní runtime operace a postupy rollbacku
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — běžné signatury selhání a kroky obnovy
|
||||
|
||||
### Přispěvatelé / Správci
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Zabezpečení / Spolehlivost
|
||||
|
||||
> Poznámka: tato sekce zahrnuje dokumenty návrhů/roadmapy. Pro aktuální chování začněte s [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) a [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Systémová navigace a správa
|
||||
|
||||
- Jednotný obsah: [SUMMARY.md](SUMMARY.md)
|
||||
- Mapa struktury dokumentace (jazyk/část/funkce): [structure/README.md](maintainers/structure-README.md)
|
||||
- Inventář/klasifikace dokumentace: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Snapshot třídění projektu: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Další jazyky
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ZeroClaw Dokumentationshub
|
||||
|
||||
Denne side er det primære indgangspunkt til dokumentationssystemet.
|
||||
|
||||
Sidst opdateret: **20. februar 2026**.
|
||||
|
||||
Lokaliserede hubs: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Start her
|
||||
|
||||
| Jeg vil… | Læs dette |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Hurtigt installere og køre ZeroClaw | [README.md (Hurtig start)](../README.md#quick-start) |
|
||||
| Bootstrap med én kommando | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Finde kommandoer efter opgave | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Hurtigt tjekke konfigurationsnøgler og standardværdier | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Opsætte brugerdefinerede udbydere/endpoints | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Opsætte Z.AI / GLM-udbyderen | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Bruge LangGraph-integrationsmønstre | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Drifte runtime (driftshåndbog) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Fejlfinde installations-/runtime-/kanalproblemer | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Køre opsætning og diagnostik for krypterede Matrix-rum | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Gennemse dokumentation efter kategori | [SUMMARY.md](SUMMARY.md) |
|
||||
| Se projektets PR/issue-dokumentationssnapshot | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Hurtigt beslutningstræ (10 sekunder)
|
||||
|
||||
- Har du brug for opsætning eller førstegangsinstallation? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Har du brug for præcise CLI/konfigurationsnøgler? → [reference/README.md](reference/README.md)
|
||||
- Har du brug for produktions-/servicedrift? → [ops/README.md](ops/README.md)
|
||||
- Ser du fejl eller regressioner? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Arbejder du på sikkerhedshærdning eller roadmap? → [security/README.md](security/README.md)
|
||||
- Arbejder du med boards/periferienheder? → [hardware/README.md](hardware/README.md)
|
||||
- Bidrag/review/CI-workflow? → [contributing/README.md](contributing/README.md)
|
||||
- Vil du se det fulde kort? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Samlinger (anbefalet)
|
||||
|
||||
- Kom i gang: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Referencekataloger: [reference/README.md](reference/README.md)
|
||||
- Drift og udrulning: [ops/README.md](ops/README.md)
|
||||
- Sikkerhedsdokumentation: [security/README.md](security/README.md)
|
||||
- Hardware/periferienheder: [hardware/README.md](hardware/README.md)
|
||||
- Bidrag/CI: [contributing/README.md](contributing/README.md)
|
||||
- Projektsnapshots: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Efter målgruppe
|
||||
|
||||
### Brugere / Operatører
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — kommandoopslag efter workflow
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — udbyder-ID'er, aliaser, legitimationsoplysningers miljøvariabler
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — kanalegenskaber og konfigurationsstier
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — opsætning af krypterede Matrix-rum (E2EE) og diagnostik ved manglende svar
|
||||
- [config-reference.md](reference/api/config-reference.md) — vigtige konfigurationsnøgler og sikre standardværdier
|
||||
- [custom-providers.md](contributing/custom-providers.md) — integrationsmønstre for brugerdefineret udbyder/base-URL
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM-opsætning og endpoint-matrix
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — fallback-integration for model/tool-call-edgecases
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — daglig runtime-drift og rollback-flows
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — almindelige fejlsignaturer og genoprettelsestrin
|
||||
|
||||
### Bidragydere / Vedligeholdere
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Sikkerhed / Pålidelighed
|
||||
|
||||
> Bemærk: dette afsnit inkluderer forslags-/roadmap-dokumenter. For aktuel adfærd, start med [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) og [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Systemnavigation og governance
|
||||
|
||||
- Samlet indholdsfortegnelse: [SUMMARY.md](SUMMARY.md)
|
||||
- Dokumentationsstrukturkort (sprog/del/funktion): [structure/README.md](maintainers/structure-README.md)
|
||||
- Dokumentationsinventar/-klassificering: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Projekt-triage-snapshot: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Andre sprog
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ZeroClaw Dokumentations-Hub
|
||||
|
||||
Diese Seite ist der zentrale Einstiegspunkt in das Dokumentationssystem.
|
||||
|
||||
Zuletzt aktualisiert: **20. Februar 2026**.
|
||||
|
||||
Lokalisierte Hubs: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Hier starten
|
||||
|
||||
| Ich möchte… | Dies lesen |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| ZeroClaw schnell installieren und starten | [README.md (Schnellstart)](../README.md#quick-start) |
|
||||
| Bootstrap mit einem Befehl | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Befehle nach Aufgabe finden | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Schnell Konfigurationsschlüssel und Standardwerte prüfen | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Benutzerdefinierte Anbieter/Endpunkte einrichten | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Den Z.AI / GLM-Anbieter einrichten | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| LangGraph-Integrationsmuster verwenden | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Die Laufzeitumgebung betreiben (Betriebshandbuch) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Installations-/Laufzeit-/Kanalprobleme beheben | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Matrix-verschlüsselte-Raum-Einrichtung und Diagnose ausführen | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Dokumentation nach Kategorie durchsuchen | [SUMMARY.md](SUMMARY.md) |
|
||||
| Projekt-PR/Issue-Dokumentations-Snapshot ansehen | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Schneller Entscheidungsbaum (10 Sekunden)
|
||||
|
||||
- Einrichtung oder Erstinstallation nötig? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Genaue CLI-/Konfigurationsschlüssel benötigt? → [reference/README.md](reference/README.md)
|
||||
- Produktions-/Servicebetrieb benötigt? → [ops/README.md](ops/README.md)
|
||||
- Fehler oder Regressionen sichtbar? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Arbeiten an Sicherheitshärtung oder Roadmap? → [security/README.md](security/README.md)
|
||||
- Arbeiten mit Boards/Peripheriegeräten? → [hardware/README.md](hardware/README.md)
|
||||
- Beitragen/Review/CI-Workflow? → [contributing/README.md](contributing/README.md)
|
||||
- Vollständige Karte gewünscht? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Sammlungen (empfohlen)
|
||||
|
||||
- Einstieg: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Referenzkataloge: [reference/README.md](reference/README.md)
|
||||
- Betrieb und Bereitstellung: [ops/README.md](ops/README.md)
|
||||
- Sicherheitsdokumentation: [security/README.md](security/README.md)
|
||||
- Hardware/Peripheriegeräte: [hardware/README.md](hardware/README.md)
|
||||
- Beitragen/CI: [contributing/README.md](contributing/README.md)
|
||||
- Projekt-Snapshots: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Nach Zielgruppe
|
||||
|
||||
### Benutzer / Betreiber
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — Befehlssuche nach Workflow
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — Anbieter-IDs, Aliase, Umgebungsvariablen für Anmeldedaten
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — Kanalfähigkeiten und Konfigurationspfade
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — Matrix-verschlüsselter-Raum-Einrichtung (E2EE) und Diagnose bei ausbleibender Antwort
|
||||
- [config-reference.md](reference/api/config-reference.md) — wichtige Konfigurationsschlüssel und sichere Standardwerte
|
||||
- [custom-providers.md](contributing/custom-providers.md) — Integrationsmuster für benutzerdefinierte Anbieter/Basis-URL
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM-Einrichtung und Endpunkt-Matrix
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — Fallback-Integration für Modell-/Tool-Call-Grenzfälle
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — täglicher Laufzeitbetrieb und Rollback-Abläufe
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — häufige Fehlersignaturen und Wiederherstellungsschritte
|
||||
|
||||
### Mitwirkende / Betreuer
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Sicherheit / Zuverlässigkeit
|
||||
|
||||
> Hinweis: Dieser Bereich enthält Vorschlags-/Roadmap-Dokumente. Für das aktuelle Verhalten beginnen Sie mit [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) und [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Systemnavigation und Governance
|
||||
|
||||
- Einheitliches Inhaltsverzeichnis: [SUMMARY.md](SUMMARY.md)
|
||||
- Dokumentationsstrukturkarte (Sprache/Teil/Funktion): [structure/README.md](maintainers/structure-README.md)
|
||||
- Dokumentationsinventar/-klassifizierung: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Projekt-Triage-Snapshot: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Andere Sprachen
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# Κέντρο Τεκμηρίωσης ZeroClaw
|
||||
|
||||
Αυτή η σελίδα είναι το κύριο σημείο εισόδου για το σύστημα τεκμηρίωσης.
|
||||
|
||||
Τελευταία ενημέρωση: **20 Φεβρουαρίου 2026**.
|
||||
|
||||
Τοπικοποιημένα κέντρα: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Ξεκινήστε Εδώ
|
||||
|
||||
| Θέλω να… | Διαβάστε αυτό |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Εγκαταστήσω και εκτελέσω το ZeroClaw γρήγορα | [README.md (Γρήγορη Εκκίνηση)](../README.md#quick-start) |
|
||||
| Εκκίνηση με μία εντολή | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Βρω εντολές ανά εργασία | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Ελέγξω γρήγορα κλειδιά και προεπιλογές ρυθμίσεων | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Ρυθμίσω προσαρμοσμένους παρόχους/endpoints | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Ρυθμίσω τον πάροχο Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Χρησιμοποιήσω τα πρότυπα ενσωμάτωσης LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Λειτουργήσω το runtime (runbook ημέρας-2) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Αντιμετωπίσω προβλήματα εγκατάστασης/runtime/καναλιού | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Εκτελέσω ρύθμιση και διαγνωστικά κρυπτογραφημένων δωματίων Matrix | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Περιηγηθώ στα έγγραφα ανά κατηγορία | [SUMMARY.md](SUMMARY.md) |
|
||||
| Δω το στιγμιότυπο εγγράφων PR/issues του έργου | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Δέντρο Γρήγορης Απόφασης (10 δευτερόλεπτα)
|
||||
|
||||
- Χρειάζεστε αρχική ρύθμιση ή εγκατάσταση; → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Χρειάζεστε ακριβή κλειδιά CLI/ρυθμίσεων; → [reference/README.md](reference/README.md)
|
||||
- Χρειάζεστε λειτουργίες παραγωγής/υπηρεσίας; → [ops/README.md](ops/README.md)
|
||||
- Βλέπετε αποτυχίες ή παλινδρομήσεις; → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Εργάζεστε στη σκλήρυνση ασφαλείας ή τον οδικό χάρτη; → [security/README.md](security/README.md)
|
||||
- Εργάζεστε με πλακέτες/περιφερειακά; → [hardware/README.md](hardware/README.md)
|
||||
- Συνεισφορά/αξιολόγηση/ροή εργασίας CI; → [contributing/README.md](contributing/README.md)
|
||||
- Θέλετε τον πλήρη χάρτη; → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Συλλογές (Συνιστώνται)
|
||||
|
||||
- Εκκίνηση: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Κατάλογοι αναφοράς: [reference/README.md](reference/README.md)
|
||||
- Λειτουργίες & ανάπτυξη: [ops/README.md](ops/README.md)
|
||||
- Έγγραφα ασφαλείας: [security/README.md](security/README.md)
|
||||
- Υλικό/περιφερειακά: [hardware/README.md](hardware/README.md)
|
||||
- Συνεισφορά/CI: [contributing/README.md](contributing/README.md)
|
||||
- Στιγμιότυπα έργου: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Ανά Κοινό
|
||||
|
||||
### Χρήστες / Χειριστές
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — αναζήτηση εντολών ανά ροή εργασίας
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — αναγνωριστικά παρόχων, ψευδώνυμα, μεταβλητές περιβάλλοντος διαπιστευτηρίων
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — δυνατότητες καναλιών και διαδρομές ρύθμισης
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — ρύθμιση κρυπτογραφημένων δωματίων Matrix (E2EE) και διαγνωστικά μη-απόκρισης
|
||||
- [config-reference.md](reference/api/config-reference.md) — κλειδιά ρυθμίσεων υψηλής σήμανσης και ασφαλείς προεπιλογές
|
||||
- [custom-providers.md](contributing/custom-providers.md) — πρότυπα ενσωμάτωσης προσαρμοσμένου παρόχου/βασικού URL
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — ρύθμιση Z.AI/GLM και πίνακας endpoints
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — εφεδρική ενσωμάτωση για ακραίες περιπτώσεις μοντέλου/κλήσης εργαλείου
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — λειτουργίες runtime ημέρας-2 και ροές επαναφοράς
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — συνήθεις υπογραφές αποτυχίας και βήματα αποκατάστασης
|
||||
|
||||
### Συνεισφέροντες / Συντηρητές
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Ασφάλεια / Αξιοπιστία
|
||||
|
||||
> Σημείωση: αυτή η περιοχή περιλαμβάνει έγγραφα πρότασης/οδικού χάρτη. Για την τρέχουσα συμπεριφορά, ξεκινήστε από [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md), και [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Πλοήγηση Συστήματος & Διακυβέρνηση
|
||||
|
||||
- Ενοποιημένος πίνακας περιεχομένων: [SUMMARY.md](SUMMARY.md)
|
||||
- Χάρτης δομής εγγράφων (γλώσσα/τμήμα/λειτουργία): [structure/README.md](maintainers/structure-README.md)
|
||||
- Απογραφή/ταξινόμηση τεκμηρίωσης: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Στιγμιότυπο διαλογής έργου: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Άλλες γλώσσες
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# Centro de Documentación ZeroClaw
|
||||
|
||||
Esta página es el punto de entrada principal del sistema de documentación.
|
||||
|
||||
Última actualización: **20 de febrero de 2026**.
|
||||
|
||||
Centros localizados: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Comience Aquí
|
||||
|
||||
| Quiero… | Leer esto |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Instalar y ejecutar ZeroClaw rápidamente | [README.md (Inicio Rápido)](../README.md#quick-start) |
|
||||
| Arranque con un solo comando | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Encontrar comandos por tarea | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Verificar rápidamente claves y valores predeterminados de config | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Configurar proveedores/endpoints personalizados | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Configurar el proveedor Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Usar los patrones de integración LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Operar el runtime (runbook día-2) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Solucionar problemas de instalación/runtime/canal | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Ejecutar configuración y diagnósticos de salas cifradas Matrix | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Navegar la documentación por categoría | [SUMMARY.md](SUMMARY.md) |
|
||||
| Ver la instantánea de docs de PR/issues del proyecto | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Árbol de Decisión Rápida (10 segundos)
|
||||
|
||||
- ¿Necesita configuración o instalación inicial? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- ¿Necesita claves exactas de CLI/configuración? → [reference/README.md](reference/README.md)
|
||||
- ¿Necesita operaciones de producción/servicio? → [ops/README.md](ops/README.md)
|
||||
- ¿Ve fallos o regresiones? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- ¿Trabaja en endurecimiento de seguridad o hoja de ruta? → [security/README.md](security/README.md)
|
||||
- ¿Trabaja con placas/periféricos? → [hardware/README.md](hardware/README.md)
|
||||
- ¿Contribución/revisión/flujo de trabajo CI? → [contributing/README.md](contributing/README.md)
|
||||
- ¿Quiere el mapa completo? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Colecciones (Recomendadas)
|
||||
|
||||
- Inicio: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Catálogos de referencia: [reference/README.md](reference/README.md)
|
||||
- Operaciones y despliegue: [ops/README.md](ops/README.md)
|
||||
- Documentación de seguridad: [security/README.md](security/README.md)
|
||||
- Hardware/periféricos: [hardware/README.md](hardware/README.md)
|
||||
- Contribución/CI: [contributing/README.md](contributing/README.md)
|
||||
- Instantáneas del proyecto: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Por Audiencia
|
||||
|
||||
### Usuarios / Operadores
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — búsqueda de comandos por flujo de trabajo
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — IDs de proveedores, alias, variables de entorno de credenciales
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — capacidades de canales y rutas de configuración
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — configuración de salas cifradas Matrix (E2EE) y diagnósticos de no-respuesta
|
||||
- [config-reference.md](reference/api/config-reference.md) — claves de configuración de alta señalización y valores predeterminados seguros
|
||||
- [custom-providers.md](contributing/custom-providers.md) — patrones de integración de proveedor personalizado/URL base
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — configuración Z.AI/GLM y matriz de endpoints
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — integración de respaldo para casos límite de modelo/llamada de herramienta
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — operaciones runtime día-2 y flujos de rollback
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — firmas de fallo comunes y pasos de recuperación
|
||||
|
||||
### Contribuidores / Mantenedores
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Seguridad / Fiabilidad
|
||||
|
||||
> Nota: esta zona incluye documentos de propuesta/hoja de ruta. Para el comportamiento actual, comience por [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md), y [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Navegación del Sistema y Gobernanza
|
||||
|
||||
- Tabla de contenidos unificada: [SUMMARY.md](SUMMARY.md)
|
||||
- Mapa de estructura de docs (idioma/sección/función): [structure/README.md](maintainers/structure-README.md)
|
||||
- Inventario/clasificación de la documentación: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Instantánea de triaje del proyecto: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Otros idiomas
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ZeroClaw-dokumentaatiokeskus
|
||||
|
||||
Tämä sivu on dokumentaatiojärjestelmän ensisijainen aloituspiste.
|
||||
|
||||
Viimeksi päivitetty: **20. helmikuuta 2026**.
|
||||
|
||||
Lokalisoidut keskukset: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Aloita Tästä
|
||||
|
||||
| Haluan… | Lue tämä |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Asentaa ja ajaa ZeroClaw nopeasti | [README.md (Pikaopas)](../README.md#quick-start) |
|
||||
| Käynnistys yhdellä komennolla | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Löytää komentoja tehtävän mukaan | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Tarkistaa nopeasti asetusavaimet ja oletusarvot | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Määrittää mukautettuja tarjoajia/päätepisteitä | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Määrittää Z.AI / GLM -tarjoajan | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Käyttää LangGraph-integrointimalleja | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Käyttää ajonaikaa (päivä-2 runbook) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Ratkaista asennus-/ajonaika-/kanavaongelmia | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Ajaa Matrix-salattujen huoneiden asetukset ja diagnostiikka | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Selata dokumentaatiota kategorioittain | [SUMMARY.md](SUMMARY.md) |
|
||||
| Nähdä projektin PR/issue-dokumenttien tilannekuva | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Nopea Päätöspuu (10 sekuntia)
|
||||
|
||||
- Tarvitsetko alkuasennuksen tai -määrityksen? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Tarvitsetko tarkat CLI/asetusavaimet? → [reference/README.md](reference/README.md)
|
||||
- Tarvitsetko tuotanto-/palvelutoimintoja? → [ops/README.md](ops/README.md)
|
||||
- Näetkö virheitä tai regressioita? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Työskenteletkö tietoturvan koventamisen tai tiekartan parissa? → [security/README.md](security/README.md)
|
||||
- Työskenteletkö levyjen/oheislaitteiden kanssa? → [hardware/README.md](hardware/README.md)
|
||||
- Osallistuminen/katselmointi/CI-työnkulku? → [contributing/README.md](contributing/README.md)
|
||||
- Haluatko täydellisen kartan? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Kokoelmat (Suositellut)
|
||||
|
||||
- Aloitus: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Viiteluettelot: [reference/README.md](reference/README.md)
|
||||
- Toiminta ja käyttöönotto: [ops/README.md](ops/README.md)
|
||||
- Tietoturvadokumentit: [security/README.md](security/README.md)
|
||||
- Laitteisto/oheislaitteet: [hardware/README.md](hardware/README.md)
|
||||
- Osallistuminen/CI: [contributing/README.md](contributing/README.md)
|
||||
- Projektin tilannekuvat: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Yleisön Mukaan
|
||||
|
||||
### Käyttäjät / Operaattorit
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — komentojen haku työnkulun mukaan
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — tarjoajien tunnisteet, aliakset, tunnistetietojen ympäristömuuttujat
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — kanavien ominaisuudet ja asetuspolut
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — Matrix-salattujen huoneiden (E2EE) asetukset ja vastaamattomuuden diagnostiikka
|
||||
- [config-reference.md](reference/api/config-reference.md) — korkean signaalin asetusavaimet ja turvalliset oletusarvot
|
||||
- [custom-providers.md](contributing/custom-providers.md) — mukautetun tarjoajan/perus-URL:n integrointimallit
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM-asetukset ja päätepistematriisi
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — varaintegrointi mallin/työkalukutsun reunatapauksille
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — ajonaikan päivä-2 toiminnot ja palautustyönkulut
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — yleiset virhesignatuurit ja palautusaskeleet
|
||||
|
||||
### Osallistujat / Ylläpitäjät
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Tietoturva / Luotettavuus
|
||||
|
||||
> Huomautus: tämä alue sisältää ehdotus-/tiekartadokumentteja. Nykyisestä toiminnasta aloita kohdista [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) ja [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Järjestelmänavigaatio & Hallintotapa
|
||||
|
||||
- Yhtenäinen sisällysluettelo: [SUMMARY.md](SUMMARY.md)
|
||||
- Dokumenttien rakennekartta (kieli/osio/toiminto): [structure/README.md](maintainers/structure-README.md)
|
||||
- Dokumentaation inventaario/luokittelu: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Projektin lajittelun tilannekuva: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Muut kielet
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# מרכז התיעוד של ZeroClaw
|
||||
|
||||
דף זה הוא נקודת הכניסה הראשית למערכת התיעוד.
|
||||
|
||||
עדכון אחרון: **20 בפברואר 2026**.
|
||||
|
||||
מרכזים מתורגמים: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## התחילו כאן
|
||||
|
||||
| אני רוצה… | קראו זאת |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| להתקין ולהריץ את ZeroClaw במהירות | [README.md (התחלה מהירה)](../README.md#quick-start) |
|
||||
| אתחול בפקודה אחת | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| למצוא פקודות לפי משימה | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| לבדוק במהירות מפתחות ובררות מחדל של הגדרות | [config-reference.md](reference/api/config-reference.md) |
|
||||
| להגדיר ספקים/נקודות קצה מותאמים אישית | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| להגדיר את ספק Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| להשתמש בתבניות שילוב LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| להפעיל את סביבת הריצה (runbook יום-2) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| לפתור בעיות התקנה/סביבת ריצה/ערוץ | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| להריץ הגדרה ואבחון של חדרים מוצפנים ב-Matrix | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| לדפדף בתיעוד לפי קטגוריה | [SUMMARY.md](SUMMARY.md) |
|
||||
| לראות תמונת מצב של PR/issues של הפרויקט | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## עץ החלטה מהיר (10 שניות)
|
||||
|
||||
- צריכים הגדרה או התקנה ראשונית? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- צריכים מפתחות CLI/הגדרות מדויקים? → [reference/README.md](reference/README.md)
|
||||
- צריכים פעולות ייצור/שירות? → [ops/README.md](ops/README.md)
|
||||
- רואים כשלים או רגרסיות? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- עובדים על הקשחת אבטחה או מפת דרכים? → [security/README.md](security/README.md)
|
||||
- עובדים עם לוחות/ציוד היקפי? → [hardware/README.md](hardware/README.md)
|
||||
- תרומה/סקירה/זרימת עבודה CI? → [contributing/README.md](contributing/README.md)
|
||||
- רוצים את המפה המלאה? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## אוספים (מומלצים)
|
||||
|
||||
- התחלה: [setup-guides/README.md](setup-guides/README.md)
|
||||
- קטלוגי עיון: [reference/README.md](reference/README.md)
|
||||
- תפעול ופריסה: [ops/README.md](ops/README.md)
|
||||
- תיעוד אבטחה: [security/README.md](security/README.md)
|
||||
- חומרה/ציוד היקפי: [hardware/README.md](hardware/README.md)
|
||||
- תרומה/CI: [contributing/README.md](contributing/README.md)
|
||||
- תמונות מצב של הפרויקט: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## לפי קהל יעד
|
||||
|
||||
### משתמשים / מפעילים
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — חיפוש פקודות לפי זרימת עבודה
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — מזהי ספקים, כינויים, משתני סביבה של אישורים
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — יכולות ערוצים ונתיבי הגדרה
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — הגדרת חדרים מוצפנים ב-Matrix (E2EE) ואבחון אי-תגובה
|
||||
- [config-reference.md](reference/api/config-reference.md) — מפתחות הגדרה בעלי אות חזק ובררות מחדל בטוחות
|
||||
- [custom-providers.md](contributing/custom-providers.md) — תבניות שילוב ספק מותאם אישית/URL בסיס
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — הגדרת Z.AI/GLM ומטריצת נקודות קצה
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — שילוב חלופי למקרי קצה של מודל/קריאת כלי
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — פעולות סביבת ריצה יום-2 וזרימות שחזור
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — חתימות כשל נפוצות וצעדי שחזור
|
||||
|
||||
### תורמים / מתחזקים
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### אבטחה / אמינות
|
||||
|
||||
> הערה: אזור זה כולל מסמכי הצעה/מפת דרכים. להתנהגות הנוכחית, התחילו מ-[config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md), ו-[troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## ניווט במערכת וממשל
|
||||
|
||||
- תוכן עניינים מאוחד: [SUMMARY.md](SUMMARY.md)
|
||||
- מפת מבנה תיעוד (שפה/חלק/פונקציה): [structure/README.md](maintainers/structure-README.md)
|
||||
- מלאי/סיווג תיעוד: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- תמונת מצב של מיון הפרויקט: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## שפות אחרות
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ZeroClaw दस्तावेज़ीकरण केंद्र
|
||||
|
||||
यह पृष्ठ दस्तावेज़ीकरण प्रणाली का प्राथमिक प्रवेश बिंदु है।
|
||||
|
||||
अंतिम अपडेट: **20 फरवरी 2026**।
|
||||
|
||||
स्थानीयकृत केंद्र: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## यहाँ से शुरू करें
|
||||
|
||||
| मैं चाहता/चाहती हूँ… | यह पढ़ें |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| ZeroClaw को जल्दी से इंस्टॉल और चलाना | [README.md (त्वरित प्रारंभ)](../README.md#quick-start) |
|
||||
| एक कमांड में बूटस्ट्रैप | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| कार्य के अनुसार कमांड खोजना | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| कॉन्फ़िग कुंजियों और डिफ़ॉल्ट मानों को जल्दी जाँचना | [config-reference.md](reference/api/config-reference.md) |
|
||||
| कस्टम प्रदाता/एंडपॉइंट कॉन्फ़िगर करना | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Z.AI / GLM प्रदाता कॉन्फ़िगर करना | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| LangGraph एकीकरण पैटर्न का उपयोग करना | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| रनटाइम संचालित करना (दिन-2 रनबुक) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| इंस्टॉलेशन/रनटाइम/चैनल समस्याओं का निवारण | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Matrix एन्क्रिप्टेड कमरों का सेटअप और डायग्नोस्टिक्स चलाना | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| श्रेणी के अनुसार दस्तावेज़ ब्राउज़ करना | [SUMMARY.md](SUMMARY.md) |
|
||||
| प्रोजेक्ट PR/issues दस्तावेज़ स्नैपशॉट देखना | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## त्वरित निर्णय वृक्ष (10 सेकंड)
|
||||
|
||||
- प्रारंभिक सेटअप या इंस्टॉलेशन चाहिए? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- सटीक CLI/कॉन्फ़िग कुंजियाँ चाहिए? → [reference/README.md](reference/README.md)
|
||||
- प्रोडक्शन/सर्विस ऑपरेशन चाहिए? → [ops/README.md](ops/README.md)
|
||||
- विफलताएँ या रिग्रेशन दिख रहे हैं? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- सुरक्षा सख्ती या रोडमैप पर काम कर रहे हैं? → [security/README.md](security/README.md)
|
||||
- बोर्ड/पेरिफेरल्स के साथ काम कर रहे हैं? → [hardware/README.md](hardware/README.md)
|
||||
- योगदान/समीक्षा/CI वर्कफ़्लो? → [contributing/README.md](contributing/README.md)
|
||||
- पूरा नक्शा चाहिए? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## संग्रह (अनुशंसित)
|
||||
|
||||
- प्रारंभ: [setup-guides/README.md](setup-guides/README.md)
|
||||
- संदर्भ सूचियाँ: [reference/README.md](reference/README.md)
|
||||
- संचालन और तैनाती: [ops/README.md](ops/README.md)
|
||||
- सुरक्षा दस्तावेज़: [security/README.md](security/README.md)
|
||||
- हार्डवेयर/पेरिफेरल्स: [hardware/README.md](hardware/README.md)
|
||||
- योगदान/CI: [contributing/README.md](contributing/README.md)
|
||||
- प्रोजेक्ट स्नैपशॉट: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## दर्शक वर्ग के अनुसार
|
||||
|
||||
### उपयोगकर्ता / ऑपरेटर
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — वर्कफ़्लो के अनुसार कमांड खोज
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — प्रदाता ID, उपनाम, क्रेडेंशियल पर्यावरण चर
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — चैनल क्षमताएँ और कॉन्फ़िगरेशन पथ
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — Matrix एन्क्रिप्टेड कमरा (E2EE) सेटअप और गैर-प्रतिक्रिया डायग्नोस्टिक्स
|
||||
- [config-reference.md](reference/api/config-reference.md) — उच्च-संकेत कॉन्फ़िग कुंजियाँ और सुरक्षित डिफ़ॉल्ट
|
||||
- [custom-providers.md](contributing/custom-providers.md) — कस्टम प्रदाता/बेस URL एकीकरण पैटर्न
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM सेटअप और एंडपॉइंट मैट्रिक्स
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — मॉडल/टूल-कॉल एज केस के लिए फ़ॉलबैक एकीकरण
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — रनटाइम दिन-2 ऑपरेशन और रोलबैक फ़्लो
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — सामान्य विफलता हस्ताक्षर और पुनर्प्राप्ति चरण
|
||||
|
||||
### योगदानकर्ता / अनुरक्षक
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### सुरक्षा / विश्वसनीयता
|
||||
|
||||
> नोट: इस क्षेत्र में प्रस्ताव/रोडमैप दस्तावेज़ शामिल हैं। वर्तमान व्यवहार के लिए, [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md), और [troubleshooting.md](ops/troubleshooting.md) से शुरू करें।
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## सिस्टम नेविगेशन और शासन
|
||||
|
||||
- एकीकृत विषय सूची: [SUMMARY.md](SUMMARY.md)
|
||||
- दस्तावेज़ संरचना नक्शा (भाषा/भाग/कार्य): [structure/README.md](maintainers/structure-README.md)
|
||||
- दस्तावेज़ीकरण सूची/वर्गीकरण: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- प्रोजेक्ट ट्राइएज स्नैपशॉट: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## अन्य भाषाएँ
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,99 @@
|
||||
# ZeroClaw Dokumentációs Központ
|
||||
|
||||
Ez az oldal a dokumentációs rendszer fő belépési pontja.
|
||||
|
||||
Utolsó frissítés: **2026. február 21.**
|
||||
|
||||
Honosított központok: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Kezdje itt
|
||||
|
||||
| Szeretném… | Olvassa el |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Gyorsan telepíteni és futtatni a ZeroClaw-t | [README.md (Gyorsindítás)](../README.md#quick-start) |
|
||||
| Egylépéses bootstrap | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Frissítés vagy eltávolítás macOS-en | [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md) |
|
||||
| Parancsok keresése feladat szerint | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Konfigurációs alapértékek és kulcsok gyors ellenőrzése | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Egyéni szolgáltatók/végpontok beállítása | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Z.AI / GLM szolgáltató beállítása | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| LangGraph integrációs minták használata | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Futtatókörnyezet üzemeltetése (2. napi kézikönyv) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Telepítési/futtatási/csatorna problémák elhárítása | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Matrix titkosított szoba beállítás és diagnosztika futtatása | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Dokumentáció böngészése kategória szerint | [SUMMARY.md](SUMMARY.md) |
|
||||
| Projekt PR/issue dokumentációs pillanatkép megtekintése | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Gyors Döntési Fa (10 másodperc)
|
||||
|
||||
- Első telepítés vagy beállítás szükséges? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Pontos CLI/konfigurációs kulcsok kellenek? → [reference/README.md](reference/README.md)
|
||||
- Éles/szolgáltatás üzemeltetés szükséges? → [ops/README.md](ops/README.md)
|
||||
- Hibákat vagy regressziókat tapasztal? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Biztonsági megerősítésen vagy ütemterven dolgozik? → [security/README.md](security/README.md)
|
||||
- Kártyákkal/perifériákkal dolgozik? → [hardware/README.md](hardware/README.md)
|
||||
- Hozzájárulás/áttekintés/CI munkafolyamat? → [contributing/README.md](contributing/README.md)
|
||||
- Teljes térképet szeretne? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Gyűjtemények (Ajánlott)
|
||||
|
||||
- Első lépések: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Referencia katalógusok: [reference/README.md](reference/README.md)
|
||||
- Üzemeltetés és telepítés: [ops/README.md](ops/README.md)
|
||||
- Biztonsági dokumentáció: [security/README.md](security/README.md)
|
||||
- Hardver/perifériák: [hardware/README.md](hardware/README.md)
|
||||
- Hozzájárulás/CI: [contributing/README.md](contributing/README.md)
|
||||
- Projekt pillanatképek: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Célközönség szerint
|
||||
|
||||
### Felhasználók / Üzemeltetők
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — parancskeresés munkafolyamat szerint
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — szolgáltató azonosítók, álnevek, hitelesítési környezeti változók
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — csatorna képességek és beállítási útvonalak
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — Matrix titkosított szoba (E2EE) beállítás és válaszhiány diagnosztika
|
||||
- [config-reference.md](reference/api/config-reference.md) — kiemelt konfigurációs kulcsok és biztonságos alapértékek
|
||||
- [custom-providers.md](contributing/custom-providers.md) — egyéni szolgáltató/alap URL integrációs sablonok
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM beállítás és végpont mátrix
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — tartalék integráció modell/eszközhívás szélsőséges esetekhez
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — 2. napi futtatókörnyezet üzemeltetés és visszaállítási folyamat
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — gyakori hibajelek és helyreállítási lépések
|
||||
|
||||
### Közreműködők / Karbantartók
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Biztonság / Megbízhatóság
|
||||
|
||||
> Megjegyzés: ez a terület javaslat/ütemterv dokumentumokat is tartalmaz. A jelenlegi viselkedésért kezdje a [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) és [troubleshooting.md](ops/troubleshooting.md) fájlokkal.
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Rendszernavigáció és Irányítás
|
||||
|
||||
- Egységes tartalomjegyzék: [SUMMARY.md](SUMMARY.md)
|
||||
- Dokumentáció szerkezeti térkép (nyelv/rész/funkció): [structure/README.md](maintainers/structure-README.md)
|
||||
- Dokumentáció leltár/osztályozás: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- i18n dokumentáció index: [i18n/README.md](i18n/README.md)
|
||||
- i18n lefedettségi térkép: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
- Projekt triage pillanatkép: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Más nyelvek
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,99 @@
|
||||
# Pusat Dokumentasi ZeroClaw
|
||||
|
||||
Halaman ini adalah titik masuk utama untuk sistem dokumentasi.
|
||||
|
||||
Pembaruan terakhir: **21 Februari 2026**.
|
||||
|
||||
Hub terlokalisasi: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Mulai di Sini
|
||||
|
||||
| Saya ingin… | Baca ini |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Menginstal dan menjalankan ZeroClaw dengan cepat | [README.md (Mulai Cepat)](../README.md#quick-start) |
|
||||
| Bootstrap dalam satu perintah | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Memperbarui atau menghapus di macOS | [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md) |
|
||||
| Mencari perintah berdasarkan tugas | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Memeriksa default dan kunci konfigurasi dengan cepat | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Mengonfigurasi penyedia/endpoint kustom | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Mengonfigurasi penyedia Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Menggunakan pola integrasi LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Mengoperasikan runtime (buku panduan hari ke-2) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Memecahkan masalah instalasi/runtime/kanal | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Menjalankan pengaturan ruang terenkripsi Matrix dan diagnostik | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Menjelajahi dokumentasi berdasarkan kategori | [SUMMARY.md](SUMMARY.md) |
|
||||
| Melihat snapshot dokumen PR/issue proyek | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Pohon Keputusan Cepat (10 detik)
|
||||
|
||||
- Butuh pengaturan atau instalasi pertama kali? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Butuh kunci CLI/konfigurasi yang tepat? → [reference/README.md](reference/README.md)
|
||||
- Butuh operasi produksi/layanan? → [ops/README.md](ops/README.md)
|
||||
- Melihat kegagalan atau regresi? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Bekerja pada penguatan keamanan atau peta jalan? → [security/README.md](security/README.md)
|
||||
- Bekerja dengan papan/periferal? → [hardware/README.md](hardware/README.md)
|
||||
- Kontribusi/review/alur kerja CI? → [contributing/README.md](contributing/README.md)
|
||||
- Ingin peta lengkap? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Koleksi (Direkomendasikan)
|
||||
|
||||
- Memulai: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Katalog referensi: [reference/README.md](reference/README.md)
|
||||
- Operasi & deployment: [ops/README.md](ops/README.md)
|
||||
- Dokumentasi keamanan: [security/README.md](security/README.md)
|
||||
- Perangkat keras/periferal: [hardware/README.md](hardware/README.md)
|
||||
- Kontribusi/CI: [contributing/README.md](contributing/README.md)
|
||||
- Snapshot proyek: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Berdasarkan Audiens
|
||||
|
||||
### Pengguna / Operator
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — pencarian perintah berdasarkan alur kerja
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — ID penyedia, alias, variabel lingkungan kredensial
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — kemampuan kanal dan jalur pengaturan
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — pengaturan ruang terenkripsi Matrix (E2EE) dan diagnostik tanpa respons
|
||||
- [config-reference.md](reference/api/config-reference.md) — kunci konfigurasi penting dan default aman
|
||||
- [custom-providers.md](contributing/custom-providers.md) — template integrasi penyedia kustom/URL dasar
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — pengaturan Z.AI/GLM dan matriks endpoint
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — integrasi fallback untuk kasus tepi model/pemanggilan alat
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — operasi runtime hari ke-2 dan alur rollback
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — tanda kegagalan umum dan langkah pemulihan
|
||||
|
||||
### Kontributor / Pengelola
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Keamanan / Keandalan
|
||||
|
||||
> Catatan: area ini mencakup dokumen proposal/peta jalan. Untuk perilaku saat ini, mulailah dengan [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md), dan [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Navigasi Sistem & Tata Kelola
|
||||
|
||||
- Daftar isi terpadu: [SUMMARY.md](SUMMARY.md)
|
||||
- Peta struktur dokumentasi (bahasa/bagian/fungsi): [structure/README.md](maintainers/structure-README.md)
|
||||
- Inventaris/klasifikasi dokumentasi: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Indeks dokumentasi i18n: [i18n/README.md](i18n/README.md)
|
||||
- Peta cakupan i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
- Snapshot triase proyek: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Bahasa lain
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,99 @@
|
||||
# Hub della Documentazione ZeroClaw
|
||||
|
||||
Questa pagina è il punto di ingresso principale del sistema di documentazione.
|
||||
|
||||
Ultimo aggiornamento: **21 febbraio 2026**.
|
||||
|
||||
Hub localizzati: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Inizia Qui
|
||||
|
||||
| Voglio… | Leggi questo |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Installare ed eseguire ZeroClaw rapidamente | [README.md (Avvio Rapido)](../README.md#quick-start) |
|
||||
| Bootstrap con un singolo comando | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Aggiornare o disinstallare su macOS | [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md) |
|
||||
| Trovare comandi per attività | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Controllare rapidamente valori predefiniti e chiavi di configurazione | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Configurare provider/endpoint personalizzati | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Configurare il provider Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Usare i pattern di integrazione LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Gestire il runtime (runbook giorno 2) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Risolvere problemi di installazione/runtime/canale | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Eseguire configurazione e diagnostica delle stanze crittografate Matrix | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Sfogliare la documentazione per categoria | [SUMMARY.md](SUMMARY.md) |
|
||||
| Vedere lo snapshot dei documenti PR/issue del progetto | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Albero Decisionale Rapido (10 secondi)
|
||||
|
||||
- Serve configurazione o installazione iniziale? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Servono chiavi CLI/configurazione esatte? → [reference/README.md](reference/README.md)
|
||||
- Servono operazioni di produzione/servizio? → [ops/README.md](ops/README.md)
|
||||
- Si verificano errori o regressioni? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Si lavora sul rafforzamento della sicurezza o sulla roadmap? → [security/README.md](security/README.md)
|
||||
- Si lavora con schede/periferiche? → [hardware/README.md](hardware/README.md)
|
||||
- Contribuzione/revisione/workflow CI? → [contributing/README.md](contributing/README.md)
|
||||
- Vuoi la mappa completa? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Collezioni (Raccomandate)
|
||||
|
||||
- Per iniziare: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Cataloghi di riferimento: [reference/README.md](reference/README.md)
|
||||
- Operazioni e deployment: [ops/README.md](ops/README.md)
|
||||
- Documentazione sulla sicurezza: [security/README.md](security/README.md)
|
||||
- Hardware/periferiche: [hardware/README.md](hardware/README.md)
|
||||
- Contribuzione/CI: [contributing/README.md](contributing/README.md)
|
||||
- Snapshot del progetto: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Per Pubblico
|
||||
|
||||
### Utenti / Operatori
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — ricerca comandi per workflow
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — ID provider, alias, variabili d'ambiente per le credenziali
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — capacità dei canali e percorsi di configurazione
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — configurazione stanze crittografate Matrix (E2EE) e diagnostica mancata risposta
|
||||
- [config-reference.md](reference/api/config-reference.md) — chiavi di configurazione importanti e valori predefiniti sicuri
|
||||
- [custom-providers.md](contributing/custom-providers.md) — template di integrazione provider personalizzato/URL base
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — configurazione Z.AI/GLM e matrice degli endpoint
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — integrazione di fallback per casi limite modello/chiamata strumenti
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — operazioni runtime giorno 2 e flusso di rollback
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — firme di errore comuni e passaggi di ripristino
|
||||
|
||||
### Contributori / Manutentori
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Sicurezza / Affidabilità
|
||||
|
||||
> Nota: quest'area include documenti di proposta/roadmap. Per il comportamento attuale, iniziare con [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) e [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Navigazione di Sistema e Governance
|
||||
|
||||
- Indice unificato: [SUMMARY.md](SUMMARY.md)
|
||||
- Mappa della struttura documentale (lingua/parte/funzione): [structure/README.md](maintainers/structure-README.md)
|
||||
- Inventario/classificazione della documentazione: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Indice documentazione i18n: [i18n/README.md](i18n/README.md)
|
||||
- Mappa di copertura i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
- Snapshot di triage del progetto: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Altre lingue
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,99 @@
|
||||
# ZeroClaw 문서 허브
|
||||
|
||||
이 페이지는 문서 시스템의 기본 진입점입니다.
|
||||
|
||||
마지막 업데이트: **2026년 2월 21일**.
|
||||
|
||||
현지화된 허브: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## 여기서 시작하세요
|
||||
|
||||
| 하고 싶은 것… | 이것을 읽으세요 |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| ZeroClaw를 빠르게 설치하고 실행 | [README.md (빠른 시작)](../README.md#quick-start) |
|
||||
| 한 번의 명령으로 부트스트랩 | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| macOS에서 업데이트 또는 제거 | [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md) |
|
||||
| 작업별 명령어 찾기 | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| 구성 기본값과 키를 빠르게 확인 | [config-reference.md](reference/api/config-reference.md) |
|
||||
| 사용자 정의 프로바이더/엔드포인트 구성 | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Z.AI / GLM 프로바이더 구성 | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| LangGraph 통합 패턴 사용 | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| 런타임 운영 (2일차 런북) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| 설치/런타임/채널 문제 해결 | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Matrix 암호화 방 설정 및 진단 실행 | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| 카테고리별 문서 찾아보기 | [SUMMARY.md](SUMMARY.md) |
|
||||
| 프로젝트 PR/이슈 문서 스냅샷 보기 | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## 빠른 의사결정 트리 (10초)
|
||||
|
||||
- 초기 설정 또는 설치가 필요한가요? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- 정확한 CLI/구성 키가 필요한가요? → [reference/README.md](reference/README.md)
|
||||
- 프로덕션/서비스 운영이 필요한가요? → [ops/README.md](ops/README.md)
|
||||
- 실패 또는 회귀가 발생하고 있나요? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- 보안 강화 또는 로드맵 작업 중인가요? → [security/README.md](security/README.md)
|
||||
- 보드/주변 장치 작업 중인가요? → [hardware/README.md](hardware/README.md)
|
||||
- 기여/검토/CI 워크플로우? → [contributing/README.md](contributing/README.md)
|
||||
- 전체 맵이 필요한가요? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## 컬렉션 (권장)
|
||||
|
||||
- 시작하기: [setup-guides/README.md](setup-guides/README.md)
|
||||
- 참조 카탈로그: [reference/README.md](reference/README.md)
|
||||
- 운영 및 배포: [ops/README.md](ops/README.md)
|
||||
- 보안 문서: [security/README.md](security/README.md)
|
||||
- 하드웨어/주변 장치: [hardware/README.md](hardware/README.md)
|
||||
- 기여/CI: [contributing/README.md](contributing/README.md)
|
||||
- 프로젝트 스냅샷: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## 대상별
|
||||
|
||||
### 사용자 / 운영자
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — 워크플로우별 명령어 검색
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — 프로바이더 ID, 별칭, 자격 증명 환경 변수
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — 채널 기능 및 설정 경로
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — Matrix 암호화 방(E2EE) 설정 및 무응답 진단
|
||||
- [config-reference.md](reference/api/config-reference.md) — 주요 구성 키 및 보안 기본값
|
||||
- [custom-providers.md](contributing/custom-providers.md) — 사용자 정의 프로바이더/기본 URL 통합 템플릿
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM 설정 및 엔드포인트 매트릭스
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — 모델/도구 호출 엣지 케이스를 위한 폴백 통합
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — 2일차 런타임 운영 및 롤백 흐름
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — 일반적인 실패 시그니처 및 복구 단계
|
||||
|
||||
### 기여자 / 유지보수자
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 보안 / 신뢰성
|
||||
|
||||
> 참고: 이 영역에는 제안/로드맵 문서가 포함되어 있습니다. 현재 동작에 대해서는 [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md), [troubleshooting.md](ops/troubleshooting.md)를 먼저 참조하세요.
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## 시스템 탐색 및 거버넌스
|
||||
|
||||
- 통합 목차: [SUMMARY.md](SUMMARY.md)
|
||||
- 문서 구조 맵 (언어/부분/기능): [structure/README.md](maintainers/structure-README.md)
|
||||
- 문서 인벤토리/분류: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- i18n 문서 색인: [i18n/README.md](i18n/README.md)
|
||||
- i18n 커버리지 맵: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
- 프로젝트 트리아지 스냅샷: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## 다른 언어
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
+2
-1
@@ -4,7 +4,8 @@ This page is the primary entry point for the documentation system.
|
||||
|
||||
Last refreshed: **February 21, 2026**.
|
||||
|
||||
Localized hubs: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
Localized hubs:
|
||||
[العربية](README.ar.md) · [বাংলা](README.bn.md) · [Čeština](README.cs.md) · [Dansk](README.da.md) · [Deutsch](README.de.md) · [Ελληνικά](README.el.md) · [Español](README.es.md) · [Suomi](README.fi.md) · [Français](README.fr.md) · [עברית](README.he.md) · [हिन्दी](README.hi.md) · [Magyar](README.hu.md) · [Bahasa Indonesia](README.id.md) · [Italiano](README.it.md) · [日本語](README.ja.md) · [한국어](README.ko.md) · [Norsk Bokmål](README.nb.md) · [Nederlands](README.nl.md) · [Polski](README.pl.md) · [Português](README.pt.md) · [Română](README.ro.md) · [Русский](README.ru.md) · [Svenska](README.sv.md) · [ไทย](README.th.md) · [Tagalog](README.tl.md) · [Türkçe](README.tr.md) · [Українська](README.uk.md) · [اردو](README.ur.md) · [Tiếng Việt](README.vi.md) · [简体中文](README.zh-CN.md).
|
||||
|
||||
## Start Here
|
||||
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
# ZeroClaw Dokumentasjonshub
|
||||
|
||||
Denne siden er hovedinngangen til dokumentasjonssystemet.
|
||||
|
||||
Sist oppdatert: **21. februar 2026**.
|
||||
|
||||
Lokaliserte huber: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Start her
|
||||
|
||||
| Jeg vil… | Les dette |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Installere og kjøre ZeroClaw raskt | [README.md (Hurtigstart)](../README.md#quick-start) |
|
||||
| Bootstrap med en enkelt kommando | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Oppdatere eller avinstallere på macOS | [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md) |
|
||||
| Finne kommandoer etter oppgave | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Raskt sjekke konfigurasjonsstandarder og nøkler | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Konfigurere egendefinerte leverandører/endepunkter | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Konfigurere Z.AI / GLM-leverandøren | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Bruke LangGraph-integrasjonsmønstre | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Drifte kjøretidsmiljøet (dag 2-runbook) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Feilsøke installasjon/kjøretid/kanal-problemer | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Kjøre Matrix-kryptert rom-oppsett og diagnostikk | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Bla gjennom dokumentasjon etter kategori | [SUMMARY.md](SUMMARY.md) |
|
||||
| Se prosjektets PR/issue-dokumentasjonsøyeblikksbilde | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Raskt beslutningstre (10 sekunder)
|
||||
|
||||
- Trenger førstegangsoppsett eller installasjon? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Trenger nøyaktige CLI/konfigurasjonsnøkler? → [reference/README.md](reference/README.md)
|
||||
- Trenger produksjons-/tjenestedrift? → [ops/README.md](ops/README.md)
|
||||
- Ser du feil eller regresjoner? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Jobber med sikkerhetsherding eller veikart? → [security/README.md](security/README.md)
|
||||
- Jobber med kort/periferiutstyr? → [hardware/README.md](hardware/README.md)
|
||||
- Bidrag/gjennomgang/CI-arbeidsflyt? → [contributing/README.md](contributing/README.md)
|
||||
- Vil du ha det fullstendige kartet? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Samlinger (Anbefalt)
|
||||
|
||||
- Kom i gang: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Referansekataloger: [reference/README.md](reference/README.md)
|
||||
- Drift og utrulling: [ops/README.md](ops/README.md)
|
||||
- Sikkerhetsdokumentasjon: [security/README.md](security/README.md)
|
||||
- Maskinvare/periferiutstyr: [hardware/README.md](hardware/README.md)
|
||||
- Bidrag/CI: [contributing/README.md](contributing/README.md)
|
||||
- Prosjektøyeblikksbilder: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Etter målgruppe
|
||||
|
||||
### Brukere / Operatører
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — kommandooppslag etter arbeidsflyt
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — leverandør-IDer, aliaser, legitimasjonsmiljøvariabler
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — kanalegenskaper og oppsettstier
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — Matrix kryptert rom (E2EE)-oppsett og diagnostikk for manglende svar
|
||||
- [config-reference.md](reference/api/config-reference.md) — viktige konfigurasjonsnøkler og sikre standardverdier
|
||||
- [custom-providers.md](contributing/custom-providers.md) — maler for egendefinert leverandør/basis-URL-integrasjon
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM-oppsett og endepunktmatrise
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — reserveintegrasjon for modell/verktøykall-grensetilfeller
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — dag 2 kjøretidsdrift og tilbakestillingsflyt
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — vanlige feilsignaturer og gjenopprettingstrinn
|
||||
|
||||
### Bidragsytere / Vedlikeholdere
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Sikkerhet / Pålitelighet
|
||||
|
||||
> Merk: dette området inkluderer forslags-/veikartdokumenter. For nåværende oppførsel, start med [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) og [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Systemnavigasjon og styring
|
||||
|
||||
- Samlet innholdsfortegnelse: [SUMMARY.md](SUMMARY.md)
|
||||
- Dokumentasjonsstrukturkart (språk/del/funksjon): [structure/README.md](maintainers/structure-README.md)
|
||||
- Dokumentasjonsinventar/klassifisering: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- i18n-dokumentasjonsindeks: [i18n/README.md](i18n/README.md)
|
||||
- i18n-dekningskart: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
- Prosjekttriageringsøyeblikksbilde: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Andre språk
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ZeroClaw Documentatiehub
|
||||
|
||||
Deze pagina is het primaire toegangspunt voor het documentatiesysteem.
|
||||
|
||||
Laatst bijgewerkt: **20 februari 2026**.
|
||||
|
||||
Gelokaliseerde hubs: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Begin Hier
|
||||
|
||||
| Ik wil… | Lees dit |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| ZeroClaw snel installeren en uitvoeren | [README.md (Snelle Start)](../README.md#quick-start) |
|
||||
| Bootstrap met één commando | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Commando's zoeken op taak | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Snel configuratiesleutels en standaardwaarden controleren | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Aangepaste providers/endpoints configureren | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Z.AI / GLM-provider instellen | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| LangGraph-integratiepatronen gebruiken | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| De runtime beheren (dag-2 runbook) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Installatie-/runtime-/kanaalproblemen oplossen | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Matrix versleutelde ruimtes configureren en diagnosticeren | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Documentatie per categorie bekijken | [SUMMARY.md](SUMMARY.md) |
|
||||
| Docs-momentopname van project-PR's/issues bekijken | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Snelle Beslisboom (10 seconden)
|
||||
|
||||
- Eerste installatie of configuratie nodig? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Exacte CLI-/configuratiesleutels nodig? → [reference/README.md](reference/README.md)
|
||||
- Productie-/servicebeheer nodig? → [ops/README.md](ops/README.md)
|
||||
- Fouten of regressies? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Bezig met beveiligingsverharding of roadmap? → [security/README.md](security/README.md)
|
||||
- Werken met boards/randapparatuur? → [hardware/README.md](hardware/README.md)
|
||||
- Bijdrage/review/CI-workflow? → [contributing/README.md](contributing/README.md)
|
||||
- De volledige kaart bekijken? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Collecties (Aanbevolen)
|
||||
|
||||
- Aan de slag: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Referentiecatalogi: [reference/README.md](reference/README.md)
|
||||
- Beheer & implementatie: [ops/README.md](ops/README.md)
|
||||
- Beveiligingsdocs: [security/README.md](security/README.md)
|
||||
- Hardware/randapparatuur: [hardware/README.md](hardware/README.md)
|
||||
- Bijdrage/CI: [contributing/README.md](contributing/README.md)
|
||||
- Projectmomentopnamen: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Per Doelgroep
|
||||
|
||||
### Gebruikers / Beheerders
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — commando's zoeken op workflow
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — provider-ID's, aliassen, omgevingsvariabelen voor inloggegevens
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — kanaalmogelijkheden en configuratiepaden
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — Matrix versleutelde ruimtes (E2EE) instellen en diagnostiek bij geen reactie
|
||||
- [config-reference.md](reference/api/config-reference.md) — configuratiesleutels met hoog belang en veilige standaardwaarden
|
||||
- [custom-providers.md](contributing/custom-providers.md) — integratie-patronen voor aangepaste providers/basis-URL
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM-configuratie en endpointmatrix
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — fallback-integratie voor model-/toolaanroep-randgevallen
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — dag-2 runtime-operaties en rollbackflows
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — veelvoorkomende foutpatronen en herstelstappen
|
||||
|
||||
### Bijdragers / Beheerders
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Beveiliging / Betrouwbaarheid
|
||||
|
||||
> Opmerking: dit gedeelte bevat voorstel-/roadmapdocumenten. Voor het huidige gedrag, begin met [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) en [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Systeemnavigatie & Governance
|
||||
|
||||
- Uniforme inhoudsopgave: [SUMMARY.md](SUMMARY.md)
|
||||
- Documentatiestructuurkaart (taal/deel/functie): [structure/README.md](maintainers/structure-README.md)
|
||||
- Documentatie-inventaris/-classificatie: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Projecttriage-momentopname: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Andere talen
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# Centrum Dokumentacji ZeroClaw
|
||||
|
||||
Ta strona jest głównym punktem wejścia do systemu dokumentacji.
|
||||
|
||||
Ostatnia aktualizacja: **20 lutego 2026**.
|
||||
|
||||
Zlokalizowane centra: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Zacznij tutaj
|
||||
|
||||
| Chcę… | Przeczytaj to |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Szybko zainstalować i uruchomić ZeroClaw | [README.md (Szybki Start)](../README.md#quick-start) |
|
||||
| Bootstrap jednym poleceniem | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Znaleźć polecenia według zadania | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Szybko sprawdzić klucze konfiguracji i wartości domyślne | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Skonfigurować niestandardowych dostawców/endpointy | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Skonfigurować dostawcę Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Użyć wzorców integracji LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Zarządzać środowiskiem uruchomieniowym (runbook dzień-2) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Rozwiązać problemy z instalacją/runtime/kanałami | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Skonfigurować i zdiagnozować szyfrowane pokoje Matrix | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Przeglądać dokumentację według kategorii | [SUMMARY.md](SUMMARY.md) |
|
||||
| Zobaczyć migawkę dokumentacji PR-ów/issues projektu | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Szybkie Drzewo Decyzyjne (10 sekund)
|
||||
|
||||
- Potrzebujesz pierwszej instalacji lub konfiguracji? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Potrzebujesz dokładnych kluczy CLI/konfiguracji? → [reference/README.md](reference/README.md)
|
||||
- Potrzebujesz operacji produkcyjnych/serwisowych? → [ops/README.md](ops/README.md)
|
||||
- Widzisz błędy lub regresje? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Pracujesz nad wzmocnieniem bezpieczeństwa lub mapą drogową? → [security/README.md](security/README.md)
|
||||
- Pracujesz z płytkami/peryferiami? → [hardware/README.md](hardware/README.md)
|
||||
- Kontrybuowanie/recenzja/workflow CI? → [contributing/README.md](contributing/README.md)
|
||||
- Chcesz zobaczyć pełną mapę? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Kolekcje (Zalecane)
|
||||
|
||||
- Rozpoczęcie pracy: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Katalogi referencyjne: [reference/README.md](reference/README.md)
|
||||
- Operacje i wdrożenie: [ops/README.md](ops/README.md)
|
||||
- Dokumentacja bezpieczeństwa: [security/README.md](security/README.md)
|
||||
- Hardware/peryferia: [hardware/README.md](hardware/README.md)
|
||||
- Kontrybuowanie/CI: [contributing/README.md](contributing/README.md)
|
||||
- Migawki projektu: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Według Odbiorców
|
||||
|
||||
### Użytkownicy / Operatorzy
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — wyszukiwanie poleceń według workflow
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — ID dostawców, aliasy, zmienne środowiskowe uwierzytelniania
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — możliwości kanałów i ścieżki konfiguracji
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — konfiguracja szyfrowanych pokojów Matrix (E2EE) i diagnostyka braku odpowiedzi
|
||||
- [config-reference.md](reference/api/config-reference.md) — klucze konfiguracji o wysokim znaczeniu i bezpieczne wartości domyślne
|
||||
- [custom-providers.md](contributing/custom-providers.md) — wzorce integracji niestandardowych dostawców/bazowego URL
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — konfiguracja Z.AI/GLM i matryca endpointów
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — integracja awaryjna dla przypadków brzegowych modelu/wywołania narzędzi
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — operacje runtime dzień-2 i przepływy rollbacku
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — typowe sygnatury błędów i kroki odzyskiwania
|
||||
|
||||
### Kontrybutorzy / Opiekunowie
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Bezpieczeństwo / Niezawodność
|
||||
|
||||
> Uwaga: ta sekcja zawiera dokumenty propozycji/mapy drogowej. Dla aktualnego zachowania zacznij od [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) i [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Nawigacja Systemowa i Zarządzanie
|
||||
|
||||
- Ujednolicony spis treści: [SUMMARY.md](SUMMARY.md)
|
||||
- Mapa struktury dokumentacji (język/część/funkcja): [structure/README.md](maintainers/structure-README.md)
|
||||
- Inwentarz/klasyfikacja dokumentacji: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Migawka triażu projektu: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Inne języki
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# Centro de Documentação ZeroClaw
|
||||
|
||||
Esta página é o ponto de entrada principal do sistema de documentação.
|
||||
|
||||
Última atualização: **20 de fevereiro de 2026**.
|
||||
|
||||
Centros localizados: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Comece Aqui
|
||||
|
||||
| Eu quero… | Leia isto |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Instalar e executar o ZeroClaw rapidamente | [README.md (Início Rápido)](../README.md#quick-start) |
|
||||
| Bootstrap com um único comando | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Encontrar comandos por tarefa | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Verificar rapidamente chaves de configuração e valores padrão | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Configurar provedores/endpoints personalizados | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Configurar o provedor Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Usar padrões de integração LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Operar o runtime (runbook dia-2) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Resolver problemas de instalação/runtime/canal | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Configurar e diagnosticar salas criptografadas Matrix | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Navegar na documentação por categoria | [SUMMARY.md](SUMMARY.md) |
|
||||
| Ver instantâneo de docs de PRs/issues do projeto | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Árvore de Decisão Rápida (10 segundos)
|
||||
|
||||
- Precisa de instalação ou configuração inicial? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Precisa de chaves CLI/configuração exatas? → [reference/README.md](reference/README.md)
|
||||
- Precisa de operações de produção/serviço? → [ops/README.md](ops/README.md)
|
||||
- Vê falhas ou regressões? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Trabalhando em endurecimento de segurança ou roadmap? → [security/README.md](security/README.md)
|
||||
- Trabalhando com placas/periféricos? → [hardware/README.md](hardware/README.md)
|
||||
- Contribuição/revisão/workflow CI? → [contributing/README.md](contributing/README.md)
|
||||
- Quer o mapa completo? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Coleções (Recomendadas)
|
||||
|
||||
- Primeiros passos: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Catálogos de referência: [reference/README.md](reference/README.md)
|
||||
- Operações e implantação: [ops/README.md](ops/README.md)
|
||||
- Documentação de segurança: [security/README.md](security/README.md)
|
||||
- Hardware/periféricos: [hardware/README.md](hardware/README.md)
|
||||
- Contribuição/CI: [contributing/README.md](contributing/README.md)
|
||||
- Instantâneos do projeto: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Por Público
|
||||
|
||||
### Usuários / Operadores
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — busca de comandos por workflow
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — IDs de provedores, aliases, variáveis de ambiente de credenciais
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — capacidades dos canais e caminhos de configuração
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — configuração de salas criptografadas Matrix (E2EE) e diagnóstico de não resposta
|
||||
- [config-reference.md](reference/api/config-reference.md) — chaves de configuração de alto sinal e valores padrão seguros
|
||||
- [custom-providers.md](contributing/custom-providers.md) — padrões de integração de provedor personalizado/URL base
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — configuração Z.AI/GLM e matriz de endpoints
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — integração de fallback para casos extremos de modelo/chamada de ferramenta
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — operações runtime dia-2 e fluxos de rollback
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — assinaturas de falha comuns e etapas de recuperação
|
||||
|
||||
### Contribuidores / Mantenedores
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Segurança / Confiabilidade
|
||||
|
||||
> Nota: esta seção inclui documentos de proposta/roadmap. Para o comportamento atual, comece com [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) e [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Navegação do Sistema e Governança
|
||||
|
||||
- Índice unificado: [SUMMARY.md](SUMMARY.md)
|
||||
- Mapa da estrutura de docs (idioma/parte/função): [structure/README.md](maintainers/structure-README.md)
|
||||
- Inventário/classificação da documentação: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Instantâneo de triagem do projeto: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Outros idiomas
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# Centrul de Documentație ZeroClaw
|
||||
|
||||
Această pagină este punctul de intrare principal al sistemului de documentație.
|
||||
|
||||
Ultima actualizare: **20 februarie 2026**.
|
||||
|
||||
Centre localizate: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Începeți Aici
|
||||
|
||||
| Vreau să… | Citiți aceasta |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Instalez și rulez ZeroClaw rapid | [README.md (Start Rapid)](../README.md#quick-start) |
|
||||
| Bootstrap cu o singură comandă | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Găsesc comenzi după sarcină | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Verific rapid cheile de configurare și valorile implicite | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Configurez furnizori/endpoint-uri personalizate | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Configurez furnizorul Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Folosesc modelele de integrare LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Administrez runtime-ul (runbook ziua-2) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Depanez probleme de instalare/runtime/canal | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Configurez și diagnostichez camerele criptate Matrix | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Navighez documentația pe categorii | [SUMMARY.md](SUMMARY.md) |
|
||||
| Văd instantaneul documentației PR-urilor/issue-urilor proiectului | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Arbore de Decizie Rapid (10 secunde)
|
||||
|
||||
- Aveți nevoie de instalare sau configurare inițială? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Aveți nevoie de chei CLI/configurare exacte? → [reference/README.md](reference/README.md)
|
||||
- Aveți nevoie de operațiuni de producție/serviciu? → [ops/README.md](ops/README.md)
|
||||
- Vedeți erori sau regresii? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Lucrați la consolidarea securității sau foaia de parcurs? → [security/README.md](security/README.md)
|
||||
- Lucrați cu plăci/periferice? → [hardware/README.md](hardware/README.md)
|
||||
- Contribuție/recenzie/workflow CI? → [contributing/README.md](contributing/README.md)
|
||||
- Doriți harta completă? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Colecții (Recomandate)
|
||||
|
||||
- Primii pași: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Cataloage de referință: [reference/README.md](reference/README.md)
|
||||
- Operațiuni și implementare: [ops/README.md](ops/README.md)
|
||||
- Documentație de securitate: [security/README.md](security/README.md)
|
||||
- Hardware/periferice: [hardware/README.md](hardware/README.md)
|
||||
- Contribuție/CI: [contributing/README.md](contributing/README.md)
|
||||
- Instantanee ale proiectului: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## După Public
|
||||
|
||||
### Utilizatori / Operatori
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — căutare comenzi după workflow
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — ID-uri furnizori, aliasuri, variabile de mediu pentru acreditări
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — capacitățile canalelor și căile de configurare
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — configurarea camerelor criptate Matrix (E2EE) și diagnosticarea lipsei de răspuns
|
||||
- [config-reference.md](reference/api/config-reference.md) — chei de configurare cu semnal ridicat și valori implicite sigure
|
||||
- [custom-providers.md](contributing/custom-providers.md) — modele de integrare furnizor personalizat/URL de bază
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — configurare Z.AI/GLM și matricea endpoint-urilor
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — integrare de rezervă pentru cazurile limită ale modelului/apelului de instrumente
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — operațiuni runtime ziua-2 și fluxuri de rollback
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — semnături de erori comune și pași de recuperare
|
||||
|
||||
### Contribuitori / Întreținători
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Securitate / Fiabilitate
|
||||
|
||||
> Notă: această secțiune include documente de propunere/foaie de parcurs. Pentru comportamentul actual, începeți cu [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) și [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Navigare în Sistem și Guvernanță
|
||||
|
||||
- Cuprins unificat: [SUMMARY.md](SUMMARY.md)
|
||||
- Harta structurii documentației (limbă/parte/funcție): [structure/README.md](maintainers/structure-README.md)
|
||||
- Inventar/clasificare a documentației: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Instantaneu de triaj al proiectului: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Alte limbi
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ZeroClaw Dokumentationshubb
|
||||
|
||||
Denna sida är den primära ingångspunkten för dokumentationssystemet.
|
||||
|
||||
Senast uppdaterad: **20 februari 2026**.
|
||||
|
||||
Lokaliserade hubbar: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Börja Här
|
||||
|
||||
| Jag vill… | Läs detta |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Installera och köra ZeroClaw snabbt | [README.md (Snabbstart)](../README.md#quick-start) |
|
||||
| Bootstrap med ett enda kommando | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Hitta kommandon efter uppgift | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Snabbt kontrollera konfigurationsnycklar och standardvärden | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Konfigurera anpassade leverantörer/endpoints | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Konfigurera Z.AI / GLM-leverantören | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Använda LangGraph-integrationsmönster | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Hantera runtime (dag-2 runbook) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Felsöka installations-/runtime-/kanalproblem | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Konfigurera och diagnostisera krypterade Matrix-rum | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Bläddra i dokumentation efter kategori | [SUMMARY.md](SUMMARY.md) |
|
||||
| Se dokumentationsöversikt för projektets PR:er/issues | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Snabbt Beslutsträd (10 sekunder)
|
||||
|
||||
- Behöver initial installation eller konfiguration? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Behöver exakta CLI-/konfigurationsnycklar? → [reference/README.md](reference/README.md)
|
||||
- Behöver produktions-/tjänsteoperationer? → [ops/README.md](ops/README.md)
|
||||
- Ser du fel eller regressioner? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Arbetar med säkerhetshärdning eller färdplan? → [security/README.md](security/README.md)
|
||||
- Arbetar med kort/kringutrustning? → [hardware/README.md](hardware/README.md)
|
||||
- Bidrag/granskning/CI-arbetsflöde? → [contributing/README.md](contributing/README.md)
|
||||
- Vill du se hela kartan? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Samlingar (Rekommenderade)
|
||||
|
||||
- Kom igång: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Referenskataloger: [reference/README.md](reference/README.md)
|
||||
- Drift och driftsättning: [ops/README.md](ops/README.md)
|
||||
- Säkerhetsdokumentation: [security/README.md](security/README.md)
|
||||
- Hårdvara/kringutrustning: [hardware/README.md](hardware/README.md)
|
||||
- Bidrag/CI: [contributing/README.md](contributing/README.md)
|
||||
- Projektögonblicksbilder: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Per Målgrupp
|
||||
|
||||
### Användare / Operatörer
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — sök kommandon efter arbetsflöde
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — leverantörs-ID:n, alias, miljövariabler för autentiseringsuppgifter
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — kanalkapaciteter och konfigurationsvägar
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — konfiguration av krypterade Matrix-rum (E2EE) och diagnostik vid uteblivet svar
|
||||
- [config-reference.md](reference/api/config-reference.md) — konfigurationsnycklar med hög signalstyrka och säkra standardvärden
|
||||
- [custom-providers.md](contributing/custom-providers.md) — integrationsmönster för anpassad leverantör/bas-URL
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM-konfiguration och endpointmatris
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — reservintegration för modell-/verktygsanropsspecialfall
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — dag-2 runtime-operationer och rollback-flöden
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — vanliga felmönster och återställningssteg
|
||||
|
||||
### Bidragsgivare / Underhållare
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Säkerhet / Tillförlitlighet
|
||||
|
||||
> Observera: denna sektion innehåller förslags-/färdplansdokument. För aktuellt beteende, börja med [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) och [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Systemnavigering och Styrning
|
||||
|
||||
- Enhetlig innehållsförteckning: [SUMMARY.md](SUMMARY.md)
|
||||
- Dokumentationsstrukturkarta (språk/del/funktion): [structure/README.md](maintainers/structure-README.md)
|
||||
- Dokumentationsinventering/-klassificering: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Projekttriageringsögonblicksbild: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Andra språk
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ศูนย์กลางเอกสาร ZeroClaw
|
||||
|
||||
หน้านี้เป็นจุดเริ่มต้นหลักของระบบเอกสาร
|
||||
|
||||
อัปเดตล่าสุด: **21 กุมภาพันธ์ 2026**
|
||||
|
||||
ศูนย์กลางภาษาต่าง ๆ: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## เริ่มต้นที่นี่
|
||||
|
||||
| ฉันต้องการ… | อ่านสิ่งนี้ |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| ติดตั้งและรัน ZeroClaw อย่างรวดเร็ว | [README.md (เริ่มต้นอย่างรวดเร็ว)](../README.md#quick-start) |
|
||||
| ติดตั้งด้วยคำสั่งเดียว | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| ค้นหาคำสั่งตามงาน | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| ตรวจสอบคีย์และค่าเริ่มต้นของการตั้งค่าอย่างรวดเร็ว | [config-reference.md](reference/api/config-reference.md) |
|
||||
| ตั้งค่าผู้ให้บริการ/endpoint แบบกำหนดเอง | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| ตั้งค่าผู้ให้บริการ Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| ใช้รูปแบบการรวม LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| ดำเนินงาน runtime (คู่มือปฏิบัติการวันที่ 2) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| แก้ไขปัญหาการติดตั้ง/runtime/ช่องทาง | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| รันการตั้งค่าและวินิจฉัยห้อง Matrix แบบเข้ารหัส | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| เรียกดูเอกสารตามหมวดหมู่ | [SUMMARY.md](SUMMARY.md) |
|
||||
| ดูสแนปช็อตเอกสาร PR/issue ของโปรเจกต์ | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## แผนผังการตัดสินใจอย่างรวดเร็ว (10 วินาที)
|
||||
|
||||
- ต้องการการตั้งค่าหรือการติดตั้งเบื้องต้น? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- ต้องการคีย์ CLI/config ที่แน่นอน? → [reference/README.md](reference/README.md)
|
||||
- ต้องการการดำเนินงานระดับโปรดักชัน/เซอร์วิส? → [ops/README.md](ops/README.md)
|
||||
- พบความล้มเหลวหรือการถดถอย? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- ทำงานเกี่ยวกับการเสริมความปลอดภัยหรือแผนงาน? → [security/README.md](security/README.md)
|
||||
- ทำงานกับบอร์ด/อุปกรณ์ต่อพ่วง? → [hardware/README.md](hardware/README.md)
|
||||
- การมีส่วนร่วม/รีวิว/เวิร์กโฟลว์ CI? → [contributing/README.md](contributing/README.md)
|
||||
- ต้องการแผนที่ทั้งหมด? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## คอลเลกชัน (แนะนำ)
|
||||
|
||||
- เริ่มต้น: [setup-guides/README.md](setup-guides/README.md)
|
||||
- แคตตาล็อกอ้างอิง: [reference/README.md](reference/README.md)
|
||||
- การดำเนินงานและการปรับใช้: [ops/README.md](ops/README.md)
|
||||
- เอกสารความปลอดภัย: [security/README.md](security/README.md)
|
||||
- ฮาร์ดแวร์/อุปกรณ์ต่อพ่วง: [hardware/README.md](hardware/README.md)
|
||||
- การมีส่วนร่วม/CI: [contributing/README.md](contributing/README.md)
|
||||
- สแนปช็อตโปรเจกต์: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## ตามกลุ่มผู้ใช้
|
||||
|
||||
### ผู้ใช้ / ผู้ดำเนินงาน
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — ค้นหาคำสั่งตามเวิร์กโฟลว์
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — ID ผู้ให้บริการ, นามแฝง, ตัวแปรสภาพแวดล้อมข้อมูลรับรอง
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — ความสามารถของช่องทางและเส้นทางการตั้งค่า
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — การตั้งค่าห้อง Matrix แบบเข้ารหัส (E2EE) และการวินิจฉัยการไม่ตอบสนอง
|
||||
- [config-reference.md](reference/api/config-reference.md) — คีย์การตั้งค่าที่สำคัญและค่าเริ่มต้นที่ปลอดภัย
|
||||
- [custom-providers.md](contributing/custom-providers.md) — รูปแบบการรวมผู้ให้บริการแบบกำหนดเอง/URL ฐาน
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — การตั้งค่า Z.AI/GLM และเมทริกซ์ endpoint
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — การรวมแบบ fallback สำหรับกรณีพิเศษของโมเดล/การเรียกเครื่องมือ
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — การดำเนินงาน runtime วันที่ 2 และโฟลว์การย้อนกลับ
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — ลายเซ็นความล้มเหลวทั่วไปและขั้นตอนการกู้คืน
|
||||
|
||||
### ผู้มีส่วนร่วม / ผู้ดูแล
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### ความปลอดภัย / ความน่าเชื่อถือ
|
||||
|
||||
> หมายเหตุ: ส่วนนี้รวมเอกสารข้อเสนอ/แผนงาน สำหรับพฤติกรรมปัจจุบัน เริ่มต้นที่ [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) และ [troubleshooting.md](ops/troubleshooting.md)
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## การนำทางระบบและการกำกับดูแล
|
||||
|
||||
- สารบัญรวม: [SUMMARY.md](SUMMARY.md)
|
||||
- แผนที่โครงสร้างเอกสาร (ภาษา/ส่วน/ฟังก์ชัน): [structure/README.md](maintainers/structure-README.md)
|
||||
- รายการ/การจำแนกเอกสาร: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- สแนปช็อตการคัดกรองโปรเจกต์: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## ภาษาอื่น ๆ
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# Sentro ng Dokumentasyon ng ZeroClaw
|
||||
|
||||
Ang pahinang ito ang pangunahing entry point ng sistema ng dokumentasyon.
|
||||
|
||||
Huling na-update: **Pebrero 21, 2026**.
|
||||
|
||||
Mga lokal na sentro: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Magsimula Dito
|
||||
|
||||
| Gusto ko… | Basahin ito |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| I-install at patakbuhin ang ZeroClaw nang mabilis | [README.md (Mabilis na Pagsisimula)](../README.md#quick-start) |
|
||||
| Bootstrap sa isang utos | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Hanapin ang mga utos ayon sa gawain | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Mabilisang suriin ang mga config key at default na halaga | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Mag-set up ng custom na provider/endpoint | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| I-set up ang Z.AI / GLM provider | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Gamitin ang mga pattern ng integrasyon ng LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Pamahalaan ang runtime (day-2 runbook) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| I-troubleshoot ang mga isyu sa pag-install/runtime/channel | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Patakbuhin ang setup at diagnostics ng encrypted Matrix room | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| I-browse ang mga dokumento ayon sa kategorya | [SUMMARY.md](SUMMARY.md) |
|
||||
| Tingnan ang snapshot ng mga PR/issue ng proyekto | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Mabilisang Decision Tree (10 segundo)
|
||||
|
||||
- Kailangan ng setup o unang pag-install? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Kailangan ng eksaktong CLI/config key? → [reference/README.md](reference/README.md)
|
||||
- Kailangan ng production/service operations? → [ops/README.md](ops/README.md)
|
||||
- May nakikitang pagkabigo o regression? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Nagtatrabaho sa security hardening o roadmap? → [security/README.md](security/README.md)
|
||||
- Nagtatrabaho sa mga board/peripheral? → [hardware/README.md](hardware/README.md)
|
||||
- Kontribusyon/review/CI workflow? → [contributing/README.md](contributing/README.md)
|
||||
- Gusto mo ang buong mapa? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Mga Koleksyon (Inirerekomenda)
|
||||
|
||||
- Pagsisimula: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Mga katalogo ng reference: [reference/README.md](reference/README.md)
|
||||
- Operasyon at deployment: [ops/README.md](ops/README.md)
|
||||
- Mga dokumento ng seguridad: [security/README.md](security/README.md)
|
||||
- Hardware/peripheral: [hardware/README.md](hardware/README.md)
|
||||
- Kontribusyon/CI: [contributing/README.md](contributing/README.md)
|
||||
- Mga snapshot ng proyekto: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Ayon sa Audience
|
||||
|
||||
### Mga Gumagamit / Operator
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — paghahanap ng utos ayon sa workflow
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — mga ID ng provider, alias, credential environment variable
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — mga kakayahan ng channel at landas ng configuration
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — setup ng encrypted Matrix room (E2EE) at diagnostics ng hindi pagtugon
|
||||
- [config-reference.md](reference/api/config-reference.md) — mahahalagang config key at secure na default
|
||||
- [custom-providers.md](contributing/custom-providers.md) — pattern ng integrasyon ng custom provider/base URL
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — setup ng Z.AI/GLM at endpoint matrix
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — fallback na integrasyon para sa edge case ng model/tool call
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — day-2 runtime operations at rollback flow
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — karaniwang failure signature at mga hakbang sa pagbawi
|
||||
|
||||
### Mga Kontribyutor / Maintainer
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Seguridad / Pagiging Maaasahan
|
||||
|
||||
> Paalala: Kasama sa seksyong ito ang mga proposal/roadmap na dokumento. Para sa kasalukuyang gawi, magsimula sa [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md), at [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Nabigasyon ng Sistema at Pamamahala
|
||||
|
||||
- Pinag-isang talaan ng nilalaman: [SUMMARY.md](SUMMARY.md)
|
||||
- Mapa ng istruktura ng docs (wika/bahagi/function): [structure/README.md](maintainers/structure-README.md)
|
||||
- Imbentaryo/klasipikasyon ng dokumentasyon: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Snapshot ng triage ng proyekto: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Iba Pang Wika
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ZeroClaw Dokümantasyon Merkezi
|
||||
|
||||
Bu sayfa, dokümantasyon sisteminin ana giriş noktasıdır.
|
||||
|
||||
Son güncelleme: **21 Şubat 2026**.
|
||||
|
||||
Yerelleştirilmiş merkezler: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Buradan Başlayın
|
||||
|
||||
| Yapmak istediğim… | Bunu oku |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| ZeroClaw'ı hızlıca kurup çalıştırmak | [README.md (Hızlı Başlangıç)](../README.md#quick-start) |
|
||||
| Tek komutla kurulum | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Göreve göre komut bulmak | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Yapılandırma anahtarlarını ve varsayılan değerleri hızlıca kontrol | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Özel sağlayıcı/endpoint yapılandırmak | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Z.AI / GLM sağlayıcısını yapılandırmak | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| LangGraph entegrasyon kalıplarını kullanmak | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Çalışma zamanını yönetmek (2. gün runbook) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Kurulum/çalışma zamanı/kanal sorunlarını gidermek | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Şifreli Matrix odası kurulumu ve tanılama çalıştırmak | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Dokümantasyonu kategoriye göre göz atmak | [SUMMARY.md](SUMMARY.md) |
|
||||
| Proje PR/sorun anlık görüntüsünü görmek | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Hızlı Karar Ağacı (10 saniye)
|
||||
|
||||
- Kurulum veya ilk yükleme mi gerekiyor? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Tam CLI/yapılandırma anahtarları mı gerekiyor? → [reference/README.md](reference/README.md)
|
||||
- Üretim/servis operasyonları mı gerekiyor? → [ops/README.md](ops/README.md)
|
||||
- Hatalar veya gerilemeler mi görüyorsunuz? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Güvenlik sertleştirme veya yol haritası üzerinde mi çalışıyorsunuz? → [security/README.md](security/README.md)
|
||||
- Kartlar/çevre birimleri ile mi çalışıyorsunuz? → [hardware/README.md](hardware/README.md)
|
||||
- Katkı/inceleme/CI iş akışı mı? → [contributing/README.md](contributing/README.md)
|
||||
- Tam haritayı mı istiyorsunuz? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Koleksiyonlar (Önerilen)
|
||||
|
||||
- Başlangıç: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Referans katalogları: [reference/README.md](reference/README.md)
|
||||
- Operasyonlar ve dağıtım: [ops/README.md](ops/README.md)
|
||||
- Güvenlik belgeleri: [security/README.md](security/README.md)
|
||||
- Donanım/çevre birimleri: [hardware/README.md](hardware/README.md)
|
||||
- Katkı/CI: [contributing/README.md](contributing/README.md)
|
||||
- Proje anlık görüntüleri: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## Hedef Kitleye Göre
|
||||
|
||||
### Kullanıcılar / Operatörler
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — iş akışına göre komut arama
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — sağlayıcı kimlikleri, takma adlar, kimlik bilgisi ortam değişkenleri
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — kanal yetenekleri ve yapılandırma yolları
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — şifreli Matrix odası (E2EE) kurulumu ve yanıt vermeme tanılaması
|
||||
- [config-reference.md](reference/api/config-reference.md) — yüksek önemli yapılandırma anahtarları ve güvenli varsayılanlar
|
||||
- [custom-providers.md](contributing/custom-providers.md) — özel sağlayıcı/temel URL entegrasyon kalıpları
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM yapılandırması ve endpoint matrisi
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — model/araç çağrısı uç durumları için yedek entegrasyon
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — 2. gün çalışma zamanı operasyonları ve geri alma akışı
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — yaygın hata imzaları ve kurtarma adımları
|
||||
|
||||
### Katkıda Bulunanlar / Bakımcılar
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Güvenlik / Güvenilirlik
|
||||
|
||||
> Not: Bu bölüm öneri/yol haritası belgelerini içerir. Mevcut davranış için [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) ve [troubleshooting.md](ops/troubleshooting.md) ile başlayın.
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Sistem Navigasyonu ve Yönetişim
|
||||
|
||||
- Birleşik içindekiler: [SUMMARY.md](SUMMARY.md)
|
||||
- Dokümantasyon yapı haritası (dil/bölüm/işlev): [structure/README.md](maintainers/structure-README.md)
|
||||
- Dokümantasyon envanteri/sınıflandırması: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Proje triyaj anlık görüntüsü: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Diğer Diller
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# Центр документації ZeroClaw
|
||||
|
||||
Ця сторінка є основною точкою входу до системи документації.
|
||||
|
||||
Останнє оновлення: **21 лютого 2026**.
|
||||
|
||||
Локалізовані центри: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md).
|
||||
|
||||
## Почніть тут
|
||||
|
||||
| Я хочу… | Читати це |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| Швидко встановити та запустити ZeroClaw | [README.md (Швидкий старт)](../README.md#quick-start) |
|
||||
| Налаштування однією командою | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| Знайти команди за завданням | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| Швидко перевірити ключі конфігурації та значення за замовчуванням | [config-reference.md](reference/api/config-reference.md) |
|
||||
| Налаштувати власного провайдера/endpoint | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Налаштувати провайдера Z.AI / GLM | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| Використовувати шаблони інтеграції LangGraph | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| Керувати середовищем виконання (runbook 2-го дня) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| Усунути проблеми встановлення/виконання/каналів | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| Запустити налаштування та діагностику зашифрованих кімнат Matrix | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| Переглянути документацію за категоріями | [SUMMARY.md](SUMMARY.md) |
|
||||
| Переглянути знімок PR/issues проекту | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## Дерево швидких рішень (10 секунд)
|
||||
|
||||
- Потрібне налаштування або початкове встановлення? → [setup-guides/README.md](setup-guides/README.md)
|
||||
- Потрібні точні ключі CLI/конфігурації? → [reference/README.md](reference/README.md)
|
||||
- Потрібні операції виробництва/сервісу? → [ops/README.md](ops/README.md)
|
||||
- Бачите збої або регресії? → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- Працюєте над зміцненням безпеки або дорожньою картою? → [security/README.md](security/README.md)
|
||||
- Працюєте з платами/периферією? → [hardware/README.md](hardware/README.md)
|
||||
- Внесок/рецензування/робочий процес CI? → [contributing/README.md](contributing/README.md)
|
||||
- Хочете повну карту? → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## Колекції (Рекомендовані)
|
||||
|
||||
- Початок роботи: [setup-guides/README.md](setup-guides/README.md)
|
||||
- Довідкові каталоги: [reference/README.md](reference/README.md)
|
||||
- Операції та розгортання: [ops/README.md](ops/README.md)
|
||||
- Документація з безпеки: [security/README.md](security/README.md)
|
||||
- Обладнання/периферія: [hardware/README.md](hardware/README.md)
|
||||
- Внесок/CI: [contributing/README.md](contributing/README.md)
|
||||
- Знімки проекту: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## За аудиторією
|
||||
|
||||
### Користувачі / Оператори
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — пошук команд за робочим процесом
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — ідентифікатори провайдерів, псевдоніми, змінні середовища облікових даних
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — можливості каналів та шляхи конфігурації
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — налаштування зашифрованих кімнат Matrix (E2EE) та діагностика відсутності відповіді
|
||||
- [config-reference.md](reference/api/config-reference.md) — ключові параметри конфігурації та безпечні значення за замовчуванням
|
||||
- [custom-providers.md](contributing/custom-providers.md) — шаблони інтеграції власного провайдера/базової URL-адреси
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — налаштування Z.AI/GLM та матриця endpoint
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — резервна інтеграція для крайніх випадків моделі/виклику інструментів
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — операції середовища виконання 2-го дня та потік відкату
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — типові сигнатури збоїв та кроки відновлення
|
||||
|
||||
### Учасники / Супровідники
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### Безпека / Надійність
|
||||
|
||||
> Примітка: цей розділ містить документи пропозицій/дорожньої карти. Для поточної поведінки почніть з [config-reference.md](reference/api/config-reference.md), [operations-runbook.md](ops/operations-runbook.md) та [troubleshooting.md](ops/troubleshooting.md).
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## Навігація системою та управління
|
||||
|
||||
- Єдиний зміст: [SUMMARY.md](SUMMARY.md)
|
||||
- Карта структури документації (мова/розділ/функція): [structure/README.md](maintainers/structure-README.md)
|
||||
- Інвентаризація/класифікація документації: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- Знімок тріажу проекту: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## Інші мови
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
@@ -0,0 +1,96 @@
|
||||
# ZeroClaw دستاویزات کا مرکز
|
||||
|
||||
یہ صفحہ دستاویزات کے نظام کا بنیادی داخلی نقطہ ہے۔
|
||||
|
||||
آخری تازہ کاری: **21 فروری 2026**۔
|
||||
|
||||
مقامی مراکز: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [Русский](README.ru.md) · [Français](README.fr.md) · [Tiếng Việt](i18n/vi/README.md)۔
|
||||
|
||||
## یہاں سے شروع کریں
|
||||
|
||||
| مجھے چاہیے… | یہ پڑھیں |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| ZeroClaw کو تیزی سے انسٹال اور چلانا | [README.md (فوری آغاز)](../README.md#quick-start) |
|
||||
| ایک کمانڈ سے بوٹسٹریپ | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| کام کے مطابق کمانڈز تلاش کرنا | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| کنفیگریشن کیز اور ڈیفالٹ اقدار کی فوری جانچ | [config-reference.md](reference/api/config-reference.md) |
|
||||
| حسب ضرورت فراہم کنندہ/اینڈ پوائنٹ ترتیب دینا | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| Z.AI / GLM فراہم کنندہ ترتیب دینا | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| LangGraph انضمام کے نمونے استعمال کرنا | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| رن ٹائم چلانا (دوسرے دن کا رن بک) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| تنصیب/رن ٹائم/چینل مسائل حل کرنا | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| خفیہ کردہ Matrix کمرے کی ترتیب اور تشخیص چلانا | [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) |
|
||||
| زمرے کے مطابق دستاویزات براؤز کرنا | [SUMMARY.md](SUMMARY.md) |
|
||||
| پراجیکٹ PR/مسائل کا سنیپ شاٹ دیکھنا | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
|
||||
## فوری فیصلے کا درخت (10 سیکنڈ)
|
||||
|
||||
- سیٹ اپ یا ابتدائی تنصیب درکار ہے؟ → [setup-guides/README.md](setup-guides/README.md)
|
||||
- درست CLI/کنفیگریشن کیز درکار ہیں؟ → [reference/README.md](reference/README.md)
|
||||
- پروڈکشن/سروس آپریشنز درکار ہیں؟ → [ops/README.md](ops/README.md)
|
||||
- ناکامیاں یا رجعت نظر آ رہی ہے؟ → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- سیکیورٹی مضبوطی یا روڈ میپ پر کام کر رہے ہیں؟ → [security/README.md](security/README.md)
|
||||
- بورڈز/پیریفرلز کے ساتھ کام کر رہے ہیں؟ → [hardware/README.md](hardware/README.md)
|
||||
- شراکت/جائزہ/CI ورک فلو؟ → [contributing/README.md](contributing/README.md)
|
||||
- مکمل نقشہ چاہیے؟ → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## مجموعے (تجویز کردہ)
|
||||
|
||||
- آغاز: [setup-guides/README.md](setup-guides/README.md)
|
||||
- حوالہ جاتی فہرستیں: [reference/README.md](reference/README.md)
|
||||
- آپریشنز اور تعیناتی: [ops/README.md](ops/README.md)
|
||||
- سیکیورٹی دستاویزات: [security/README.md](security/README.md)
|
||||
- ہارڈویئر/پیریفرلز: [hardware/README.md](hardware/README.md)
|
||||
- شراکت/CI: [contributing/README.md](contributing/README.md)
|
||||
- پراجیکٹ سنیپ شاٹس: [maintainers/README.md](maintainers/README.md)
|
||||
|
||||
## سامعین کے مطابق
|
||||
|
||||
### صارفین / آپریٹرز
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md) — ورک فلو کے مطابق کمانڈ تلاش
|
||||
- [providers-reference.md](reference/api/providers-reference.md) — فراہم کنندہ IDs، عرفی نام، اسناد ماحولیاتی متغیرات
|
||||
- [channels-reference.md](reference/api/channels-reference.md) — چینل کی صلاحیتیں اور کنفیگریشن کے راستے
|
||||
- [matrix-e2ee-guide.md](security/matrix-e2ee-guide.md) — خفیہ کردہ Matrix کمرے (E2EE) کی ترتیب اور عدم جواب کی تشخیص
|
||||
- [config-reference.md](reference/api/config-reference.md) — اہم کنفیگریشن کیز اور محفوظ ڈیفالٹ اقدار
|
||||
- [custom-providers.md](contributing/custom-providers.md) — حسب ضرورت فراہم کنندہ/بیس URL انضمام کے نمونے
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md) — Z.AI/GLM ترتیب اور اینڈ پوائنٹ میٹرکس
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md) — ماڈل/ٹول کال ایج کیسز کے لیے فال بیک انضمام
|
||||
- [operations-runbook.md](ops/operations-runbook.md) — دوسرے دن کے رن ٹائم آپریشنز اور رول بیک فلو
|
||||
- [troubleshooting.md](ops/troubleshooting.md) — عام ناکامی کے نشانات اور بحالی کے اقدامات
|
||||
|
||||
### شراکت دار / دیکھ بھال کنندگان
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### سیکیورٹی / قابل اعتمادی
|
||||
|
||||
> نوٹ: اس حصے میں تجویز/روڈ میپ دستاویزات شامل ہیں۔ موجودہ رویے کے لیے [config-reference.md](reference/api/config-reference.md)، [operations-runbook.md](ops/operations-runbook.md) اور [troubleshooting.md](ops/troubleshooting.md) سے شروع کریں۔
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
## نظام نیویگیشن اور گورننس
|
||||
|
||||
- متحد فہرست مضامین: [SUMMARY.md](SUMMARY.md)
|
||||
- دستاویزات ساختی نقشہ (زبان/حصہ/فنکشن): [structure/README.md](maintainers/structure-README.md)
|
||||
- دستاویزات کی فہرست/درجہ بندی: [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- پراجیکٹ ٹرائج سنیپ شاٹ: [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
|
||||
## دیگر زبانیں
|
||||
|
||||
- English: [README.md](README.md)
|
||||
- 简体中文: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 日本語: [README.ja.md](README.ja.md)
|
||||
- Русский: [README.ru.md](README.ru.md)
|
||||
- Français: [README.fr.md](README.fr.md)
|
||||
- Tiếng Việt: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
+53
-47
@@ -2,7 +2,7 @@
|
||||
|
||||
这是文档系统的中文入口页。
|
||||
|
||||
最后对齐:**2026-02-18**。
|
||||
最后对齐:**2026-03-14**。
|
||||
|
||||
> 说明:命令、配置键、API 路径保持英文;实现细节以英文文档为准。
|
||||
|
||||
@@ -11,77 +11,83 @@
|
||||
| 我想要… | 建议阅读 |
|
||||
|---|---|
|
||||
| 快速安装并运行 | [../README.zh-CN.md](../README.zh-CN.md) / [../README.md](../README.md) |
|
||||
| 一键安装与初始化 | [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md) |
|
||||
| 按任务找命令 | [commands-reference.md](reference/cli/commands-reference.md) |
|
||||
| 快速查看配置默认值与关键项 | [config-reference.md](reference/api/config-reference.md) |
|
||||
| 接入自定义 Provider / endpoint | [custom-providers.md](contributing/custom-providers.md) |
|
||||
| 配置 Z.AI / GLM Provider | [zai-glm-setup.md](setup-guides/zai-glm-setup.md) |
|
||||
| 使用 LangGraph 工具调用集成 | [langgraph-integration.md](contributing/langgraph-integration.md) |
|
||||
| 进行日常运维(runbook) | [operations-runbook.md](ops/operations-runbook.md) |
|
||||
| 快速排查安装/运行问题 | [troubleshooting.md](ops/troubleshooting.md) |
|
||||
| macOS 平台更新与卸载 | [macos-update-uninstall.md](i18n/zh-CN/setup-guides/macos-update-uninstall.zh-CN.md) |
|
||||
| 一键安装与初始化 | [one-click-bootstrap.md](i18n/zh-CN/setup-guides/one-click-bootstrap.zh-CN.md) |
|
||||
| 按任务找命令 | [commands-reference.md](i18n/zh-CN/reference/cli/commands-reference.zh-CN.md) |
|
||||
| 快速查看配置默认值与关键项 | [config-reference.md](i18n/zh-CN/reference/api/config-reference.zh-CN.md) |
|
||||
| 接入自定义 Provider / endpoint | [custom-providers.md](i18n/zh-CN/contributing/custom-providers.zh-CN.md) |
|
||||
| 配置 Z.AI / GLM Provider | [zai-glm-setup.md](i18n/zh-CN/setup-guides/zai-glm-setup.zh-CN.md) |
|
||||
| 使用 LangGraph 工具调用集成 | [langgraph-integration.md](i18n/zh-CN/contributing/langgraph-integration.zh-CN.md) |
|
||||
| 进行日常运维(runbook) | [operations-runbook.md](i18n/zh-CN/ops/operations-runbook.zh-CN.md) |
|
||||
| 快速排查安装/运行/通道问题 | [troubleshooting.md](i18n/zh-CN/ops/troubleshooting.zh-CN.md) |
|
||||
| Matrix 加密房间配置与诊断 | [matrix-e2ee-guide.md](i18n/zh-CN/security/matrix-e2ee-guide.zh-CN.md) |
|
||||
| 统一目录导航 | [SUMMARY.md](SUMMARY.md) |
|
||||
| 查看 PR/Issue 扫描快照 | [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md) |
|
||||
| 查看 PR/Issue 扫描快照 | [project-triage-snapshot-2026-02-18.md](i18n/zh-CN/maintainers/project-triage-snapshot-2026-02-18.zh-CN.md) |
|
||||
|
||||
## 10 秒决策树(先看这个)
|
||||
|
||||
- 首次安装或快速启动 → [setup-guides/README.md](setup-guides/README.md)
|
||||
- 需要精确命令或配置键 → [reference/README.md](reference/README.md)
|
||||
- 需要部署与服务化运维 → [ops/README.md](ops/README.md)
|
||||
- 遇到报错、异常或回归 → [troubleshooting.md](ops/troubleshooting.md)
|
||||
- 查看安全现状与路线图 → [security/README.md](security/README.md)
|
||||
- 接入板卡与外设 → [hardware/README.md](hardware/README.md)
|
||||
- 参与贡献、评审与 CI → [contributing/README.md](contributing/README.md)
|
||||
- 首次安装或快速启动 → [setup-guides/README.md](i18n/zh-CN/setup-guides/README.zh-CN.md)
|
||||
- 需要精确命令或配置键 → [reference/README.md](i18n/zh-CN/reference/README.zh-CN.md)
|
||||
- 需要部署与服务化运维 → [ops/README.md](i18n/zh-CN/ops/README.zh-CN.md)
|
||||
- 遇到报错、异常或回归 → [troubleshooting.md](i18n/zh-CN/ops/troubleshooting.zh-CN.md)
|
||||
- 查看安全现状与路线图 → [security/README.md](i18n/zh-CN/security/README.zh-CN.md)
|
||||
- 接入板卡与外设 → [hardware/README.md](i18n/zh-CN/hardware/README.zh-CN.md)
|
||||
- 参与贡献、评审与 CI → [contributing/README.md](i18n/zh-CN/contributing/README.zh-CN.md)
|
||||
- 查看完整文档地图 → [SUMMARY.md](SUMMARY.md)
|
||||
|
||||
## 按目录浏览(推荐)
|
||||
|
||||
- 入门文档: [setup-guides/README.md](setup-guides/README.md)
|
||||
- 参考手册: [reference/README.md](reference/README.md)
|
||||
- 运维与部署: [ops/README.md](ops/README.md)
|
||||
- 安全文档: [security/README.md](security/README.md)
|
||||
- 硬件与外设: [hardware/README.md](hardware/README.md)
|
||||
- 贡献与 CI: [contributing/README.md](contributing/README.md)
|
||||
- 项目快照: [maintainers/README.md](maintainers/README.md)
|
||||
- 入门文档: [setup-guides/README.md](i18n/zh-CN/setup-guides/README.zh-CN.md)
|
||||
- 参考手册: [reference/README.md](i18n/zh-CN/reference/README.zh-CN.md)
|
||||
- 运维与部署: [ops/README.md](i18n/zh-CN/ops/README.zh-CN.md)
|
||||
- 安全文档: [security/README.md](i18n/zh-CN/security/README.zh-CN.md)
|
||||
- 硬件与外设: [hardware/README.md](i18n/zh-CN/hardware/README.zh-CN.md)
|
||||
- 贡献与 CI: [contributing/README.md](i18n/zh-CN/contributing/README.zh-CN.md)
|
||||
- 项目快照: [maintainers/README.md](i18n/zh-CN/maintainers/README.zh-CN.md)
|
||||
|
||||
## 按角色
|
||||
|
||||
### 用户 / 运维
|
||||
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [commands-reference.md](i18n/zh-CN/reference/cli/commands-reference.zh-CN.md) — 按工作流查询命令
|
||||
- [providers-reference.md](i18n/zh-CN/reference/api/providers-reference.zh-CN.md) — Provider ID、别名、凭证环境变量
|
||||
- [channels-reference.md](i18n/zh-CN/reference/api/channels-reference.zh-CN.md) — 通道功能与配置路径
|
||||
- [matrix-e2ee-guide.md](i18n/zh-CN/security/matrix-e2ee-guide.zh-CN.md) — Matrix 加密房间(E2EE)配置与无响应诊断
|
||||
- [config-reference.md](i18n/zh-CN/reference/api/config-reference.zh-CN.md) — 高优先级配置项与安全默认值
|
||||
- [custom-providers.md](i18n/zh-CN/contributing/custom-providers.zh-CN.md) — 自定义 Provider/基础 URL 集成模板
|
||||
- [zai-glm-setup.md](i18n/zh-CN/setup-guides/zai-glm-setup.zh-CN.md) — Z.AI/GLM 配置与端点矩阵
|
||||
- [langgraph-integration.md](i18n/zh-CN/contributing/langgraph-integration.zh-CN.md) — 模型/工具调用边缘场景的降级集成方案
|
||||
- [operations-runbook.md](i18n/zh-CN/ops/operations-runbook.zh-CN.md) — 日常运行时运维与回滚流程
|
||||
- [troubleshooting.md](i18n/zh-CN/ops/troubleshooting.zh-CN.md) — 常见故障特征与恢复步骤
|
||||
|
||||
### 贡献者 / 维护者
|
||||
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
- [pr-workflow.md](i18n/zh-CN/contributing/pr-workflow.zh-CN.md)
|
||||
- [reviewer-playbook.md](i18n/zh-CN/contributing/reviewer-playbook.zh-CN.md)
|
||||
- [ci-map.md](i18n/zh-CN/contributing/ci-map.zh-CN.md)
|
||||
- [actions-source-policy.md](i18n/zh-CN/contributing/actions-source-policy.zh-CN.md)
|
||||
|
||||
### 安全 / 稳定性
|
||||
|
||||
> 说明:本分组内有 proposal/roadmap 文档,可能包含设想中的命令或配置。当前可执行行为请优先阅读 [config-reference.md](reference/api/config-reference.md)、[operations-runbook.md](ops/operations-runbook.md)、[troubleshooting.md](ops/troubleshooting.md)。
|
||||
> 说明:本分组内有 proposal/roadmap 文档,可能包含设想中的命令或配置。当前可执行行为请优先阅读 [config-reference.md](i18n/zh-CN/reference/api/config-reference.md)、[operations-runbook.md](i18n/zh-CN/ops/operations-runbook.md)、[troubleshooting.md](i18n/zh-CN/ops/troubleshooting.zh-CN.md)。
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
- [security/README.md](i18n/zh-CN/security/README.zh-CN.md)
|
||||
- [agnostic-security.md](i18n/zh-CN/security/agnostic-security.zh-CN.md)
|
||||
- [frictionless-security.md](i18n/zh-CN/security/frictionless-security.zh-CN.md)
|
||||
- [sandboxing.md](i18n/zh-CN/security/sandboxing.zh-CN.md)
|
||||
- [resource-limits.md](i18n/zh-CN/ops/resource-limits.zh-CN.md)
|
||||
- [audit-logging.md](i18n/zh-CN/security/audit-logging.zh-CN.md)
|
||||
- [security-roadmap.md](i18n/zh-CN/security/security-roadmap.zh-CN.md)
|
||||
|
||||
## 文档治理与分类
|
||||
|
||||
- 统一目录(TOC):[SUMMARY.md](SUMMARY.md)
|
||||
- 文档结构图(按语言/分区/功能):[structure/README.md](maintainers/structure-README.md)
|
||||
- 文档清单与分类:[docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- 文档结构图(按语言/分区/功能):[structure/README.md](i18n/zh-CN/maintainers/structure-README.zh-CN.md)
|
||||
- 文档清单与分类:[docs-inventory.md](i18n/zh-CN/maintainers/docs-inventory.zh-CN.md)
|
||||
- 国际化文档索引:[i18n/README.md](i18n/README.md)
|
||||
- 国际化覆盖度地图:[i18n-coverage.md](i18n/zh-CN/maintainers/i18n-coverage.zh-CN.md)
|
||||
- 项目分诊快照:[project-triage-snapshot-2026-02-18.md](i18n/zh-CN/maintainers/project-triage-snapshot-2026-02-18.zh-CN.md)
|
||||
|
||||
## 其他语言
|
||||
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
# ملخص توثيق ZeroClaw (جدول المحتويات الموحد)
|
||||
|
||||
هذا الملف هو جدول المحتويات المرجعي لنظام التوثيق.
|
||||
|
||||
> 📖 [النسخة الإنجليزية](SUMMARY.md)
|
||||
|
||||
آخر تحديث: **18 فبراير 2026**.
|
||||
|
||||
## نقاط الدخول حسب اللغة
|
||||
|
||||
- خريطة هيكل التوثيق (اللغة/القسم/الوظيفة): [structure/README.md](maintainers/structure-README.md)
|
||||
- README بالإنجليزية: [../README.md](../README.md)
|
||||
- README بالصينية: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README باليابانية: [../README.ja.md](../README.ja.md)
|
||||
- README بالروسية: [../README.ru.md](../README.ru.md)
|
||||
- README بالفرنسية: [../README.fr.md](../README.fr.md)
|
||||
- README بالفيتنامية: [../README.vi.md](../README.vi.md)
|
||||
- التوثيق بالإنجليزية: [README.md](README.md)
|
||||
- التوثيق بالصينية: [README.zh-CN.md](README.zh-CN.md)
|
||||
- التوثيق باليابانية: [README.ja.md](README.ja.md)
|
||||
- التوثيق بالروسية: [README.ru.md](README.ru.md)
|
||||
- التوثيق بالفرنسية: [README.fr.md](README.fr.md)
|
||||
- التوثيق بالفيتنامية: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- فهرس الترجمة: [i18n/README.md](i18n/README.md)
|
||||
- خريطة تغطية الترجمة: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## الفئات
|
||||
|
||||
### 1) البدء السريع
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) مرجع الأوامر والإعدادات والتكاملات
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) التشغيل والنشر
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) تصميم الأمان والمقترحات
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) العتاد والأجهزة الطرفية
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) المساهمة وCI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) حالة المشروع واللقطات
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# ZeroClaw ডকুমেন্টেশন সারাংশ (একীভূত সূচিপত্র)
|
||||
|
||||
এই ফাইলটি ডকুমেন্টেশন সিস্টেমের প্রামাণিক সূচিপত্র।
|
||||
|
||||
> 📖 [ইংরেজি সংস্করণ](SUMMARY.md)
|
||||
|
||||
সর্বশেষ আপডেট: **১৮ ফেব্রুয়ারি ২০২৬**।
|
||||
|
||||
## ভাষা অনুযায়ী প্রবেশ বিন্দু
|
||||
|
||||
- ডক কাঠামো মানচিত্র (ভাষা/অংশ/ফাংশন): [structure/README.md](maintainers/structure-README.md)
|
||||
- ইংরেজি README: [../README.md](../README.md)
|
||||
- চীনা README: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- জাপানি README: [../README.ja.md](../README.ja.md)
|
||||
- রুশ README: [../README.ru.md](../README.ru.md)
|
||||
- ফরাসি README: [../README.fr.md](../README.fr.md)
|
||||
- ভিয়েতনামি README: [../README.vi.md](../README.vi.md)
|
||||
- ইংরেজি ডকুমেন্টেশন: [README.md](README.md)
|
||||
- চীনা ডকুমেন্টেশন: [README.zh-CN.md](README.zh-CN.md)
|
||||
- জাপানি ডকুমেন্টেশন: [README.ja.md](README.ja.md)
|
||||
- রুশ ডকুমেন্টেশন: [README.ru.md](README.ru.md)
|
||||
- ফরাসি ডকুমেন্টেশন: [README.fr.md](README.fr.md)
|
||||
- ভিয়েতনামি ডকুমেন্টেশন: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- স্থানীয়করণ সূচক: [i18n/README.md](i18n/README.md)
|
||||
- i18n কভারেজ মানচিত্র: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## বিভাগসমূহ
|
||||
|
||||
### ১) দ্রুত শুরু
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### ২) কমান্ড, কনফিগারেশন ও ইন্টিগ্রেশন রেফারেন্স
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### ৩) পরিচালনা ও ডিপ্লয়মেন্ট
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### ৪) নিরাপত্তা নকশা ও প্রস্তাবনা
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### ৫) হার্ডওয়্যার ও পেরিফেরাল
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### ৬) অবদান ও CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### ৭) প্রকল্পের অবস্থা ও স্ন্যাপশট
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Souhrn dokumentace ZeroClaw (Jednotný obsah)
|
||||
|
||||
Tento soubor je kanonický obsah dokumentačního systému.
|
||||
|
||||
> 📖 [Anglická verze](SUMMARY.md)
|
||||
|
||||
Poslední aktualizace: **18. února 2026**.
|
||||
|
||||
## Vstupní body podle jazyka
|
||||
|
||||
- Mapa struktury dokumentace (jazyk/část/funkce): [structure/README.md](maintainers/structure-README.md)
|
||||
- README v angličtině: [../README.md](../README.md)
|
||||
- README v čínštině: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README v japonštině: [../README.ja.md](../README.ja.md)
|
||||
- README v ruštině: [../README.ru.md](../README.ru.md)
|
||||
- README ve francouzštině: [../README.fr.md](../README.fr.md)
|
||||
- README ve vietnamštině: [../README.vi.md](../README.vi.md)
|
||||
- Dokumentace v angličtině: [README.md](README.md)
|
||||
- Dokumentace v čínštině: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Dokumentace v japonštině: [README.ja.md](README.ja.md)
|
||||
- Dokumentace v ruštině: [README.ru.md](README.ru.md)
|
||||
- Dokumentace ve francouzštině: [README.fr.md](README.fr.md)
|
||||
- Dokumentace ve vietnamštině: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Index lokalizace: [i18n/README.md](i18n/README.md)
|
||||
- Mapa pokrytí i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Kategorie
|
||||
|
||||
### 1) Rychlý start
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Reference příkazů, konfigurace a integrací
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Provoz a nasazení
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Návrh zabezpečení a návrhy
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware a periferie
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Přispívání a CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Stav projektu a snapshoty
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# ZeroClaw Dokumentationsoversigt (Samlet indholdsfortegnelse)
|
||||
|
||||
Denne fil er den kanoniske indholdsfortegnelse for dokumentationssystemet.
|
||||
|
||||
> 📖 [Engelsk version](SUMMARY.md)
|
||||
|
||||
Sidst opdateret: **18. februar 2026**.
|
||||
|
||||
## Indgangspunkter efter sprog
|
||||
|
||||
- Dokumentationsstrukturkort (sprog/del/funktion): [structure/README.md](maintainers/structure-README.md)
|
||||
- README på engelsk: [../README.md](../README.md)
|
||||
- README på kinesisk: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README på japansk: [../README.ja.md](../README.ja.md)
|
||||
- README på russisk: [../README.ru.md](../README.ru.md)
|
||||
- README på fransk: [../README.fr.md](../README.fr.md)
|
||||
- README på vietnamesisk: [../README.vi.md](../README.vi.md)
|
||||
- Dokumentation på engelsk: [README.md](README.md)
|
||||
- Dokumentation på kinesisk: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Dokumentation på japansk: [README.ja.md](README.ja.md)
|
||||
- Dokumentation på russisk: [README.ru.md](README.ru.md)
|
||||
- Dokumentation på fransk: [README.fr.md](README.fr.md)
|
||||
- Dokumentation på vietnamesisk: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Lokaliseringsindeks: [i18n/README.md](i18n/README.md)
|
||||
- i18n-dækningskort: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Kategorier
|
||||
|
||||
### 1) Hurtig start
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Kommando-, konfigurations- og integrationsreference
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Drift og udrulning
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Sikkerhedsdesign og forslag
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware og periferienheder
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Bidrag og CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Projektstatus og snapshots
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# ZeroClaw Dokumentationsübersicht (Einheitliches Inhaltsverzeichnis)
|
||||
|
||||
Diese Datei ist das kanonische Inhaltsverzeichnis des Dokumentationssystems.
|
||||
|
||||
> 📖 [Englische Version](SUMMARY.md)
|
||||
|
||||
Zuletzt aktualisiert: **18. Februar 2026**.
|
||||
|
||||
## Einstiegspunkte nach Sprache
|
||||
|
||||
- Dokumentationsstrukturkarte (Sprache/Teil/Funktion): [structure/README.md](maintainers/structure-README.md)
|
||||
- README auf Englisch: [../README.md](../README.md)
|
||||
- README auf Chinesisch: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README auf Japanisch: [../README.ja.md](../README.ja.md)
|
||||
- README auf Russisch: [../README.ru.md](../README.ru.md)
|
||||
- README auf Französisch: [../README.fr.md](../README.fr.md)
|
||||
- README auf Vietnamesisch: [../README.vi.md](../README.vi.md)
|
||||
- Dokumentation auf Englisch: [README.md](README.md)
|
||||
- Dokumentation auf Chinesisch: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Dokumentation auf Japanisch: [README.ja.md](README.ja.md)
|
||||
- Dokumentation auf Russisch: [README.ru.md](README.ru.md)
|
||||
- Dokumentation auf Französisch: [README.fr.md](README.fr.md)
|
||||
- Dokumentation auf Vietnamesisch: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Lokalisierungsindex: [i18n/README.md](i18n/README.md)
|
||||
- i18n-Abdeckungskarte: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Kategorien
|
||||
|
||||
### 1) Schnellstart
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Befehls-, Konfigurations- und Integrationsreferenz
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Betrieb und Bereitstellung
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Sicherheitsdesign und Vorschläge
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware und Peripheriegeräte
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Beitragen und CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Projektstatus und Snapshots
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Περίληψη Τεκμηρίωσης ZeroClaw (Ενοποιημένος Πίνακας Περιεχομένων)
|
||||
|
||||
Αυτό το αρχείο αποτελεί τον κανονικό πίνακα περιεχομένων του συστήματος τεκμηρίωσης.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Τελευταία ενημέρωση: **18 Φεβρουαρίου 2026**.
|
||||
|
||||
## Σημεία εισόδου ανά γλώσσα
|
||||
|
||||
- Χάρτης δομής εγγράφων (γλώσσα/τμήμα/λειτουργία): [structure/README.md](maintainers/structure-README.md)
|
||||
- README στα αγγλικά: [../README.md](../README.md)
|
||||
- README στα κινέζικα: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README στα ιαπωνικά: [../README.ja.md](../README.ja.md)
|
||||
- README στα ρωσικά: [../README.ru.md](../README.ru.md)
|
||||
- README στα γαλλικά: [../README.fr.md](../README.fr.md)
|
||||
- README στα βιετναμέζικα: [../README.vi.md](../README.vi.md)
|
||||
- Τεκμηρίωση στα αγγλικά: [README.md](README.md)
|
||||
- Τεκμηρίωση στα κινέζικα: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Τεκμηρίωση στα ιαπωνικά: [README.ja.md](README.ja.md)
|
||||
- Τεκμηρίωση στα ρωσικά: [README.ru.md](README.ru.md)
|
||||
- Τεκμηρίωση στα γαλλικά: [README.fr.md](README.fr.md)
|
||||
- Τεκμηρίωση στα βιετναμέζικα: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Ευρετήριο τοπικοποίησης: [i18n/README.md](i18n/README.md)
|
||||
- Χάρτης κάλυψης i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Κατηγορίες
|
||||
|
||||
### 1) Γρήγορη εκκίνηση
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Αναφορά εντολών, ρυθμίσεων και ενσωματώσεων
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Λειτουργία και ανάπτυξη
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Σχεδιασμός ασφαλείας και προτάσεις
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Υλικό και περιφερειακά
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Συνεισφορά και CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Κατάσταση έργου και στιγμιότυπα
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Resumen de Documentación ZeroClaw (Tabla de Contenidos Unificada)
|
||||
|
||||
Este archivo constituye la tabla de contenidos canónica del sistema de documentación.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Última actualización: **18 de febrero de 2026**.
|
||||
|
||||
## Puntos de entrada por idioma
|
||||
|
||||
- Mapa de estructura de docs (idioma/sección/función): [structure/README.md](maintainers/structure-README.md)
|
||||
- README en inglés: [../README.md](../README.md)
|
||||
- README en chino: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README en japonés: [../README.ja.md](../README.ja.md)
|
||||
- README en ruso: [../README.ru.md](../README.ru.md)
|
||||
- README en francés: [../README.fr.md](../README.fr.md)
|
||||
- README en vietnamita: [../README.vi.md](../README.vi.md)
|
||||
- Documentación en inglés: [README.md](README.md)
|
||||
- Documentación en chino: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Documentación en japonés: [README.ja.md](README.ja.md)
|
||||
- Documentación en ruso: [README.ru.md](README.ru.md)
|
||||
- Documentación en francés: [README.fr.md](README.fr.md)
|
||||
- Documentación en vietnamita: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Índice de localización: [i18n/README.md](i18n/README.md)
|
||||
- Mapa de cobertura i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Categorías
|
||||
|
||||
### 1) Inicio rápido
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Referencia de comandos, configuración e integraciones
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Operaciones y despliegue
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Diseño de seguridad y propuestas
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware y periféricos
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Contribución y CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Estado del proyecto e instantáneas
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# ZeroClaw-dokumentaation yhteenveto (Yhtenäinen sisällysluettelo)
|
||||
|
||||
Tämä tiedosto muodostaa dokumentaatiojärjestelmän kanonisen sisällysluettelon.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Viimeksi päivitetty: **18. helmikuuta 2026**.
|
||||
|
||||
## Aloituspisteet kielen mukaan
|
||||
|
||||
- Dokumenttien rakennekartta (kieli/osio/toiminto): [structure/README.md](maintainers/structure-README.md)
|
||||
- README englanniksi: [../README.md](../README.md)
|
||||
- README kiinaksi: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README japaniksi: [../README.ja.md](../README.ja.md)
|
||||
- README venäjäksi: [../README.ru.md](../README.ru.md)
|
||||
- README ranskaksi: [../README.fr.md](../README.fr.md)
|
||||
- README vietnamiksi: [../README.vi.md](../README.vi.md)
|
||||
- Dokumentaatio englanniksi: [README.md](README.md)
|
||||
- Dokumentaatio kiinaksi: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Dokumentaatio japaniksi: [README.ja.md](README.ja.md)
|
||||
- Dokumentaatio venäjäksi: [README.ru.md](README.ru.md)
|
||||
- Dokumentaatio ranskaksi: [README.fr.md](README.fr.md)
|
||||
- Dokumentaatio vietnamiksi: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Lokalisointiluettelo: [i18n/README.md](i18n/README.md)
|
||||
- i18n-kattavuuskartta: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Kategoriat
|
||||
|
||||
### 1) Pikaopas
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Komento-, asetus- ja integrointiviitteet
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Toiminta ja käyttöönotto
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Tietoturvasuunnittelu ja ehdotukset
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Laitteisto ja oheislaitteet
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Osallistuminen ja CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Projektin tila ja tilannekuvat
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# סיכום תיעוד ZeroClaw (תוכן עניינים מאוחד)
|
||||
|
||||
קובץ זה מהווה את תוכן העניינים הקנוני של מערכת התיעוד.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
עדכון אחרון: **18 בפברואר 2026**.
|
||||
|
||||
## נקודות כניסה לפי שפה
|
||||
|
||||
- מפת מבנה תיעוד (שפה/חלק/פונקציה): [structure/README.md](maintainers/structure-README.md)
|
||||
- README באנגלית: [../README.md](../README.md)
|
||||
- README בסינית: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README ביפנית: [../README.ja.md](../README.ja.md)
|
||||
- README ברוסית: [../README.ru.md](../README.ru.md)
|
||||
- README בצרפתית: [../README.fr.md](../README.fr.md)
|
||||
- README בווייטנאמית: [../README.vi.md](../README.vi.md)
|
||||
- תיעוד באנגלית: [README.md](README.md)
|
||||
- תיעוד בסינית: [README.zh-CN.md](README.zh-CN.md)
|
||||
- תיעוד ביפנית: [README.ja.md](README.ja.md)
|
||||
- תיעוד ברוסית: [README.ru.md](README.ru.md)
|
||||
- תיעוד בצרפתית: [README.fr.md](README.fr.md)
|
||||
- תיעוד בווייטנאמית: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- אינדקס תרגום: [i18n/README.md](i18n/README.md)
|
||||
- מפת כיסוי i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## קטגוריות
|
||||
|
||||
### 1) התחלה מהירה
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) עיון בפקודות, הגדרות ושילובים
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) תפעול ופריסה
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) עיצוב אבטחה והצעות
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) חומרה וציוד היקפי
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) תרומה ו-CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) מצב הפרויקט ותמונות מצב
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# ZeroClaw दस्तावेज़ीकरण सारांश (एकीकृत विषय सूची)
|
||||
|
||||
यह फ़ाइल दस्तावेज़ीकरण प्रणाली की कैनोनिकल विषय सूची है।
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
अंतिम अपडेट: **18 फरवरी 2026**।
|
||||
|
||||
## भाषा के अनुसार प्रवेश बिंदु
|
||||
|
||||
- दस्तावेज़ संरचना नक्शा (भाषा/भाग/कार्य): [structure/README.md](maintainers/structure-README.md)
|
||||
- अंग्रेज़ी README: [../README.md](../README.md)
|
||||
- चीनी README: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- जापानी README: [../README.ja.md](../README.ja.md)
|
||||
- रूसी README: [../README.ru.md](../README.ru.md)
|
||||
- फ़्रेंच README: [../README.fr.md](../README.fr.md)
|
||||
- वियतनामी README: [../README.vi.md](../README.vi.md)
|
||||
- अंग्रेज़ी दस्तावेज़ीकरण: [README.md](README.md)
|
||||
- चीनी दस्तावेज़ीकरण: [README.zh-CN.md](README.zh-CN.md)
|
||||
- जापानी दस्तावेज़ीकरण: [README.ja.md](README.ja.md)
|
||||
- रूसी दस्तावेज़ीकरण: [README.ru.md](README.ru.md)
|
||||
- फ़्रेंच दस्तावेज़ीकरण: [README.fr.md](README.fr.md)
|
||||
- वियतनामी दस्तावेज़ीकरण: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- स्थानीयकरण सूचकांक: [i18n/README.md](i18n/README.md)
|
||||
- i18n कवरेज नक्शा: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## श्रेणियाँ
|
||||
|
||||
### 1) त्वरित प्रारंभ
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) कमांड, कॉन्फ़िगरेशन और एकीकरण संदर्भ
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) संचालन और तैनाती
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) सुरक्षा डिज़ाइन और प्रस्ताव
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) हार्डवेयर और पेरिफेरल्स
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) योगदान और CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) प्रोजेक्ट स्थिति और स्नैपशॉट
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,92 @@
|
||||
# ZeroClaw Dokumentáció Összefoglaló (Egységes tartalomjegyzék)
|
||||
|
||||
Ez a fájl a dokumentációs rendszer kanonikus tartalomjegyzéke.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Utolsó frissítés: **2026. február 18.**
|
||||
|
||||
## Nyelvi belépési pontok
|
||||
|
||||
- Dokumentáció szerkezeti térkép (nyelv/rész/funkció): [structure/README.md](maintainers/structure-README.md)
|
||||
- Angol README: [../README.md](../README.md)
|
||||
- Kínai README: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- Japán README: [../README.ja.md](../README.ja.md)
|
||||
- Orosz README: [../README.ru.md](../README.ru.md)
|
||||
- Francia README: [../README.fr.md](../README.fr.md)
|
||||
- Vietnámi README: [../README.vi.md](../README.vi.md)
|
||||
- Angol dokumentációs központ: [README.md](README.md)
|
||||
- Kínai dokumentációs központ: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Japán dokumentációs központ: [README.ja.md](README.ja.md)
|
||||
- Orosz dokumentációs központ: [README.ru.md](README.ru.md)
|
||||
- Francia dokumentációs központ: [README.fr.md](README.fr.md)
|
||||
- Vietnámi dokumentációs központ: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Honosítási dokumentáció index: [i18n/README.md](i18n/README.md)
|
||||
- i18n lefedettségi térkép: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Kategóriák
|
||||
|
||||
### 1) Első lépések
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Parancs/konfiguráció referencia és integrációk
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Üzemeltetés és telepítés
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Biztonsági tervezés és javaslatok
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardver és perifériák
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Közreműködés és CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
- [extension-examples.md](contributing/extension-examples.md)
|
||||
- [testing.md](contributing/testing.md)
|
||||
|
||||
### 7) Projekt állapot és pillanatképek
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,92 @@
|
||||
# Ringkasan Dokumentasi ZeroClaw (Daftar Isi Terpadu)
|
||||
|
||||
File ini adalah daftar isi kanonik untuk sistem dokumentasi.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Pembaruan terakhir: **18 Februari 2026**.
|
||||
|
||||
## Titik Masuk Bahasa
|
||||
|
||||
- Peta struktur dokumentasi (bahasa/bagian/fungsi): [structure/README.md](maintainers/structure-README.md)
|
||||
- README Inggris: [../README.md](../README.md)
|
||||
- README Cina: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README Jepang: [../README.ja.md](../README.ja.md)
|
||||
- README Rusia: [../README.ru.md](../README.ru.md)
|
||||
- README Prancis: [../README.fr.md](../README.fr.md)
|
||||
- README Vietnam: [../README.vi.md](../README.vi.md)
|
||||
- Hub dokumentasi Inggris: [README.md](README.md)
|
||||
- Hub dokumentasi Cina: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Hub dokumentasi Jepang: [README.ja.md](README.ja.md)
|
||||
- Hub dokumentasi Rusia: [README.ru.md](README.ru.md)
|
||||
- Hub dokumentasi Prancis: [README.fr.md](README.fr.md)
|
||||
- Hub dokumentasi Vietnam: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Indeks dokumentasi lokalisasi: [i18n/README.md](i18n/README.md)
|
||||
- Peta cakupan i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Koleksi
|
||||
|
||||
### 1) Memulai
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Referensi perintah/konfigurasi & integrasi
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Operasi & deployment
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Desain keamanan & proposal
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Perangkat keras & periferal
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Kontribusi & CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
- [extension-examples.md](contributing/extension-examples.md)
|
||||
- [testing.md](contributing/testing.md)
|
||||
|
||||
### 7) Status proyek & snapshot
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,92 @@
|
||||
# Riepilogo della Documentazione ZeroClaw (Indice Unificato)
|
||||
|
||||
Questo file è l'indice canonico del sistema di documentazione.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Ultimo aggiornamento: **18 febbraio 2026**.
|
||||
|
||||
## Punti di ingresso per lingua
|
||||
|
||||
- Mappa della struttura documentale (lingua/parte/funzione): [structure/README.md](maintainers/structure-README.md)
|
||||
- README inglese: [../README.md](../README.md)
|
||||
- README cinese: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README giapponese: [../README.ja.md](../README.ja.md)
|
||||
- README russo: [../README.ru.md](../README.ru.md)
|
||||
- README francese: [../README.fr.md](../README.fr.md)
|
||||
- README vietnamita: [../README.vi.md](../README.vi.md)
|
||||
- Hub documentazione inglese: [README.md](README.md)
|
||||
- Hub documentazione cinese: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Hub documentazione giapponese: [README.ja.md](README.ja.md)
|
||||
- Hub documentazione russo: [README.ru.md](README.ru.md)
|
||||
- Hub documentazione francese: [README.fr.md](README.fr.md)
|
||||
- Hub documentazione vietnamita: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Indice documentazione localizzazione: [i18n/README.md](i18n/README.md)
|
||||
- Mappa di copertura i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Collezioni
|
||||
|
||||
### 1) Per iniziare
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Riferimento comandi/configurazione e integrazioni
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Operazioni e deployment
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Progettazione della sicurezza e proposte
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware e periferiche
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Contribuzione e CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
- [extension-examples.md](contributing/extension-examples.md)
|
||||
- [testing.md](contributing/testing.md)
|
||||
|
||||
### 7) Stato del progetto e snapshot
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,92 @@
|
||||
# ZeroClaw 문서 요약 (통합 목차)
|
||||
|
||||
이 파일은 문서 시스템의 정식 목차입니다.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
마지막 업데이트: **2026년 2월 18일**.
|
||||
|
||||
## 언어별 진입점
|
||||
|
||||
- 문서 구조 맵 (언어/부분/기능): [structure/README.md](maintainers/structure-README.md)
|
||||
- 영어 README: [../README.md](../README.md)
|
||||
- 중국어 README: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- 일본어 README: [../README.ja.md](../README.ja.md)
|
||||
- 러시아어 README: [../README.ru.md](../README.ru.md)
|
||||
- 프랑스어 README: [../README.fr.md](../README.fr.md)
|
||||
- 베트남어 README: [../README.vi.md](../README.vi.md)
|
||||
- 영어 문서 허브: [README.md](README.md)
|
||||
- 중국어 문서 허브: [README.zh-CN.md](README.zh-CN.md)
|
||||
- 일본어 문서 허브: [README.ja.md](README.ja.md)
|
||||
- 러시아어 문서 허브: [README.ru.md](README.ru.md)
|
||||
- 프랑스어 문서 허브: [README.fr.md](README.fr.md)
|
||||
- 베트남어 문서 허브: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- 현지화 문서 색인: [i18n/README.md](i18n/README.md)
|
||||
- i18n 커버리지 맵: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## 컬렉션
|
||||
|
||||
### 1) 시작하기
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) 명령어/구성 참조 및 통합
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) 운영 및 배포
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) 보안 설계 및 제안
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) 하드웨어 및 주변 장치
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) 기여 및 CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
- [extension-examples.md](contributing/extension-examples.md)
|
||||
- [testing.md](contributing/testing.md)
|
||||
|
||||
### 7) 프로젝트 상태 및 스냅샷
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
+57
-7
@@ -8,17 +8,67 @@ Last refreshed: **February 18, 2026**.
|
||||
|
||||
- Docs Structure Map (language/part/function): [structure/README.md](maintainers/structure-README.md)
|
||||
- English README: [../README.md](../README.md)
|
||||
- Chinese README: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- Japanese README: [../README.ja.md](../README.ja.md)
|
||||
- Russian README: [../README.ru.md](../README.ru.md)
|
||||
- Arabic README: [../README.ar.md](../README.ar.md)
|
||||
- Bengali README: [../README.bn.md](../README.bn.md)
|
||||
- Czech README: [../README.cs.md](../README.cs.md)
|
||||
- Danish README: [../README.da.md](../README.da.md)
|
||||
- German README: [../README.de.md](../README.de.md)
|
||||
- Greek README: [../README.el.md](../README.el.md)
|
||||
- Spanish README: [../README.es.md](../README.es.md)
|
||||
- Finnish README: [../README.fi.md](../README.fi.md)
|
||||
- French README: [../README.fr.md](../README.fr.md)
|
||||
- Hebrew README: [../README.he.md](../README.he.md)
|
||||
- Hindi README: [../README.hi.md](../README.hi.md)
|
||||
- Hungarian README: [../README.hu.md](../README.hu.md)
|
||||
- Indonesian README: [../README.id.md](../README.id.md)
|
||||
- Italian README: [../README.it.md](../README.it.md)
|
||||
- Japanese README: [../README.ja.md](../README.ja.md)
|
||||
- Korean README: [../README.ko.md](../README.ko.md)
|
||||
- Norwegian Bokmål README: [../README.nb.md](../README.nb.md)
|
||||
- Dutch README: [../README.nl.md](../README.nl.md)
|
||||
- Polish README: [../README.pl.md](../README.pl.md)
|
||||
- Portuguese README: [../README.pt.md](../README.pt.md)
|
||||
- Romanian README: [../README.ro.md](../README.ro.md)
|
||||
- Russian README: [../README.ru.md](../README.ru.md)
|
||||
- Swedish README: [../README.sv.md](../README.sv.md)
|
||||
- Thai README: [../README.th.md](../README.th.md)
|
||||
- Tagalog README: [../README.tl.md](../README.tl.md)
|
||||
- Turkish README: [../README.tr.md](../README.tr.md)
|
||||
- Ukrainian README: [../README.uk.md](../README.uk.md)
|
||||
- Urdu README: [../README.ur.md](../README.ur.md)
|
||||
- Vietnamese README: [../README.vi.md](../README.vi.md)
|
||||
- Chinese README: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- English Docs Hub: [README.md](README.md)
|
||||
- Chinese Docs Hub: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Japanese Docs Hub: [README.ja.md](README.ja.md)
|
||||
- Russian Docs Hub: [README.ru.md](README.ru.md)
|
||||
- Arabic Docs Hub: [README.ar.md](README.ar.md)
|
||||
- Bengali Docs Hub: [README.bn.md](README.bn.md)
|
||||
- Czech Docs Hub: [README.cs.md](README.cs.md)
|
||||
- Danish Docs Hub: [README.da.md](README.da.md)
|
||||
- German Docs Hub: [README.de.md](README.de.md)
|
||||
- Greek Docs Hub: [README.el.md](README.el.md)
|
||||
- Spanish Docs Hub: [README.es.md](README.es.md)
|
||||
- Finnish Docs Hub: [README.fi.md](README.fi.md)
|
||||
- French Docs Hub: [README.fr.md](README.fr.md)
|
||||
- Vietnamese Docs Hub: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Hebrew Docs Hub: [README.he.md](README.he.md)
|
||||
- Hindi Docs Hub: [README.hi.md](README.hi.md)
|
||||
- Hungarian Docs Hub: [README.hu.md](README.hu.md)
|
||||
- Indonesian Docs Hub: [README.id.md](README.id.md)
|
||||
- Italian Docs Hub: [README.it.md](README.it.md)
|
||||
- Japanese Docs Hub: [README.ja.md](README.ja.md)
|
||||
- Korean Docs Hub: [README.ko.md](README.ko.md)
|
||||
- Norwegian Bokmål Docs Hub: [README.nb.md](README.nb.md)
|
||||
- Dutch Docs Hub: [README.nl.md](README.nl.md)
|
||||
- Polish Docs Hub: [README.pl.md](README.pl.md)
|
||||
- Portuguese Docs Hub: [README.pt.md](README.pt.md)
|
||||
- Romanian Docs Hub: [README.ro.md](README.ro.md)
|
||||
- Russian Docs Hub: [README.ru.md](README.ru.md)
|
||||
- Swedish Docs Hub: [README.sv.md](README.sv.md)
|
||||
- Thai Docs Hub: [README.th.md](README.th.md)
|
||||
- Tagalog Docs Hub: [README.tl.md](README.tl.md)
|
||||
- Turkish Docs Hub: [README.tr.md](README.tr.md)
|
||||
- Ukrainian Docs Hub: [README.uk.md](README.uk.md)
|
||||
- Urdu Docs Hub: [README.ur.md](README.ur.md)
|
||||
- Vietnamese Docs Hub: [README.vi.md](README.vi.md)
|
||||
- Chinese Docs Hub: [README.zh-CN.md](README.zh-CN.md)
|
||||
- i18n Docs Index: [i18n/README.md](i18n/README.md)
|
||||
- i18n Coverage Map: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
# ZeroClaw Dokumentasjonssammendrag (Samlet innholdsfortegnelse)
|
||||
|
||||
Denne filen er den kanoniske innholdsfortegnelsen for dokumentasjonssystemet.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Sist oppdatert: **18. februar 2026**.
|
||||
|
||||
## Språkinngangspunkter
|
||||
|
||||
- Dokumentasjonsstrukturkart (språk/del/funksjon): [structure/README.md](maintainers/structure-README.md)
|
||||
- Engelsk README: [../README.md](../README.md)
|
||||
- Kinesisk README: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- Japansk README: [../README.ja.md](../README.ja.md)
|
||||
- Russisk README: [../README.ru.md](../README.ru.md)
|
||||
- Fransk README: [../README.fr.md](../README.fr.md)
|
||||
- Vietnamesisk README: [../README.vi.md](../README.vi.md)
|
||||
- Engelsk dokumentasjonshub: [README.md](README.md)
|
||||
- Kinesisk dokumentasjonshub: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Japansk dokumentasjonshub: [README.ja.md](README.ja.md)
|
||||
- Russisk dokumentasjonshub: [README.ru.md](README.ru.md)
|
||||
- Fransk dokumentasjonshub: [README.fr.md](README.fr.md)
|
||||
- Vietnamesisk dokumentasjonshub: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Lokaliseringsdokumentasjonsindeks: [i18n/README.md](i18n/README.md)
|
||||
- i18n-dekningskart: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Samlinger
|
||||
|
||||
### 1) Kom i gang
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [macos-update-uninstall.md](setup-guides/macos-update-uninstall.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Kommando-/konfigurasjonsreferanse og integrasjoner
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Drift og utrulling
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Sikkerhetsdesign og forslag
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Maskinvare og periferiutstyr
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Bidrag og CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
- [extension-examples.md](contributing/extension-examples.md)
|
||||
- [testing.md](contributing/testing.md)
|
||||
|
||||
### 7) Prosjektstatus og øyeblikksbilder
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# ZeroClaw Documentatieoverzicht (Uniforme Inhoudsopgave)
|
||||
|
||||
Dit bestand is de canonieke inhoudsopgave van het documentatiesysteem.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Laatst bijgewerkt: **18 februari 2026**.
|
||||
|
||||
## Toegangspunten per taal
|
||||
|
||||
- Documentatiestructuurkaart (taal/deel/functie): [structure/README.md](maintainers/structure-README.md)
|
||||
- README in het Engels: [../README.md](../README.md)
|
||||
- README in het Chinees: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README in het Japans: [../README.ja.md](../README.ja.md)
|
||||
- README in het Russisch: [../README.ru.md](../README.ru.md)
|
||||
- README in het Frans: [../README.fr.md](../README.fr.md)
|
||||
- README in het Vietnamees: [../README.vi.md](../README.vi.md)
|
||||
- Documentatie in het Engels: [README.md](README.md)
|
||||
- Documentatie in het Chinees: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Documentatie in het Japans: [README.ja.md](README.ja.md)
|
||||
- Documentatie in het Russisch: [README.ru.md](README.ru.md)
|
||||
- Documentatie in het Frans: [README.fr.md](README.fr.md)
|
||||
- Documentatie in het Vietnamees: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Lokalisatie-index: [i18n/README.md](i18n/README.md)
|
||||
- i18n-dekkingskaart: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Categorieën
|
||||
|
||||
### 1) Snelle start
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Commando-, configuratie- en integratiereferentie
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Beheer en implementatie
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Beveiligingsontwerp en voorstellen
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware en randapparatuur
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Bijdrage en CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Projectstatus en momentopnamen
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Podsumowanie Dokumentacji ZeroClaw (Ujednolicony Spis Treści)
|
||||
|
||||
Ten plik stanowi kanoniczny spis treści systemu dokumentacji.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Ostatnia aktualizacja: **18 lutego 2026**.
|
||||
|
||||
## Punkty wejścia według języka
|
||||
|
||||
- Mapa struktury dokumentacji (język/część/funkcja): [structure/README.md](maintainers/structure-README.md)
|
||||
- README po angielsku: [../README.md](../README.md)
|
||||
- README po chińsku: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README po japońsku: [../README.ja.md](../README.ja.md)
|
||||
- README po rosyjsku: [../README.ru.md](../README.ru.md)
|
||||
- README po francusku: [../README.fr.md](../README.fr.md)
|
||||
- README po wietnamsku: [../README.vi.md](../README.vi.md)
|
||||
- Dokumentacja po angielsku: [README.md](README.md)
|
||||
- Dokumentacja po chińsku: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Dokumentacja po japońsku: [README.ja.md](README.ja.md)
|
||||
- Dokumentacja po rosyjsku: [README.ru.md](README.ru.md)
|
||||
- Dokumentacja po francusku: [README.fr.md](README.fr.md)
|
||||
- Dokumentacja po wietnamsku: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Indeks lokalizacji: [i18n/README.md](i18n/README.md)
|
||||
- Mapa pokrycia i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Kategorie
|
||||
|
||||
### 1) Szybki start
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Polecenia, konfiguracja i referencje integracji
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Eksploatacja i wdrożenie
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Projektowanie bezpieczeństwa i propozycje
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware i peryferia
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Kontrybuowanie i CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Status projektu i migawki
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Resumo da Documentação ZeroClaw (Índice Unificado)
|
||||
|
||||
Este arquivo constitui o índice canônico do sistema de documentação.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Última atualização: **18 de fevereiro de 2026**.
|
||||
|
||||
## Pontos de entrada por idioma
|
||||
|
||||
- Mapa da estrutura de docs (idioma/parte/função): [structure/README.md](maintainers/structure-README.md)
|
||||
- README em inglês: [../README.md](../README.md)
|
||||
- README em chinês: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README em japonês: [../README.ja.md](../README.ja.md)
|
||||
- README em russo: [../README.ru.md](../README.ru.md)
|
||||
- README em francês: [../README.fr.md](../README.fr.md)
|
||||
- README em vietnamita: [../README.vi.md](../README.vi.md)
|
||||
- Documentação em inglês: [README.md](README.md)
|
||||
- Documentação em chinês: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Documentação em japonês: [README.ja.md](README.ja.md)
|
||||
- Documentação em russo: [README.ru.md](README.ru.md)
|
||||
- Documentação em francês: [README.fr.md](README.fr.md)
|
||||
- Documentação em vietnamita: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Índice de localização: [i18n/README.md](i18n/README.md)
|
||||
- Mapa de cobertura i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Categorias
|
||||
|
||||
### 1) Início rápido
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Referência de comandos, configuração e integrações
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Operações e implantação
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Design de segurança e propostas
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware e periféricos
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Contribuição e CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Estado do projeto e instantâneos
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Rezumatul Documentației ZeroClaw (Cuprins Unificat)
|
||||
|
||||
Acest fișier constituie cuprinsul canonic al sistemului de documentație.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Ultima actualizare: **18 februarie 2026**.
|
||||
|
||||
## Puncte de intrare pe limbă
|
||||
|
||||
- Harta structurii documentației (limbă/parte/funcție): [structure/README.md](maintainers/structure-README.md)
|
||||
- README în engleză: [../README.md](../README.md)
|
||||
- README în chineză: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README în japoneză: [../README.ja.md](../README.ja.md)
|
||||
- README în rusă: [../README.ru.md](../README.ru.md)
|
||||
- README în franceză: [../README.fr.md](../README.fr.md)
|
||||
- README în vietnameză: [../README.vi.md](../README.vi.md)
|
||||
- Documentație în engleză: [README.md](README.md)
|
||||
- Documentație în chineză: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Documentație în japoneză: [README.ja.md](README.ja.md)
|
||||
- Documentație în rusă: [README.ru.md](README.ru.md)
|
||||
- Documentație în franceză: [README.fr.md](README.fr.md)
|
||||
- Documentație în vietnameză: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Index de localizare: [i18n/README.md](i18n/README.md)
|
||||
- Hartă de acoperire i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Categorii
|
||||
|
||||
### 1) Start rapid
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Referință comenzi, configurare și integrări
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Operațiuni și implementare
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Design de securitate și propuneri
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware și periferice
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Contribuție și CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Starea proiectului și instantanee
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# ZeroClaw Dokumentationssammanfattning (Enhetlig Innehållsförteckning)
|
||||
|
||||
Denna fil utgör den kanoniska innehållsförteckningen för dokumentationssystemet.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Senast uppdaterad: **18 februari 2026**.
|
||||
|
||||
## Ingångspunkter per språk
|
||||
|
||||
- Dokumentationsstrukturkarta (språk/del/funktion): [structure/README.md](maintainers/structure-README.md)
|
||||
- README på engelska: [../README.md](../README.md)
|
||||
- README på kinesiska: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README på japanska: [../README.ja.md](../README.ja.md)
|
||||
- README på ryska: [../README.ru.md](../README.ru.md)
|
||||
- README på franska: [../README.fr.md](../README.fr.md)
|
||||
- README på vietnamesiska: [../README.vi.md](../README.vi.md)
|
||||
- Dokumentation på engelska: [README.md](README.md)
|
||||
- Dokumentation på kinesiska: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Dokumentation på japanska: [README.ja.md](README.ja.md)
|
||||
- Dokumentation på ryska: [README.ru.md](README.ru.md)
|
||||
- Dokumentation på franska: [README.fr.md](README.fr.md)
|
||||
- Dokumentation på vietnamesiska: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Lokaliseringsindex: [i18n/README.md](i18n/README.md)
|
||||
- i18n-täckningskarta: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Kategorier
|
||||
|
||||
### 1) Snabbstart
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Kommando-, konfigurations- och integrationsreferens
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Drift och driftsättning
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Säkerhetsdesign och förslag
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hårdvara och kringutrustning
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Bidrag och CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Projektstatus och ögonblicksbilder
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# สรุปเอกสาร ZeroClaw (สารบัญรวม)
|
||||
|
||||
ไฟล์นี้เป็นสารบัญหลักของระบบเอกสาร
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
อัปเดตล่าสุด: **18 กุมภาพันธ์ 2026**
|
||||
|
||||
## จุดเริ่มต้นตามภาษา
|
||||
|
||||
- แผนที่โครงสร้างเอกสาร (ภาษา/ส่วน/ฟังก์ชัน): [structure/README.md](maintainers/structure-README.md)
|
||||
- README ภาษาอังกฤษ: [../README.md](../README.md)
|
||||
- README ภาษาจีน: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README ภาษาญี่ปุ่น: [../README.ja.md](../README.ja.md)
|
||||
- README ภาษารัสเซีย: [../README.ru.md](../README.ru.md)
|
||||
- README ภาษาฝรั่งเศส: [../README.fr.md](../README.fr.md)
|
||||
- README ภาษาเวียดนาม: [../README.vi.md](../README.vi.md)
|
||||
- เอกสารภาษาอังกฤษ: [README.md](README.md)
|
||||
- เอกสารภาษาจีน: [README.zh-CN.md](README.zh-CN.md)
|
||||
- เอกสารภาษาญี่ปุ่น: [README.ja.md](README.ja.md)
|
||||
- เอกสารภาษารัสเซีย: [README.ru.md](README.ru.md)
|
||||
- เอกสารภาษาฝรั่งเศส: [README.fr.md](README.fr.md)
|
||||
- เอกสารภาษาเวียดนาม: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- ดัชนีการแปล: [i18n/README.md](i18n/README.md)
|
||||
- แผนที่ความครอบคลุม i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## หมวดหมู่
|
||||
|
||||
### 1) เริ่มต้นอย่างรวดเร็ว
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) คู่มือคำสั่ง การตั้งค่า และการรวมระบบ
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) การดำเนินงานและการปรับใช้
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) การออกแบบความปลอดภัยและข้อเสนอ
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) ฮาร์ดแวร์และอุปกรณ์ต่อพ่วง
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) การมีส่วนร่วมและ CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) สถานะโปรเจกต์และสแนปช็อต
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Buod ng Dokumentasyon ng ZeroClaw (Pinag-isang Talaan ng Nilalaman)
|
||||
|
||||
Ang file na ito ang canonical na talaan ng nilalaman ng sistema ng dokumentasyon.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Huling na-update: **Pebrero 18, 2026**.
|
||||
|
||||
## Mga Entry Point Ayon sa Wika
|
||||
|
||||
- Mapa ng istruktura ng docs (wika/bahagi/function): [structure/README.md](maintainers/structure-README.md)
|
||||
- README sa Ingles: [../README.md](../README.md)
|
||||
- README sa Tsino: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README sa Hapones: [../README.ja.md](../README.ja.md)
|
||||
- README sa Ruso: [../README.ru.md](../README.ru.md)
|
||||
- README sa Pranses: [../README.fr.md](../README.fr.md)
|
||||
- README sa Vietnamese: [../README.vi.md](../README.vi.md)
|
||||
- Dokumentasyon sa Ingles: [README.md](README.md)
|
||||
- Dokumentasyon sa Tsino: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Dokumentasyon sa Hapones: [README.ja.md](README.ja.md)
|
||||
- Dokumentasyon sa Ruso: [README.ru.md](README.ru.md)
|
||||
- Dokumentasyon sa Pranses: [README.fr.md](README.fr.md)
|
||||
- Dokumentasyon sa Vietnamese: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Index ng lokalisasyon: [i18n/README.md](i18n/README.md)
|
||||
- Mapa ng saklaw ng i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Mga Kategorya
|
||||
|
||||
### 1) Mabilis na Pagsisimula
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Reference ng Utos, Configuration, at Integrasyon
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Operasyon at Deployment
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Disenyo ng Seguridad at mga Panukala
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Hardware at Peripheral
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Kontribusyon at CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Estado ng Proyekto at mga Snapshot
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# ZeroClaw Dokümantasyon Özeti (Birleşik İçindekiler)
|
||||
|
||||
Bu dosya, dokümantasyon sisteminin kanonik içindekiler tablosudur.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Son güncelleme: **18 Şubat 2026**.
|
||||
|
||||
## Dile Göre Giriş Noktaları
|
||||
|
||||
- Dokümantasyon yapı haritası (dil/bölüm/işlev): [structure/README.md](maintainers/structure-README.md)
|
||||
- İngilizce README: [../README.md](../README.md)
|
||||
- Çince README: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- Japonca README: [../README.ja.md](../README.ja.md)
|
||||
- Rusça README: [../README.ru.md](../README.ru.md)
|
||||
- Fransızca README: [../README.fr.md](../README.fr.md)
|
||||
- Vietnamca README: [../README.vi.md](../README.vi.md)
|
||||
- İngilizce dokümantasyon: [README.md](README.md)
|
||||
- Çince dokümantasyon: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Japonca dokümantasyon: [README.ja.md](README.ja.md)
|
||||
- Rusça dokümantasyon: [README.ru.md](README.ru.md)
|
||||
- Fransızca dokümantasyon: [README.fr.md](README.fr.md)
|
||||
- Vietnamca dokümantasyon: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Yerelleştirme dizini: [i18n/README.md](i18n/README.md)
|
||||
- i18n kapsam haritası: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Kategoriler
|
||||
|
||||
### 1) Hızlı Başlangıç
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Komut, Yapılandırma ve Entegrasyon Referansı
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Operasyonlar ve Dağıtım
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Güvenlik Tasarımı ve Öneriler
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Donanım ve Çevre Birimleri
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Katkı ve CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Proje Durumu ve Anlık Görüntüler
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Зміст документації ZeroClaw (Єдиний зміст)
|
||||
|
||||
Цей файл є канонічним змістом системи документації.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Останнє оновлення: **18 лютого 2026**.
|
||||
|
||||
## Точки входу за мовою
|
||||
|
||||
- Карта структури документації (мова/розділ/функція): [structure/README.md](maintainers/structure-README.md)
|
||||
- README англійською: [../README.md](../README.md)
|
||||
- README китайською: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README японською: [../README.ja.md](../README.ja.md)
|
||||
- README російською: [../README.ru.md](../README.ru.md)
|
||||
- README французькою: [../README.fr.md](../README.fr.md)
|
||||
- README в'єтнамською: [../README.vi.md](../README.vi.md)
|
||||
- Документація англійською: [README.md](README.md)
|
||||
- Документація китайською: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Документація японською: [README.ja.md](README.ja.md)
|
||||
- Документація російською: [README.ru.md](README.ru.md)
|
||||
- Документація французькою: [README.fr.md](README.fr.md)
|
||||
- Документація в'єтнамською: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- Індекс локалізації: [i18n/README.md](i18n/README.md)
|
||||
- Карта покриття i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Категорії
|
||||
|
||||
### 1) Швидкий старт
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Довідник команд, конфігурації та інтеграцій
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Експлуатація та розгортання
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Проектування безпеки та пропозиції
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Обладнання та периферія
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Внесок та CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Стан проекту та знімки
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# ZeroClaw دستاویزات کا خلاصہ (متحد فہرست مضامین)
|
||||
|
||||
یہ فائل دستاویزات کے نظام کی معیاری فہرست مضامین ہے۔
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
آخری تازہ کاری: **18 فروری 2026**۔
|
||||
|
||||
## زبان کے مطابق داخلی نقاط
|
||||
|
||||
- دستاویزات ساختی نقشہ (زبان/حصہ/فنکشن): [structure/README.md](maintainers/structure-README.md)
|
||||
- انگریزی README: [../README.md](../README.md)
|
||||
- چینی README: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- جاپانی README: [../README.ja.md](../README.ja.md)
|
||||
- روسی README: [../README.ru.md](../README.ru.md)
|
||||
- فرانسیسی README: [../README.fr.md](../README.fr.md)
|
||||
- ویتنامی README: [../README.vi.md](../README.vi.md)
|
||||
- انگریزی دستاویزات: [README.md](README.md)
|
||||
- چینی دستاویزات: [README.zh-CN.md](README.zh-CN.md)
|
||||
- جاپانی دستاویزات: [README.ja.md](README.ja.md)
|
||||
- روسی دستاویزات: [README.ru.md](README.ru.md)
|
||||
- فرانسیسی دستاویزات: [README.fr.md](README.fr.md)
|
||||
- ویتنامی دستاویزات: [i18n/vi/README.md](i18n/vi/README.md)
|
||||
- لوکلائزیشن انڈیکس: [i18n/README.md](i18n/README.md)
|
||||
- i18n کوریج نقشہ: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## زمرے
|
||||
|
||||
### 1) فوری آغاز
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) کمانڈز، کنفیگریشن اور انضمام کا حوالہ
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) آپریشنز اور تعیناتی
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) سیکیورٹی ڈیزائن اور تجاویز
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) ہارڈویئر اور پیریفرلز
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) شراکت اور CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) پراجیکٹ کی حالت اور سنیپ شاٹس
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
@@ -0,0 +1,89 @@
|
||||
# Tóm tắt Tài liệu ZeroClaw (Mục lục Thống nhất)
|
||||
|
||||
Tệp này là mục lục chính thức của hệ thống tài liệu.
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
Cập nhật lần cuối: **18 tháng 2, 2026**.
|
||||
|
||||
## Điểm vào theo Ngôn ngữ
|
||||
|
||||
- Bản đồ cấu trúc tài liệu (ngôn ngữ/phần/chức năng): [structure/README.md](maintainers/structure-README.md)
|
||||
- README tiếng Anh: [../README.md](../README.md)
|
||||
- README tiếng Trung: [../README.zh-CN.md](../README.zh-CN.md)
|
||||
- README tiếng Nhật: [../README.ja.md](../README.ja.md)
|
||||
- README tiếng Nga: [../README.ru.md](../README.ru.md)
|
||||
- README tiếng Pháp: [../README.fr.md](../README.fr.md)
|
||||
- README tiếng Việt: [../README.vi.md](../README.vi.md)
|
||||
- Tài liệu tiếng Anh: [README.md](README.md)
|
||||
- Tài liệu tiếng Trung: [README.zh-CN.md](README.zh-CN.md)
|
||||
- Tài liệu tiếng Nhật: [README.ja.md](README.ja.md)
|
||||
- Tài liệu tiếng Nga: [README.ru.md](README.ru.md)
|
||||
- Tài liệu tiếng Pháp: [README.fr.md](README.fr.md)
|
||||
- Tài liệu tiếng Việt: [README.vi.md](README.vi.md)
|
||||
- Chỉ mục bản địa hóa: [i18n/README.md](i18n/README.md)
|
||||
- Bản đồ phủ sóng i18n: [i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
|
||||
## Danh mục
|
||||
|
||||
### 1) Bắt đầu Nhanh
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
|
||||
### 2) Tham chiếu Lệnh, Cấu hình và Tích hợp
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
|
||||
### 3) Vận hành và Triển khai
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
|
||||
### 4) Thiết kế Bảo mật và Đề xuất
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
|
||||
### 5) Phần cứng và Thiết bị Ngoại vi
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
|
||||
### 6) Đóng góp và CI
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
|
||||
### 7) Trạng thái Dự án và Ảnh chụp
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
+73
-48
@@ -4,11 +4,11 @@
|
||||
|
||||
> 📖 [English version](SUMMARY.md)
|
||||
|
||||
最后更新:**2026年2月18日**。
|
||||
最后更新:**2026年3月14日**。
|
||||
|
||||
## 语言入口
|
||||
|
||||
- 文档结构图(按语言/分区/功能):[structure/README.md](maintainers/structure-README.md)
|
||||
- 文档结构图(按语言/分区/功能):[structure/README.md](i18n/zh-CN/maintainers/structure-README.zh-CN.md)
|
||||
- 英文 README:[../README.md](../README.md)
|
||||
- 中文 README:[../README.zh-CN.md](../README.zh-CN.md)
|
||||
- 日文 README:[../README.ja.md](../README.ja.md)
|
||||
@@ -22,68 +22,93 @@
|
||||
- 法文文档中心:[README.fr.md](README.fr.md)
|
||||
- 越南文文档中心:[i18n/vi/README.md](i18n/vi/README.md)
|
||||
- 国际化文档索引:[i18n/README.md](i18n/README.md)
|
||||
- 国际化覆盖图:[i18n-coverage.md](maintainers/i18n-coverage.md)
|
||||
- 国际化覆盖图:[i18n-coverage.md](i18n/zh-CN/maintainers/i18n-coverage.zh-CN.md)
|
||||
|
||||
## 分类
|
||||
|
||||
### 1) 快速入门
|
||||
|
||||
- [setup-guides/README.md](setup-guides/README.md)
|
||||
- [one-click-bootstrap.md](setup-guides/one-click-bootstrap.md)
|
||||
- [setup-guides/README.md](i18n/zh-CN/setup-guides/README.zh-CN.md)
|
||||
- [macos-update-uninstall.md](i18n/zh-CN/setup-guides/macos-update-uninstall.zh-CN.md)
|
||||
- [one-click-bootstrap.md](i18n/zh-CN/setup-guides/one-click-bootstrap.zh-CN.md)
|
||||
- [mattermost-setup.md](i18n/zh-CN/setup-guides/mattermost-setup.zh-CN.md)
|
||||
- [nextcloud-talk-setup.md](i18n/zh-CN/setup-guides/nextcloud-talk-setup.zh-CN.md)
|
||||
- [zai-glm-setup.md](i18n/zh-CN/setup-guides/zai-glm-setup.zh-CN.md)
|
||||
|
||||
### 2) 命令 / 配置参考与集成
|
||||
|
||||
- [reference/README.md](reference/README.md)
|
||||
- [commands-reference.md](reference/cli/commands-reference.md)
|
||||
- [providers-reference.md](reference/api/providers-reference.md)
|
||||
- [channels-reference.md](reference/api/channels-reference.md)
|
||||
- [nextcloud-talk-setup.md](setup-guides/nextcloud-talk-setup.md)
|
||||
- [config-reference.md](reference/api/config-reference.md)
|
||||
- [custom-providers.md](contributing/custom-providers.md)
|
||||
- [zai-glm-setup.md](setup-guides/zai-glm-setup.md)
|
||||
- [langgraph-integration.md](contributing/langgraph-integration.md)
|
||||
- [reference/README.md](i18n/zh-CN/reference/README.zh-CN.md)
|
||||
- [commands-reference.md](i18n/zh-CN/reference/cli/commands-reference.zh-CN.md)
|
||||
- [providers-reference.md](i18n/zh-CN/reference/api/providers-reference.zh-CN.md)
|
||||
- [channels-reference.md](i18n/zh-CN/reference/api/channels-reference.zh-CN.md)
|
||||
- [config-reference.md](i18n/zh-CN/reference/api/config-reference.zh-CN.md)
|
||||
- [custom-providers.md](i18n/zh-CN/contributing/custom-providers.zh-CN.md)
|
||||
- [langgraph-integration.md](i18n/zh-CN/contributing/langgraph-integration.zh-CN.md)
|
||||
|
||||
### 3) 运维与部署
|
||||
### 3) SOP(标准操作流程)
|
||||
|
||||
- [ops/README.md](ops/README.md)
|
||||
- [operations-runbook.md](ops/operations-runbook.md)
|
||||
- [release-process.md](contributing/release-process.md)
|
||||
- [troubleshooting.md](ops/troubleshooting.md)
|
||||
- [network-deployment.md](ops/network-deployment.md)
|
||||
- [mattermost-setup.md](setup-guides/mattermost-setup.md)
|
||||
- [reference/sop/README.md](i18n/zh-CN/reference/sop/README.zh-CN.md)
|
||||
- [reference/sop/syntax.md](i18n/zh-CN/reference/sop/syntax.zh-CN.md)
|
||||
- [reference/sop/cookbook.md](i18n/zh-CN/reference/sop/cookbook.zh-CN.md)
|
||||
- [reference/sop/connectivity.md](i18n/zh-CN/reference/sop/connectivity.zh-CN.md)
|
||||
- [reference/sop/observability.md](i18n/zh-CN/reference/sop/observability.zh-CN.md)
|
||||
|
||||
### 4) 安全设计与提案
|
||||
### 4) 运维与部署
|
||||
|
||||
- [security/README.md](security/README.md)
|
||||
- [agnostic-security.md](security/agnostic-security.md)
|
||||
- [frictionless-security.md](security/frictionless-security.md)
|
||||
- [sandboxing.md](security/sandboxing.md)
|
||||
- [resource-limits.md](ops/resource-limits.md)
|
||||
- [audit-logging.md](security/audit-logging.md)
|
||||
- [security-roadmap.md](security/security-roadmap.md)
|
||||
- [ops/README.md](i18n/zh-CN/ops/README.zh-CN.md)
|
||||
- [operations-runbook.md](i18n/zh-CN/ops/operations-runbook.zh-CN.md)
|
||||
- [release-process.md](i18n/zh-CN/contributing/release-process.zh-CN.md)
|
||||
- [troubleshooting.md](i18n/zh-CN/ops/troubleshooting.zh-CN.md)
|
||||
- [network-deployment.md](i18n/zh-CN/ops/network-deployment.zh-CN.md)
|
||||
- [proxy-agent-playbook.md](i18n/zh-CN/ops/proxy-agent-playbook.zh-CN.md)
|
||||
- [resource-limits.md](i18n/zh-CN/ops/resource-limits.zh-CN.md)
|
||||
|
||||
### 5) 硬件与外设
|
||||
### 5) 安全设计与提案
|
||||
|
||||
- [hardware/README.md](hardware/README.md)
|
||||
- [hardware-peripherals-design.md](hardware/hardware-peripherals-design.md)
|
||||
- [adding-boards-and-tools.md](contributing/adding-boards-and-tools.md)
|
||||
- [nucleo-setup.md](hardware/nucleo-setup.md)
|
||||
- [arduino-uno-q-setup.md](hardware/arduino-uno-q-setup.md)
|
||||
- [datasheets/nucleo-f401re.md](hardware/datasheets/nucleo-f401re.md)
|
||||
- [datasheets/arduino-uno.md](hardware/datasheets/arduino-uno.md)
|
||||
- [datasheets/esp32.md](hardware/datasheets/esp32.md)
|
||||
- [security/README.md](i18n/zh-CN/security/README.zh-CN.md)
|
||||
- [matrix-e2ee-guide.md](i18n/zh-CN/security/matrix-e2ee-guide.zh-CN.md)
|
||||
- [agnostic-security.md](i18n/zh-CN/security/agnostic-security.zh-CN.md)
|
||||
- [frictionless-security.md](i18n/zh-CN/security/frictionless-security.zh-CN.md)
|
||||
- [sandboxing.md](i18n/zh-CN/security/sandboxing.zh-CN.md)
|
||||
- [audit-logging.md](i18n/zh-CN/security/audit-logging.zh-CN.md)
|
||||
- [security-roadmap.md](i18n/zh-CN/security/security-roadmap.zh-CN.md)
|
||||
|
||||
### 6) 贡献与 CI
|
||||
### 6) 硬件与外设
|
||||
|
||||
- [contributing/README.md](contributing/README.md)
|
||||
- [hardware/README.md](i18n/zh-CN/hardware/README.zh-CN.md)
|
||||
- [hardware-peripherals-design.md](i18n/zh-CN/hardware/hardware-peripherals-design.zh-CN.md)
|
||||
- [adding-boards-and-tools.md](i18n/zh-CN/contributing/adding-boards-and-tools.zh-CN.md)
|
||||
- [nucleo-setup.md](i18n/zh-CN/hardware/nucleo-setup.zh-CN.md)
|
||||
- [arduino-uno-q-setup.md](i18n/zh-CN/hardware/arduino-uno-q-setup.zh-CN.md)
|
||||
- [android-setup.md](i18n/zh-CN/hardware/android-setup.zh-CN.md)
|
||||
- [datasheets/nucleo-f401re.md](i18n/zh-CN/hardware/datasheets/nucleo-f401re.zh-CN.md)
|
||||
- [datasheets/arduino-uno.md](i18n/zh-CN/hardware/datasheets/arduino-uno.zh-CN.md)
|
||||
- [datasheets/esp32.md](i18n/zh-CN/hardware/datasheets/esp32.zh-CN.md)
|
||||
|
||||
### 7) 贡献与 CI
|
||||
|
||||
- [contributing/README.md](i18n/zh-CN/contributing/README.zh-CN.md)
|
||||
- [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||||
- [pr-workflow.md](contributing/pr-workflow.md)
|
||||
- [reviewer-playbook.md](contributing/reviewer-playbook.md)
|
||||
- [ci-map.md](contributing/ci-map.md)
|
||||
- [actions-source-policy.md](contributing/actions-source-policy.md)
|
||||
- [pr-workflow.md](i18n/zh-CN/contributing/pr-workflow.zh-CN.md)
|
||||
- [reviewer-playbook.md](i18n/zh-CN/contributing/reviewer-playbook.zh-CN.md)
|
||||
- [ci-map.md](i18n/zh-CN/contributing/ci-map.zh-CN.md)
|
||||
- [actions-source-policy.md](i18n/zh-CN/contributing/actions-source-policy.zh-CN.md)
|
||||
- [extension-examples.md](i18n/zh-CN/contributing/extension-examples.zh-CN.md)
|
||||
- [testing.md](i18n/zh-CN/contributing/testing.zh-CN.md)
|
||||
- [testing-telegram.md](i18n/zh-CN/contributing/testing-telegram.zh-CN.md)
|
||||
- [cargo-slicer-speedup.md](i18n/zh-CN/contributing/cargo-slicer-speedup.zh-CN.md)
|
||||
- [change-playbooks.md](i18n/zh-CN/contributing/change-playbooks.zh-CN.md)
|
||||
- [cla.md](i18n/zh-CN/contributing/cla.zh-CN.md)
|
||||
- [doc-template.md](i18n/zh-CN/contributing/doc-template.zh-CN.md)
|
||||
- [docs-contract.md](i18n/zh-CN/contributing/docs-contract.zh-CN.md)
|
||||
- [pr-discipline.md](i18n/zh-CN/contributing/pr-discipline.zh-CN.md)
|
||||
|
||||
### 7) 项目状态与快照
|
||||
### 8) 项目状态与快照
|
||||
|
||||
- [maintainers/README.md](maintainers/README.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](maintainers/project-triage-snapshot-2026-02-18.md)
|
||||
- [docs-inventory.md](maintainers/docs-inventory.md)
|
||||
- [maintainers/README.md](i18n/zh-CN/maintainers/README.zh-CN.md)
|
||||
- [project-triage-snapshot-2026-02-18.md](i18n/zh-CN/maintainers/project-triage-snapshot-2026-02-18.zh-CN.md)
|
||||
- [docs-inventory.md](i18n/zh-CN/maintainers/docs-inventory.zh-CN.md)
|
||||
- [refactor-candidates.md](i18n/zh-CN/maintainers/refactor-candidates.zh-CN.md)
|
||||
- [repo-map.md](i18n/zh-CN/maintainers/repo-map.zh-CN.md)
|
||||
- [structure-README.md](i18n/zh-CN/maintainers/structure-README.zh-CN.md)
|
||||
- [trademark.md](i18n/zh-CN/maintainers/trademark.zh-CN.md)
|
||||
|
||||
@@ -0,0 +1,114 @@
|
||||
# Οδηγός Ρυθμίσεων ZeroClaw (config.toml)
|
||||
|
||||
Αυτός ο οδηγός εξηγεί τις πιο σημαντικές ρυθμίσεις που μπορείτε να κάνετε στο αρχείο `config.toml`.
|
||||
|
||||
Τελευταίος έλεγχος: **19 Φεβρουαρίου 2026**.
|
||||
|
||||
## Πού βρίσκεται το αρχείο ρυθμίσεων;
|
||||
|
||||
Το ZeroClaw ψάχνει για τις ρυθμίσεις με την εξής σειρά:
|
||||
1. Στη διαδρομή που ορίζει η μεταβλητή `ZEROCLAW_WORKSPACE`.
|
||||
2. Στο αρχείο `~/.zeroclaw/config.toml` (αυτή είναι η συνηθισμένη θέση).
|
||||
|
||||
## Βασικές Ρυθμίσεις (Core)
|
||||
|
||||
| Ρύθμιση | Τι ορίζει |
|
||||
|---|---|
|
||||
| `default_provider` | Ποιον πάροχο AI χρησιμοποιείτε (π.χ. `openai`, `ollama`). |
|
||||
| `default_model` | Ποιο συγκεκριμένο μοντέλο AI χρησιμοποιείτε (π.χ. `gpt-4o`). |
|
||||
| `default_temperature` | Πόσο "δημιουργική" θα είναι η AI (τιμή από 0 έως 2). |
|
||||
|
||||
## 1. Συμπεριφορά της AI (Agent)
|
||||
|
||||
- `max_tool_iterations`: Πόσες φορές μπορεί η AI να χρησιμοποιήσει εργαλεία για να απαντήσει σε 1 μήνυμα (προεπιλογή: 10).
|
||||
- `max_history_messages`: Πόσα προηγούμενα μηνύματα θυμάται η AI στη συνομιλία (προεπιλογή: 50).
|
||||
|
||||
## 2. Αυτονομία και Ασφάλεια (Autonomy)
|
||||
|
||||
Εδώ ρυθμίζετε πόση ελευθερία έχει η AI να κάνει αλλαγές στον υπολογιστή σας.
|
||||
|
||||
- `level`:
|
||||
- `read_only`: Μπορεί μόνο να διαβάζει αρχεία.
|
||||
- `supervised`: Χρειάζεται την έγκρισή σας για σημαντικές ενέργειες (προεπιλογή).
|
||||
- `full`: Μπορεί να τρέχει εντολές ελεύθερα (προσοχή!).
|
||||
- `allowed_commands`: Λίστα με τις εντολές που επιτρέπεται να τρέχει η AI.
|
||||
- `forbidden_paths`: Φάκελοι που η AI **δεν** επιτρέπεται να αγγίξει (π.χ. `/etc`).
|
||||
|
||||
## 3. Μνήμη (Memory)
|
||||
|
||||
Πώς αποθηκεύει η AI τις πληροφορίες που της δίνετε.
|
||||
- `backend`: Μπορεί να είναι `sqlite` (βάση δεδομένων), `markdown` (απλά αρχεία κειμένου) ή `none` (καμία μνήμη).
|
||||
|
||||
## 4. Κανάλια Επικοινωνίας (Channels)
|
||||
|
||||
Κάθε κανάλι (Telegram, Discord κ.λπ.) έχει τη δική του ενότητα στο αρχείο.
|
||||
|
||||
Παράδειγμα για το **Telegram**:
|
||||
```toml
|
||||
[channels_config.telegram]
|
||||
bot_token = "το-κλειδί-σας"
|
||||
allowed_users = ["το-όνομά-σας"] # Ποιοι επιτρέπεται να μιλάνε στο bot
|
||||
```
|
||||
|
||||
## 5. Έλεγχος Κόστους (Cost)
|
||||
|
||||
Αν χρησιμοποιείτε πληρωμένες υπηρεσίες AI, μπορείτε να βάλετε όρια.
|
||||
- `daily_limit_usd`: Μέγιστο ποσό ανά ημέρα (π.χ. 10.00 δολάρια).
|
||||
- `monthly_limit_usd`: Μέγιστο ποσό ανά μήνα.
|
||||
|
||||
## 6. Εικόνες (Multimodal)
|
||||
|
||||
Ρυθμίσεις για το πώς η AI βλέπει εικόνες.
|
||||
- `max_images`: Μέγιστος αριθμός εικόνων ανά μήνυμα.
|
||||
- `allow_remote_fetch`: Αν επιτρέπεται στην AI να κατεβάζει εικόνες από το ίντερνετ μέσω συνδέσμων (links).
|
||||
|
||||
---
|
||||
|
||||
## Συμβουλές
|
||||
|
||||
- Αν αλλάξετε το αρχείο `config.toml`, πρέπει να κάνετε επανεκκίνηση το ZeroClaw για να δει τις αλλαγές.
|
||||
- Χρησιμοποιήστε την εντολή `zeroclaw doctor` για να βεβαιωθείτε ότι οι ρυθμίσεις σας είναι σωστές.
|
||||
|
||||
## Ενημέρωση (2026-03-03)
|
||||
|
||||
- Στην ενότητα `[agent]` προστέθηκαν τα `allowed_tools` και `denied_tools`.
|
||||
- Αν το `allowed_tools` δεν είναι κενό, ο primary agent βλέπει μόνο τα εργαλεία της λίστας.
|
||||
- Το `denied_tools` εφαρμόζεται μετά το allowlist και αφαιρεί επιπλέον εργαλεία.
|
||||
- Άγνωστες τιμές στο `allowed_tools` αγνοούνται (με debug log) και δεν μπλοκάρουν την εκκίνηση.
|
||||
- Αν `allowed_tools` και `denied_tools` καταλήξουν να αφαιρέσουν όλα τα εκτελέσιμα εργαλεία, η εκκίνηση αποτυγχάνει άμεσα με σαφές μήνυμα ρύθμισης.
|
||||
- Για πλήρη πίνακα πεδίων και παράδειγμα, δείτε το αγγλικό `config-reference.md` στην ενότητα `[agent]`.
|
||||
- Μην μοιράζεστε ποτέ το αρχείο `config.toml` με άλλους, καθώς περιέχει τα μυστικά κλειδιά σας (tokens).
|
||||
|
||||
## Ενημέρωση (2026-03-12)
|
||||
|
||||
- Στην ενότητα `[agent]` προστέθηκε το `tool_filter_groups` για φιλτράρισμα schema tool MCP ανά γύρο.
|
||||
|
||||
### `tool_filter_groups`
|
||||
|
||||
Μειώνει τα tokens ανά γύρο περιορίζοντας ποια schema tool MCP αποστέλλονται στο LLM. Τα ενσωματωμένα εργαλεία (χωρίς πρόθεμα `mcp_`) περνούν πάντα αναλλοίωτα.
|
||||
|
||||
Κάθε εγγραφή είναι πίνακας με τα εξής πεδία:
|
||||
|
||||
| Πεδίο | Τύπος | Σκοπός |
|
||||
|---|---|---|
|
||||
| `mode` | `"always"` \| `"dynamic"` | `always`: το εργαλείο συμπεριλαμβάνεται πάντα. `dynamic`: συμπεριλαμβάνεται μόνο όταν το μήνυμα χρήστη περιέχει λέξη-κλειδί. |
|
||||
| `tools` | `[string]` | Μοτίβα ονόματος εργαλείου. Υποστηρίζεται ένα `*` wildcard (π.χ. `"mcp_vikunja_*"`). |
|
||||
| `keywords` | `[string]` | (Μόνο για dynamic) Υποαλφαριθμητικά χωρίς διάκριση πεζών-κεφαλαίων που αντιστοιχούν στο τελευταίο μήνυμα χρήστη. |
|
||||
|
||||
Όταν το `tool_filter_groups` είναι κενό, η λειτουργία είναι ανενεργή και όλα τα εργαλεία περνούν κανονικά (συμβατό με προηγούμενες εκδόσεις).
|
||||
|
||||
Παράδειγμα:
|
||||
|
||||
```toml
|
||||
[agent]
|
||||
# Τα εργαλεία MCP Vikunja είναι πάντα διαθέσιμα.
|
||||
[[agent.tool_filter_groups]]
|
||||
mode = "always"
|
||||
tools = ["mcp_vikunja_*"]
|
||||
|
||||
# Τα εργαλεία MCP browser συμπεριλαμβάνονται μόνο όταν ο χρήστης αναφέρει πλοήγηση.
|
||||
[[agent.tool_filter_groups]]
|
||||
mode = "dynamic"
|
||||
tools = ["mcp_browser_*"]
|
||||
keywords = ["περιήγηση", "πλοήγηση", "άνοιγμα url", "στιγμιότυπο"]
|
||||
```
|
||||
@@ -70,6 +70,7 @@ Lưu ý cho người dùng container:
|
||||
| `max_history_messages` | `50` | Số tin nhắn lịch sử tối đa giữ lại mỗi phiên |
|
||||
| `parallel_tools` | `false` | Bật thực thi tool song song trong một lượt |
|
||||
| `tool_dispatcher` | `auto` | Chiến lược dispatch tool |
|
||||
| `tool_call_dedup_exempt` | `[]` | Tên tool được miễn kiểm tra trùng lặp trong cùng một lượt |
|
||||
|
||||
Lưu ý:
|
||||
|
||||
@@ -77,6 +78,7 @@ Lưu ý:
|
||||
- Nếu tin nhắn kênh vượt giá trị này, runtime trả về: `Agent exceeded maximum tool iterations (<value>)`.
|
||||
- Trong vòng lặp tool của CLI, gateway và channel, các lời gọi tool độc lập được thực thi đồng thời mặc định khi không cần phê duyệt; thứ tự kết quả giữ ổn định.
|
||||
- `parallel_tools` áp dụng cho API `Agent::turn()`. Không ảnh hưởng đến vòng lặp runtime của CLI, gateway hay channel.
|
||||
- `tool_call_dedup_exempt` nhận mảng tên tool chính xác. Các tool trong danh sách được phép gọi nhiều lần với cùng tham số trong một lượt. Ví dụ: `tool_call_dedup_exempt = ["browser"]`.
|
||||
|
||||
## `[agents.<name>]`
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# 贡献、评审和 CI 文档
|
||||
|
||||
适用于贡献者、评审者和维护者。
|
||||
|
||||
## 核心政策
|
||||
|
||||
- 贡献指南:[../../../../CONTRIBUTING.md](../../../../CONTRIBUTING.md)
|
||||
- PR 工作流规则:[./pr-workflow.zh-CN.md](./pr-workflow.zh-CN.md)
|
||||
- 评审者手册:[./reviewer-playbook.zh-CN.md](./reviewer-playbook.zh-CN.md)
|
||||
- CI 地图和所有权:[./ci-map.zh-CN.md](./ci-map.zh-CN.md)
|
||||
- Actions 源政策:[./actions-source-policy.zh-CN.md](./actions-source-policy.zh-CN.md)
|
||||
- 扩展示例:[./extension-examples.zh-CN.md](./extension-examples.zh-CN.md)
|
||||
- 测试指南:[./testing.zh-CN.md](./testing.zh-CN.md)
|
||||
|
||||
## 建议阅读顺序
|
||||
|
||||
1. `CONTRIBUTING.md`
|
||||
2. `pr-workflow.md`
|
||||
3. `reviewer-playbook.md`
|
||||
4. `ci-map.md`
|
||||
@@ -0,0 +1,79 @@
|
||||
# Actions 源政策
|
||||
|
||||
本文档定义了本仓库当前的 GitHub Actions 源代码控制政策。
|
||||
|
||||
## 当前政策
|
||||
|
||||
- 仓库 Actions 权限:已启用
|
||||
- 允许的 Actions 模式:已选择
|
||||
|
||||
已选白名单(质量门控、Beta 发布和稳定发布工作流中当前使用的所有 Actions):
|
||||
|
||||
| Action | 使用位置 | 目的 |
|
||||
|--------|---------|---------|
|
||||
| `actions/checkout@v4` | 所有工作流 | 仓库检出 |
|
||||
| `actions/upload-artifact@v4` | release、promote-release | 上传构建产物 |
|
||||
| `actions/download-artifact@v4` | release、promote-release | 下载构建产物用于打包 |
|
||||
| `dtolnay/rust-toolchain@stable` | 所有工作流 | 安装 Rust 工具链(1.92.0) |
|
||||
| `Swatinem/rust-cache@v2` | 所有工作流 | Cargo 构建/依赖缓存 |
|
||||
| `softprops/action-gh-release@v2` | release、promote-release | 创建 GitHub Releases |
|
||||
| `docker/setup-buildx-action@v3` | release、promote-release | Docker Buildx 设置 |
|
||||
| `docker/login-action@v3` | release、promote-release | GHCR 认证 |
|
||||
| `docker/build-push-action@v6` | release、promote-release | 多平台 Docker 镜像构建和推送 |
|
||||
|
||||
等效的白名单模式:
|
||||
|
||||
- `actions/*`
|
||||
- `dtolnay/rust-toolchain@*`
|
||||
- `Swatinem/rust-cache@*`
|
||||
- `softprops/action-gh-release@*`
|
||||
- `docker/*`
|
||||
|
||||
## 工作流
|
||||
|
||||
| 工作流 | 文件 | 触发条件 |
|
||||
|----------|------|---------|
|
||||
| 质量门控 | `.github/workflows/checks-on-pr.yml` | 指向 `master` 的拉取请求 |
|
||||
| Beta 发布 | `.github/workflows/release-beta-on-push.yml` | 推送到 `master` |
|
||||
| 稳定发布 | `.github/workflows/release-stable-manual.yml` | 手动 `workflow_dispatch` |
|
||||
|
||||
## 变更控制
|
||||
|
||||
记录每个政策变更时包含:
|
||||
|
||||
- 变更日期/时间(UTC)
|
||||
- 操作者
|
||||
- 原因
|
||||
- 白名单变更(新增/移除的模式)
|
||||
- 回滚说明
|
||||
|
||||
使用以下命令导出当前有效政策:
|
||||
|
||||
```bash
|
||||
gh api repos/zeroclaw-labs/zeroclaw/actions/permissions
|
||||
gh api repos/zeroclaw-labs/zeroclaw/actions/permissions/selected-actions
|
||||
```
|
||||
|
||||
## 护栏
|
||||
|
||||
- 任何新增或变更 `uses:` Action 源的 PR 必须包含白名单影响说明。
|
||||
- 新的第三方 Action 在加入白名单前需要显式的维护者评审。
|
||||
- 仅为验证过的缺失 Action 扩展白名单;避免宽泛的通配符例外。
|
||||
|
||||
## 变更日志
|
||||
|
||||
- 2026-03-10:重命名工作流 — CI → 质量门控(`checks-on-pr.yml`)、Beta 发布 → Release Beta(`release-beta-on-push.yml`)、升级发布 → Release Stable(`release-stable-manual.yml`)。向质量门控添加了 `lint` 和 `security` 作业。添加了跨平台构建(`cross-platform-build-manual.yml`)。
|
||||
- 2026-03-05:完整工作流重构 — 将 22 个工作流替换为 3 个(CI、Beta 发布、升级发布)
|
||||
- 移除不再使用的模式:`DavidAnson/markdownlint-cli2-action@*`、`lycheeverse/lychee-action@*`、`EmbarkStudios/cargo-deny-action@*`、`rustsec/audit-check@*`、`rhysd/actionlint@*`、`sigstore/cosign-installer@*`、`Checkmarx/vorpal-reviewdog-github-action@*`、`useblacksmith/*`
|
||||
- 新增:`Swatinem/rust-cache@*`(替代 `useblacksmith/*` rust-cache 分支)
|
||||
- 保留:`actions/*`、`dtolnay/rust-toolchain@*`、`softprops/action-gh-release@*`、`docker/*`
|
||||
- 2026-03-05:CI 构建优化 — 添加了 mold 链接器、cargo-nextest、CARGO_INCREMENTAL=0
|
||||
- 由于 GHA 缓存后端不稳定导致构建失败,移除了 sccache
|
||||
|
||||
## 回滚
|
||||
|
||||
紧急解除阻塞路径:
|
||||
|
||||
1. 临时将 Actions 政策设置回 `all`。
|
||||
2. 识别缺失条目后恢复选中的白名单。
|
||||
3. 记录事件和最终白名单变更。
|
||||
@@ -0,0 +1,116 @@
|
||||
# 添加开发板和工具 — ZeroClaw 硬件指南
|
||||
|
||||
本指南解释如何向 ZeroClaw 添加新的硬件开发板和自定义工具。
|
||||
|
||||
## 快速开始:通过 CLI 添加开发板
|
||||
|
||||
```bash
|
||||
# 添加开发板(更新 ~/.zeroclaw/config.toml)
|
||||
zeroclaw peripheral add nucleo-f401re /dev/ttyACM0
|
||||
zeroclaw peripheral add arduino-uno /dev/cu.usbmodem12345
|
||||
zeroclaw peripheral add rpi-gpio native # 用于树莓派 GPIO(Linux)
|
||||
|
||||
# 重启守护进程应用更改
|
||||
zeroclaw daemon --host 127.0.0.1 --port 42617
|
||||
```
|
||||
|
||||
## 支持的开发板
|
||||
|
||||
| 开发板 | 传输方式 | 路径示例 |
|
||||
|-----------------|-----------|---------------------------|
|
||||
| nucleo-f401re | 串口 | /dev/ttyACM0, /dev/cu.usbmodem* |
|
||||
| arduino-uno | 串口 | /dev/ttyACM0, /dev/cu.usbmodem* |
|
||||
| arduino-uno-q | 桥接 | (Uno Q IP 地址) |
|
||||
| rpi-gpio | 原生 | native |
|
||||
| esp32 | 串口 | /dev/ttyUSB0 |
|
||||
|
||||
## 手动配置
|
||||
|
||||
编辑 `~/.zeroclaw/config.toml`:
|
||||
|
||||
```toml
|
||||
[peripherals]
|
||||
enabled = true
|
||||
datasheet_dir = "docs/datasheets" # 可选:RAG 支持,用于将"打开红色 LED"映射到引脚 13
|
||||
|
||||
[[peripherals.boards]]
|
||||
board = "nucleo-f401re"
|
||||
transport = "serial"
|
||||
path = "/dev/ttyACM0"
|
||||
baud = 115200
|
||||
|
||||
[[peripherals.boards]]
|
||||
board = "arduino-uno"
|
||||
transport = "serial"
|
||||
path = "/dev/cu.usbmodem12345"
|
||||
baud = 115200
|
||||
```
|
||||
|
||||
## 添加数据手册(RAG)
|
||||
|
||||
将 `.md` 或 `.txt` 文件放入 `docs/datasheets/`(或你的 `datasheet_dir`)。按开发板命名文件:`nucleo-f401re.md`、`arduino-uno.md`。
|
||||
|
||||
### 引脚别名(推荐)
|
||||
|
||||
添加 `## Pin Aliases` 部分,以便代理可以将"红色 LED"映射到引脚 13:
|
||||
|
||||
```markdown
|
||||
# 我的开发板
|
||||
|
||||
## 引脚别名
|
||||
|
||||
| 别名 | 引脚 |
|
||||
|-------------|-----|
|
||||
| red_led | 13 |
|
||||
| builtin_led | 13 |
|
||||
| user_led | 5 |
|
||||
```
|
||||
|
||||
或使用键值格式:
|
||||
|
||||
```markdown
|
||||
## 引脚别名
|
||||
red_led: 13
|
||||
builtin_led: 13
|
||||
```
|
||||
|
||||
### PDF 数据手册
|
||||
|
||||
使用 `rag-pdf` 特性时,ZeroClaw 可以索引 PDF 文件:
|
||||
|
||||
```bash
|
||||
cargo build --features hardware,rag-pdf
|
||||
```
|
||||
|
||||
将 PDF 放入数据手册目录。它们会被提取和分块用于 RAG(检索增强生成)。
|
||||
|
||||
## 添加新的开发板类型
|
||||
|
||||
1. **创建数据手册** — `docs/datasheets/my-board.md`,包含引脚别名和 GPIO(通用输入输出)信息。
|
||||
2. **添加到配置** — `zeroclaw peripheral add my-board /dev/ttyUSB0`
|
||||
3. **实现外设**(可选)—— 对于自定义协议,在 `src/peripherals/` 中实现 `Peripheral` 特征,并在 `create_peripheral_tools` 中注册。
|
||||
|
||||
完整设计请参见 [`docs/hardware/hardware-peripherals-design.md`](../hardware/hardware-peripherals-design.zh-CN.md)。
|
||||
|
||||
## 添加自定义工具
|
||||
|
||||
1. 在 `src/tools/` 中实现 `Tool` 特征。
|
||||
2. 在 `create_peripheral_tools`(硬件工具)或代理工具注册表中注册。
|
||||
3. 在 `src/agent/loop_.rs` 的代理 `tool_descs` 中添加工具描述。
|
||||
|
||||
## CLI 参考
|
||||
|
||||
| 命令 | 描述 |
|
||||
|---------|-------------|
|
||||
| `zeroclaw peripheral list` | 列出已配置的开发板 |
|
||||
| `zeroclaw peripheral add <board> <path>` | 添加开发板(写入配置) |
|
||||
| `zeroclaw peripheral flash` | 烧录 Arduino 固件 |
|
||||
| `zeroclaw peripheral flash-nucleo` | 烧录 Nucleo 固件 |
|
||||
| `zeroclaw hardware discover` | 列出 USB 设备 |
|
||||
| `zeroclaw hardware info` | 通过 probe-rs 获取芯片信息 |
|
||||
|
||||
## 故障排除
|
||||
|
||||
- **找不到串口** — macOS 上使用 `/dev/cu.usbmodem*`;Linux 上使用 `/dev/ttyACM0` 或 `/dev/ttyUSB0`。
|
||||
- **构建硬件支持** — `cargo build --features hardware`
|
||||
- **Nucleo 支持 probe-rs** — `cargo build --features hardware,probe`
|
||||
@@ -0,0 +1,57 @@
|
||||
# 使用 cargo-slicer 加速构建
|
||||
|
||||
[cargo-slicer](https://github.com/nickel-org/cargo-slicer) 是一个 `RUSTC_WRAPPER`,它在 MIR(中级中间表示,Mid-level Intermediate Representation)层对不可达的库函数进行桩实现,跳过最终二进制永远不会调用的代码的 LLVM 代码生成。
|
||||
|
||||
## 基准测试结果
|
||||
|
||||
| 环境 | 模式 | 基准时间 | 使用 cargo-slicer | 耗时节省 |
|
||||
|---|---|---|---|---|
|
||||
| 48 核服务器 | syn 预分析 | 3分52秒 | 3分31秒 | **-9.1%** |
|
||||
| 48 核服务器 | MIR 精确模式 | 3分52秒 | 2分49秒 | **-27.2%** |
|
||||
| 树莓派 4 | syn 预分析 | 25分03秒 | 17分54秒 | **-28.6%** |
|
||||
|
||||
所有测量都是干净的 `cargo +nightly build --release`。MIR 精确模式读取实际的编译器 MIR 来构建更准确的调用图,相比基于 syn 的分析的 799 个单体项,它可以桩实现 1060 个单体项。
|
||||
|
||||
## CI 集成
|
||||
|
||||
工作流 `.github/workflows/ci-build-fast.yml`(尚未实现)旨在与标准版本构建并行运行加速版本构建。它在 Rust 代码变更和工作流变更时触发,不阻塞合并,作为非阻塞检查并行运行。
|
||||
|
||||
CI 使用弹性双路径策略:
|
||||
- **快速路径:** 安装 `cargo-slicer` 和 `rustc-driver` 二进制文件,运行 MIR 精确模式的切片构建。
|
||||
- **回退路径:** 如果 `rustc-driver` 安装失败(例如由于 nightly `rustc` API 变化),则运行普通的 `cargo +nightly build --release`,而不是让检查失败。
|
||||
|
||||
这可以保持检查有用且正常通过,同时在工具链兼容时保留加速能力。
|
||||
|
||||
## 本地使用
|
||||
|
||||
```bash
|
||||
# 一次性安装
|
||||
cargo install cargo-slicer
|
||||
rustup component add rust-src rustc-dev llvm-tools-preview --toolchain nightly
|
||||
cargo +nightly install cargo-slicer --profile release-rustc \
|
||||
--bin cargo-slicer-rustc --bin cargo_slicer_dispatch \
|
||||
--features rustc-driver
|
||||
|
||||
# 使用 syn 预分析构建(在 zeroclaw 根目录执行)
|
||||
cargo-slicer pre-analyze
|
||||
CARGO_SLICER_VIRTUAL=1 CARGO_SLICER_CODEGEN_FILTER=1 \
|
||||
RUSTC_WRAPPER=$(which cargo_slicer_dispatch) \
|
||||
cargo +nightly build --release
|
||||
|
||||
# 使用 MIR 精确模式构建(更多桩实现,更大节省)
|
||||
# 步骤 1:生成 .mir-cache(首次构建使用 MIR_PRECISE)
|
||||
CARGO_SLICER_MIR_PRECISE=1 CARGO_SLICER_WORKSPACE_CRATES=zeroclaw,zeroclaw_robot_kit \
|
||||
CARGO_SLICER_VIRTUAL=1 CARGO_SLICER_CODEGEN_FILTER=1 \
|
||||
RUSTC_WRAPPER=$(which cargo_slicer_dispatch) \
|
||||
cargo +nightly build --release
|
||||
# 步骤 2:后续构建自动使用 .mir-cache
|
||||
```
|
||||
|
||||
## 工作原理
|
||||
|
||||
1. **预分析** 通过 `syn` 扫描工作区源代码,构建跨 crate 调用图(约 2 秒)。
|
||||
2. **跨 crate 广度优先搜索** 从 `main()` 开始,识别哪些公共库函数是实际可达的。
|
||||
3. **MIR 桩实现** 将不可达的函数体替换为 `Unreachable` 终止符 —— 单体收集器找不到被调用者,会修剪整个代码生成子树。
|
||||
4. **MIR 精确模式**(可选)从二进制 crate 的角度读取实际的编译器 MIR,构建真实的调用图,识别更多不可达函数。
|
||||
|
||||
不会修改任何源文件。输出的二进制功能完全相同。
|
||||
@@ -0,0 +1,55 @@
|
||||
# 变更操作手册
|
||||
|
||||
ZeroClaw 常见扩展和修改模式的分步指南。
|
||||
|
||||
每个扩展特征的完整代码示例请参见 [extension-examples.md](./extension-examples.zh-CN.md)。
|
||||
|
||||
## 添加提供商
|
||||
|
||||
- 在 `src/providers/` 中实现 `Provider` 特征。
|
||||
- 在 `src/providers/mod.rs` 工厂中注册。
|
||||
- 为工厂接线和错误路径添加聚焦测试。
|
||||
- 避免提供商特定行为泄漏到共享编排代码中。
|
||||
|
||||
## 添加渠道
|
||||
|
||||
- 在 `src/channels/` 中实现 `Channel` 特征。
|
||||
- 保持 `send`、`listen`、`health_check`、输入语义一致。
|
||||
- 用测试覆盖认证/白名单/健康检查行为。
|
||||
|
||||
## 添加工具
|
||||
|
||||
- 在 `src/tools/` 中实现带有严格参数 schema 的 `Tool` 特征。
|
||||
- 验证和清理所有输入。
|
||||
- 返回结构化的 `ToolResult`;运行时路径中避免 panic。
|
||||
|
||||
## 添加外设
|
||||
|
||||
- 在 `src/peripherals/` 中实现 `Peripheral` 特征。
|
||||
- 外设暴露 `tools()` —— 每个工具委托给硬件(GPIO、传感器等)。
|
||||
- 如有需要,在配置 schema 中注册开发板类型。
|
||||
- 协议和固件说明请参见 `docs/hardware/hardware-peripherals-design.md`。
|
||||
|
||||
## 安全/运行时/网关变更
|
||||
|
||||
- 包含威胁/风险说明和回滚策略。
|
||||
- 为故障模式和边界添加/更新测试或验证证据。
|
||||
- 保持可观测性有用但不包含敏感信息。
|
||||
- 对于 `.github/workflows/**` 变更,在 PR 说明中包含 Actions 白名单影响,源变更时更新 `docs/contributing/actions-source-policy.md`。
|
||||
|
||||
## 文档系统/README/信息架构变更
|
||||
|
||||
- 将文档导航视为产品 UX:保持从 README → 文档中心 → SUMMARY → 分类索引的清晰路径。
|
||||
- 保持顶层导航简洁;避免相邻导航块之间的重复链接。
|
||||
- 运行时表面变更时,更新 `docs/reference/` 中的相关参考。
|
||||
- 导航或关键措辞变更时,保持所有支持的语言(`en`、`zh-CN`、`ja`、`ru`、`fr`、`vi`)的多语言入口点一致。
|
||||
- 共享文档措辞变更时,在同一个 PR 中同步对应的本地化文档(或显式记录延迟更新和后续 PR)。
|
||||
|
||||
## 架构边界规则
|
||||
|
||||
- 优先通过添加特征实现 + 工厂接线来扩展功能;避免为孤立功能进行跨模块重写。
|
||||
- 保持依赖方向向内指向契约:具体集成依赖于特征/配置/工具层,而不是其他具体集成。
|
||||
- 避免跨子系统耦合(例如提供商代码导入渠道内部实现,工具代码直接修改网关策略)。
|
||||
- 保持模块职责单一:编排在 `agent/`、传输在 `channels/`、模型 I/O 在 `providers/`、策略在 `security/`、执行在 `tools/`。
|
||||
- 仅在重复使用至少三次后(三原则)才引入新的共享抽象,且至少有一个真实调用者。
|
||||
- 对于配置/schema 变更,将键视为公共契约:记录默认值、兼容性影响和迁移/回滚路径。
|
||||
@@ -0,0 +1,127 @@
|
||||
# CI 工作流地图
|
||||
|
||||
本文档解释每个 GitHub 工作流的作用、运行时机以及是否应该阻塞合并。
|
||||
|
||||
关于 PR、合并、推送和发布的逐事件交付行为,请参见 [`.github/workflows/master-branch-flow.md`](../../../../.github/workflows/master-branch-flow.md)。
|
||||
|
||||
## 合并阻塞 vs 可选
|
||||
|
||||
合并阻塞检查应保持小巧且具有确定性。可选检查对自动化和维护很有用,但不应阻塞正常开发。
|
||||
|
||||
### 合并阻塞
|
||||
|
||||
- `.github/workflows/ci-run.yml`(`CI`)
|
||||
- 目的:Rust 验证(`cargo fmt --all -- --check`、`cargo clippy --locked --all-targets -- -D clippy::correctness`、变更 Rust 行的严格增量代码检查门控、`test`、发布构建冒烟测试)+ 文档变更时的质量检查(`markdownlint` 仅阻塞变更行上的问题;链接检查仅扫描变更行上添加的链接)
|
||||
- 附加行为:对于影响 Rust 代码的 PR 和推送,`CI Required Gate` 要求 `lint` + `test` + `build` 全部通过(无 PR 专属构建绕过)
|
||||
- 附加行为:变更 `.github/workflows/**` 的 PR 要求至少一名 `WORKFLOW_OWNER_LOGINS` 中的用户批准(仓库变量 fallback:`theonlyhennygod,JordanTheJet,SimianAstronaut7`)
|
||||
- 附加行为:代码检查门控在 `test`/`build` 之前运行;当 PR 上的代码检查/文档门控失败时,CI 会发布带有失败门控名称和本地修复命令的可操作反馈评论
|
||||
- 合并门控:`CI Required Gate`
|
||||
- `.github/workflows/workflow-sanity.yml`(`Workflow Sanity`)
|
||||
- 目的:检查 GitHub 工作流文件(`actionlint`、制表符检查)
|
||||
- 推荐用于变更工作流的 PR
|
||||
- `.github/workflows/pr-intake-checks.yml`(`PR Intake Checks`)
|
||||
- 目的:CI 前的安全 PR 检查(模板完整性、新增行的制表符/尾随空格/冲突标记),带有即时置顶反馈评论
|
||||
|
||||
### 非阻塞但重要
|
||||
|
||||
- `.github/workflows/pub-docker-img.yml`(`Docker`)
|
||||
- 目的:`master` PR 的 Docker 冒烟检查,仅在标签推送(`v*`)时发布镜像
|
||||
- `.github/workflows/sec-audit.yml`(`Security Audit`)
|
||||
- 目的:依赖项安全公告检查(`rustsec/audit-check`,固定 SHA)和政策/许可证检查(`cargo deny`)
|
||||
- `.github/workflows/sec-codeql.yml`(`CodeQL Analysis`)
|
||||
- 目的:计划/手动运行的静态分析,用于发现安全问题
|
||||
- `.github/workflows/sec-vorpal-reviewdog.yml`(`Sec Vorpal Reviewdog`)
|
||||
- 目的:使用 reviewdog 注解对支持的非 Rust 文件(`.py`、`.js`、`.jsx`、`.ts`、`.tsx`)进行手动安全编码反馈扫描
|
||||
- 噪音控制:默认排除常见测试/夹具路径和测试文件模式(`include_tests=false`)
|
||||
- `.github/workflows/pub-release.yml`(`Release`)
|
||||
- 目的:在验证模式下构建发布产物(手动/计划),在标签推送或手动发布模式下发布 GitHub Release
|
||||
- `.github/workflows/pub-homebrew-core.yml`(`Pub Homebrew Core`)
|
||||
- 目的:针对标记发布的手动、机器人拥有的 Homebrew core 公式升级 PR 流程
|
||||
- 护栏:发布标签必须匹配 `Cargo.toml` 版本
|
||||
- `.github/workflows/pr-label-policy-check.yml`(`Label Policy Sanity`)
|
||||
- 目的:验证 `.github/label-policy.json` 中的共享贡献者等级政策,并确保标签工作流使用该政策
|
||||
- `.github/workflows/test-rust-build.yml`(`Rust Reusable Job`)
|
||||
- 目的:可复用的 Rust 设置/缓存 + 命令运行器,供工作流调用者使用
|
||||
|
||||
### 可选仓库自动化
|
||||
|
||||
- `.github/workflows/pr-labeler.yml`(`PR Labeler`)
|
||||
- 目的:范围/路径标签 + 大小/风险标签 + 细粒度模块标签(`<module>: <component>`)
|
||||
- 附加行为:标签描述作为悬停提示自动管理,解释每个自动判断规则
|
||||
- 附加行为:provider/config/onboard/integration 变更中与提供商相关的关键词会提升为 `provider:*` 标签(例如 `provider:kimi`、`provider:deepseek`)
|
||||
- 附加行为:层级去重仅保留最具体的范围标签(例如 `tool:composio` 会抑制 `tool:core` 和 `tool`)
|
||||
- 附加行为:模块命名空间会被压缩 — 单个具体模块保留 `prefix:component` 格式;多个具体模块会折叠为仅 `prefix`
|
||||
- 附加行为:根据已合并 PR 数量为 PR 应用贡献者等级(`trusted` ≥5 个,`experienced` ≥10 个,`principal` ≥20 个,`distinguished` ≥50 个)
|
||||
- 附加行为:最终标签集按优先级排序(`risk:*` 优先,然后是 `size:*`,然后是贡献者等级,最后是模块/路径标签)
|
||||
- 附加行为:受管理的标签颜色按显示顺序排列,当存在多个标签时产生从左到右的平滑渐变效果
|
||||
- 手动治理:支持 `workflow_dispatch` 的 `mode=audit|repair` 参数,用于检查/修复整个仓库的受管理标签元数据偏差
|
||||
- 附加行为:手动编辑 PR 标签时会自动校正风险 + 大小标签(`labeled`/`unlabeled` 事件);当维护者有意覆盖自动化风险选择时应用 `risk: manual`
|
||||
- 高风险启发式路径:`src/security/**`、`src/runtime/**`、`src/gateway/**`、`src/tools/**`、`.github/workflows/**`
|
||||
- 护栏:维护者可以应用 `risk: manual` 冻结自动化风险重计算
|
||||
- `.github/workflows/pr-auto-response.yml`(`PR Auto Responder`)
|
||||
- 目的:首次贡献者引导 + 标签驱动的响应路由(`r:support`、`r:needs-repro` 等)
|
||||
- 附加行为:根据已合并 PR 数量为 Issue 应用贡献者等级(`trusted` ≥5 个,`experienced` ≥10 个,`principal` ≥20 个,`distinguished` ≥50 个),与 PR 等级阈值完全匹配
|
||||
- 附加行为:贡献者等级标签被视为自动化管理的(PR/Issue 上的手动添加/移除会被自动校正)
|
||||
- 护栏:基于标签的关闭路由仅适用于 Issue;PR 永远不会被路由标签自动关闭
|
||||
- `.github/workflows/pr-check-stale.yml`(`Stale`)
|
||||
- 目的:陈旧 Issue/PR 生命周期自动化
|
||||
- `.github/dependabot.yml`(`Dependabot`)
|
||||
- 目的:分组、速率限制的依赖更新 PR(Cargo + GitHub Actions)
|
||||
- `.github/workflows/pr-check-status.yml`(`PR Hygiene`)
|
||||
- 目的:提醒陈旧但活跃的 PR 在队列饥饿前 rebase/重新运行必需检查
|
||||
|
||||
## 触发地图
|
||||
|
||||
- `CI`:推送到 `master`、针对 `master` 的 PR
|
||||
- `Docker`:标签推送(`v*`)用于发布,匹配的 `master` PR 用于冒烟构建,手动触发仅用于冒烟测试
|
||||
- `Release`:标签推送(`v*`)、每周计划(仅验证)、手动触发(验证或发布)
|
||||
- `Pub Homebrew Core`:仅手动触发
|
||||
- `Security Audit`:推送到 `master`、针对 `master` 的 PR、每周计划
|
||||
- `Sec Vorpal Reviewdog`:仅手动触发
|
||||
- `Workflow Sanity`:当 `.github/workflows/**`、`.github/*.yml` 或 `.github/*.yaml` 变更时的 PR/推送
|
||||
- `Dependabot`:所有更新 PR 指向 `master`
|
||||
- `PR Intake Checks`:`pull_request_target` 事件(opened/reopened/synchronize/edited/ready_for_review)
|
||||
- `Label Policy Sanity`:当 `.github/label-policy.json`、`.github/workflows/pr-labeler.yml` 或 `.github/workflows/pr-auto-response.yml` 变更时的 PR/推送
|
||||
- `PR Labeler`:`pull_request_target` 生命周期事件
|
||||
- `PR Auto Responder`:Issue opened/labeled、`pull_request_target` opened/labeled
|
||||
- `Stale PR Check`:每日计划、手动触发
|
||||
- `PR Hygiene`:每 12 小时计划、手动触发
|
||||
|
||||
## 快速分类指南
|
||||
|
||||
1. `CI Required Gate` 失败:从 `.github/workflows/ci-run.yml` 开始排查。
|
||||
2. PR 上的 Docker 失败:检查 `.github/workflows/pub-docker-img.yml` 的 `pr-smoke` 作业。
|
||||
3. 发布失败(标签/手动/计划):检查 `.github/workflows/pub-release.yml` 和 `prepare` 作业输出。
|
||||
4. Homebrew 公式发布失败:检查 `.github/workflows/pub-homebrew-core.yml` 摘要输出和机器人令牌/fork 变量。
|
||||
5. 安全检查失败:检查 `.github/workflows/sec-audit.yml` 和 `deny.toml`。
|
||||
6. 工作流语法/代码检查失败:检查 `.github/workflows/workflow-sanity.yml`。
|
||||
7. PR 提交检查失败:检查 `.github/workflows/pr-intake-checks.yml` 的置顶评论和运行日志。
|
||||
8. 标签政策一致性失败:检查 `.github/workflows/pr-label-policy-check.yml`。
|
||||
9. CI 中的文档检查失败:检查 `.github/workflows/ci-run.yml` 中的 `docs-quality` 作业日志。
|
||||
10. CI 中的严格增量代码检查失败:检查 `lint-strict-delta` 作业日志,并与 `BASE_SHA` 差异范围比较。
|
||||
|
||||
## 维护规则
|
||||
|
||||
- 保持合并阻塞检查的确定性和可复现性(适用时使用 `--locked`)。
|
||||
- 发布节奏和标签规范遵循 [`docs/contributing/release-process.md`](./release-process.zh-CN.md) 的"发布前验证"要求。
|
||||
- 保持 `.github/workflows/ci-run.yml`、`dev/ci.sh` 和 `.githooks/pre-push` 中的 Rust 质量政策一致(`./scripts/ci/rust_quality_gate.sh` + `./scripts/ci/rust_strict_delta_gate.sh`)。
|
||||
- 使用 `./scripts/ci/rust_strict_delta_gate.sh`(或 `./dev/ci.sh lint-delta`)作为变更 Rust 行的增量严格合并门控。
|
||||
- 定期通过 `./scripts/ci/rust_quality_gate.sh --strict` 运行完整严格代码检查审计(例如通过 `./dev/ci.sh lint-strict`),并在聚焦的 PR 中跟踪清理工作。
|
||||
- 通过 `./scripts/ci/docs_quality_gate.sh` 保持文档 Markdown 门控的增量性(阻塞变更行问题,单独报告基线问题)。
|
||||
- 通过 `./scripts/ci/collect_changed_links.py` + lychee 保持文档链接门控的增量性(仅检查变更行上添加的链接)。
|
||||
- 优先使用显式工作流权限(最小权限原则)。
|
||||
- 保持 Actions 源政策限制为已批准的白名单模式(参见 [`docs/contributing/actions-source-policy.md`](./actions-source-policy.zh-CN.md))。
|
||||
- 实际可行时为耗时工作流使用路径过滤器。
|
||||
- 保持文档质量检查低噪音(增量 Markdown + 增量新增链接检查)。
|
||||
- 保持依赖更新量可控(分组 + PR 限制)。
|
||||
- 避免将引导/社区自动化与合并门控逻辑混合。
|
||||
- 测试层级:`cargo test --test component`、`cargo test --test integration`、`cargo test --test system`。
|
||||
- 实时测试(仅手动):`cargo test --test live -- --ignored`。
|
||||
|
||||
## 自动化副作用控制
|
||||
|
||||
- 优先使用可手动覆盖的确定性自动化(`risk: manual`),以应对上下文复杂的情况。
|
||||
- 保持自动响应评论去重,防止分类噪音。
|
||||
- 保持自动关闭行为仅适用于 Issue;维护者拥有 PR 关闭/合并决定权。
|
||||
- 如果自动化出错,首先校正标签,然后带着显式理由继续评审。
|
||||
- 在深度评审前使用 `superseded` / `stale-candidate` 标签清理重复或休眠的 PR。
|
||||
@@ -0,0 +1,98 @@
|
||||
# ZeroClaw 贡献者许可协议(CLA)
|
||||
|
||||
**版本 1.0 — 2026 年 2 月**
|
||||
**ZeroClaw Labs**
|
||||
|
||||
---
|
||||
|
||||
## 目的
|
||||
|
||||
本贡献者许可协议("CLA")阐明了贡献者授予 ZeroClaw Labs 的知识产权权利。本协议同时保护 ZeroClaw 项目的贡献者和用户。
|
||||
|
||||
通过向 ZeroClaw 仓库提交贡献(拉取请求、补丁、包含代码的 Issue,或任何其他形式的代码提交),即表示你同意本 CLA 的条款。
|
||||
|
||||
---
|
||||
|
||||
## 1. 定义
|
||||
|
||||
- **"贡献"** 指任何原创作品,包括对现有作品的任何修改或补充,提交给 ZeroClaw Labs 以包含在 ZeroClaw 项目中。
|
||||
|
||||
- **"你"** 指提交贡献的个人或法律实体。
|
||||
|
||||
- **"ZeroClaw Labs"** 指负责 ZeroClaw 项目(位于 https://github.com/zeroclaw-labs/zeroclaw)的维护者和组织。
|
||||
|
||||
---
|
||||
|
||||
## 2. 版权许可授予
|
||||
|
||||
你授予 ZeroClaw Labs 和 ZeroClaw Labs 分发软件的接收者永久的、全球性的、非排他的、免费的、免许可费的、不可撤销的版权许可,用于:
|
||||
|
||||
- 在 **MIT 许可证和 Apache 许可证 2.0 下** 复制、准备衍生作品、公开展示、公开表演、再许可和分发你的贡献及衍生作品。
|
||||
|
||||
---
|
||||
|
||||
## 3. 专利许可授予
|
||||
|
||||
你授予 ZeroClaw Labs 和 ZeroClaw Labs 分发软件的接收者永久的、全球性的、非排他的、免费的、免许可费的、不可撤销的专利许可,用于制造、委托制造、使用、许诺销售、销售、进口和以其他方式转让你的贡献。
|
||||
|
||||
本专利许可仅适用于你可授权的专利权利要求,这些权利要求仅因你的贡献本身或与 ZeroClaw 项目组合而必然被侵权。
|
||||
|
||||
**这对你的保护:** 如果第三方针对包含你贡献的 ZeroClaw 提起专利诉讼,你对项目的专利许可不会被撤销。
|
||||
|
||||
---
|
||||
|
||||
## 4. 你保留权利
|
||||
|
||||
本 CLA **不会** 将你贡献的所有权转让给 ZeroClaw Labs。你保留对贡献的完整版权所有权。你可以在任何其他项目中以任何许可自由使用你的贡献。
|
||||
|
||||
---
|
||||
|
||||
## 5. 原创作品
|
||||
|
||||
你声明:
|
||||
|
||||
1. 每项贡献都是你的原创作品,或者你有足够的权利根据本 CLA 提交。
|
||||
2. 你的贡献不会故意侵犯任何第三方的专利、版权、商标或其他知识产权。
|
||||
3. 如果你的雇主对你创造的知识产权拥有权利,你已获得提交贡献的许可,或者你的雇主已与 ZeroClaw Labs 签署了企业 CLA。
|
||||
|
||||
---
|
||||
|
||||
## 6. 无商标权利
|
||||
|
||||
本 CLA 不授予你使用 ZeroClaw 名称、商标、服务标记或徽标的任何权利。商标政策请参见 [trademark.md](../maintainers/trademark.zh-CN.md)。
|
||||
|
||||
---
|
||||
|
||||
## 7. 署名
|
||||
|
||||
ZeroClaw Labs 会在仓库提交历史和 NOTICE 文件中保留贡献者的署名。你的贡献会被永久公开记录。
|
||||
|
||||
---
|
||||
|
||||
## 8. 双许可承诺
|
||||
|
||||
所有被接受进入 ZeroClaw 项目的贡献均同时采用以下两种许可:
|
||||
|
||||
- **MIT 许可证** — 宽松的开源使用
|
||||
- **Apache 许可证 2.0** — 专利保护和更强的知识产权保证
|
||||
|
||||
这种双许可模式确保为整个贡献者社区提供最大的兼容性和保护。
|
||||
|
||||
---
|
||||
|
||||
## 9. 如何同意
|
||||
|
||||
通过向 ZeroClaw 仓库打开拉取请求或提交补丁,即表示你同意本 CLA。个人贡献者无需单独签名。
|
||||
|
||||
对于 **企业贡献者**(代表公司或组织提交),请打开标题为"企业 CLA — [公司名称]"的 Issue,维护者会跟进处理。
|
||||
|
||||
---
|
||||
|
||||
## 10. 问题
|
||||
|
||||
如果你对本 CLA 有疑问,请在以下地址打开 Issue:
|
||||
https://github.com/zeroclaw-labs/zeroclaw/issues
|
||||
|
||||
---
|
||||
|
||||
*本 CLA 基于 Apache 个人贡献者许可协议 v2.0,针对 ZeroClaw 双许可模式进行了调整。*
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user