Skip to content

The 'data/' directory created by 'sirchmunk init' is unused and undocumented #85

@smartcmd

Description

@smartcmd

Description

When running sirchmunk init, a data/ directory is created as part of the working directory structure (cli/cli.py:216-224):

directories = [
    work_path,
    work_path / "data",       # <-- this one
    work_path / "logs",
    work_path / ".cache",
    work_path / ".cache" / "models",
    work_path / ".cache" / "knowledge",
    work_path / ".cache" / "history",
    work_path / ".cache" / "settings",
]

However, this data/ directory appears to be unused and undocumented:

  1. No code references: No other part of the codebase reads from or writes to this directory. It is only created during init.
  2. Not a default search path: SIRCHMUNK_SEARCH_PATHS does not default to data/, so Sirchmunk won't automatically search files placed there.
  3. Missing from documentation: The README's "Data Storage" section documents the .cache/ structure but does not mention data/.

Suggestion

Either:

  • Option A: Remove the data/ directory from init if it serves no purpose, to keep the workspace clean.
  • Option B: Give it a clear role — e.g., make it a default search path, document it as the recommended location for user files, and mention it in the README.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions