Outline
Search, read, and manage Outline wiki documents. Use when: (1) searching wiki for documentation, (2) reading wiki pages or articles, (3) listing wiki collections or documents, (4) creating or updating wiki content, (5) exporting documents as markdown. Works with any Outline wiki instance (self-hosted or cloud).From its SKILL.md
npx -y skills add sanjay3290/ai-skills --skill outlineAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
3 things to look at
- reads credentialsReads from 2 credential sources: `OUTLINE_API_KEY` and 1 more.
- runs commandsInstructs the agent to run 8 commands, including `pip install -r requirements.txt` and 7 more.
- fetches URLsInstructs the agent to fetch 1 URL, including OUTLINE_API_URL.
What its file declares
Copied from the file, not written here
The file declares its own license as Apache-2.0. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
4.4 KB, 993 tokens by cl100k_base, as published. Nobody here has run it
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/api
Usage
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> --json
List collections
python3 scripts/outline.py list-collections
python3 scripts/outline.py list-collections --limit 50
List 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> --draft
Update 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> --publish
Export document as markdown
python3 scripts/outline.py export <document-id>
python3 scripts/outline.py export <document-id> --output doc.md
Test authentication
python3 scripts/outline.py auth-info
JSON Output
Add --json flag to any command for machine-readable output:
python3 scripts/outline.py search "query" --json
python3 scripts/outline.py read <id> --json
Operations 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 |
|---|---|---|---|
| OUTLINE_API_KEY | Yes | - | Your Outline API token |
| OUTLINE_API_URL | No | https://app.getoutline.com/api | API URL |
| OUTLINE_TIMEOUT | No | 30 | Request timeout (seconds) |
| OUTLINE_VERIFY_SSL | 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 OUTLINE_API_KEY environment variable |
| Authentication failed | Verify API key is valid and not expired |
| Connection timeout | Check OUTLINE_API_URL 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
What ships with it: 5 files
29.4 KB alongside SKILL.md, 1 of them executable
scripts/
- outline.pyruns22.4 KB
- .env.example599 B
- .gitignore322 B
- README.md6.1 KB
- requirements.txt67 B
Gives 0 of the 12 instructions most docs writing skills give in 993 tokens
Counted across 1,951 of the 3,904 authors here whose files we hold, read 2026-09-06
- Use third-person for skill descriptionsin 54 of 1951, across 35 files
- Start descriptions with Use whenin 43 of 1951, across 29 files
- Run baseline scenarios before writing any skillin 40 of 1951, across 26 files
- Use active voicein 40 of 1951, across 36 files
- Map file responsibilities before defining tasksin 36 of 1951, across 29 files
- Use checkbox syntax for tracking stepsin 35 of 1951, across 27 files
- Ask one question at a timein 35 of 1951
- Offer execution options after saving the planin 33 of 1951, across 24 files
- Include complete code in every stepin 33 of 1951, across 27 files
- Design units with clear boundaries and interfacesin 31 of 1951, across 23 files
- Announce the skill usage at the startin 30 of 1951
- Verify agent compliance after adding the skillin 29 of 1951, across 17 files
Said here and by no other author read
- Run auth-info to verify connection
- Use read to retrieve document content
- Use list-collections to view available collections
- Use export to save documents as markdown
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.