Skip to content

config --init could create a more comprehensive sample config file #25

@ronistrom

Description

@ronistrom

Summary

uvx skene-growth config --init could generate a more comprehensive sample config file that aligns with the Configuration docs, so new users see all supported options in one place.

Current behavior

The generated sample config likely includes only a minimal set of options.

Proposed behavior

Have config --init create a sample config that includes (with comments), similar to the docs:

  • Provider / API: api_key, provider, model, base_url (with a short note that base_url is for generic/OpenRouter-style endpoints)
  • Paths: output_dir with the default
  • Logging: verbose, debug (with a note that debug logs to .skene-growth/debug/)
  • Exclusions: exclude_folders with a small example list and a comment that matching is by exact name, substring, or path pattern (and that it’s merged with built-in defaults)

Rationale

  • The Configuration page already documents a full sample; --init could output the same structure so the file is both a working default and a reference.
  • Users who run config --init first are more likely to discover exclude_folders, debug, and base_url (e.g. for OpenRouter) without digging through the docs.
  • A single, doc-aligned sample reduces drift between “what the docs show” and “what the tool generates.”

Example structure (conceptual)

# .skene-growth.config
# See: https://www.skene.ai/resources/docs/skene-growth/guides/configuration

# api_key = ""  # or use SKENE_API_KEY env var
provider = "openai"
# model = "gpt-4o"
# base_url = ""  # for generic/OpenRouter-compatible endpoints

output_dir = "./skene-context"
verbose = false
debug = false  # logs LLM I/O to .skene-growth/debug/

# Matches: exact name, substring in path, or path pattern (merged with built-in defaults)
exclude_folders = ["tests", "vendor"]

If you’d like, I can turn this into a concrete patch for the init command.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions