Skip to main content

​
Prerequisites

Before installing FERAL, make sure you have the following:
DependencyMinimum VersionCheck Command
Python3.11+python3 --version
Node.js20+node --version
pipLatestpip --version
GitAny recentgit --version
macOS users can install prerequisites with brew install python@3.11 node. Linux users should use their system package manager.

​
Choose Your Install Path

​
Post-Install

After any install path, run the setup wizard to configure your LLM provider and identity: 
feral setup
This walks you through choosing a model provider, setting API keys, and creating your USER.md identity file. See First Run for a full walkthrough.

​
Troubleshooting

The feral binary is not on your PATH. If you used the one-liner, activate the environment:
source ~/.feral-env/bin/activate
If you installed via git clone, ensure feral-core is installed in your active Python environment.
Pin your pip to the latest version and retry:
pip install --upgrade pip
pip install -e ".[llm]"
FERAL’s dashboard requires Node 20+. Use nvm to manage versions:
nvm install 20
nvm use 20
Make sure Docker Desktop is running and you have at least 4 GB of RAM allocated. Pull fresh base images:
docker compose build --no-cache