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

# Reference

Reference documentation for the CBFS public API

Use this section as the lookup index for CBFS's public API. The [usage guides](/usage/disk-usage.md) explain common workflows; these pages describe public methods, arguments, return values, and provider-specific boundaries.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Disk Service</strong></td><td>Register, resolve, inspect, and shut down disks.</td><td><a href="/reference/reference/disk-service.md">Disk Service</a></td></tr><tr><td><strong>Disk API</strong></td><td>Explore the common IDisk contract shared by providers.</td><td><a href="/reference/reference/disk-api.md">Disk API</a></td></tr><tr><td><strong>File Object</strong></td><td>Use the fluent wrapper returned by disk.file().</td><td><a href="/reference/reference/file-object.md">File Object</a></td></tr><tr><td><strong>Provider capabilities</strong></td><td>Compare supported operations across Local, RAM, and S3.</td><td><a href="/reference/reference/provider-capabilities.md">Provider Capabilities</a></td></tr><tr><td><strong>Configuration</strong></td><td>Configure disks, provider properties, and environment variables.</td><td><a href="/reference/reference/configuration.md">Configuration</a></td></tr><tr><td><strong>Integration and lifecycle</strong></td><td>Use injection, helpers, module disks, and interception points.</td><td><a href="/reference/reference/integration.md">Integration and Lifecycle</a></td></tr><tr><td><strong>Errors</strong></td><td>Handle missing paths, overwrite failures, and provider errors.</td><td><a href="/reference/reference/errors.md">Errors</a></td></tr></tbody></table>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cbfs.ortusbooks.com/reference/reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.