byokey 0.1.0

Bring Your Own Keys — AI subscription-to-API proxy gateway
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
49
50
51
52
53
54
55
56
57
58
59

# Contributing to byokey

## Requirements

- Rust stable (recommended via [rustup](https://rustup.rs/))
- SQLite 3 (system-level; pre-installed on macOS)

## Common Commands

```bash
# Build everything
cargo build --workspace

# Run tests
cargo test --workspace
cargo test -p byokey-types          # single crate (-p uses package name)
cargo test -p byokey-translate      # pure logic tests (no I/O, fastest)

# Lint (CI runs with -D warnings, same locally)
cargo clippy --workspace -- -D warnings

# Format
cargo fmt --all

# Start the CLI server
cargo run -- serve --config config.yaml
```

## Coding Guidelines

- `unsafe` code is forbidden at the workspace level (`forbid`)
- `clippy::pedantic` is enabled; ensure zero warnings before committing
- edition 2024
- All async traits use the `async-trait` macro
- Error types: use `ByokError` across crate boundaries, `anyhow` within a crate

## Workspace Layering Rules

Strict DAG — no reverse cross-layer dependencies:

```
Layer 0  byokey-types     — core types & traits, zero intra-workspace deps
Layer 1  byokey-config    — configuration parsing
         byokey-store     — token persistence
Layer 2  byokey-auth      — OAuth flows (does not depend on translate / provider)
         byokey-translate — format conversion (pure functions, does not depend on auth)
Layer 3  byokey-provider  — Provider Executor
Layer 4  byokey-proxy     — axum HTTP server
```

## Commit Convention

Use [Conventional Commits](https://www.conventionalcommits.org/):

```
feat(auth): add Kiro device code flow
fix(proxy): handle empty SSE chunk
refactor(translate): simplify gemini response parser
```