# spuff

## Docs

- [AI Coding Tools](https://spuff.avelino.run/ai-tools.md)
- [Spuff Technical Architecture](https://spuff.avelino.run/architecture.md)
- [Configuration Reference](https://spuff.avelino.run/configuration.md)
- [Project Configuration (spuff.yaml)](https://spuff.avelino.run/project-config.md)
- [Security Model](https://spuff.avelino.run/security.md)
- [Spuff Specification](https://spuff.avelino.run/spec.md)
- [Troubleshooting Guide](https://spuff.avelino.run/troubleshooting.md)
- [Architecture Decision Records](https://spuff.avelino.run/adr.md)
- [ADR-0001: Use cloud-init for VM Bootstrap](https://spuff.avelino.run/adr/0001-cloud-init-bootstrap.md)
- [ADR-0002: Two-Phase Bootstrap (Sync + Async)](https://spuff.avelino.run/adr/0002-two-phase-bootstrap.md)
- [ADR-0003: SQLite for Local State Management](https://spuff.avelino.run/adr/0003-sqlite-local-state.md)
- [ADR-0004: SSH Agent Forwarding for Git Access](https://spuff.avelino.run/adr/0004-ssh-agent-forwarding.md)
- [ADR-0005: Provider Trait for Cloud Abstraction](https://spuff.avelino.run/adr/0005-provider-trait-abstraction.md)
- [ADR-0006: Project Configuration Specification (spuff.yaml)](https://spuff.avelino.run/adr/0006-project-config-spec.md)
- [ADR-NNNN: Title](https://spuff.avelino.run/adr/template.md)
- [Development Guide](https://spuff.avelino.run/development.md)
- [Cross-Compilation Guide](https://spuff.avelino.run/development/cross-compilation.md)
- [Debugging Guide](https://spuff.avelino.run/development/debugging.md)
- [Release Process](https://spuff.avelino.run/development/releasing.md)
- [Development Setup](https://spuff.avelino.run/development/setup.md)
- [Testing Guide](https://spuff.avelino.run/development/testing.md)
- [Provider System](https://spuff.avelino.run/providers.md)
- [Creating a New Provider](https://spuff.avelino.run/providers/creating-a-provider.md)
- [Provider API Reference](https://spuff.avelino.run/providers/provider-api.md)
- [Testing Providers](https://spuff.avelino.run/providers/testing-providers.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://spuff.avelino.run/ai-tools.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.