Keep your side projects in orbit

Orbit is a powerful CLI tool and TUI application for managing your side projects. Built with Go, using Cobra for CLI, Bubble Tea for TUI, and Lip Gloss for styling.

Features

• Workspace Management - Initialize and manage multiple workspaces
• Project Organization - Create projects with repo, docs, and secret folders
• Status Tracking - Track project status (active, archived, done)
• Aliases - Set short aliases for projects with long names
• README Viewer - Beautiful markdown rendering in terminal

Installation

Quick Setup (Recommended)

Run the automated setup script to install all dependencies:

git clone https://github.com/henrynguci/orbit.git
cd orbit
./setup.sh

This script will automatically install:

• Go 1.21+
• glow (markdown viewer)
• All Go project dependencies

Manual Installation

If you prefer to install manually:

git clone https://github.com/henrynguci/orbit.git
cd orbit
go build -o orbit .

Move to PATH

sudo mv orbit /usr/local/bin/

CLI Commands

Initialize a Workspace

orbit init ~/my-workspace

orbit init ~/my-workspace --project my-project
orbit init ~/my-workspace -p my-project

With project, creates:

~/my-workspace/
└── project/
    └── my-project/
        ├── repo/
        ├── docs/
        └── secret/

List Projects

orbit ls

View Project Info

orbit info <project-name>

Set Project Status

orbit set <project-name> <status>

orbit set myproject active
orbit set oldproject archived
orbit set completed-project done

Get Project Status

orbit status <project-name>

Set Alias

orbit alias <project-name> <alias>

Configuration

Configuration is stored in ~/.config/orbit/config.json:

{
  "workspaces": [
    "/home/user/workspace1"
  ],
  "projects": {
    "myproject": {
      "name": "myproject",
      "alias": "mp",
      "path": "/home/user/workspace1/project/myproject",
      "status": "active"
    }
  }
}

Development

Prerequisites

• Go 1.21+

Build

make build

go build -o orbit .

Install

make install

License

MIT License - see LICENSE file for details.

Acknowledgments

• Charm for the amazing TUI libraries
• Cobra for CLI framework
• Glow for markdown rendering

---

Made with by henrynguci