elio

https://elio-fm.github.io/docs/
Admin
elio is a command-line file manager that helps users navigate directories, preview files, and select...
Tokens:6,472
Snippets:100
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start in Directory and Focus File

Source: https://elio-fm.github.io/docs/cli

Run 'elio Downloads/example.pdf' to start in 'Downloads' and focus on 'example.pdf'.

```bash
elio Downloads/example.pdf
```

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

### Start in Specific Directory

Source: https://elio-fm.github.io/docs/cli

Run 'elio Downloads' to start Elio in the 'Downloads' directory.

```bash
elio Downloads
```

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

### Install Preview Tools on FreeBSD

Source: https://elio-fm.github.io/docs

Installs Poppler utilities, FFmpeg, resvg, and 7-zip using pkg for expanded preview functionality.

```bash
pkg install poppler-utils ffmpeg resvg 7-zip
```

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

### Install Preview Tools on Windows with WinGet

Source: https://elio-fm.github.io/docs

Installs Poppler, FFmpeg, and 7-Zip using WinGet for enhanced preview capabilities. Note: resvg must be installed separately.

```bash
winget install --id oschwartz10612.Poppler -e
winget install --id Gyan.FFmpeg -e
winget install --id 7zip.7zip -e
```

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

### Install Preview Tools with Homebrew

Source: https://elio-fm.github.io/docs

Installs Poppler, FFmpeg, resvg, and sevenzip using Homebrew for enhanced preview features.

```bash
brew install poppler ffmpeg resvg sevenzip
```

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

### Install Preview Tools on Arch Linux

Source: https://elio-fm.github.io/docs

Installs Poppler, FFmpeg, resvg, and 7zip using pacman for enhanced preview support.

```bash
sudo pacman -S poppler ffmpeg resvg 7zip
```

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

### Install Preview Tools on Debian/Ubuntu

Source: https://elio-fm.github.io/docs

Installs Poppler utilities, FFmpeg, resvg, and 7zip using apt for broader file preview support.

```bash
sudo apt install poppler-utils ffmpeg resvg 7zip
```

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

### Install Preview Tools on Fedora

Source: https://elio-fm.github.io/docs

Installs Poppler utilities, FFmpeg, resvg, and 7zip using dnf for improved preview capabilities.

```bash
sudo dnf install poppler-utils ffmpeg resvg 7zip
```

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

### Install Preview Tools on Windows with Scoop

Source: https://elio-fm.github.io/docs

Installs Poppler, FFmpeg, resvg, and 7zip using Scoop for improved file preview support.

```bash
scoop install poppler ffmpeg resvg 7zip
```

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

### Chooser Mode: Start in Directory and Write to Stdout

Source: https://elio-fm.github.io/docs/cli

Run 'elio --chooser-file - Downloads' to start in 'Downloads' and write selected paths to standard output.

```bash
elio --chooser-file - Downloads
```

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

### Install Shell Integration

Source: https://elio-fm.github.io/docs/shell-integration

Run this command to automatically detect and install the appropriate shell integration for your current shell. Restart your shell or run the printed command to apply changes.

```shell
elio shell install
```

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

### Install Shell Integration for Fish

Source: https://elio-fm.github.io/docs/shell-integration

Installs elio's shell integration for the Fish shell. This command adds necessary configuration to your Fish environment.

```shell
elio shell install fish
```

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

### Current Directory: Start in Directory and Save on Exit

Source: https://elio-fm.github.io/docs/cli

Run 'elio --cwd-file /path/to/cwd-file Downloads' to start in 'Downloads' and save the final directory to the specified file upon exit.

```bash
elio --cwd-file /path/to/cwd-file Downloads
```

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

### Install Shell Integration for Bash

Source: https://elio-fm.github.io/docs/shell-integration

Installs elio's shell integration specifically for the Bash shell. This command modifies your Bash startup files.

```shell
elio shell install bash
```

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

### Configure Go-to Entries

Source: https://elio-fm.github.io/docs/configuration

Define custom entries for the go-to menu, including built-in locations, custom paths, and associated shortcut keys. Custom paths can be absolute or start with `~/`.

```toml
[goto]
entries = [
  "top",
  { builtin = "downloads", key = "D" },
  "home",
  "config",
  "trash",
  { title = "tmp", path = "/tmp", key = "T" },
]

```

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

### Install Shell Integration for Zsh

Source: https://elio-fm.github.io/docs/shell-integration

Installs elio's shell integration for the Zsh shell. This command updates your Zsh configuration files.

```shell
elio shell install zsh
```

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

### Install Shell Integration for Nushell

Source: https://elio-fm.github.io/docs/shell-integration

Installs elio's shell integration for Nushell. This command ensures elio works correctly within your Nushell environment.

```shell
elio shell install nu
```

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

### Configuration for Chooser Key

Source: https://elio-fm.github.io/docs/cli

Remap the key used to confirm selections in chooser mode by editing the 'config.toml' file. The example shows setting 'enter' as the confirmation key.

```toml
choose = "enter"
```

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

### Open Directory and Focus File

Source: https://elio-fm.github.io/docs/cli

Run 'elio example.png' to open the current directory and focus on 'example.png'.

```bash
elio example.png
```

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

### Configure UI Defaults

Source: https://elio-fm.github.io/docs/configuration

Set startup defaults for the user interface, including showing the top bar, hidden files, and grid view density. These settings can be changed while Elio is running.

```toml
[ui]
show_top_bar = true  # show top bar (default hidden)
show_hidden = true   # show dotfiles by default
start_in_grid = true # start in grid view
grid_zoom = 1        # grid density, 0–2

```

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

### Open Current Directory

Source: https://elio-fm.github.io/docs/cli

Run 'elio' to open the current directory in Elio.

```bash
elio
```

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

### Chooser Mode: Write to File

Source: https://elio-fm.github.io/docs/cli

Use '--chooser-file /path/to/choice-file' to run Elio as a picker and write selected paths to a specified file.

```bash
elio --chooser-file /path/to/choice-file
```

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

### Configure Key Bindings

Source: https://elio-fm.github.io/docs/configuration

Customize browser action bindings using single keys, lists of keys, named keys, and modifiers. Actions not specified retain their default bindings.

```toml
[keys]
open_with = ["O", "w"]                  # list = multiple keys
rename = ["r", "F2"]                    # named keys work too
search_files = "ctrl+f"                 # ctrl/alt/shift modifiers
nav_right = []                          # [] removes a default binding
open_or_enter = ["enter", "l", "right"] # reuse keys you freed
delete_permanently = "D"                # uppercase = shifted letter

```

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

### Chooser Mode: Write to Stdout

Source: https://elio-fm.github.io/docs/cli

Use '--chooser-file -' to run Elio as a picker and write selected paths to standard output.

```bash
elio --chooser-file -
```

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

### Configure Syntax Highlighting Colors

Source: https://elio-fm.github.io/docs/themes

Customize the colors for syntax-highlighted code previews, including background, foreground, line numbers, and specific token types like comments and keywords. Set `bg` to `none` for a transparent background.

```toml
[preview.code]
bg = "none"                 # preview background; none = transparent
fg = "#d7e3f4"              # normal code text
line_number = "#7b90a7"     # gutter line numbers
line_highlight = "#151515"  # active/current line

comment = "#6f8399"         # comments
string = "#79e7d5"          # quoted strings
keyword = "#7aaeff"         # language keywords
function = "#36d7ff"        # function names
invalid = "#ff8585"         # invalid/error tokens

```

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

### Current Directory: Save on Exit to File

Source: https://elio-fm.github.io/docs/cli

Use '--cwd-file /path/to/cwd-file' to save the directory where Elio exits to a specified file.

```bash
elio --cwd-file /path/to/cwd-file
```

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

### Configure Pane Layout

Source: https://elio-fm.github.io/docs/configuration

Adjust the relative weights for the Places, Files, and Preview panes. A value of 0 hides a pane. These are relative weights, not fixed column counts.

```toml
[layout.panes]
places = 10  # Places width; 0 hides it
files = 45   # Files width; must be > 0
preview = 45 # Preview width; 0 hides it

```

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

### Generate Bash Wrapper Snippet

Source: https://elio-fm.github.io/docs/shell-integration

Prints the wrapper snippet for Bash, which you can manually add to your shell configuration files. This allows for custom integration.

```shell
elio shell init bash
```

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

### Generate Zsh Wrapper Snippet

Source: https://elio-fm.github.io/docs/shell-integration

Generates the necessary wrapper snippet for Zsh. You can paste this output into your Zsh startup files for manual integration.

```shell
elio shell init zsh
```

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

### Configure Places Entries and Icons

Source: https://elio-fm.github.io/docs/configuration

Customize the pinned sidebar entries and whether the Devices section is visible. You can use built-in IDs or custom paths for entries, and specify custom icons.

```toml
[places]
show_devices = true # show Devices below Places
entries = [
  "home",         # built-in Place, default icon
  { builtin = "downloads", icon = "" },
  { title = "Projects", path = "~/workspace", icon = "󰚝" },
  "trash",
]

```

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

### Define Default File Class Icons and Colors

Source: https://elio-fm.github.io/docs/themes

Set the default icon and color for common file classes like directories, code files, and configuration files. These defaults can be overridden by specific extensions or filenames.

```toml
[classes.directory]
icon = "󰉋"         # folder icon
color = "#5ba8ff"  # folder color

[classes.code]
icon = "󰆍"         # default code-file icon
color = "#38d5ff"  # default code-file color

[classes.config]
icon = "󰒓"         # default config-file icon
color = "#b38cff"  # default config-file color

```

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

### Generate Nushell Wrapper Snippet

Source: https://elio-fm.github.io/docs/shell-integration

Outputs the wrapper snippet for Nushell. This allows for manual integration by adding the snippet to your Nushell configuration.

```shell
elio shell init nu
```

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

### Override File Extensions and Exact Names

Source: https://elio-fm.github.io/docs/themes

Provide specific icon and color overrides for particular file extensions (e.g., `.rs`) or exact filenames (e.g., `Cargo.toml`) and directory names (e.g., `node_modules`). These rules take precedence over class defaults.

```toml
[extensions.rs]
class = "code"     # reuse the code class
icon = ""         # Rust icon
color = "#dea584"  # Rust file color

[files."Cargo.toml"]
class = "config"   # exact filename override
icon = ""

[directories."node_modules"]
icon = "󰏗"         # exact directory-name override
color = "#6f7d8d"  # directory color

```

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

### Uninstall Shell Integration

Source: https://elio-fm.github.io/docs/shell-integration

Use this command to remove elio's shell integration. This will revert any changes made to your shell's startup files.

```shell
elio shell uninstall
```

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

### Generate Fish Wrapper Snippet

Source: https://elio-fm.github.io/docs/shell-integration

Provides the wrapper snippet for Fish shell integration. This snippet can be manually added to your Fish configuration.

```shell
elio shell init fish
```

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

### Define App-wide Color Palette

Source: https://elio-fm.github.io/docs/themes

Configure the main interface colors, including backgrounds, text, borders, and status markers. Colors can be specified as hex codes, ANSI color names, or indexed colors.

```toml
# Colors accept #rrggbb, ansi-blue, indexed-12, none, or transparent.
[palette]
# App surfaces
bg = "#050505"               # page background
chrome = "#0c0c0c"           # top/outer chrome
chrome_alt = "#101010"       # alternate chrome surfaces

panel = "#121212"            # file/preview panels
panel_alt = "#0f0f0f"        # alternate panels
surface = "#161616"          # cards, inputs, overlays
elevated = "#1d1d1d"         # raised overlay surfaces

border = "#303030"           # pane/card borders
path_bg = "#111111"          # path bar background

# Text
text = "#e7edf5"             # primary text
muted = "#8c97a8"            # secondary text
chip_text = "#0c0c0c"        # text on bright chips

# Controls and states
accent = "#7aaeff"           # focused controls and links
accent_soft = "#1a2740"      # subtle accent backgrounds
accent_text = "#eef4ff"      # text on accent surfaces
selected_bg = "#243758"      # selected row background
selected_border = "#9cbcff"  # selected pane border

# Status markers
selection_bar = "#ffb24a"    # selected/marked item bar
yank_bar = "ansi-green"      # copied item bar
cut_bar = "ansi-red"         # cut item bar
progress_bar = "#41a0dc"     # background operation progress

```

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

### Uninstall Shell Integration for Fish

Source: https://elio-fm.github.io/docs/shell-integration

Removes elio's shell integration from your Fish shell configuration.

```shell
elio shell uninstall fish
```

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

### Uninstall Shell Integration for Nushell

Source: https://elio-fm.github.io/docs/shell-integration

Removes elio's shell integration from your Nushell configuration.

```shell
elio shell uninstall nu
```

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

### Uninstall Shell Integration for Bash

Source: https://elio-fm.github.io/docs/shell-integration

Removes elio's shell integration specifically from your Bash configuration.

```shell
elio shell uninstall bash
```

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

### Uninstall Shell Integration for Zsh

Source: https://elio-fm.github.io/docs/shell-integration

Removes elio's shell integration from your Zsh configuration.

```shell
elio shell uninstall zsh
```
Tokens:
Raw