superfile

https://superfile.dev
Admin
superfile is a modern terminal file manager with a focus on beautiful UI, complete functionality,...
Tokens:25,498
Snippets:421
Trust Score:6.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start Superfile

Source: https://superfile.dev/getting-started/installation

Run this command in your terminal to start the Superfile application after installation.

```bash
spf
```

--------------------------------

### Install dcompress using go get

Source: https://superfile.dev/notice

Installs the dcompress package using the go get command. Assumes a working Go installation on a Unix-like OS.

```bash
go get github.com/hotei/dcompress
```

--------------------------------

### Install Superfile with Homebrew

Source: https://superfile.dev/getting-started/installation

Install Superfile using the Homebrew package manager after installing Homebrew.

```bash
brew install superfile
```

--------------------------------

### Install Superfile with Scoop

Source: https://superfile.dev/getting-started/installation

Install Superfile using the Scoop package manager.

```bash
scoop install superfile
```

--------------------------------

### Install Superfile on NixOS with nix profile

Source: https://superfile.dev/getting-started/installation

Install Superfile using the nix profile command on NixOS.

```bash
nix profile install github:yorukot/superfile#superfile
```

--------------------------------

### Install dcompress using git clone

Source: https://superfile.dev/notice

Installs the dcompress package by cloning the repository. Use this if Go is not yet installed.

```bash
cd DestinationDirectory
git clone https://github.com/hotei/dcompress.git
```

--------------------------------

### Install Superfile with Pixi

Source: https://superfile.dev/getting-started/installation

Install Superfile globally using the Pixi package manager.

```bash
pixi global install superfile
```

--------------------------------

### Install Superfile on Linux/macOS with wget

Source: https://superfile.dev/getting-started/installation

Use this command to download and execute the Superfile installation script on Linux or macOS using wget.

```bash
bash -c "$(wget -qO- https://superfile.dev/install.sh)"
```

--------------------------------

### Install Superfile with Winget

Source: https://superfile.dev/getting-started/installation

Install Superfile using the Windows Package Manager (winget).

```bash
winget install --id yorukot.superfile
```

--------------------------------

### Install Superfile on Arch Linux with pacman

Source: https://superfile.dev/getting-started/installation

Install Superfile from the official Arch Linux repositories using pacman.

```bash
sudo pacman -S superfile
```

--------------------------------

### Install Superfile on Windows with PowerShell

Source: https://superfile.dev/getting-started/installation

Use this command to download and execute the Superfile installation script on Windows using PowerShell.

```powershell
powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.dev/install.ps1'))"
```

--------------------------------

### Install Superfile on Arch Linux with yay

Source: https://superfile.dev/getting-started/installation

Build and install the most recent version of Superfile from GitHub using the AUR helper yay.

```bash
yay -S superfile-git
```

--------------------------------

### Install Superfile on Linux/macOS with curl

Source: https://superfile.dev/getting-started/installation

Use this command to download and execute the Superfile installation script on Linux or macOS using curl.

```bash
bash -c "$(curl -sLo- https://superfile.dev/install.sh)"
```

--------------------------------

### Install a Specific Superfile Version on Linux/macOS

Source: https://superfile.dev/getting-started/installation

Specify a version using the SPF_INSTALL_VERSION environment variable when installing Superfile with curl.

```bash
SPF_INSTALL_VERSION=1.2.1 bash -c "$(curl -sLo- https://superfile.dev/install.sh)"
```

--------------------------------

### Install a Specific Superfile Version on Windows with PowerShell

Source: https://superfile.dev/getting-started/installation

Specify a version using the SPF_INSTALL_VERSION environment variable when installing Superfile with PowerShell.

```powershell
powershell -ExecutionPolicy Bypass -Command "$env:SPF_INSTALL_VERSION=1.2.1; Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.dev/install.ps1'))"
```

--------------------------------

### Set up Custom Hotkeys

Source: https://superfile.dev/configure/custom-hotkeys

Use this command to set up your custom hotkeys. Ensure you do not use hotkeys that conflict with Superfile's essential controls.

```bash
$EDITOR HOTKEYS_PATHcopy
```

--------------------------------

### Set Default Theme

Source: https://superfile.dev/configure/custom-theme

Use this command to open your configuration file and set a theme.

```bash
$EDITOR CONFIG_PATH
```

--------------------------------

### Configure Open With Mappings

Source: https://superfile.dev/configure/superfile-config

Map file extensions to specific commands for opening files. The file path is appended as the last argument to the command.

```toml
[open_with]
xopp = "xournalpp"
conf = "nvim"
```

--------------------------------

### Apply Existing Theme

Source: https://superfile.dev/configure/custom-theme

Modify your configuration file to use a specific theme by name.

```toml
- theme = 'catppuccin'
+ theme = 'theme_name_you_like'
```

--------------------------------

### Open Configuration File

Source: https://superfile.dev/configure/enable-plugin

Opens the Superfile configuration file using the default editor. Ensure you have located your config file path.

```bash
$EDITOR CONFIG_PATHcopy
```

--------------------------------

### Configuration Format for Plugins

Source: https://superfile.dev/configure/enable-plugin

Illustrates the TOML format for enabling or disabling plugins. Set plugin values to 'true' to enable or 'false' to disable.

```toml
metadata = false
enable_md5_checksum = false
zoxide_support = falsecopy
```

--------------------------------

### Showcase Superfile Features

Source: https://superfile.dev

Run this command to view a showcase of Superfile's various features and capabilities directly within the terminal.

```bash
superfile --showcase
```

--------------------------------

### Open Directory with Editor

Source: https://superfile.dev/getting-started/tutorial

Use the 'E' key binding to open the current directory with the configured default directory editor. Ensure your editor supports this functionality to avoid errors.

```shell
E
```

--------------------------------

### Vim-like Global Hotkeys Configuration

Source: https://superfile.dev/configure/custom-hotkeys

Defines global hotkeys for various Superfile actions, mimicking Vim controls. Ensure hotkeys are unique.

```toml
confirm = ['enter', '']
quit = ['ctrl+c', ''] # a.k.a. "theprimeagen troller"
cd_quit = ['Q', '']

list_up = ['k', '']
list_down = ['j', '']
page_up = ['pgup','']
page_down = ['pgdown','']

create_new_file_panel = ['n', '']
close_file_panel = ['q', '']
next_file_panel = ['tab', '']
previous_file_panel = ['shift+tab', '']
split_file_panel = ['N', '']
toggle_file_preview_panel = ['f', '']
open_sort_options_menu = ['o', '']
toggle_reverse_sort = ['R', '']

focus_on_process_bar = ['ctrl+p', '']
focus_on_sidebar = ['ctrl+s', '']
focus_on_metadata = ['ctrl+d', '']

file_panel_item_create = ['a', '']
file_panel_item_rename = ['r', '']

copy_items = ['y', '']
cut_items = ['x', '']
paste_items = ['p', '']
delete_items = ['d', '']
permanently_delete_items = ['D', '']

extract_file = ['ctrl+e', '']
compress_file = ['ctrl+a', '']

open_file_with_editor = ['e', '']
open_current_directory_with_editor = ['E', '']

pinned_directory = ['P', '']
toggle_dot_file = ['.', '']
change_panel_mode = ['m', '']
open_help_menu = ['?', '']
open_spf_prompt = ['>', '']
open_command_line = [':', '']
open_zoxide = ['z', '']
copy_path = ['Y', '']
copy_present_working_directory = ['c', '']
toggle_footer = ['ctrl+f', '']
```

--------------------------------

### Open Superfile Configuration File

Source: https://superfile.dev/configure/superfile-config

Use this command to open your Superfile configuration file in your default editor.

```shell
$EDITOR config_pathcopy
```

--------------------------------

### Specify Custom Config File Path

Source: https://superfile.dev/configure/config-file-path

Use the -c or --config-file flag to point to a custom location for the main config.toml file.

```bash
spf -c /path/to/your/config.toml
```

--------------------------------

### Open New Panel at Specified Path in SPF Mode

Source: https://superfile.dev/getting-started/tutorial

Use the 'open <PATH>' command in SPF mode to open a new panel at a specified directory. Environment variables and shell commands can be substituted.

```shell
open $(dirname $(which bash))
```

--------------------------------

### Specify Custom Hotkey File Path

Source: https://superfile.dev/configure/config-file-path

Use the --hotkey-file flag to specify a different path for the hotkey.toml file.

```bash
spf --hotkey-file /path/to/your/hotkey.toml
```

--------------------------------

### Use Superfile with X-CMD

Source: https://superfile.dev/getting-started/installation

Manage Superfile using the x-cmd toolbox, a package manager for Posix Shell.

```bash
x env use superfile
```

--------------------------------

### Default Catppuccin Mocha Theme Configuration

Source: https://superfile.dev/configure/custom-theme

This TOML file defines the 'Catppuccin Mocha' theme, showcasing all supported keys for Superfile's theming. It includes settings for code syntax highlighting, base colors, and various UI elements like file panels, sidebars, and modals.

```toml
##############################################
#                                            #
#           Catppuccin Mocha Theme           #
#                                            #
##############################################

# This theme was created by: https://github.com/AnshumanNeon ! Thank you <3

# This contains the theme config file for superfile! For more details see:
# https://superfile.dev/configure/custom-theme/

###############################################################################
#                           Code Syntax Highlighting                          #
###############################################################################

# Find one you like at: https://github.com/alecthomas/chroma/blob/master/styles.

code_syntax_highlight = "catppuccin-mocha"

###############################################################################
#                                 Base Colors                                 #
###############################################################################

#-- Full Screen
full_screen_fg = "#a6adc8"
full_screen_bg = "#1e1e2e"

#-- Gradient
# Note: This currently only supports two colors.
gradient_color = ["#89b4fa", "#cba6f7"]
directory_icon_color = ""

#-- File Panel
file_panel_fg = "#a6adc8"
file_panel_bg = "#1e1e2e"
file_panel_border = "#6c7086"
file_panel_border_active = "#b4befe"
file_panel_top_directory_icon = "#a6e3a1"
file_panel_top_path = "#89b5fa"
file_panel_item_selected_fg = "#98D0FD"
file_panel_item_selected_bg = "#1e1e2e"

#-- Footer
footer_fg = "#a6adc8"
footer_bg = "#1e1e2e"
footer_border = "#6c7086"
footer_border_active = "#a6e3a1"

#-- Sidebar
sidebar_fg = "#a6adc8"
sidebar_bg = "#1e1e2e"
sidebar_title = "#74c7ec"
sidebar_border = "#1e1e2e"
sidebar_border_active = "#f38ba8"
sidebar_item_selected_fg = "#A6DBF7"
sidebar_item_selected_bg = "#1e1e2e"
sidebar_divider = "#868686"

#-- Modals
modal_fg = "#a6adc8"
modal_bg = "#1e1e2e"
modal_border_active = "#868686"
modal_cancel_fg = "#383838"
modal_cancel_bg = "#eba0ac"
modal_confirm_fg = "#383838"
modal_confirm_bg = "#89dceb"

#-- Help Menu
help_menu_hotkey = "#89dceb"
help_menu_title = "#eba0ac"

#-- Special
cursor = "#f5e0dc"
correct = "#a6e3a1"
error = "#f38ba8"
hint = "#73c7ec"
cancel = "#eba0ac"
```

--------------------------------

### Open Fish Configuration File

Source: https://superfile.dev/configure/superfile-config

This command opens your Fish shell configuration file for editing.

```shell
$EDITOR ~/.config/fish/config.fishcopy
```

--------------------------------

### Enable Metadata Plugin in Configuration

Source: https://superfile.dev/configure/enable-plugin

Enables the metadata plugin by setting its value to 'true' in the configuration file. This is a common pattern for enabling any plugin.

```diff
- metadata = false
+ metadata = truecopy
```

```toml
metadata = truecopy
```

--------------------------------

### Add Superfile to NixOS flake inputs

Source: https://superfile.dev/getting-started/installation

Configure your NixOS flake to include Superfile as a dependency.

```nix
inputs = {
  superfile = {
    url = "github:yorukot/superfile";
  };
  # ...
};

```
Tokens:
Raw