instagres 0.1.0-wip

WIP:: Rust SDK for instant PostgreSQL instance provisioning via Neon
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

**instagres** is a Rust-based project for instant PostgreSQL instance provisioning (name suggests "instant Postgres").

## Build and Development Commands

### Building
```bash
cargo build          # Debug build
cargo build --release # Release build
```

### Running
```bash
cargo run           # Run debug build
cargo run --release # Run release build
```

### Testing
```bash
cargo test                    # Run all tests
cargo test <test_name>        # Run specific test
cargo test -- --nocapture     # Run tests with stdout output
cargo test -- --test-threads=1 # Run tests sequentially
```

### Code Quality
```bash
cargo clippy                  # Run linter
cargo clippy -- -D warnings   # Run linter, treating warnings as errors
cargo fmt                     # Format code
cargo fmt -- --check          # Check formatting without modifying
```

### Other Useful Commands
```bash
cargo check        # Fast compilation check without generating binary
cargo clean        # Clean build artifacts
cargo doc --open   # Generate and open documentation
```

## Architecture Notes

This is an early-stage project. Architecture details will be added as the codebase develops.