사용 방법
- 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
- 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
- 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
npx skills add https://github.com/sanjay3290/ai-skills --skill outline시작 전 확인
- 설치에는 모델 구독, API 한도, 파일 접근 권한이 포함되지 않습니다.
- 별점 수와 설치 수는 활동 지표이며 독립적인 품질·보안 검증이 아닙니다.
원본 저장소의 제목, 예시, 코드, 표, 링크, 이미지를 유지해 표시합니다.
Outline Wiki Skill
Search, read, create, and manage documents in any Outline wiki instance. Works with all AI clients supporting the Agent Skills Standard.
Requirements
- Python 3.8+
- Dependencies:
pip install -r requirements.txt
Setup
- Get your API key from your Outline wiki:
- Go to Settings > API Tokens
- Create a new token with appropriate permissions
- Configure the environment:
cp .env.example .env
# Edit .env with your API key- Set the environment variables:
export OUTLINE_API_KEY=your-api-key-here
# Optional: for self-hosted instances
export OUTLINE_API_URL=https://your-wiki.example.com/apiUsage
Search documents
python3 scripts/outline.py search "deployment guide"
python3 scripts/outline.py search "API documentation" --limit 10
python3 scripts/outline.py search "onboarding" --collection-id <id>Read a document
python3 scripts/outline.py read <document-id>
python3 scripts/outline.py read <document-id> --jsonList collections
python3 scripts/outline.py list-collections
python3 scripts/outline.py list-collections --limit 50List documents in a collection
python3 scripts/outline.py list-documents --collection-id <id>Get collection details
python3 scripts/outline.py get-collection <collection-id>Create a document
python3 scripts/outline.py create --title "New Guide" --collection-id <id>
python3 scripts/outline.py create --title "Guide" --collection-id <id> --text "# Content here"
python3 scripts/outline.py create --title "Draft" --collection-id <id> --draftUpdate a document
python3 scripts/outline.py update <document-id> --title "Updated Title"
python3 scripts/outline.py update <document-id> --text "New content"
python3 scripts/outline.py update <document-id> --publishExport document as markdown
python3 scripts/outline.py export <document-id>
python3 scripts/outline.py export <document-id> --output doc.mdTest authentication
python3 scripts/outline.py auth-infoJSON Output
Add --json flag to any command for machine-readable output:
python3 scripts/outline.py search "query" --json
python3 scripts/outline.py read <id> --jsonOperations Reference
| Command | Description | Required Args |
|---|---|---|
| search | Full-text search | query |
| read | Get document content | document_id |
| list-collections | List all collections | - |
| list-documents | List docs (optionally in collection) | - |
| get-collection | Get collection details | collection_id |
| create | Create new document | --title, --collection-id |
| update | Update existing document | document_id |
| export | Export as markdown | document_id |
| auth-info | Test API connection | - |
Environment Variables
| Variable | Required | Default | Description |
|---|---|---|---|
| OUTLINEAPIKEY | Yes | - | Your Outline API token |
| OUTLINEAPIURL | No | https://app.getoutline.com/api | API URL |
| OUTLINE_TIMEOUT | No | 30 | Request timeout (seconds) |
| OUTLINEVERIFYSSL | No | true | Set to false to skip SSL verification (for self-hosted instances with self-signed certs) |
Troubleshooting
| Error | Solution |
|---|---|
| API key not configured | Set OUTLINEAPIKEY environment variable |
| Authentication failed | Verify API key is valid and not expired |
| Connection timeout | Check OUTLINEAPIURL and network connectivity |
| SSL certificate error | Set OUTLINE_VERIFY_SSL=false for self-signed certs |
| Document not found | Verify document ID is correct |
| Permission denied | Check API token has required permissions |
Exit Codes
- 0: Success
- 1: Error (auth failed, not found, invalid request)
Workflow
- Run
auth-infoto verify connection - Run
list-collectionsto see available collections - Run
searchorlist-documentsto find content - Run
readto get full document content - Use
create/updateto modify wiki content