orzbob Documentation

Become a 100x engineer with improved workflow

orzbob is a terminal-based session manager designed to help developers manage multiple project sessions efficiently using git worktrees and tmux.

Getting Started

To get started with orzbob, you'll need to install it on your system.

curl -fsSL https://raw.githubusercontent.com/carnivoroustoad/orzbob/main/install.sh | bash

This command will install orzbob, along with its dependencies (tmux and GitHub CLI) if they are not already installed.

Requirements

A Unix-like operating system (MacOS, Linux)
Git
Tmux (installed automatically)
GitHub CLI (installed automatically)

Commands

Here are the main commands available in orzbob:

Basic Commands

orz

Run this in a git repository to initialize orzbob and manage your sessions.

orz new [branch-name]

Create a new session with the specified branch name. This will create a new git worktree.

orz list

List all available sessions.

orz switch [session-name]

Switch to an existing session.

orz delete [session-name]

Delete a session and its associated git worktree.

Advanced Commands

orz update

Check for and install updates to orzbob.

orz help

Display help information about orzbob commands.

Configuration

orzbob can be configured to suit your workflow preferences. The configuration file is located at:

~/.config/orzbob/config.json

You can customize the following settings:

Default Branch: The default branch to use when creating new worktrees.
Tmux Configuration: Customize how tmux sessions are created and managed.
Git Integration: Configure how orzbob interacts with git repositories.

Git Integration

orzbob uses git worktrees to create isolated development environments for each session. This allows you to work on multiple branches simultaneously without having to stash or commit your changes.

When you create a new session, orzbob will:

Create a new git worktree at ~/.orzbob/worktrees/[branch-name]
Set up a new tmux session for the worktree
Provide an isolated environment for your development

Tmux Usage

orzbob leverages tmux to manage terminal sessions. Here are some helpful tmux commands that you can use while working with orzbob:

Ctrl+b d: Detach from the current tmux session
Ctrl+b c: Create a new window
Ctrl+b n: Go to the next window
Ctrl+b p: Go to the previous window
Ctrl+b %: Split the window vertically
Ctrl+b ": Split the window horizontally
Ctrl+b arrow keys: Navigate between panes

FAQ

How do I update orzbob?

You can update orzbob by running:

orz update

Can I use orzbob with non-GitHub repositories?

Yes, orzbob works with any git repository. The GitHub CLI integration is primarily for convenience features.

How do I report issues or request features?

You can report issues or request features on the GitHub issues page.

Does orzbob work on Windows?

orzbob is primarily designed for Unix-like operating systems (macOS, Linux). Windows support may be limited.

How can I contribute to orzbob?

Contributions are welcome! Check out our contributing guidelines to get started.