Settings � Projects

You’ll rarely need this unless you work with multiple Ren’Py games on the same machine. Single-project users can skip it entirely.

Manage named project roots so you can switch between projects without retyping paths.

What it controls

Project root, include/exclude rules, and the default project used when --project is omitted.

When to use

New workspace setup, scope adjustments, switching between multiple Ren’Py games.

CLI commands

# List all registered projects
branchpy projects list [--json]

# Add a project
branchpy projects add <name> <path>

# Set the default project
branchpy projects set-default <name-or-path>

# Show a project path
branchpy projects show <name>

# Remove a project
branchpy projects remove <name>

# Rename a project
branchpy projects rename <old-name> <new-name>

The default project is used automatically when you run branchpy analyze without --project.

Project-level config

# Initialise a .branchpy.toml config in the project folder
branchpy config init [--name <name>]

# Show current config
branchpy config show

# Set a config key
branchpy config set <key> <value>

Safe defaults: keep default include rules; avoid broad excludes that hide code.

Learn more: Technical/cli/configuration