From 13f721a03d8f865d9aaa0e43e92b2fd15d03d009 Mon Sep 17 00:00:00 2001 From: Roman Isaev Date: Thu, 21 May 2026 23:24:59 +0000 Subject: [PATCH] add README.org --- README.md | 2 -- README.org | 36 ++++++++++++++++++++++++++++++++++++ incus-tramp.el | 8 +++++--- 3 files changed, 41 insertions(+), 5 deletions(-) delete mode 100644 README.md create mode 100644 README.org diff --git a/README.md b/README.md deleted file mode 100644 index 3b5c8c7..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# incus-tramp - diff --git a/README.org b/README.org new file mode 100644 index 0000000..8d9c2a8 --- /dev/null +++ b/README.org @@ -0,0 +1,36 @@ +* incus-tramp - TRAMP integration for Incus containers + +=incus-tramp= is a simple intermediary layer which implements communication +logic between =TRAMP= and the =incus= CLI in order to access containers +similarly to how it is implemented for Docker, Podman, and other programs. + +** Key features: +- Connection to running Incus containers via the standard TRAMP interface. +- Access/editing of files within containers, as well as copying/moving files + to/from containers. +- Autocompletion from a list of running containers. +- Access to containers via multi-hop connections (e.g., =ssh -> ssh -> incus=). + +** Configuration + +#+begin_src emacs-lisp + (use-package incus-tramp :ensure nil :after tramp :vc + git@github.com:mdnight/incus-tramp.git :config (incus-tramp-enable-method)) +#+end_src + +** Usage + +This package implements the TRAMP method =incus= to access running containers: + +#+begin_example + +C-x C-f /incus:container:/path/to/file + +where + container is the name of the container. Names are normally equal to + names in the output of the command "incus list --columns=n". + +#+end_example + + +This package was inspired by the original [[https://gitlab.com/lckarssen/incus-tramp][incus-tramp]] package created by [[https://gitlab.com/lckarssen][Lennart C. Karssen]] diff --git a/incus-tramp.el b/incus-tramp.el index aabeddb..53ee2fd 100644 --- a/incus-tramp.el +++ b/incus-tramp.el @@ -11,18 +11,20 @@ ;; This file is not part of GNU Emacs. -;; GNU Emacs is free software: you can redistribute it and/or modify +;;; License: + +;; This program is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. -;; GNU Emacs is distributed in the hope that it will be useful, +;; This program is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License -;; along with GNU Emacs. If not, see . +;; along with this program. If not, see . ;;; Commentary: