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

# Technical Reference

Every option, setting, default and database table, in one place.

The rest of these docs show you how to use OF-Scraper. This section is for when you need the exact details: what a setting is called, what its default is, and what else it affects.

Every page here is built from the code itself, so it matches what the program actually does.

## Pick a page

<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>⌨️ Command-line options</strong></td><td>Every command and option you can type, with its default and the <code>config.json</code> setting it replaces.</td><td><a href="/ofsc/reference/cli.md">Command-line options</a></td></tr><tr><td><strong>⚙️ config.json keys</strong></td><td>Every setting in <code>config.json</code>: what it does, its default, and older names that still work.</td><td><a href="/ofsc/reference/config.md">config.json keys</a></td></tr><tr><td><strong>🌱 Environment defaults</strong></td><td>Built-in limits, timeouts and retry settings, and the environment variables that change them.</td><td><a href="/ofsc/reference/env.md">Environment defaults</a></td></tr><tr><td><strong>🏷️ Placeholders</strong></td><td>The <code>{names}</code> you can use to build folder and file names.</td><td><a href="/ofsc/reference/placeholders.md">Placeholders</a></td></tr><tr><td><strong>🗄️ Database tables</strong></td><td>What OF-Scraper remembers about each creator, and what writes each record.</td><td><a href="/ofsc/reference/database.md">Database tables</a></td></tr><tr><td><strong>🧭 How settings and files work</strong></td><td>Which setting wins, which files get written, and where everything is saved.</td><td><a href="/ofsc/reference/how-it-works.md">How settings and files work</a></td></tr></tbody></table>

## Common questions

**I changed `config.json` but nothing changed.** A command-line option overrides the same setting in `config.json`. See [which setting wins](/ofsc/reference/how-it-works.md#where-a-settings-value-comes-from).

**How do I change where files are saved or what they're called?** Set `file_options.save_location`, `dir_format` and `file_format` in [config.json](/ofsc/reference/config.md), using the [placeholders](/ofsc/reference/placeholders.md).

**Where are my config, logs and database?** See the [default folder layout](/ofsc/reference/how-it-works.md#default-folder-layout).

**Downloads are slow or keep getting rate-limited.** The retry and wait times are in [Rate-limit and backoff settings](/ofsc/reference/env.md#rate-limit-and-backoff-settings).

**What does this fork add?** See [Fork Changes](/ofsc/fork-changes.md), or the short list in [Features only this fork has](/ofsc/reference/how-it-works.md#features-only-this-fork-has).


---

# 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://cloakedkeys.gitbook.io/ofsc/reference.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.
