civitai-to-obsidian/config.example.yaml at main · mister-gone-int/civitai-to-obsidian · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# CivitAI to Obsidian Configuration
# Copy this file to config.yaml and customize for your setup

# Obsidian vault configuration
obsidian:
  # Path to your Obsidian vault
  vault_path: "/path/to/your/obsidian/vault"

  # Media folder structure (relative to vault root)
  media_folder: "zzMedia/Model and Lora Example Images"

  # Base directory for notes (relative to vault root)
  base_directory: "Diffusion"

  # Directory structure by base model
  directories:
    flux: "1 - FLUX"
    sdxl: "3 - SDXL"
    sd15: "2 - SD15"
    pony: "4 - PONY"
    illust: "5 - ILLUST"
    other: "9 - Other"

  # Subdirectories by model type
  type_directories:
    lora: "Lora"
    checkpoint: "Models"
    textualinversion: "Embeddings"
    other: "Other"

# CivitAI API configuration
civitai:
  # Your CivitAI API key (optional, but recommended for higher rate limits)
  # Get one at: https://civitai.com/user/account
  api_key: null

  # API base URL (don't change unless CivitAI changes their API)
  base_url: "https://civitai.com/api/v1"

# Rate limiting configuration
rate_limits:
  # Delay between image downloads in seconds
  download_delay: 2.0

  # Delay between API calls in seconds
  api_delay: 1.5

  # Maximum retries for failed requests
  max_retries: 3

  # Backoff factor for retries
  backoff_factor: 1

# Default fetch options
defaults:
  # Default number of images to fetch
  image_limit: 200

  # Default sort order: "Most Reactions", "Newest", "Most Comments"
  sort_order: "Most Reactions"

  # Default time period: "AllTime", "Year", "Month", "Week", "Day"
  time_period: "AllTime"

  # Default content gating. false (default) pulls SFW images into the
  # normal note + folder; true pulls NSFW-only images into a dedicated
  # note + image folder both prefixed "NSFW - ". Override per-run with
  # --nsfw / --no-nsfw. (The old "nsfw_filter" string key is obsolete
  # and ignored.)
  nsfw: false

  # Skip images that have no generation metadata (prompt, sampler,
  # etc). On by default — a library of meta-less duds isn't useful as
  # a reference. Override per run with --no-require-meta.
  require_meta: true

  # Drop images whose prompts look like Buzz tip-begging
  # ("buzz please", "give me buzz", "#buzzfarming", etc).
  # On by default. Override per run with --no-filter-begging.
  filter_begging: true

  # Additional regex patterns to apply on top of the built-in
  # begging filter. Each entry is a Python regex; matching is
  # case-insensitive and runs against the prompt + negative prompt.
  # Use this when new spam phrases start showing up and you don't
  # want to wait for a built-in update.
  begging_patterns_extra: []
    # - '\bplz\s+tip\b'
    # - '\bfollow\s+me\s+for\s+more'

  # Tags to drop when any appears as a whole word in an image's
  # POSITIVE prompt (case-insensitive). Matching is literal/whole-word,
  # so "loli" hits the tag `loli` but not `lollipop`; multi-word phrases
  # match only when the words are adjacent.
  #
  # The effective blacklist is the UNION of three sources (a tag in ANY
  # of them is dropped): this inline list, a blacklist file (see below),
  # and the per-run --blacklist-tags "a, b, c" flag. Empty union = off.
  blacklist_tags: []
    # - loli
    # - gore
    # - scat

  # Optional path to a blacklist file (comma- and/or newline-separated;
  # '#' starts a comment). Defaults to `blacklist.txt` beside this config
  # file when present — that default file is gitignored, so it's the
  # place to keep a long personal blacklist out of version control.
  # Override the path with --blacklist-file PATH.
  # blacklist_file: "blacklist.txt"

# Settings for backfill_image_metadata.py — the standalone tool
# that patches generation metadata into previously-downloaded images.
backfill:
  # Where to write `.civitai-orig` rollback backups when --backup is
  # passed. With this set, each backup lands under
  # <backup_dir>/<source-folder-name>/<file>.civitai-orig, keeping
  # the source folders clean. Unset (or null) → backups land as
  # siblings next to the original file (legacy behavior).
  #
  # Note: this only specifies the LOCATION of backups; you must
  # still pass --backup on the command line for backups to be
  # created. Configuring backup_dir alone won't enable backups.
  # backup_dir: "/absolute/path/to/your/image-backups"
  backup_dir: null

# Metadata configuration
metadata:
  # Author name for generated notes
  author: "Your Name"

  # Base tags to include in all notes
  base_tags:
    - "diffusion"
    - "ai"
    - "civitai"