Struct Forge 

pub struct Forge { /* private fields */ }

Main entry point for ForgeKit SDK.

The Forge type provides access to all code intelligence modules.

Implementations

impl Forge

pub async fn open(path: impl AsRef<Path>) -> Result<Self>

Opens a Forge instance on given codebase path.

This will create or open a graph database at .forge/graph.db within the codebase directory. Uses SQLite backend by default.

Arguments

• path - Path to codebase directory

Returns

A Forge instance or an error if database cannot be opened.

pub async fn open_with_backend( path: impl AsRef<Path>, backend: BackendKind, ) -> Result<Self>

Opens a Forge instance with a specific backend.

Arguments

• path - Path to codebase directory
• backend - Backend kind (SQLite or Native V3)

Returns

A Forge instance or an error if database cannot be opened.

pub fn backend_kind(&self) -> BackendKind

Returns the backend kind currently in use.

pub fn graph(&self) -> GraphModule

Returns the graph module for symbol and reference queries.

pub fn search(&self) -> SearchModule

Returns the search module for semantic code queries.

pub fn cfg(&self) -> CfgModule

Returns the CFG module for control flow analysis.

pub fn edit(&self) -> EditModule

Returns the edit module for span-safe refactoring.

pub fn analysis(&self) -> AnalysisModule

Returns the analysis module for combined operations.

pub fn build(&self) -> Option<BuildModule>

Returns the build module for build system operations.

Detects the build system from the codebase root. Returns None if no known build system is detected.

pub fn as_workspace(&self) -> Result<Workspace>

Returns the workspace view for monorepo awareness.

pub fn project(&self) -> ProjectModule

Returns the project module for scaffolding and detection.

pub fn dependency(&self) -> DependencyModule

Returns the dependency module for manifest operations.

pub fn codebase_path(&self) -> &Path

Returns the codebase path.

pub fn db_path(&self) -> &Path

Returns the resolved database path.

This is where the SQLite or Native V3 database file lives, as determined by the magellan registry or the ~/.magellan/<stem>/<stem>.db fallback.

Trait Implementations

impl Clone for Forge

fn clone(&self) -> Forge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Forge

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

Formats the value using the given formatter.