ProjectAtlas Configuration

ProjectAtlas reads projectatlas.toml or .projectatlas/config.toml. All paths are relative to the config file.

[project]
root = "."
map_path = ".projectatlas/projectatlas.toon"
nonsource_files_path = ".projectatlas/projectatlas-nonsource-files.toon"
purpose_filename = ".purpose"

[scan]
source_extensions = [".py", ".js", ".ts", ".tsx", ".jsx", ".vue", ".css", ".mjs", ".cjs", ".d.ts", ".java", ".kt", ".scala", ".cs", ".go", ".rs", ".rb", ".php", ".c", ".h", ".cpp", ".hpp", ".cc", ".cxx", ".swift", ".lua", ".sh", ".bash", ".zsh", ".ps1", ".psm1", ".psd1", ".sql"]
exclude_dir_names = [".git", ".projectatlas", ".venv", "__pycache__", "node_modules", "dist", "build"]
exclude_dir_suffixes = [".egg-info"]
exclude_path_prefixes = []
non_source_path_prefixes = []
max_scan_lines = 80

[purpose]
default_style = "javadoc"
line_comment_prefixes = ["//", "#", "--", ";"]
# styles_by_extension = { ".go" = "line-comment", ".c" = "block-comment" }

[summary_rules]
ascii_only = true
no_commas = true
max_length = 140

[untracked]
allowed_filenames = [".purpose"]
allowlist_dir_prefixes = []
allowlist_files = []
asset_allowed_prefixes = []
asset_extensions = [".png", ".jpg", ".jpeg", ".svg", ".gif", ".webp", ".ico", ".pdf", ".ttf", ".woff", ".woff2"]

projectatlas init auto-detects repo languages and writes the config with the detected extensions by default. Pass --no-detect-languages to keep the static template.

Purpose styles

  • purpose.default_style controls the fallback header style (javadoc, block-comment, or line-comment).
  • purpose.styles_by_extension maps specific extensions to a style.
  • purpose.line_comment_prefixes controls which line-comment prefixes are recognized.

Example:

[purpose]
default_style = "javadoc"
line_comment_prefixes = ["//", "#", "--", ";"]

[purpose.styles_by_extension]
".go" = "line-comment"
".rs" = "line-comment"
".c" = "block-comment"

Non-source file list

If you set project.nonsource_files_path, ProjectAtlas reads a TOON file with a nonsource_files[]: section. This file is agent-maintained input for non-source summaries (configs, docs, assets) and is merged into the generated atlas. The legacy project.manual_files_path key is still accepted for backward compatibility.

nonsource_files[]:
  path/to/file.txt,One line purpose summary

These entries are merged into the file list for non-source or config files that cannot carry headers.