OtterWiki VSCode Extension

Send code snippets and files directly to your OtterWiki instance from VSCode.

Features

• Send Code Snippets: Select code and send it to your wiki with one command
• Send Full Files: Send entire file contents to the wiki
• Quick Snap: Rapidly capture snippets without dialogs
• Auto-Submit Dialog: Smart 4-second timer that pauses when you interact
• Secure Credentials: Passwords stored in VSCode's encrypted secret storage
• Keyboard Shortcuts: Configurable shortcuts for quick access
• Context Menu Integration: Right-click to send selections or files

Installation

1. Install the extension from the VSCode Marketplace
2. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
3. Run OtterWiki: Configure
4. Enter your wiki details:
   • Wiki URL (e.g., https://wiki.example.com)
   • Username
   • Password (stored securely)
   • Root page path (e.g., code)
   • Default page path (e.g., snippets)

Usage

Send Selection

1. Select code in the editor
2. Use one of these methods:
   • Press Ctrl+Shift+O (Mac: Cmd+Shift+O)
   • Right-click → "Send to OtterWiki"
   • Command Palette → "OtterWiki: Send Selection"
3. Edit the title and page path (or wait 4 seconds for auto-submit)
4. Content is sent to your wiki!

Quick Snap

For rapid snippet collection without dialogs:

1. Select code
2. Press Ctrl+Shift+S (Mac: Cmd+Shift+S)
3. Content is immediately sent to the default page

Send Full File

1. Open a file
2. Command Palette → "OtterWiki: Send File"
3. Edit title and path, or wait for auto-submit

Configuration

Access settings via File > Preferences > Settings and search for "OtterWiki":

• otterwiki.wikiUrl: Your OtterWiki instance URL
• otterwiki.username: Your username
• otterwiki.rootPage: Root page for snippets (default: code)
• otterwiki.defaultPage: Default page path (default: snippets)
• otterwiki.autoSubmitDelay: Auto-submit delay in seconds (default: 4, set to 0 to disable)
• otterwiki.includeLineNumbers: Include line numbers in snippets (default: true)

Keyboard Shortcuts

• Ctrl+Shift+O / Cmd+Shift+O: Send Selection
• Ctrl+Shift+S / Cmd+Shift+S: Quick Snap

You can customize these in VSCode's Keyboard Shortcuts settings.

Commands

• OtterWiki: Send Selection - Send selected code to wiki
• OtterWiki: Send File - Send entire file to wiki
• OtterWiki: Quick Snap - Quickly send selection without dialog
• OtterWiki: Configure - Configure extension settings
• OtterWiki: Test Connection - Test connection to your wiki

Security

• Passwords are stored using VSCode's SecretStorage API (encrypted)
• HTTPS is strongly recommended for wiki URLs
• Credentials are never logged or exposed

Requirements

• VSCode 1.85.0 or higher
• An OtterWiki instance (self-hosted or cloud)
• Valid OtterWiki credentials

Known Issues

• None currently reported

Release Notes

0.1.0

Initial release:

• Send code selections to OtterWiki
• Send full files to OtterWiki
• Quick Snap for rapid collection
• Auto-submit dialog with timer
• Secure credential storage
• Keyboard shortcuts and context menu integration

Contributing

Found a bug or have a feature request? Please open an issue on our GitHub repository.

License

MIT License - see LICENSE file for details

About OtterWiki

OtterWiki is a minimalistic wiki powered by Python, Markdown, and Git. Learn more at otterwiki.com.