Struct SpnPaths 

pub struct SpnPaths { /* private fields */ }

Centralized path management for the ~/.spn directory structure.

Provides type-safe access to all paths used by spn-cli, spn-daemon, and other tools in the SuperNovae ecosystem.

Implementations

impl SpnPaths

pub fn new() -> Result<Self, PathError>

Create paths rooted at the default location (~/.spn).

Returns an error if the HOME directory is not available.

Example

use spn_client::SpnPaths;

let paths = SpnPaths::new()?;
println!("Root: {:?}", paths.root());

pub fn with_root(root: PathBuf) -> Self

Create paths with a custom root directory.

Useful for testing or custom installations.

Example

use spn_client::SpnPaths;
use std::path::PathBuf;

let paths = SpnPaths::with_root(PathBuf::from("/tmp/spn-test"));
assert_eq!(paths.root().to_str().unwrap(), "/tmp/spn-test");

pub fn root(&self) -> &Path

Root directory (~/.spn).

pub fn bin_dir(&self) -> PathBuf

Binary directory (~/.spn/bin).

Contains symlinks or stubs for nika, novanet, etc.

pub fn packages_dir(&self) -> PathBuf

Packages directory (~/.spn/packages).

Structure: packages/@scope/name/version/

pub fn cache_dir(&self) -> PathBuf

Cache directory (~/.spn/cache).

Contains downloaded tarballs and temporary files.

pub fn tarballs_dir(&self) -> PathBuf

Tarballs cache directory (~/.spn/cache/tarballs).

pub fn registry_dir(&self) -> PathBuf

Registry cache directory (~/.spn/registry).

Contains cached package index data.

pub fn config_file(&self) -> PathBuf

Global configuration file (~/.spn/config.toml).

pub fn secrets_file(&self) -> PathBuf

Secrets file (~/.spn/secrets.env).

Alternative to OS keychain for storing API keys.

pub fn socket_file(&self) -> PathBuf

Daemon socket file (~/.spn/daemon.sock).

pub fn pid_file(&self) -> PathBuf

Daemon PID file (~/.spn/daemon.pid).

pub fn state_file(&self) -> PathBuf

State file (~/.spn/state.json).

Tracks installed packages and their versions.

pub fn package_dir(&self, name: &str, version: &str) -> PathBuf

Get the path for a specific package version.

Arguments

• name - Package name (e.g., “@workflows/code-review”)
• version - Package version (e.g., “1.0.0”)

Example

use spn_client::SpnPaths;
use std::path::PathBuf;

let paths = SpnPaths::with_root(PathBuf::from("/home/user/.spn"));
let pkg_path = paths.package_dir("@workflows/code-review", "1.0.0");
assert!(pkg_path.to_string_lossy().contains("@workflows"));

pub fn binary(&self, name: &str) -> PathBuf

Get the path for a binary stub.

Arguments

• name - Binary name (e.g., “nika”, “novanet”)

pub fn ensure_dirs(&self) -> Result<(), PathError>

Ensure all required directories exist.

Creates the following directories if they don’t exist:

• ~/.spn/
• ~/.spn/bin/
• ~/.spn/packages/
• ~/.spn/cache/
• ~/.spn/cache/tarballs/
• ~/.spn/registry/

Example

use spn_client::SpnPaths;

let paths = SpnPaths::new()?;
paths.ensure_dirs()?;

pub fn exists(&self) -> bool

Check if the root directory exists.

Trait Implementations

impl Clone for SpnPaths

fn clone(&self) -> SpnPaths

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpnPaths

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpnPaths

fn default() -> Self

Creates SpnPaths with the default root, panicking if HOME is unavailable.

Note: Prefer SpnPaths::new() which returns a Result.