|
1 | 1 | # TuringFlow |
2 | 2 |
|
| 3 | +[](https://github.com/nschaetti/TuringFlow/actions/workflows/rust.yml) |
| 4 | +[](https://codecov.io/gh/nschaetti/TuringFlow) |
| 5 | + |
3 | 6 | <p align="center"> |
4 | 7 | <picture> |
5 | 8 | <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/nschaetti/TuringFlow/refs/heads/main/images/turingflow_banner.png"> |
6 | | - <img src="https://raw.githubusercontent.com/nschaetti/TuringFlow/refs/heads/main/images/turingflow_banner.png" alt="OpenClaw" width="500"> |
| 9 | + <img src="https://raw.githubusercontent.com/nschaetti/TuringFlow/refs/heads/main/images/turingflow_banner.png" alt="TuringFlow" width="500"> |
7 | 10 | </picture> |
8 | 11 | </p> |
| 12 | + |
| 13 | +TuringFlow is an agent transport + runtime foundation with: |
| 14 | + |
| 15 | +- a secure `TFPv1` daemon (`turingflowd`) over mTLS, |
| 16 | +- registry/routing/ack/dedupe persistence in SQLite, |
| 17 | +- a kernel-style access control model for agent operations, |
| 18 | +- CLI tooling for model interactions. |
| 19 | + |
| 20 | +## Current scope |
| 21 | + |
| 22 | +- `turingflowd` API endpoints: health, register, heartbeat, resolve, send, ack. |
| 23 | +- Config-driven runtime: |
| 24 | + - `config/turingflowd.yaml` |
| 25 | + - `config/kingdoms.yaml` |
| 26 | + - `config/policies.yaml` |
| 27 | +- Kernel syscalls and policy engine: |
| 28 | + - `fs.list/read/write` |
| 29 | + - `proc.exec` |
| 30 | + - `net.http` |
| 31 | + - deny-by-default + audit log in SQLite. |
| 32 | + |
| 33 | +## Quick start |
| 34 | + |
| 35 | +Build: |
| 36 | + |
| 37 | +```bash |
| 38 | +cargo build |
| 39 | +``` |
| 40 | + |
| 41 | +Show CLI help: |
| 42 | + |
| 43 | +```bash |
| 44 | +cargo run --bin turingflow -- --help |
| 45 | +``` |
| 46 | + |
| 47 | +Show daemon help: |
| 48 | + |
| 49 | +```bash |
| 50 | +cargo run --bin turingflowd -- --help |
| 51 | +``` |
| 52 | + |
| 53 | +Run daemon (requires valid cert files in config): |
| 54 | + |
| 55 | +```bash |
| 56 | +cargo run --bin turingflowd -- --config config/turingflowd.yaml --kingdoms-config config/kingdoms.yaml |
| 57 | +``` |
| 58 | + |
| 59 | +## Documentation |
| 60 | + |
| 61 | +- User docs: `docs/user/quickstart.md` |
| 62 | +- Developer docs: `docs/dev/architecture.md` |
| 63 | +- Operations docs: `docs/ops/runbook.md` |
| 64 | +- Full index: `docs/README.md` |
| 65 | + |
| 66 | +## Testing |
| 67 | + |
| 68 | +Run all key test suites: |
| 69 | + |
| 70 | +```bash |
| 71 | +cargo test --lib |
| 72 | +cargo test --test tfpv1_integration |
| 73 | +cargo test --test turingflowd_http_integration |
| 74 | +``` |
| 75 | + |
| 76 | +Tooling security lint (no direct host access in tools perimeter): |
| 77 | + |
| 78 | +```bash |
| 79 | +bash scripts/check_tooling_no_direct_host_access.sh |
| 80 | +``` |
0 commit comments