> ## Documentation Index
> Fetch the complete documentation index at: https://atlas.rebuildingus.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Install Scout

> Install the Scout CLI and verify the local command.

Scout is packaged as the `atlas-scout` application and exposes the `scout`
command.

## Install From Source

Install Scout from the Atlas repository:

```bash theme={null}
brew install python@3.12 uv
```

```bash theme={null}
git clone https://github.com/RebuildingAmerica/atlas.git
cd atlas

uv tool install --reinstall --editable ./scout \
  --with-editable ./libs/shared \
  --with-editable ./libs/discovery-engine
```

Verify the command:

```bash theme={null}
scout --help
scout db path
```

Run the setup flow:

```bash theme={null}
scout setup
```

`scout-dev` is for Atlas contributors working inside the repository. It is not
installed for end users.

## Homebrew

Homebrew will be the simplest install path after the first Scout formula is
published:

```bash theme={null}
brew install rebuildingamerica/tap/atlas-scout
```

If that command fails, use the source install above.

## Requirements

* macOS with Homebrew.
* A local model provider, such as LM Studio or Ollama, for local discovery.
* A search key for search-backed discovery.
* An Atlas account only when you want login, sync, or worker mode.

Scout stores configuration and local data in OS-standard user directories. Run:

```bash theme={null}
scout db path
scout config show
```

## JavaScript-Rendered Pages

Scout fetches pages without a browser first. When a page needs JavaScript,
Scout can use headless Chromium through Playwright.

When Scout is installed with Homebrew, the formula installs the Playwright
Python package but does not download Chromium during install. Add Chromium when
you want JavaScript rendering:

```bash theme={null}
$(brew --prefix atlas-scout)/libexec/bin/playwright install chromium
```

For source installs, use Playwright directly through `uvx`:

```bash theme={null}
uvx --from playwright playwright install chromium
```

## Optional Shell Integration

Scout can install shell completion and local man pages:

```bash theme={null}
scout setup --install-completion --install-man
```

Use explicit directories when your shell environment needs them:

```bash theme={null}
scout setup \
  --install-completion \
  --completion-shell zsh \
  --completion-dir ~/.zfunc \
  --install-man \
  --man-dir ~/.local/share/man/man1
```