Core library for git-workon, an opinionated git worktree workflow tool.

This crate (published as workon) provides the building blocks for cloning, initialising, and managing git repositories in a bare-repo-plus-worktrees layout.

Key types

• WorktreeDescriptor — wraps a git2 Worktree with rich metadata methods
• BranchType — controls how a branch is created for a new worktree
• WorkonConfig — reads workon.* settings from git config
• PullRequest / PrMetadata — PR reference parsing and gh CLI integration
• MoveOptions — options for move_worktree
• WorkonError and its sub-types — all error variants with miette diagnostics

Key functions

Example

use workon::{get_repo, get_worktrees, add_worktree, BranchType};

let repo = get_repo(None)?;

for wt in get_worktrees(&repo)? {
    println!("{}: {}", wt.name().unwrap_or("?"), wt.path().display());
}

let wt = add_worktree(&repo, "my-feature", BranchType::Normal, None, false)?;
println!("Created: {}", wt.path().display());

workon

Core library for git-workon: an opinionated git worktree workflow tool.

Published on crates.io as git-workon-lib (library name: workon).

Usage

[dependencies]
git-workon-lib = "0.1"

use workon::{get_repo, get_worktrees, add_worktree, BranchType};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let repo = get_repo(None)?;

    // List all worktrees
    for wt in get_worktrees(&repo)? {
        println!("{}: {}", wt.name().unwrap_or("?"), wt.path().display());
    }

    // Create a new worktree
    let wt = add_worktree(&repo, "my-feature", BranchType::Normal, None)?;
    println!("Created worktree at {}", wt.path().display());

    Ok(())
}

API docs

Full API documentation is on docs.rs.