nut 🔩

A workspace manager for working with multiple GitHub repositories simultaneously.

Overview

nut creates isolated workspaces for organizing and managing clones of GitHub repositories. The import command uses a local cache reduce cloning time to a minimum.

This package is experimental and not feature complete.

Installation

Cargo

Install cargo by following the instructions in the cargo book, then install the nut-workspace crate:

cargo install nut-workspace

Usage

nut --help

Create a workspace

nut create --description "Description of your workspace"

This creates a new workspace and starts a shell session within it.

List workspaces

nut list

Enter an existing workspace

nut enter <workspace-id>

Import repositories

Import a single repository:

nut import --user <username> --repo <repository> --github-token <token>

Import all repositories from a user:

nut import --user <username> --github-token <token>

Import all repositories from an organization:

nut import --org <organization> --github-token <token>

Status command

Check the status of all repositories in the workspace:

nut status

Other commands

• nut cache-dir - Print git cache directory path
• nut data-dir - Print workspace data directory path

Not implemented yet

• nut reset - Reset changes in workspace
• nut commit --message <msg> - Commit changes
• nut submit [--branch <name>] [--create-pr] - Submit changes

How it works

nut maintains two directories:

• Cache directory: Stores bare git repositories as mirrors for fast cloning
• Data directory: Contains individual workspaces, each with their own repository clones

When importing repositories, nut first creates or updates a cached bare clone, then uses git clone --local to create fast workspace copies. Workspaces are identified by ULID timestamps. nut is smart and just knows when the cache repositories need updating.

Development

Running Tests

The project includes integration tests that verify the CLI behavior:

cargo test

For more information about the testing strategy, see tests/README.md.

Building

cargo build --release

License

See LICENSE file for details.