Quick Start
Set up GridOS and build your first AI-powered workbook in under five minutes.
Add API Keys
Connect Gemini, Claude, Groq, or OpenRouter to unlock AI features.
Core Concepts
Understand workbooks, sheets, agents, and the preview/apply flow.
API Reference
Explore the full REST API — chat, apply, chain, and manage workbooks.
How GridOS works
GridOS combines a reliable Python grid engine with AI agents that read your sheet, plan their writes, and propose changes for you to approve or dismiss.Start the server
Clone the repo, install dependencies, and run
uvicorn main:app --reload. Open http://127.0.0.1:8000.Add an API key
Click the gear icon in the top menu bar. Paste a key for any one provider — Gemini, Claude, Groq, or OpenRouter. You only need one to get started.
Describe your workbook
On the landing page, type what you want to build — “Monthly budget with 6 months of actuals” — and press Enter. GridOS routes your prompt, builds a plan, and populates the sheet.
Key features
Multi-provider AI
Switch between Gemini, Claude, Groq, and OpenRouter models per request from the chat composer.
Formula synthesis
Natural-language prompts become executable grid formulas with collision-safe cell placement.
Chain mode
Let the agent auto-apply a multi-step plan end-to-end, observing formula results between steps.
Templates
Start from built-in models: DCF, Monthly Budget, Break-Even, Loan Amortization, Income Statement.
Charts
Ask for a chart in plain English — bar, line, or pie — anchored wherever you want on the sheet.
Custom macros
Define reusable named formulas that the AI can propose and you can approve with one click.