OpenClaw Documentation Skill
繁體中文 | English
이 저장소는 공식 OpenClaw 문서를 자동으로 업데이트되는 Agent Skill로 변환합니다.
GitHub Actions가 상위(upstream)의 docs/ 디렉토리를 매일 미러링하고, 정확한 소스 리비전을 기록하며, 점진적 공개(progressive disclosure)를 위해 간결한 토픽 카탈로그를 생성합니다.
이 스킬이 도움이 되는 영역
- 설치, 업데이트, 마이그레이션 및 배포
- 게이트웨이 구성, 운영, 네트워킹 및 보안
- Telegram, WhatsApp, Discord, Slack, LINE, Signal과 같은 메시징 채널
- 모델 제공업체(Model providers), 인증, 장애 조치(failover) 및 로컬 모델
- Agent, 세션, 메모리, 도구(tools), 플러그인, 노드 및 자동화
- CLI 오류 및 증상 기반 문제 해결
점진적 공개 (Progressive disclosure)
전체 문서 세트는 의도적으로 모델 컨텍스트에 주입되지 않습니다.
SKILL.md
→ compact references/SKILL_INDEX.md
→ one references/_catalog/<topic>.md
...
정확한 오류, CLI 명령어 및 구성 키는 카탈로그를 우회하여 references/ 전반에서 직접 검색됩니다. 생성된 카탈로그는 각 상위 페이지의 title, summary, 그리고 read_when 메타데이터를 사용합니다.
설치 (Install)
SkillHub(CLI)를 통해 설치
SkillHub를 사용하여 직접 설치할 수 있습니다:
npx skillhub install tbdavid2019/openclaw-docs-skill/openclaw-docs --platform codex
...
Git Clone을 통해 설치
신뢰할 수 있게 업데이트하려면 Git checkout으로 설치합니다. 목적지를 에이전트가 사용하는 스킬 디렉토리로 교체하십시오:
git clone https://github.com/tbdavid2019/openclaw-docs-skill.git \
~/.gemini/antigravity/skills/openclaw-docs
Codex의 경우, 일반적인 목적지는 다음과 같습니다:
git clone https://github.com/tbdavid2019/openclaw-docs-skill.git \
~/.codex/skills/openclaw-docs
직접 클론한 후에는 설치 프로그램을 한 번 실행하여 fast-forward-only 의미론으로 가져오고, 스냅샷을 검증하며, 커밋을 출력하십시오:
bash <skill-directory>/scripts/install-skill.sh
설치 프로그램은 다른 체크아웃에서 실행될 때 새 목적지로 클론할 수 있습니다:
bash openclaw-docs-skill/scripts/install-skill.sh <skill-directory>
설치된 체크아웃을 나중에 업데이트하려면:
bash <skill-directory>/scripts/install-skill.sh
공개 저장소는 매일 동기화됩니다. 설치된 체크아웃은 질문할 때마다 네트워크 업데이트를 수행하지 않으며, 설치 프로그램이나 git pull이 명시적으로 실행될 때만 변경됩니다.
호스트 플랫폼이 스킬을 관리 디렉터리에 복사하는 경우, 해당 플랫폼의 업데이트 메커니즘을 사용하십시오. 복사된 스냅샷은 여전히 사용할 수 있지만, Git 체크아웃으로 스스로 업데이트할 수는 없습니다.
AI 에이전트 설치 계약
사용자가 이 저장소 URL을 제공하고 스킬 설치를 요청할 때:
- 호스트를 감지하고 쓰기 전에 실제 스킬 디렉터리를 확인합니다.
CODEX_HOME이 설정된 경우 Codex의 경우 $CODEX_HOME/skills/openclaw-docs를 선호하며, 그렇지 않으면 ~/.codex/skills/openclaw-docs를 사용하십시오. 일반적인 Antigravity 목적지는 ~/.gemini/antigravity/skills/openclaw-docs입니다. 다른 호스트의 경우 추측하기보다는 구성 요소를 검사하거나 사용자에게 문의해야 합니다.
- 목적지를 확인합니다. 존재하지 않으면, 최종 디렉터리 이름으로
openclaw-docs를 사용하여 이 저장소를 클론합니다. 이미 이 저장소의 Git 체크아웃인 경우 그대로 유지합니다. 비(非)Git 디렉터리를 덮어쓰지 마십시오. 충돌을 설명하고 사용자에게 어떻게 진행할지 문의하십시오.
- 검증 전에 반드시 설치 프로그램을 실행해야 합니다:
bash <skill-directory>/scripts/install-skill.sh. 기존 체크아웃의 경우, 설치 프로그램은 반드시 git pull --ff-only를 성공적으로 완료해야 합니다. 풀(pull) 또는 유효성 검사 실패는 설치 또는 업데이트가 실패했음을 의미합니다. 새 클론 후에도 동일한 검증이 적용되도록 설치 프로그램을 실행하십시오.
- 설치된
SKILL.md 파일을 읽습니다. 설치의 일부로 scripts/sync-docs.sh나 scripts/generate_index.py를 실행하지 마십시오.
이것들은 유지 관리자 도구입니다. 설치는 반드시 저장소의 커밋된 스냅샷을 사용해야 합니다.
5. 대상 디렉터리에 SKILL.md, agents/openai.yaml, references/SOURCE.json, references/SKILL_INDEX.md, 그리고 references/_catalog/가 포함되어 있는지 확인합니다.
6. references/SOURCE.json을 읽은 다음, 절대 설치 디렉터리, 스킬(Skill) 저장소 커밋, 그리고 업스트림 문서화 커밋을 보고합니다. 설치 프로그램이 이 세 가지를 모두 출력합니다.
7. 호스트가 시작 시에만 스킬을 발견하는 경우, 사용자에게 재로드하거나 호스트를 다시 시작하도록 안내합니다. 그런 다음 다음 명령어로 검색 기능을 테스트합니다: Use $openclaw-docs to explain how to check OpenClaw Gateway health.
8. 풀(pull), 검증(validation), 커밋 보고, 그리고 필요한 모든 재로드 지침이 완료될 때까지 설치 성공을 선언하지 마십시오. 자격 증명이나 관련 없는 구성 값은 절대 출력하지 마십시오.
복사하여 붙여넣기 설치 요청:
Install the following repository as the OpenClaw documentation skill:
...
저장소 구조 (Repository structure)
openclaw-docs-skill/
├── SKILL.md
├── agents/openai.yaml
...
references/SOURCE.json은 현재 스냅샷으로 표현되는 업스트림 저장소(upstream repository), 커밋, 커밋 날짜, 그리고 문서 개수를 식별합니다.
유지 관리자 워크플로우 (Maintainer workflow)
공식 저장소에서 새로 고침:
스킬 및 생성된 아티팩트 검증:
python3 -m unittest -v tests/test_repo.py
python3 scripts/generate_index.py --check
동기화(sync)는 references/가 대체되기 전에 스테이징되고 검증됩니다. 가져오기 실패, 낮은 문서 개수, 누락된 필수 페이지 또는 유효하지 않은 생성 인덱스는 현재의 참조(references)를 그대로 유지합니다.
동기화된 문서, references/SOURCE.json, references/SKILL_INDEX.md, 또는 references/_catalog/는 수동으로 편집하지 마십시오.
문서 출처 (Documentation source)
콘텐츠는 공식 OpenClaw 저장소와 OpenClaw 문서화에서 동기화됩니다.
라이선스 (License)
AGPL-3.0. OpenClaw 문서는 상위 라이선스 약관의 적용을 받습니다.
감사의 글
win4r/OpenClaw-Skill에서 영감을 받았습니다.