Skip to content

Commit 0373dea

Browse files
Copilotyiwang
andcommitted
Update localgpt.rs comments: XDG paths and correct filenames
Co-authored-by: yiwang <142937+yiwang@users.noreply.github.com>
1 parent dacdec6 commit 0373dea

1 file changed

Lines changed: 21 additions & 6 deletions

File tree

crates/core/src/security/localgpt.rs

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,18 +73,33 @@
7373
//! };
7474
//!
7575
//! // At context assembly — always append the security block last:
76-
//! let block = build_ending_security_block(user_policy.as_deref());
76+
//! let block = build_ending_security_block(user_policy.as_deref(), true);
7777
//! ```
7878
//!
7979
//! ## File Hierarchy
8080
//!
81+
//! LocalGPT follows the XDG Base Directory Specification. Paths can be customized
82+
//! via environment variables (see `paths.rs`).
83+
//!
8184
//! ```text
82-
//! ~/.localgpt/ # State directory
83-
//! ├── .device_key # 32-byte HMAC key (0600)
84-
//! ├── .security_audit.jsonl # Append-only audit log
85-
//! └── workspace/
85+
//! ~/.config/localgpt/ # Config directory (XDG_CONFIG_HOME)
86+
//! └── config.toml # User configuration
87+
//!
88+
//! ~/.local/share/localgpt/ # Data directory (XDG_DATA_HOME)
89+
//! ├── localgpt.device.key # 32-byte HMAC key (0600)
90+
//! └── workspace/ # Memory workspace
8691
//! ├── LocalGPT.md # User security policy
87-
//! └── .localgpt_manifest.json # HMAC signature manifest
92+
//! ├── .localgpt_manifest.json # HMAC signature manifest
93+
//! ├── MEMORY.md # Long-term memory
94+
//! └── HEARTBEAT.md # Autonomous tasks
95+
//!
96+
//! ~/.local/state/localgpt/ # State directory (XDG_STATE_HOME)
97+
//! ├── localgpt.audit.jsonl # Append-only audit log
98+
//! ├── agents/{agent_id}/sessions/ # Session transcripts
99+
//! └── logs/ # Application logs
100+
//!
101+
//! ~/.cache/localgpt/ # Cache directory (XDG_CACHE_HOME)
102+
//! └── memory/{agent_id}.sqlite # Search index & embeddings
88103
//! ```
89104
//!
90105
//! ## Threat Model

0 commit comments

Comments
 (0)