Local, Project, and Global Settings

Entire uses a layered configuration system that allows project-wide settings to be shared via Git while supporting personal overrides. Use this page when you are deciding whether a setting should apply to everyone on the project, only to your machine, or to all repositories you work in.

Local Settings
Project Settings
Global Settings

Local settings have the highest priority and are used for personal preferences, private rules, machine-specific paths, and temporary debugging.

Local settings file

Local settings are stored in .entire/settings.local.json and are automatically ignored by Git.Local settings are merged with project settings. You only need to specify the settings you want to override:

.entire/settings.local.json

{
  "log_level": "debug",
  "telemetry": false
}

Local settings reference

Use these settings locally when the behavior should not affect teammates.

Setting path	Type	Use for	Learn more
`commit_linking`	string	Personal commit-linking behavior during `git commit`	Capture Checkpoints
`strategy_options.push_sessions`	boolean	Checkpoint push behavior only on your machine	Checkpoint Storage
`strategy_options.checkpoint_remote`	object	Personal checkpoint remote while testing storage behavior	Checkpoint Storage
`redaction.pii.enabled`	boolean	Optional PII redaction for your own captured sessions	Privacy and Redaction
`redaction.custom_redactions`	object	Private regex redaction rules that should not be committed	Privacy and Redaction
`telemetry`	boolean/null	Personal analytics preference in this repository	Privacy and Redaction
`sign_checkpoint_commits`	boolean	Personal checkpoint commit signing preference	Privacy and Redaction
`log_level`	string	Temporary debug logging without changing team settings	Logging and Diagnostics
`external_agents`	boolean	External agent plugin discovery only on your machine	Agent Hooks
`absolute_git_hook_path`	boolean	Full `entire` binary path in Git hooks for GUI Git clients on your machine	Git Hooks

Modify local settings

Use the CLI
Edit JSON

Add --local when the command should write to .entire/settings.local.json.

entire configure --local --telemetry=false
entire configure --local --skip-push-sessions
entire configure --local --absolute-git-hook-path

If a setting does not have a CLI flag, edit .entire/settings.local.json directly.

Edit .entire/settings.local.json directly:

vim .entire/settings.local.json

Top-level settings are written directly:

.entire/settings.local.json

{
  "log_level": "debug"
}

Dotted setting paths are written as nested objects:

.entire/settings.local.json

{
  "redaction": {
    "custom_redactions": {
      "private_codename": "PROJECT_[A-Z]{4}"
    }
  }
}

Verify local settings

After editing local settings, run:

entire status --detailed

Use this to confirm Entire is still reading the repository configuration. If the behavior does not match .entire/settings.local.json, check the setting name and JSON nesting. Local settings override project and global settings for the same setting path.

Project settings apply to the current repository and are used for shared behavior such as checkpoint storage, team redaction rules, and default repository behavior.

Project settings file

Project settings are stored in .entire/settings.json.When Entire creates project settings, the file starts with:

.entire/settings.json

{
  "enabled": true
}

Most projects can start here. Add settings only when the repository should share that behavior.

Project settings reference

Use these settings in .entire/settings.json when the behavior should apply to the whole project.

Setting path	Type	Default	Description	Learn more
`enabled`	boolean	`true`	Whether Entire is active in this repository	Local, Project, and Global Settings
`commit_linking`	string	`"prompt"`	Controls whether Entire prompts before linking a Git commit to recent agent session context	Capture Checkpoints
`strategy_options.push_sessions`	boolean	`true`	Automatically push checkpoint data when someone runs `git push`	Checkpoint Storage
`strategy_options.checkpoint_remote`	object	`null`	Push checkpoint data to a separate repository	Checkpoint Storage
`strategy_options.summarize.enabled`	boolean	`false`	Auto-generate checkpoint summaries at commit time	Checkpoint Storage
`redaction.pii.enabled`	boolean	`false`	Enable optional PII redaction on top of always-on secret redaction	Privacy and Redaction
`redaction.custom_redactions`	object	`{}`	Add shared regex rules that replace matches with `REDACTED`	Privacy and Redaction
`telemetry`	boolean/null	`null`	Send anonymous usage analytics for this repository	Privacy and Redaction
`sign_checkpoint_commits`	boolean	`true`	Sign checkpoint commits using your existing Git signing key	Privacy and Redaction
`log_level`	string	`"info"`	Log verbosity: `debug`, `info`, `warn`, `error`	Logging and Diagnostics
`external_agents`	boolean	`false`	Enable discovery of external agent plugins from `$PATH`	Agent Hooks
`absolute_git_hook_path`	boolean	`false`	Embed the full `entire` binary path in Git hooks for GUI Git clients	Git Hooks

Modify project settings

Use the CLI
Edit JSON

Add --project when the command should write to .entire/settings.json.

entire configure --project --checkpoint-remote github:owner/repo
entire configure --project --skip-push-sessions
entire configure --project --telemetry=false

If a setting does not have a CLI flag, edit .entire/settings.json directly.

Edit .entire/settings.json directly:

vim .entire/settings.json

Top-level settings are written directly:

.entire/settings.json

{
  "telemetry": false
}

Dotted setting paths are written as nested objects:

.entire/settings.json

{
  "strategy_options": {
    "push_sessions": false
  }
}

Verify project settings

After editing project settings, run:

entire status --detailed

Use this to confirm Entire is still reading the repository configuration. If the behavior does not match .entire/settings.json, check for an override in .entire/settings.local.json. Local settings have higher priority than project settings.

Global settings apply to all repositories and are used for personal defaults that should apply across projects.

Global settings file

Global settings are stored in ~/.config/entire/settings.json.Use global settings for personal defaults that should apply across repositories.Example:

~/.config/entire/settings.json

{
  "telemetry": false
}

Global settings reference

Use global settings for personal defaults that should apply unless a project or local setting overrides them.

Setting path	Type	Default	Description
`telemetry`	boolean	`false`	Default telemetry setting for new repositories

Modify global settings

Use the CLI
Edit JSON

entire configure updates repository settings. There is no global flag for entire configure, so edit ~/.config/entire/settings.json directly.

Create the config directory if it does not exist, then edit the file:

mkdir -p ~/.config/entire
vim ~/.config/entire/settings.json

Example:

~/.config/entire/settings.json

{
  "telemetry": false
}

Verify global settings

After editing global settings, run this from an Entire-enabled repository:

entire status --detailed

Use this to confirm Entire is still reading configuration. Global settings apply only when the same setting is not set in .entire/settings.json or .entire/settings.local.json.

Getting Started

Platforms

Guides

Security

Resources

Local, Project, and Global Settings

Local settings file

Local settings reference

Modify local settings

Verify local settings

Project settings file

Project settings reference

Modify project settings

Verify project settings

Global settings file

Global settings reference

Modify global settings

Verify global settings

​Local settings file

​Local settings reference

​Modify local settings

​Verify local settings

​Project settings file

​Project settings reference

​Modify project settings

​Verify project settings

​Global settings file

​Global settings reference

​Modify global settings

​Verify global settings

Local settings file

Local settings reference

Modify local settings

Verify local settings

Project settings file

Project settings reference

Modify project settings

Verify project settings

Global settings file

Global settings reference

Modify global settings

Verify global settings