Skip to main content

​
Requirements

  • Python 3.12+ — Check with python --version
  • pip — Comes with Python. Check with pip --version
  • An LLM API key — At least one of: Anthropic, OpenAI, or Google Gemini (or a self-hosted LLM)

​
Install from PyPI

Verify the installation:

​
Initialize

​
Global setup (required)

This creates ~/.fliiq/ with:
Edit ~/.fliiq/.env and add at least one API key:
.env

​
Project-specific setup (optional)

This creates .fliiq/ in your project directory with additional customization:
Project-level config takes priority over global config. This lets you customize the agent per-project without affecting your global setup. Resolution order: project .fliiq/ > global ~/.fliiq/ > bundled defaults.

​
Optional Dependencies

Some skills require extra packages that aren’t installed by default (to keep the base install lightweight):
If you try to use a skill without its dependencies, the agent will tell you exactly what to install.

​
Verify Setup

doctor checks:
  • API keys are set and valid
  • SOUL.md is present
  • Playbooks directory exists
  • MCP servers are reachable (if configured)
  • Skills directories are valid
Fix any issues it reports before running your first command.

​
Development Install

If you’re contributing to Fliiq or want to run from source:
This installs Fliiq in editable mode with dev dependencies (pytest, ruff, etc.).

​
Upgrading

Your ~/.fliiq/ directory (memory, skills, jobs, config) is preserved across upgrades.