megafile

README

MegaFile

A simple and colorful TUI shell for Linux, written in Go.

This project can be used as the github.com/xyproto/megafile package, or as a standalone exectuable.

(screenshot of the previous version, before the project rename)

Building

make

Installation

make install

Commands

• any filename - edit file with $EDITOR
• cd, .. or any directory name - change directory
• ./script.sh - execute a script named script.sh
• ls or dir list directory (happens automatically, though)
• q, quit or exit - exit program

Hotkeys

Navigation and Selection

• ↑/↓/←/→ - navigate and select files
• Page Up/Down - jump to first/last entry in current column
• Home or ctrl-a - jump to first file (or start of line when typing)
• End or ctrl-e - jump to last file (or end of line when typing)

Execution

• Return - execute selected file, or run typed command
• Esc - clear selection (first press), exit program (second press)

Text Editing

• Backspace - delete character, or go up directory (when at start)
• ctrl-h - delete character, or toggle hidden files (when at start)
• ctrl-d - delete character under cursor, or exit program
• ctrl-k - delete text to the end of the line
• ctrl-c - clear text, or exit program

File Operations

• Tab - cycle through files, or tab completion
• ctrl-f - search for text in files

Directory Navigation

• ctrl-space - enter the most recent subdirectory
• ctrl-n - cycle to next directory
• ctrl-p - cycle to previous directory
• ctrl-b - go to parent directory

Display

• ctrl-o - toggle show hidden files
• ctrl-l - clear screen

External Tools

• ctrl-t - run tig
• ctrl-g - run lazygit

Exit

• ctrl-q - exit program immediately

General info

• Version: 1.3.2
• License: BSD-3
• Author: Alexander F. Rødseth <xyproto@archlinux.org>

Documentation

Overview

Package megafile provides functionality for a simple TUI for browsing files and directories

Index

• Variables
• func Cleanup(c *vt.Canvas)
• type FileEntry
• type State
  • func New(c *vt.Canvas, tty *vt.TTY, startdirs []string, startMessage, editor string) *State
  • func (s *State) Run() (string, error)

Variables

var ErrExit = errors.New("exit")

ErrExit is the error that is returned if the user appeared to want to exit

Functions

func Cleanup

func Cleanup(c *vt.Canvas)

Cleanup tries to set everything right in the terminal emulator before returning

Types

type FileEntry

type FileEntry struct {
	// contains filtered or unexported fields
}

FileEntry represents a file entry with position and name information

type State

type State struct {
	StartMessage string // title/header

	Directories []string

	AngleColor          vt.AttributeColor
	PromptColor         vt.AttributeColor
	TitleColor          vt.AttributeColor
	HighlightBackground vt.AttributeColor
	Background          vt.AttributeColor
	EdgeBackground      vt.AttributeColor
	WrittenTextColor    vt.AttributeColor

	ShowHidden bool
	// contains filtered or unexported fields
}

State holds the current state of the shell, then canvas and the directory structures

func New

func New(c *vt.Canvas, tty *vt.TTY, startdirs []string, startMessage, editor string) *State

New creates a new MegaFile State c and tty is a canvas and TTY, initiated with the vt package startdirs is a slice of directories to browse (toggle with tab) startMessage is the string to display at the top of the screen the function returns the absolute path to the directory the user ended up in, and an error if something went wrong

func (*State) Run

func (s *State) Run() (string, error)

Run launches a file browser