cli-anything-siyuan

cli-anything-siyuan은(는) 무엇을 하나요?

SiYuan(思源笔记)을 위한 CLI 도구입니다. SiYuan은 로컬 우선 지식 관리 및 노트 작성 애플리케이션입니다.

이 CLI는 실행 중인 SiYuan 커널의 HTTP API(http://127.0.0.1:6806)에 연결하여 노트북, 문서, 블록, 검색 및 내보내기 기능에 구조화된 접근을 제공합니다.

필수 조건

• SiYuan이 실행 중이어야 함 (설정 → 정보에서 API 토큰 확인 가능)
• Python 3.10+
• 설치: pip install cli-anything-siyuan 또는 agent-harness/에서 pip install -e .

명령 그룹

notebook — 노트북 관리

하위 명령	설명
list	모든 노트북 나열
create <name>	새 노트북 생성
rename <id> <name>	노트북 이름 변경
remove <id>	노트북 삭제
open <id>	노트북 열기

doc — 문서 관리

하위 명령	설명
create <notebook> <path> [--md "content"]	문서 생성
list <notebook> [path]	문서 나열
tree <notebook> [--path / --depth]	문서 트리 표시
get <id>	ID로 문서 경로 가져오기
rename <id> <title>	문서 이름 변경
remove <id>	문서 삭제

block — 블록 작업

하위 명령	설명
insert <data> [--previous / --parent]	블록 삽입
update <id> <data>	블록 업데이트
delete <id>	블록 삭제
get <id>	블록 kramdown 소스 가져오기
children <id>	하위 블록 가져오기

기타 명령

명령	설명
sql <stmt>	블록 데이터베이스에 SQL 실행
search <query>	블록 전체 텍스트 검색
export md <doc-id>	문서를 Markdown으로 내보내기
tag list	모든 태그 나열
version	SiYuan 커널 버전 표시
status	연결 및 세션 상태 표시
repl	대화형 REPL 시작

에이전트 가이드

• 기계가 읽기 쉬운 출력을 위해 항상 --json 사용
• 강력한 검색: SQL 수준 접근을 위해 sql "SELECT * FROM blocks WHERE content LIKE '%keyword%'" 사용
• 문서 ID는 20210817205410-2kvfpfn와 같은 타임스탬프 기반 형식
• API 토큰은 SiYuan 설정 → 정보에서 확인 가능
• 기본 연결 주소: http://127.0.0.1:6806

예제

# 노트북 목록 (JSON)
cli-anything-siyuan --json notebook list

# Markdown으로 문서 생성 (--md 플래그, 셸 이스케이프 주의)
cli-anything-siyuan doc create nb1 /projects/new --md "## Title\n\nContent"

# 문서 생성 — 표준 입력으로 Markdown 전달 (셸 이스케이프 문제 회피)
# PowerShell here-string (리터럴, 이스케이프 불필요):
@'
## Title
`backticks`와 (괄호) 그리고 "따옴표"가 포함된 콘텐츠
'@ | cli-anything-siyuan doc create nb1 /projects/new --md -

# Bash heredoc:
# cat <<'EOF' | cli-anything-siyuan doc create nb1 /projects/new --md -
# ## Title
# `backticks`와 (괄호)가 포함된 콘텐츠
# EOF

# SQL 검색
cli-anything-siyuan sql "SELECT id, content FROM blocks WHERE content LIKE '%meeting%' LIMIT 5"

# 내보내기
cli-anything-siyuan export md doc123

# REPL 진입
cli-anything-siyuan

오류 처리

• 연결 오류: SiYuan이 실행 중이고 API 토큰이 올바른지 확인
• API 오류: {"code": N, "msg": "..."} 형식으로 반환 — message 필드 확인
• 인증 오류: ~/.siyuan-cli.json 또는 SIYUAN_TOKEN 환경 변수의 토큰 확인