Code Monkey home page Code Monkey logo

ff's Introduction

ff

ff is file manager written in Go.

Features

  • preview file/directory
  • copy/paste file
  • make a new file/directory
  • rename a file/directory
  • edit file with $EDITOR
  • open file/directory
  • bookmark directory

Go version

  • 1.13~

Support OS

  • Linux/Unix
  • Mac

Installtion

$ git clone https://github.com/skanehira/ff
$ cd ff
$ go install

NOTE: Installation with go get is not recommended because libraries's version is not locked.

Usage

Settings

If your terminal LC_CTYPE is not en_US.UTF-8, please set as following.

export LC_CTYPE=en_US.UTF-8

Options

$ ff -h
Usage of ff:
  -ignorecase
        ignore case when searching
  -log
        enable log
  -preview
        enable preview panel

If you use -log that will print log. If log file not exists, then will be create in $XDG_CONFIG_HOME/ff/ff.log.

-preview is enable preview panel that you can preview file or directories.

Config

You can using config.yaml to config log, preview, etc...

# print log to file
log:
  enable: true
  file: $XDG_CONFIG_HOME/ff/ff.log

# preview the contents of file or directory
preview:
  enable: true
  # preview colorscheme. you can use colorscheme following
  # https://xyproto.github.io/splash/docs/all.html
  colorscheme: monokai

# if ignore_case is true, ignore case when searching
ignore_case: true

# if enable is true, can use bookmark
bookmark:
  enable: true
  file: $XDG_CONFIG_HOME/ff/bookmark.db

The config.yaml should be placed in the following path.

OS path
MacOS $HOME/Library/Application Support/ff/config.yaml
Linux/Unix $XDG_CONFIG_HOME/ff/config.yaml

About bookmark

ff can use b to bookmark directory. bookmark will be stored sqlite3 database. If you want enable bookmark, you have to specify database file.

Database file will auto create when ff starting. If ff can't create database file, then will use inmemory mode.

The inmemory mode will save bookmark to memory, so if ff quit bookmarks will lost.

About Edit file

If you runing ff in Vim's terminal and $EDITOR is vim, ff will use running Vim to edit file.

About open action

If you use o to open file or directory, ff will using open in MacOS, xdg-open in Linux. You can set environment variable FF_OPEN_CMD to change open command.

About executing command

ff can executing command, but it can't use stdin, stdout, stderr. Example, if you run vim , ff will freeze. So, you only can executing command that doesn't use stdin, stdout, stderr.

Keybinding

path

key operation
tab focus to files
Enter change directory

files

key operation
tab focus to files
tab focus to path
j move to next
k move to previous
g move to top
G move to bottom
ctrl-b move previous page
ctrl-f move netxt page
h cd to specified path
l cd to parent path
y copy selected file
p paste copy file to current directory
d delete selected file or directory
m make a new dir
n make a new file
r rename a dir or file
e edit file with $EDITOR
o open file or directory
f// search files or directories
ctrl-j scroll preview panel down
ctrl-k scroll preview panel up
c/: focus cmdline panel
. edit config.yaml
b bookmark dirctory
B open bookmarks panel

bookmark

key operation
a add bookmark
d delete bookmark
q close bookmarks panel
ctrl-g go to bookmark
f// search bookmarks

cmd

key operation
enter executing command
tab/esc focus files

Author

skanehira

ff's People

Contributors

skanehira avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.