> For the complete documentation index, see [llms.txt](https://spuff.avelino.run/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://spuff.avelino.run/adr.md).

# Architecture Decision Records

This directory contains Architecture Decision Records (ADRs) for the spuff project.

## What is an ADR?

An ADR is a document that captures an important architectural decision made along with its context and consequences. ADRs help:

* **Document** the reasoning behind decisions
* **Communicate** decisions to the team
* **Onboard** new contributors by explaining "why"
* **Revisit** decisions when context changes

## ADR Index

| ID                                              | Title                                | Status   | Date    |
| ----------------------------------------------- | ------------------------------------ | -------- | ------- |
| [0001](/adr/0001-cloud-init-bootstrap.md)       | Use cloud-init for VM bootstrap      | Accepted | 2025-01 |
| [0002](/adr/0002-two-phase-bootstrap.md)        | Two-phase bootstrap (sync + async)   | Accepted | 2025-01 |
| [0003](/adr/0003-sqlite-local-state.md)         | SQLite for local state management    | Accepted | 2025-01 |
| [0004](/adr/0004-ssh-agent-forwarding.md)       | SSH agent forwarding for git access  | Accepted | 2025-01 |
| [0005](/adr/0005-provider-trait-abstraction.md) | Provider trait for cloud abstraction | Accepted | 2025-01 |
| [0006](/adr/0006-project-config-spec.md)        | Project configuration (spuff.yaml)   | Accepted | 2025-01 |

## Status Values

* **Proposed** - Under discussion
* **Accepted** - Decision made, implementing
* **Deprecated** - Superseded by another ADR
* **Superseded** - Replaced by a newer ADR

## Creating a New ADR

1. Copy the template:

   ```bash
   cp docs/adr/template.md docs/adr/NNNN-title.md
   ```
2. Fill in the template with:
   * Context: What is the situation?
   * Decision: What did we decide?
   * Consequences: What are the results?
3. Submit a PR for review
4. Update this README with the new ADR

## Template

See [template.md](/adr/template.md) for the ADR template.

## References

* [ADR GitHub Organization](https://adr.github.io/)
* [Michael Nygard's Article](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)


---

# 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 that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://spuff.avelino.run/adr.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.