claude_core 1.0.0

Shared Claude Code primitives: path topology and process utilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

//! Canonical paths for all `~/.claude/` filesystem locations.
//!
//! # Design
//!
//! All `~/.claude/` paths are computed from the `HOME` environment variable.
//! [`ClaudePaths::new()`] returns `None` if `HOME` is not set (CI environments
//! without a home directory, containers, etc.).
//!
//! This module is the single authoritative source for `~/.claude/` path
//! constants across the workspace. All modules that need a `~/.claude/` path
//! must obtain it from `ClaudePaths`, not by constructing it independently.
//!
//! # Examples
//!
//! ```no_run
//! use claude_core::ClaudePaths;
//!
//! let p = ClaudePaths::new().expect( "HOME must be set" );
//! println!( "credentials: {}", p.credentials_file().display() );
//! println!( "accounts:    {}", p.accounts_dir().display() );
//! println!( "projects:    {}", p.projects_dir().display() );
//! ```

use std::path::{ Path, PathBuf };

/// Canonical paths for all `~/.claude/` filesystem locations.
///
/// Computed from the `HOME` environment variable. Returns `None` from
/// [`ClaudePaths::new()`] if `HOME` is not set.
///
/// # Examples
///
/// ```no_run
/// use claude_core::ClaudePaths;
///
/// if let Some( p ) = ClaudePaths::new()
/// {
///   println!( "base: {}", p.base().display() );
/// }
/// ```
#[ derive( Debug, Clone ) ]
pub struct ClaudePaths
{
  base : PathBuf,
}

impl ClaudePaths
{
  /// Create a `ClaudePaths` from the `HOME` environment variable.
  ///
  /// Returns `None` if `HOME` is not set.
  ///
  /// # Examples
  ///
  /// ```no_run
  /// use claude_core::ClaudePaths;
  ///
  /// let p = ClaudePaths::new().expect( "HOME must be set" );
  /// ```
  #[ inline ]
  #[ must_use ]
  pub fn new() -> Option< Self >
  {
    let home = std::env::var( "HOME" ).ok()?;
    Some( Self { base : PathBuf::from( home ).join( ".claude" ) } )
  }

  /// Base `~/.claude/` directory.
  #[ inline ]
  #[ must_use ]
  pub fn base( &self ) -> &Path
  {
    &self.base
  }

  /// Path to `~/.claude/.credentials.json` — active OAuth token.
  #[ inline ]
  #[ must_use ]
  pub fn credentials_file( &self ) -> PathBuf
  {
    self.base.join( ".credentials.json" )
  }

  /// Path to `~/.claude/accounts/` — named credential snapshots.
  #[ inline ]
  #[ must_use ]
  pub fn accounts_dir( &self ) -> PathBuf
  {
    self.base.join( "accounts" )
  }

  /// Path to `~/.claude/projects/` — conversation history root.
  #[ inline ]
  #[ must_use ]
  pub fn projects_dir( &self ) -> PathBuf
  {
    self.base.join( "projects" )
  }

  /// Path to `~/.claude/stats-cache.json` — usage statistics.
  #[ inline ]
  #[ must_use ]
  pub fn stats_file( &self ) -> PathBuf
  {
    self.base.join( "stats-cache.json" )
  }

  /// Path to `~/.claude/settings.json` — user settings.
  #[ inline ]
  #[ must_use ]
  pub fn settings_file( &self ) -> PathBuf
  {
    self.base.join( "settings.json" )
  }

  /// Path to `~/.claude/session-env/` — per-session environment records.
  #[ inline ]
  #[ must_use ]
  pub fn session_env_dir( &self ) -> PathBuf
  {
    self.base.join( "session-env" )
  }

  /// Path to `~/.claude/sessions/` — session records.
  #[ inline ]
  #[ must_use ]
  pub fn sessions_dir( &self ) -> PathBuf
  {
    self.base.join( "sessions" )
  }
}