Files
waggle-os/docs/GETTING-STARTED.md
Oleg Maslov 0c3e2ead3b
Some checks failed
Installer Smoke / installer-smoke (push) Has been cancelled
moving
2026-09-02 10:10:29 +02:00

93 lines
3.2 KiB
Markdown

# Getting Started with Waggle
Welcome to Waggle — your AI operating system with persistent memory.
## Quick Start (5 minutes)
### 1. Install Waggle
Download the desktop app for your platform:
- **Windows**: Download the `.msi` installer
- **macOS**: Download the `.dmg` installer
Run the installer and launch Waggle.
### 2. Set Up Your API Key
- Open Waggle — the onboarding wizard appears on first launch
- Get an Anthropic API key at https://console.anthropic.com/settings/keys
- Paste it in the wizard and click "Validate & save"
### 3. Create Your First Workspace
- Choose a template (Sales, Research, Legal, etc.) or start blank
- Pick a persona (Researcher, Writer, Analyst, etc.)
- Name your workspace
### 4. Start Working
Type anything in the chat. Your agent can:
- Search the web (works immediately, no setup)
- Create Word documents with professional formatting
- Read and write files in your workspace
- Run shell commands (sandboxed)
- Run 15 workflow commands (type `/` to see them)
- Remember everything across sessions
### 5. The Memory Magic
After your first conversation, try closing and reopening the workspace.
Type: "What do you remember about our discussion?"
Your agent remembers everything — decisions, context, preferences.
## Key Features
### Workflow Commands
Type `/` in chat to see all commands:
- `/research [topic]` — deep web research with synthesis
- `/draft [type]` — create documents with professional formatting
- `/plan [goal]` — structured planning with steps
- `/catchup` — get a summary of where things stand
- `/decide [question]` — structured decision analysis
- `/review [topic]` — review work or documents
- `/spawn [task]` — delegate work to a sub-agent
- `/skills` — browse and install new capabilities
- `/status` — workspace health and statistics
- `/memory` — explore what your agent remembers
- `/focus` — set the current work focus
- `/now` — quick workspace snapshot
- `/help` — see all available commands
### Personas
Press `Ctrl+Shift+P` to switch personas. Each changes how your agent thinks:
- **Researcher**: deep investigation with citations
- **Writer**: document creation with formatting
- **Analyst**: data analysis with structured output
- **Planner**: project planning and task breakdown
- ...and more
### Keyboard Shortcuts
- `Ctrl+K` — search everything
- `Ctrl+Shift+1` through `Ctrl+Shift+7` — switch views
- `Ctrl+Shift+P` — switch persona
- `/` — workflow commands
### Memory View
Press `Ctrl+Shift+5` to browse everything your agent remembers.
Search, filter by type, and explore the knowledge graph.
### Workspace Home
When you open a workspace, you see the "Workspace Now" overview:
- A summary of where things stand
- Recent decisions and open items
- Recent conversation threads
- Key memories
Once you start chatting, click the **Workspace Overview** toggle above the messages to return to this view at any time.
## Product Scopes
Waggle works across four product scopes:
- **Solo** — personal productivity with persistent memory
- **Teams** — shared workspaces with collaboration
- **Business** — team management, analytics, and governance
- **Enterprise** — full KVARK integration, compliance, and audit trails
## Need Help?
Type `/help` in chat for a full command reference.