DeepFellow Server

The deepfellow server group manages the DeepFellow Server installation running in Docker.

deepfellow server [OPTIONS] COMMAND [ARGS]...

deepfellow server Commands

Install Templates

--template accepts the built-in workspace name, or a path to your own YAML template file. A template has two parts: config pre-fills the install settings (fields it sets are applied without prompting), and post_start_actions runs after the server starts — use it to create the admin user automatically.

config:
  port: 8000
  infra_url: http://infra:8086
  # Omit this key if the API key is generated at infra install time and not known ahead of install.
  infra_api_key: your-infra-api-key
  docker_network: deepfellow-infra-net
  vectordb_type: milvus
  vectordb_url: http://milvus:19530
  vectordb_database_name: deepfellow
  embedding_model: mxbai-embed-large
  embedding_size: "1024"

# Runs after the server starts, in order.
post_start_actions:
  # Create the admin user. Leave name/email/password null to be prompted for them at install time.
  - function: server.create_admin
    kwargs:
      directory: "~/.deepfellow/server"
      name: null
      email: null
      password: null

Valid config keys:

• port
• infra_url
• infra_api_key
• docker_network
• vectordb_type
• vectordb_url
• vectordb_database_name
• embedding_model
• embedding_size

The only valid post_start_actions function is server.create_admin, whose kwargs must match the server create-admin command parameters. The built-in workspace template omits infra_api_key, since that key is generated at infra install time and is not knowable by a static template.

The built-in workspace template is equivalent to the example above: it sets the milvus vector database with the mxbai-embed-large embedding model (1024 dimensions) and runs a server.create_admin action that leaves name/email/password to be prompted for at install time. Under --non-interactive there is no prompt to fall back on, so a template that leaves them null is rejected before the install starts. A full copy of this example ships with the CLI source at deepfellow/server/templates/example.yaml.

deepfellow server env

Manage DeepFellow Server environment variables. For what each variable means and what it defaults to, read Configuration.

deepfellow server env [OPTIONS] COMMAND [ARGS]...

deepfellow server config

Manage Server's dynamic runtime configuration.

deepfellow server config [OPTIONS] COMMAND [ARGS]...

deepfellow server organization

Manage organizations.

deepfellow server organization [OPTIONS] COMMAND [ARGS]...

deepfellow server project

Manage projects.

deepfellow server project [OPTIONS] COMMAND [ARGS]...

deepfellow server toolbox

Manage toolboxes. A toolbox is a project-scoped container for tools.

deepfellow server toolbox [OPTIONS] COMMAND [ARGS]...

deepfellow server tool

Manage tools within a toolbox. A tool always belongs to a toolbox: create the toolbox first, then add tools to it.

deepfellow server tool [OPTIONS] COMMAND [ARGS]...

A tool's definition is a JSON object with a type field, one of mcp, infra-mcp, custom-mcp, file_search, image_generation, or websearch. Each type takes a different set of fields; for example, an mcp tool takes server_label and server_url:

{
  "type": "mcp",
  "server_label": "git mcp",
  "server_url": "http://127.0.0.1:8001/mcp",
  "server_description": "Git operations over MCP"
}