ss-tools/specs/017-llm-analysis-plugin/quickstart.md

Quickstart: LLM Analysis Plugin

Prerequisites

1. An API Key from OpenAI, OpenRouter, or Kilo.
2. (Optional) Playwright browsers installed for high-fidelity screenshots:

   playwright install chromium
   

Configuration

1. Navigate to Settings > LLM Providers.
2. Click "Add Provider".
3. Select type (e.g., OpenRouter).
4. Enter your API Key and Base URL (e.g., https://openrouter.ai/api/v1).
5. Set a default model (e.g., anthropic/claude-3.5-sonnet).
6. Click Save.

Usage

Dashboard Validation

1. Go to Environments.
2. Select a dashboard from the list.
3. Click "Validate".
4. Wait for the task to complete and view the report in the Task History panel.

Dataset Documentation

1. Go to Tools > Documentation.
2. Select a dataset.
3. Click "Generate Docs".
4. Review the generated descriptions and changes will be applied to the metadata.

Git Commit Generation

1. Make changes to files in the repository.
2. Go to the Git plugin tab.
3. Stage your files.
4. Click the "✨" (Magic) button next to the commit message box.
5. Review and edit the suggested message before committing.