> 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/installation.md).

# Install

Getting OF-Scraper onto you system

***

## Version Info

> ℹ️ **This fork is on PyPI as `ofscraper-community`.** The command is still `ofscraper`. The `ofscraper` package on PyPI is upstream's last release and does not have the fork's fixes.

> ℹ️ **Go to** [**https://github.com/cloakedkeys/OF-Scraper-Community/releases**](https://github.com/cloakedkeys/OF-Scraper-Community/releases) **for the latest release**

[![drawing](https://img.shields.io/github/v/release/cloakedkeys/OF-Scraper-Community?label=release\&color=00a8e8)](https://github.com/cloakedkeys/OF-Scraper-Community/releases/latest)

##

***

## Before Starting

The guide assumes you have your terminal program open and have already installed Python. If you're unsure about this, follow this guide

[Installing Prerequisites](/ofsc/installation/pre-install-guide.md)

***

## Install via a package manager

> ℹ️ **uv is recommended for its virtual environment management capabilities.**
>
> **It serves as an abstraction layer over pip, placing installed scripts within isolated virtual environments. This approach is highly recommended for script installation as it offers several advantages:**
>
> * **Prevents conflicts:** By isolating scripts and their dependencies within virtual environments, uv effectively eliminates conflicts with other Python packages or system-wide installations.
> * **Enhances organization:** Each script resides in its own distinct virtual environment, promoting better organization and clarity in project management.
> * **Simplifies updates:** uv streamlines the process of updating scripts, ensuring you always have access to the latest versions and features

### **Option 1: uv Install**

[UV Install](/ofsc/installation/uv-install.md)

### **Option 2: pipx install**

```
pipx install ofscraper-community
```

Like uv, pipx gives the tool its own environment.

### **Option 3: PIP install**

```
pip install ofscraper-community
```

Use a virtual environment, as pip installs into the current Python environment.

> ℹ️ **Don't install `ofscraper` and `ofscraper-community` together with pip.** Both provide the `ofscraper` command, so they overwrite each other. Run `pip uninstall ofscraper` first. If you already have both, uninstall both and then install `ofscraper-community` again. uv and pipx keep each tool separate, so they don't have this problem.

To get the latest changes on `main` before they're released, install from GitHub:

```
pip install git+https://github.com/cloakedkeys/OF-Scraper-Community
```

## Install via Docker

[Docker](/ofsc/installation/docker.md)

## Compiled Binaries \[No Install]

> ℹ️ **A pyinstaller based binary is an executable file that contains your Python script and all the necessary dependencies to run it on different operating systems. Pyinstaller analyzes the script and bundles it with the Python interpreter, libraries, modules, and other resources into a single file or folder**

> ℹ️ **Support for issues specific to how pyinstaller operates may be limited**

[Binary Releases](/ofsc/installation/binary-releases.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 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/installation.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.