Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ten3roberts/graphene.nvim
Simple asynchronous file viewer for Neovim
https://github.com/ten3roberts/graphene.nvim
Last synced: about 2 months ago
JSON representation
Simple asynchronous file viewer for Neovim
- Host: GitHub
- URL: https://github.com/ten3roberts/graphene.nvim
- Owner: ten3roberts
- License: mit
- Created: 2022-05-03T16:58:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-15T20:11:07.000Z (11 months ago)
- Last Synced: 2024-02-15T21:27:50.181Z (11 months ago)
- Language: Lua
- Size: 78.1 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Graphene
A simple asynchronous file explorer.
A developer should not be hindered by their file explorer.
Graphene allows you to easily browse your project, folder by folder, creating
files, moving them around, and perhaps most importantly: opening them.
Graphene is **not** a tree viewer. The mind only has so much capacity, and as
such, Graphene focuses on your immediate surroundings letting you be focused on
the files at hand.
## Setup
Simply call:
```lua
require "graphene".setup {}
```
## Configuration
```lua
local actions = require "graphene.actions"
require "graphene".setup {
format_item = require "graphene.icons".format,
highlight_items = require "graphene.icons".highlight,
sort = default_sort,
override_netrw = true,
mappings = {
[""] = actions.edit,
[""] = actions.edit,
["q"] = actions.quit,
["l"] = actions.edit,
[""] = actions.split,
[""] = actions.vsplit,
["u"] = actions.up,
["h"] = actions.up,
["i"] = actions.open,
["r"] = actions.rename,
["D"] = actions.delete,
[","] = actions.toggle_selected,
["y"] = actions.yank,
["d"] = actions.cut,
["p"] = actions.paste,
[""] = actions.open_dir_external,
["o"] = actions.open_external,
}
```
## Usage
```vim
:edit . " Open cwd
:edit /path/to/directory
```
or
```vim
Graphene " Open directory of current file
Graphene . " Open cwd
```
Graphene is also accessible through a lua api, if desired.
```lua
lua require"graphene".init([path])
```
## Bulk File Operations
At any point, or or more files can be selected with `,`.
Use `d` to cut the files.
Navigate or create a folder and hit `p` to paste. The files will be moved to the
new location.
Use `y` to copy the marked files, and paste them with `p`.
If in visual mode, the currently selected lines will be used instead of the
marked items.
The clipboard is shared between all graphene instances, which means you can
copy, cut and paste between splits.
Use `d` to cut the files.
Navigate or create a folder and hit `p` to paste. The files will be moved to the
new location.
Use `y` to copy the marked files, and paste them with `p`.
If in visual mode, the currently selected lines will be used instead of the
marked items.
The clipboard is shared between all graphene instances, which means you can
copy, cut and paste between splits.