outline

Files (6)

• .env.example
• .gitignore
• README.md
• SKILL.md
• requirements.txt
• outline.py · scripts/

SKILL.md (first lines)

# 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

1. Get your API key from your Outline wiki:
   - Go to **Settings > API Tokens**
   - Create a new token with appropriate permissions

2. Configure the environment:
   ```bash
   cp .env.example .env
   # Edit .env with your API key
   ```

3. Set the environment variables:
   ```bash
   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
```bash
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
```bash
python3 scripts/outline.py read <document-id>
python3 scripts/outline.py read <document-id> --json
```

### List collections
```bash
python3 scripts/outline.py list-collections
python3 scripts/outline.py list-collections --limit 50
```

### List documents in a collection
```bash
python3 scripts/outline.py list-documents --collection-id <id>
```

### Get collection details
```bash
python3 scripts/outline.py get-collection <collection-id>
```

### Create a document
```bash
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
```bash
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
```bash
python3 scripts/outline.py export <document-id>
python3 scripts/outline.py export <document-id> --output doc.md
```

### Test authentication
```bash
python3 scripts/outline.py auth-info
```

## JSON Output

Add `--json` flag to any command for machine-readable output:
```bash
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 |
|-------|----------|

From sanjay3290/ai-skills, Apache-2.0.

More from sanjay3290/ai-skills