canola-collection

Optional adapters and extensions for canola.nvim. Install only what you need — canola core ships with the local filesystem adapter only.

Component	Description
canola-git	Git-aware hiding + git_status column
canola-ssh	Remote filesystem via SSH + SCP
canola-s3	AWS S3 via aws CLI
canola-ftp	FTP/FTPS via curl
canola-trash	OS-specific recycle bin
canola-resession	Session restore via resession.nvim

Installation

Install with your package manager of choice or via luarocks:

luarocks install canola-collection

Components are opt-in. Define a component's vim.g.canola_* table before canola-collection loads to register it. Empty tables enable defaults. No setup() call needed.

Configuration

Each component has its own vim.g table. Define only the ones you want; empty tables enable defaults.

canola-git

Git-aware hidden file filtering and a git_status column. Tracked dotfiles (.gitignore, .github/) stay visible. Gitignored files disappear. Directories show the most severe status among their children.

Define vim.g.canola_git to enable canola-git. An empty table enables defaults.

vim.g.canola_git = {
  show = { untracked = true, ignored = false },
  format = 'compact', -- 'compact' | 'symbol' | 'porcelain'
}

Add the column to your canola config:

vim.g.canola = {
  columns = { 'git_status', 'icon' },
}

The cache refreshes automatically on mutations, focus changes, buffer entry, and :! shell commands. To refresh manually:

require('canola-git').invalidate()

canola-ssh

Browse remote filesystems via SSH. Uses SCP for file transfers.

Define vim.g.canola_ssh to enable SSH support. An empty table enables defaults.

vim.g.canola_ssh = {
  extra_args = {},
  border = nil,
  recursive = false,
  hosts = {
    ['nas.local'] = { extra_args = { '-O' } },
  },
}

Open with :edit canola-ssh://user@host/path/.

canola-s3

Browse AWS S3 buckets via the aws CLI.

Define vim.g.canola_s3 to enable S3 support. An empty table enables defaults.

vim.g.canola_s3 = {
  extra_args = {},
  recursive = false,
  buckets = {
    ['my-r2'] = { extra_args = { '--endpoint-url', 'https://...' } },
  },
}

Open with :edit canola-s3://bucket/prefix/.

canola-ftp

Browse FTP/FTPS servers via curl.

Define vim.g.canola_ftp to enable FTP/FTPS support. An empty table enables defaults.

vim.g.canola_ftp = {
  extra_args = {},
  recursive = false,
  hosts = {
    ['ftp.example.com'] = { extra_args = { '--insecure' } },
  },
}

Open with :edit canola-ftp://host/path/ or canola-ftps://host/path/.

canola-trash

OS-specific recycle bin (freedesktop, macOS, Windows). Define vim.g.canola_trash to enable it. An empty table enables defaults:

vim.g.canola_trash = {}

canola-resession

Session restore via resession.nvim:

require('resession').setup({
  extensions = { canola = {} },
})

Documentation

:help canola-collection

Acknowledgements

• oil.nvim - the file explorer canola.nvim is built on
• resession.nvim - session restore framework
• @llakala - delete_to_trash bug report (#40)