Skip to content

setup-guide.md

Latest commit

 

History

History
103 lines (71 loc) · 2.34 KB

setup-guide.md

File metadata and controls

103 lines (71 loc) · 2.34 KB

AI Analyst Setup Guide

Prerequisites

  • Python 3.10+ with pip
  • Claude Code CLI installed (docs)
  • Your data in CSV, DuckDB, or a supported warehouse (Postgres, BigQuery, Snowflake)

Quick Start

1. Clone and install

git clone <repo-url> ai-analyst
cd ai-analyst
pip install -e ".[dev]"

2. Launch Claude Code

claude

3. Connect your data

On first launch, Claude will detect a fresh install and start the interactive setup interview. It walks you through:

  1. Your role and team -- so Claude adapts its communication style
  2. Your data source -- CSV directory, DuckDB file, or warehouse connection
  3. Your business context -- what your company does, key metrics, team structure
  4. Your preferences -- output formats, chart style, export channels

You can also run the setup manually at any time:

/setup

4. Start analyzing

Once setup is complete, just ask a question:

What's our conversion rate by device type?

Or run the full analysis pipeline:

/run-pipeline

Connecting Data Sources

CSV files

Place your CSV files in a directory (e.g., data/my_dataset/) and tell Claude during setup. Each .csv file becomes a queryable table.

Local DuckDB

Point Claude to a .duckdb file during setup. DuckDB provides fast SQL queries over local data.

External Warehouses

For Postgres, BigQuery, or Snowflake connections, you'll need to configure MCP (Model Context Protocol) servers. Run /connect-data and follow the prompts.

Resetting

To start fresh:

/setup reset
  • Tier 1 reset -- clears your profile and preferences
  • Tier 2 reset -- clears everything including dataset connections

Running Tests

python -m pytest tests/ -v

Project Structure

ai-analyst/
  .claude/skills/     -- Claude skill definitions (auto-applied behaviors)
  .knowledge/         -- Knowledge system (populated by setup and usage)
  agents/             -- Agent prompt templates (multi-step workflows)
  helpers/            -- Python utility modules
  tests/              -- Pytest test suite
  data/               -- Your datasets (gitignored)
  docs/               -- Documentation
  outputs/            -- Analysis outputs (charts, decks, narratives)
  working/            -- Intermediate work files