https://github.com/GianlucaP106/mynav
Workspace and session management TUI
https://github.com/GianlucaP106/mynav
cli development go management productivity sessions terminal tmux tui workspaces
Last synced: 4 months ago
JSON representation
Workspace and session management TUI
- Host: GitHub
- URL: https://github.com/GianlucaP106/mynav
- Owner: GianlucaP106
- Created: 2024-04-25T02:45:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-31T01:52:50.000Z (5 months ago)
- Last Synced: 2025-01-31T02:34:01.433Z (5 months ago)
- Topics: cli, development, go, management, productivity, sessions, terminal, tmux, tui, workspaces
- Language: Go
- Homepage:
- Size: 4.44 MB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- trackawesomelist - mynav (⭐13)
README
# MyNav 🧭
A powerful terminal-based workspace navigator and session manager built in Go. MyNav helps developers organize and manage multiple projects through an intuitive interface, seamlessly integrating with tmux sessions.
[](LICENSE)
[](CONTRIBUTING.md)
## 🎤 Elevator Pitch
Before creating mynav, I often found myself frustrated when working on multiple projects using tmux, as I had to manually navigate between project directories. While tmux’s choose-tree feature allows jumping between active sessions, it relies on the tmux server staying alive and doesn't fully meet the needs of a robust workspace manager. mynav bridges this gap by combining tmux's powerful features with a workspace management system, enabling a more efficient and streamlined development workflow in a terminal environment.
## ✨ Features
- 📁 **Smart Workspace Organization**
- Group projects into topics for better organization
- Automatic git repository detection and status
- Quick workspace creation and navigation
- Customizable workspace hierarchy
- 💻 **Advanced Session Management**
- Seamless tmux session creation and switching
- Live session preview with window/pane information
- Bulk session operations (kill, detach)
- 🎯 **Modern Interface**
- Clean, intuitive terminal UI
- Vim-style navigation
- Quick updates and notifications
- Fuzzy search functionality
- 🔧 **Developer Experience**
- Git integration with repository status
- Built with tmux (uses tmux for sessions)
- Cross-platform support (macOS & Linux)
- Extensive keyboard shortcuts
## 🚀 Quick Start
### Try with docker
```bash
docker run -it --name mynav --rm ubuntu bash -c '
apt update &&
apt install -y git golang-go neovim tmux curl unzip &&
cd &&
(curl -fsSL https://raw.githubusercontent.com/GianlucaP106/mynav/main/install.bash | bash) &&
export PATH="$PATH:$HOME/.mynav" &&
mkdir nav && cd nav &&
mynav
'
```
### One-Line Installation
```bash
curl -fsSL https://raw.githubusercontent.com/GianlucaP106/mynav/main/install.bash | bash
```
### Manual Installation
```bash
# Clone the repository
git clone https://github.com/GianlucaP106/mynav.git
# Navigate to project directory
cd mynav
# Build project
go build
```
### Prerequisites
- Tmux 3.0+
- Git (optional, for repository features)
- Terminal with UTF-8 support
## 📖 Usage
### Basic Commands
```bash
# Launch mynav in current directory
mynav
# Launch in specific directory
mynav -path /your/project/path
# Check version
mynav -version
```
### Common Workflows
- **Creating a New Workspace and Session**
```bash
# Using the UI
mynav
# Press 'a' to create new topic
# Enter topic and press 'a' to create a workspace
# Enter the workspace session with 'Enter'
```
- **Managing Sessions**
```bash
# Using the UI
mynav
# Navigate to workspaces
# Press Enter to create/attach to session
# Navigate to sessions
# Press 'X' to kill session
# Press 'D' to detach from session
```
## ⌨️ Key Bindings
### Navigation
| Key | Action | Context |
|-----|--------|---------|
| `h/←` | Focus left panel | Global |
| `l/→` | Focus right panel | Global |
| `j/↓` | Move down | List views |
| `k/↑` | Move up | List views |
| `Tab` | Toggle focus | Search dialog |
| `Esc` | Close/cancel | Dialogs |
### Actions
| Key | Action | Context |
|-----|--------|---------|
| `Enter` | Open/select item | Global |
| `a` | Create new topic/workspace | Topics/Workspaces view |
| `D` | Delete item | Topics/Workspaces/Sessions view |
| `r` | Rename item | Topics/Workspaces view |
| `X` | Kill session | Workspaces/Sessions view |
| `s` | Search workspaces | Global |
| `?` | Toggle help menu | Global |
| `q` | Quit application | Global |
| `<` | Cycle preview left | Global |
| `>` | Cycle preview right | Global |
| `Ctrl+C` | Quit application | Global |
## ⚙️ Configuration
- MyNav uses a configuration system that supports multiple independent workspaces
- MyNav looks for configuration in the current or any parent directory
- Multiple independent directories can be initialized with MyNav
- Nested configurations are not allowed (invoking mynav nestedly will simply open the parent configuration)
- Home directory cannot be initialized as a MyNav workspace
## 🛠️ Development
### Setting Up Development Environment
Mynav is a straightforward, low-configuration project that only requires the Go runtime to get started in development.
## 🤝 Contributing
Ensure commits use conventional commits.
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---