Skip to content
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,8 @@ require("oil").setup({
},
-- Extra arguments to pass to SCP when moving/copying files over SSH
extra_scp_args = {},
-- Extra arguments to pass to aws s3 when creating/deleting/moving/copying files using aws s3
extra_s3_args = {},
-- EXPERIMENTAL support for performing file operations with git
git = {
-- Return true to automatically git add/mv/rm files
Expand Down Expand Up @@ -355,6 +357,16 @@ This may look familiar. In fact, this is the same url format that netrw uses.

Note that at the moment the ssh adapter does not support Windows machines, and it requires the server to have a `/bin/sh` binary as well as standard unix commands (`ls`, `rm`, `mv`, `mkdir`, `chmod`, `cp`, `touch`, `ln`, `echo`).

### S3

This adapter allows you to browse files stored in aws s3. To use it, make sure `aws` is setup correctly and then simply open a buffer using the following name template:

```
nvim oil-s3://[bucket]/[path]
```

Note that older versions of Neovim don't support numbers in the url, so for Neovim 0.11 and older the url starts with `oil-sss`.

## Recipes

- [Toggle file detail view](doc/recipes.md#toggle-file-detail-view)
Expand Down
6 changes: 4 additions & 2 deletions doc/oil.txt
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@ CONFIG *oil-confi
},
-- Extra arguments to pass to SCP when moving/copying files over SSH
extra_scp_args = {},
-- Extra arguments to pass to aws s3 when creating/deleting/moving/copying files using aws s3
extra_s3_args = {},
-- EXPERIMENTAL support for performing file operations with git
git = {
-- Return true to automatically git add/mv/rm files
Expand Down Expand Up @@ -428,7 +430,7 @@ icon *column-ico
the icon

size *column-size*
Adapters: files, ssh
Adapters: files, ssh, s3
Sortable: this column can be used in view_props.sort
The size of the file

Expand Down Expand Up @@ -476,7 +478,7 @@ atime *column-atim
{format} `string` Format string (see :help strftime)

birthtime *column-birthtime*
Adapters: files
Adapters: files, s3
Sortable: this column can be used in view_props.sort
The time the file was created

Expand Down
Loading