Skip to content

simplito/deepfellow-cli

Repository files navigation

DeepFellow

DeepFellow CLI

Privacy-First AI Infrastructure Framework — deploy and manage private AI on your own infrastructure.

Docs · Quickstart · Architecture · License


deepfellow-cli is the command-line tool for installing, configuring, and managing DeepFellow — a framework for running AI models on your own infrastructure with full data control, an OpenAI-compatible API, and a modular plugin system for prompt filtering, anonymization, and response validation.

Requirements

Installation

curl https://deepfellow.ai/install.sh | bash

Verify with deepfellow --help.

To uninstall:

uv tool uninstall deepfellow-cli    # or pipx / pip3 uninstall

Quickstart

1. Set up Infra (model hosting layer)

deepfellow infra install    # interactive — configures API keys, Docker network, etc.
deepfellow infra start

2. Install a model

deepfellow infra service install ollama
deepfellow infra model install ollama gemma3:1b

Pick a model that fits your VRAM — see our model recommendations and Supported Models for guidance.

3. Set up Server (API & management layer)

deepfellow server install   # interactive — configures MongoDB, Qdrant, DeepFellow Infra connection
deepfellow server start

4. Create admin & log in

deepfellow server create-admin
deepfellow server login

5. Create organization, project & API key

deepfellow server organization create "My Company"
export ORG_ID=u4hdn4uamdu4hs
deepfellow server project create $ORG_ID "My Project"
export PROJ_ID=amdu4hsu4hdn4u
deepfellow server project api-key create $ORG_ID $PROJ_ID "my-key"

Done. Your private AI is running and accepting OpenAI-compatible API requests.

CLI Reference

Non-interactive mode

Majority of commands run interactively by default. For scripting and automation, pass --non-interactive with the required options:

export DF_INFRA_API_KEY=dfapi-u4hdn4u-amdu4hs-cbgurg-223hdgr
deepfellow --non-interactive infra install
deepfellow --non-interactive server install \
  --infra-url https://infra.local:8086

Every interactive prompt has a corresponding --flag. Run any command with --help to see all available options.

Infra

deepfellow infra install                             # Interactive setup
deepfellow infra start / stop                        # Start / stop DeepFellow Infra containers
deepfellow infra info                                # Show config & env vars
deepfellow infra ssl-on                              # Configure SSL
deepfellow infra service install                     # Add model backend (ollama, vllm, …)
deepfellow infra service uninstall                   # Remove backend + its models
deepfellow infra model install                       # Pull a model
deepfellow infra model uninstall                     # Remove a model
deepfellow infra connect                             # Attach to a multi-node Mesh
deepfellow infra disconnect                          # Disconnect from Mesh
deepfellow infra env set                             # Set / unset env variable
deepfellow infra uninstall                           # Full removal

Server

deepfellow server install                            # Interactive setup
deepfellow server start / stop                       # Start / stop DeepFellow Server containers
deepfellow server info                               # Show config & env vars
deepfellow server create-admin                       # Create admin account
deepfellow server login                              # Authenticate for CLI admin tasks
deepfellow server password-reset                     # Reset user password
deepfellow server organization create                # Create an organization
deepfellow server project create                     # Create a project
deepfellow server api-key create                     # Generate an API key
deepfellow server env set                            # Set / unset env variable
deepfellow server uninstall                          # Full removal

Configuration

All state lives in ~/.deepfellow/ — env files, Docker Compose configs, secrets, and model storage. Use deepfellow infra info or deepfellow server info to inspect current settings, or env set to modify them. See Installation docs for the full list of environment variables.

Learn More

License

DeepFellow Free License — free for personal use and organizational R&D. Commercial use requires a commercial license.

About

Built by Simplito in Toruń, Poland — creators of PrivMX.

deepfellow.ai · GitHub · contact@simplito.com

About

Privacy-First AI Infrastructure Framework

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages