Skip to content

Configuration

Config file locations

TierLocationScope
1~/.chub/config.yamlPersonal defaults (machine-wide)
2.chub/config.yamlProject config (git-tracked)
3.chub/profiles/<name>.yamlRole/task profile

Later tiers override earlier ones. No tier is required.

Full config example

yaml
# .chub/config.yaml

# Registry sources
sources:
  - name: official
    url: https://cdn.aichub.org/v1
  - name: company
    url: https://docs.internal.company.com/chub

cdn_url: "https://cdn.aichub.org/v1"
source: "official"            # default source
output_dir: "./dist"
output_format: "markdown"     # or json
refresh_interval: 86400       # cache TTL in seconds
telemetry: false
feedback: false

# Agent rules
agent_rules:
  global:
    - "Follow the project coding conventions"
  modules:
    backend:
      path: "src/api/**"
      rules:
        - "Use Zod for validation"
  include_pins: true
  include_context: true
  targets:
    - claude.md
    - cursorrules

# Monorepo auto-profile
auto_profile:
  - path: "packages/api/**"
    profile: backend
  - path: "packages/web/**"
    profile: frontend

Environment variables

VariableDescription
CHUB_DIROverride ~/.chub data directory
CHUB_BUNDLE_URLOverride the default CDN URL
CHUB_PROJECT_DIROverride project root (for testing)

pins.yaml

yaml
pins:
  - id: openai/chat
    lang: python          # optional
    version: "4.0"        # optional
    reason: "Use v4 API"  # optional
    source: official      # optional

Profile format

yaml
name: Backend Developer
extends: base              # optional inheritance
description: "Backend dev context"
rules:
  - "Use Zod for validation"
pins:
  - openai/chat
context:
  - api-conventions.md

Context doc frontmatter

yaml
---
name: Project Architecture
description: "Architecture overview"
tags: architecture, microservices
---
FieldRequiredDescription
nameYesDisplay name
descriptionNoShort description
tagsNoComma-separated search tags