Development Guide

# macOS
brew install just

# Windows
winget install Casey.Just        # or: scoop install just

# Linux (Debian/Ubuntu)
sudo apt install just            # Ubuntu 24.04+, otherwise use cargo

# Any platform with Rust installed
cargo install just

git clone https://github.com/librefang/librefang.git
cd librefang

# Build + install CLI with dashboard (recommended for first-time setup)
just install

# Build workspace libraries only
just build

# Run all tests
just test

# Lint (must have zero clippy warnings)
just lint

# Local CI simulation: build + test + clippy + web lint
just ci

# Build entire workspace (dashboard assets are pre-committed, no extra step needed)
cargo build --workspace

# Build CLI only
cargo build -p librefang-cli

# Build desktop app
cargo build -p librefang-desktop

# Initialize config (~/.librefang/config.toml)
librefang init

# Start the daemon
librefang start

# Open dashboard: http://127.0.0.1:4545/

# Rebuild dashboard assets
just dashboard-build

# Or manually:
cd crates/librefang-api/dashboard
pnpm install --frozen-lockfile
pnpm run build
cd ../../..
cargo build -p librefang-cli

# Option A: start daemon + dashboard dev server together
just dev

# Option B: manually
librefang start                          # Terminal 1: backend daemon
cd crates/librefang-api/dashboard        # Terminal 2: Vite dev server
pnpm install && pnpm dev
# Open http://localhost:5173/dashboard/  # Auto-proxies /api to 127.0.0.1:4545

# Run all tests
cargo test --workspace

# Run specific crate
cargo test -p librefang-kernel

# Run doc tests
cargo test --doc

# Must have zero warnings
cargo clippy --workspace --all-targets -- -D warnings

# Format check
cargo fmt --all -- --check

librefang/
├── Cargo.lock
├── Cargo.toml
├── crates/
│   ├── librefang-cli/          # CLI tool
│   ├── librefang-api/         # REST API server
│   ├── librefang-kernel/      # Core kernel
│   ├── librefang-runtime/     # Agent runtime
│   ├── librefang-memory/      # Memory subsystem
│   ├── librefang-types/       # Shared types
│   ├── librefang-channels/    # Channel adapters
│   ├── librefang-skills/      # Skill system
│   ├── librefang-hands/       # Hands system
│   ├── librefang-wire/        # P2P protocol
│   ├── librefang-desktop/     # Desktop app
│   ├── librefang-migrate/     # Migration tools
│   └── librefang-extensions/   # Extensions
├── xtask/                      # Build scripts
├── docs/                       # Project documentation
└── scripts/                    # Helper scripts

// crates/librefang-channels/src/my_channel.rs

use async_trait::async_trait;
use std::pin::Pin;
use futures::Stream;
use crate::types::{ChannelAdapter, ChannelContent, ChannelMessage, ChannelStatus, ChannelType, ChannelUser};

pub struct MyChannel {
    // channel-specific fields (e.g. API client, config)
}

#[async_trait]
impl ChannelAdapter for MyChannel {
    fn name(&self) -> &str {
        "my_channel"
    }

    fn channel_type(&self) -> ChannelType {
        ChannelType::Custom("my_channel".to_string())
    }

    async fn start(
        &self,
    ) -> Result<
        Pin<Box<dyn Stream<Item = ChannelMessage> + Send>>,
        Box<dyn std::error::Error + Send + Sync>,
    > {
        // Return a stream of incoming messages
        todo!()
    }

    async fn send(
        &self,
        _user: &ChannelUser,
        _content: ChannelContent,
    ) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        // Send response back to the user
        Ok(())
    }

    async fn stop(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        Ok(())
    }
}

// crates/librefang-channels/src/lib.rs — add the feature-gated module
#[cfg(feature = "channel-my-channel")]
pub mod my_channel;

// crates/librefang-types/src/config.rs

#[derive(Debug, Clone, Deserialize)]
pub struct MyChannelConfig {
    pub api_key_env: String,
    pub allowed_users: Option<Vec<String>>,
}

# skills/my-skill/skill.toml
name = "my-skill"
version = "1.0.0"
description = "My custom skill"

[runtime]
type = "python"
entrypoint = "main.py"

[tools]
provided = ["my_tool"]

[requirements]
packages = ["requests"]

# skills/my-skill/main.py

def my_tool(param: str) -> str:
    """My custom tool description"""
    # Implement logic
    return f"Result: {param}"

# Register tools
TOOLS = [my_tool]

# Skills are automatically compiled into binary
cargo build --workspace

// crates/librefang-runtime/src/tools/mod.rs

use crate::tool::{Tool, ToolResult};

pub struct MyTool;

impl Tool for MyTool {
    fn name(&self) -> &str {
        "my_tool"
    }

    fn description(&self) -> &str {
        "My custom tool description"
    }

    async fn execute(&self, params: Value) -> ToolResult {
        // Implement tool logic
        Ok(Value::String("result".to_string()))
    }
}

// crates/librefang-runtime/src/lib.rs

pub fn register_tools(registry: &mut ToolRegistry) {
    registry.register(MyTool::new());
}

// crates/librefang-runtime/src/llm/my_provider.rs

use crate::llm::{LlmDriver, LlmResponse, LlmError};

pub struct MyProvider {
    api_key: String,
    base_url: String,
}

#[async_trait]
impl LlmDriver for MyProvider {
    async fn complete(&self, prompt: &str) -> Result<LlmResponse, LlmError> {
        // Call API
        Ok(LlmResponse {
            text: "response".to_string(),
            tokens: 100,
        })
    }
}

// crates/librefang-types/src/models.rs

pub fn get_provider(name: &str) -> Option<Box<dyn LlmDriver>> {
    match name {
        "my_provider" => Some(Box::new(MyProvider::new())),
        _ => None,
    }
}

# Format: <type>(<scope>): <description>

git commit -m "feat(kernel): add new scheduling algorithm"
git commit -m "fix(channels): resolve Slack rate limit"
git commit -m "docs(api): update endpoint documentation"
git commit -m "test(runtime): add tool execution tests"

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_my_function() {
        assert_eq!(my_function(2), 4);
    }
}

#[tokio::test]
async fn test_agent_spawn() {
    let kernel = Kernel::new().await;
    let agent = kernel.spawn("test-agent").await;
    assert!(agent.is_running());
}

#[tokio::bench]
async fn benchmark_llm_call(b: &mut Bencher) {
    b.iter(|| {
        runtime.block_on(llm.complete("test prompt"))
    })
}

use tracing::{info, warn, error};

info!("Starting agent {}", agent_id);
warn!("Rate limit exceeded for channel {}", channel_id);
error!("Failed to connect to provider: {}", error);

# Enable verbose logging
RUST_LOG=debug cargo run

# See specific module only
RUST_LOG=librefang_kernel=trace cargo run

# 1. Check that the daemon is running and healthy
curl -s http://127.0.0.1:4545/api/health

# 2. Verify the HTML is served (should return <!doctype html>...)
curl -s http://127.0.0.1:4545/ | head -5

# 3. Test a specific asset path (pick from the <script> tag in the HTML)
curl -sI http://127.0.0.1:4545/dashboard/assets/index-DVRukrPy.js
# 200 = OK, 404 = assets not embedded

# 4. If assets 404, rebuild the dashboard locally and recompile
just dashboard-build
cargo build -p librefang-cli --release

# Check API endpoints directly
curl -s http://127.0.0.1:4545/api/status | python3 -m json.tool
curl -s http://127.0.0.1:4545/api/agents | python3 -m json.tool

# Check browser console for CORS or auth errors (F12 → Console)
# Default install has no auth — if api_key is set, pass it:
curl -s -H "Authorization: Bearer YOUR_KEY" http://127.0.0.1:4545/api/status

# Vite proxies /api to http://127.0.0.1:4545 — make sure daemon is running
librefang status
# If not running:
librefang start

# CPU profiling
cargo flamegraph --bin librefang-cli -- start

cargo xtask release
#   1) stable  -> 2026.3.2314
#   2) beta    -> 2026.3.2314-beta1
#   3) rc      -> 2026.3.2314-rc1
#   4) lts     -> 2026.3.0-lts

cargo xtask release --dry-run --version "2026.3.0-lts"

v2026.3.0-lts     ← initial LTS
v2026.3.1-lts     ← patch 1 (bug fix)
v2026.3.2-lts     ← patch 2 (security fix)

# On main branch — choose option 4
cargo xtask release

# Switch to the LTS branch
git checkout release/2026.3

# Cherry-pick the fix from main
git cherry-pick <commit-sha>

# Release the patch (auto-increments patch number)
cargo xtask release --lts-patch