agnes-the-ai-analyst/docs/QUICKSTART.md
ZdenekSrotyr 2cbffce85f
ci: propagate infra-v* tags to template repo + auto-merge rules (#17)
* dryrun: verify per-branch GHCR tag

* ci: propagate infra-v* tag bumps to template repo

On push of any infra-v* tag, opens a PR in keboola/agnes-infra-template
that bumps the module ref in terraform/main.tf. Auto-merge rules in the
template (Renovate + CI validate + GitHub native auto-merge) land it
without manual work on patch/minor bumps.

Requires repo secret TEMPLATE_REPO_TOKEN (fine-grained PAT with
Contents:write + Pull requests:write on keboola/agnes-infra-template).

Fail-soft: if secret is missing the job is skipped and Renovate on the
template repo picks up the new tag on its next cycle as a fallback.

* docs(onboarding): 'Keeping the template up-to-date' maintainer section

Documents the two mechanisms (upstream release hook + Renovate), the
required repo settings (allow_auto_merge, validate.yml gate), the TOKEN
secret setup, and the one-time setup checklist. Notes the difference
between template repo (auto-merge on) and customer infra repos
(human approval).
2026-04-21 21:32:58 +02:00

1.5 KiB

Quick Start Guide

Prerequisites

  • Python 3.10+
  • SSH access to a Linux server (for production deployment)
  • Data source credentials (Keboola token, BigQuery service account, etc.)

Local Development Setup

  1. Clone the repository:

    git clone <repo-url>
    cd ai-data-analyst
    
  2. Run the initialization script:

    bash scripts/init.sh
    
  3. Configure your instance:

    cp config/instance.yaml.example config/instance.yaml
    # Edit config/instance.yaml with your settings
    
  4. Set up environment variables:

    # Edit .env with your data source credentials
    
  5. Register your tables:

    # Tables are registered via the admin API or web UI — no config file needed
    
  6. Sync data:

    source .venv/bin/activate
    python -m src.data_sync
    

Server Deployment

See DEPLOYMENT.md for full server setup instructions.

Using with Claude Code

Open the project in Claude Code. The CLAUDE.md file will guide the AI assistant through setup and analysis workflows.

Analyst Setup

  1. Visit your instance URL (e.g., https://data.yourcompany.com)
  2. Sign in with your company email
  3. Register your SSH key
  4. Follow the setup instructions to sync data locally

Analysis Workflow

  1. Sync latest data: bash server/scripts/sync_data.sh
  2. Open Claude Code in your project directory
  3. Ask Claude to analyze your data using DuckDB