69 lines
2 KiB
Org Mode
69 lines
2 KiB
Org Mode
|
# -*- mode: doom-docs-org -*-
|
||
|
|
#+title: :tools chezmoi
|
||
|
|
#+subtitle: Manage your dotfiles with chezmoi inside Emacs
|
||
|
|
#+created: May 05, 2022
|
||
|
|
#+since: 22.05
|
||
|
|
|
||
|
|
* Description :unfold:
|
||
|
|
This module provides convenience functions for interacting with the [[https://chezmoi.io][chezmoi]]
|
||
|
|
dotfile management system via Emacs.
|
||
|
|
|
||
|
|
** Maintainers
|
||
|
|
- [[doom-user:][@abougouffa]]
|
||
|
|
|
||
|
|
** Module flags
|
||
|
|
/This module has no flags./
|
||
|
|
|
||
|
|
** Packages
|
||
|
|
- [[doom-package:][chezmoi]]
|
||
|
|
|
||
|
|
** TODO Hacks
|
||
|
|
#+begin_quote
|
||
|
|
🔨 This module's hacks haven't been documented yet. [[doom-contrib-module:][Document them?]]
|
||
|
|
#+end_quote
|
||
|
|
|
||
|
|
** TODO Changelog
|
||
|
|
# This section will be machine generated. Don't edit it by hand.
|
||
|
|
/This module does not have a changelog yet./
|
||
|
|
|
||
|
|
* Installation
|
||
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||
|
|
|
||
|
|
This module requires [[https://chezmoi.io][chezmoi]].
|
||
|
|
|
||
|
|
* TODO Usage
|
||
|
|
#+begin_quote
|
||
|
|
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||
|
|
#+end_quote
|
||
|
|
|
||
|
|
This module facilitate editing dotfiles managed by ~chezmoi~.
|
||
|
|
|
||
|
|
This module provides a set of Emacs commands that are equivalent to ~chezmoi~
|
||
|
|
commands, including:
|
||
|
|
|
||
|
|
| Command | chezmoi equivalent |
|
||
|
|
|--------------+--------------------|
|
||
|
|
| find-file | chezmoi edit |
|
||
|
|
| save-buffer | chezmoi apply |
|
||
|
|
| diff | chezmoi diff |
|
||
|
|
| ediff | chezmoi merge |
|
||
|
|
| magit-status | chezmoi git status |
|
||
|
|
|
||
|
|
More information can be found on the [[https://github.com/tuh8888/chezmoi.el][chezmoi.el]] GitHub page.
|
||
|
|
|
||
|
|
* TODO Configuration
|
||
|
|
#+begin_quote
|
||
|
|
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||
|
|
#+end_quote
|
||
|
|
|
||
|
|
* Troubleshooting
|
||
|
|
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||
|
|
|
||
|
|
* Frequently asked questions
|
||
|
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||
|
|
|
||
|
|
* TODO Appendix
|
||
|
|
#+begin_quote
|
||
|
|
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||
|
|
#+end_quote
|