chezmoi-mousse

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #golang #android #rust #deep-learning #linux #cli #vue #pytorch #openai

(★ 31)

GUI for chezmoi in the terminal, with a wink to the mouse. Built with textual. Manage dotfiles.

chezmoi-mousse 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fmatmaer%2Fchezmoi-mousse%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)
[![Framework: Textual](https://img.shields.io/badge/framework-Textual-5967FF?logo=textual)](https://www.textualize.io/)
[![Black](https://img.shields.io/github/actions/workflow/status/matmaer/chezmoi-mousse/linting.yml?branch=main&label=black&logo=black)](https://github.com/matmaer/chezmoi-mousse/actions/workflows/linting.yml)
[![Ruff](https://img.shields.io/github/actions/workflow/status/matmaer/chezmoi-mousse/linting.yml?branch=main&label=ruff&logo=ruff)](https://github.com/matmaer/chezmoi-mousse/actions/workflows/linting.yml)

> [!NOTE]
> It's safe to use the app to visualize your `chezmoi` repository, as no write operations are enabled by default.
> See the [Use Case](#use-case) to disable dry-run or [Test](#test) first with dummy files.
> The app is not packaged yet but you can simply run it as a `Python` module, see the [Start](#start) section.
> Please share any issues on the [Issues](https://github.com/matmaer/chezmoi-mousse/issues) page, thanks!

Graphical user interface in the terminal for [chezmoi](https://github.com/twpayne/chezmoi), see the [chezmoi docs](https://www.chezmoi.io/).

The rich visualization is made possible thanks to [textual](https://github.com/Textualize/textual), see the [textual docs](https://textual.textualize.io/).

Commands are issued using [Python](https://www.python.org/) its [Subprocess management](https://docs.python.org/3/library/subprocess.html).

## Screenshots

Check out the [Wiki Screenshots](https://github.com/matmaer/chezmoi-mousse/wiki/Screenshots)!

## Use Case

- You have an initilazed or existing chezmoi repository.
- To enable operations, press `D`, `d` or click the `Remove --dry-run` or `Add --dry-run` text in the footer. This will enable/disable commands changing your files or the chezmoi state. Test first in a VM or container, see the [Test](#test) section.
- Run the app with your own user. Running the app with `sudo` or elevated permissions is **not needed** and **should be avoided**. Chezmoi [explicitly](https://www.chezmoi.io/user-guide/frequently-asked-questions/design/#can-i-use-chezmoi-to-manage-files-outside-my-home-directory) discourages operating outside of your home directory.
- The current implementation has only been used or tested with `autocommit` enabled, feedback is welcome.

## Start

### Pre build binary for Linux

https://github.com/matmaer/chezmoi-mousse/releases/latest

```shell
wget https://github.com/matmaer/chezmoi-mousse/releases/latest/download/chezmoi-mousse
chmod +x chezmoi-mousse
./chezmoi-mousse
```

### Run from source all platforms

Clone the repository: `git clone https://github.com/matmaer/chezmoi-mousse.git`

Change directory: `cd chezmoi-mousse` and `cd src`

The easiest way is to run the app with `uv`, [install uv](https://docs.astral.sh/uv/getting-started/installation/) on your platform. Then in the chezmoi-mousse src directory, run:

`uv run --no-dev --python 3.13 --with textual -m chezmoi_mousse`

If Python 3.13 with `textual` is available in you env, in the `src` directory, you can run:

`python -m chezmoi_mousse`

> [!NOTE]
> Navigate to the "Config" tab and check the output from `chezmoi doctor`

## Test

To test the app without "real" dotfiles in a container or VM:

In the src directory of the cloned repository, you can run

`CHEZMOI_MOUSSE_DEBUG_MODE=1 uv run --python 3.13 --with textual -m chezmoi_mousse`

Then on the "Debug" tab, you can generate some files in the home directory, and offer the possibility to modify the generated files to have diffs.
Files are generated using the `Faker` [package](https://faker.readthedocs.io/en/master/#)

See the [Debug tab screenshot](https://github.com/matmaer/chezmoi-mousse/wiki/Screenshots#debug-tab)

### Platform packaging
- Apple
  - [ ] app store
  - [ ] single executable file
  - [x] run from source
- Linux
  - [ ] [AppImage](https://appimage.org/)
  - [ ] [flatpak](https://flatpak.org/)
  - [ ] [snap](https://snapcraft.io/)
  - [x] [single executable file](https://github.com/matmaer/chezmoi-mousse/releases/latest)
  - [x] run from source
- Windows
  - [ ] app store
  - [ ] single executable file
  - [x] run from source
)

## Available `chezmoi` commands

> [!NOTE]
> The lists for [Write Operations](#write-operations) and [Read Operations](#read-operations) below are a limited subset of available chezmoi commands, run `chezmoi help` in your terminal to see all commands.  Commands below without a checkmark are being implemented,
>
> See [Implemented configuration options](#implemented-configuration-options) below, not all flags are implemented, however usage with default flag values should run without errors. If you find an issue, please share it on the [Issues](https://github.com/matmaer/chezmoi-mousse/issues) page.

### Write Operations

- [ ] `chezmoi add` directory
- [x] `chezmoi add` file
- [ ] `chezmoi archive`
- [x] `chezmoi apply` directory
- [x] `chezmoi apply` file
- [x] `chezmoi destroy` directory
- [x] `chezmoi destroy` file
- [ ] `chezmoi edit`
- [x] `chezmoi forget` directory
- [x] `chezmoi forget` file
- [ ] `chezmoi generate`
- [ ] `chezmoi import`
- [ ] `chezmoi init` new repository
- [ ] `chezmoi init` clone repository
- [ ] `chezmoi purge`
- [x] `chezmoi re-add` file

### Read Operations

- [x] `chezmoi cat`
- [x] `chezmoi cat-config`
- [x] `chezmoi dump-config`
- [x] `chezmoi data`
- [x] `chezmoi diff`
- [x] `chezmoi doctor`
- [x] `chezmoi git log`
- [x] `chezmoi ignored`
- [x] `chezmoi managed`
- [x] `chezmoi source-dir`
- [x] `chezmoi status`
- [ ] `chezmoi unmanaged`

### Implemented configuration options

**Legend:**

- :green_circle: Follow user configuration or chezmoi defaults
- :green_square: Providing **flags** for the `chezmoi` command, managed by this app.
- :negative_squared_cross_mark: Not in scope
- :bulb: Follows user config with warning
- :black_circle: Under development, help wanted or to be documented

> [!NOTE] `chezmoi` command **flags** can override your local config file.
> See the [_run_cmd.py](https://github.com/matmaer/chezmoi-mousse/blob/main/src/chezmoi_mousse/_run_cmd.py) file for the exact flags in use.

### Top level

- :green_circle: cacheDir
- :green_square: color (`--no-color`, app manages color)
- :green_circle: data
- :green_circle: destDir
- :black_circle: encryption
- :black_circle: env
- :green_circle: format
- :green_square: interactive (`--interactive=false`, app provides safeguards but overrides user config!)
- :negative_squared_cross_mark: mode (`--mode=file`, only file mode is supported)
- :green_square: pager (`--no-pager`, app limits output)
- :green_square: pagerArgs
- :black_circle: persistentState
- :green_square: progress (`--progress=false`, app shows progress)
- :black_circle: scriptEnv
- :black_circle: scriptTempDir
- :green_circle: sourceDir
- :green_circle: tempDir (check the Config tab `chezmoi doctor` output for any issue)
- :green_circle: umask
- :black_circle: useBuiltinAge
- :green_square: useBuiltinGit (`--use-builtin-git=true`)
- :negative_squared_cross_mark: verbose (outputs are parsed without verbose flag)
- :black_circle: workingTree

add
- :black_circle: add.encrypt
- :black_circle: add.secrets
- :black_circle: add.templateSymlinks

age
- :black_circle: age.args
- :black_circle: age.command
- :black_circle: age.identities
- :black_circle: age.identity
- :black_circle: age.passphrase
- :black_circle: age.recipient
- :black_circle: age.recipients
- :black_circle: age.recipientsFile
- :black_circle: age.recipientsFiles
- :black_circle: age.suffix
- :black_circle: age.symmetric

awsSecretsManager
- :black_circle: awsSecretsManager.profile
- :black_circle: awsSecretsManager.region

azureKeyVault
- :black_circle: azureKeyVault.defaultVault

bitwarden
- :black_circle: bitwarden.command
- :black_circle: bitwarden.unlock

bitwardenSecrets
- :black_circle: bitwardenSecrets.command

cd
- :negative_squared_cross_mark: cd.args
- :negative_squared_cross_mark: cd.command

diff
- :negative_squared_cross_mark: diff.args (Start a discussion if you have a use case)
- :green_square: diff.command (`chezmoi --use-builtin-diff`)
- :negative_squared_cross_mark: diff.exclude (diffs are shown for a selected path)
- :green_square: diff.pager (`chezmoi --no-pager --use-builtin-diff`)
- :negative_squared_cross_mark: diff.pagerArgs
- :green_square: diff.reverse (`--reverse` flag is used to show diffs on the ReAdd tab)
- :black_circle: diff.scriptContents

edit
- :black_circle: edit.apply
- :black_circle: edit.args
- :black_circle: edit.command
- :black_circle: edit.hardlink
- :black_circle: edit.minDuration
- :black_circle: edit.watch

ejson
- :black_circle: ejson.key
- :black_circle: ejson.keyDir

git
- :black_circle: git.autoAdd
- :bulb: git.autoCommit
- :bulb: git.autoPush
- :green_circle: git.command (`chezmoi git -- <git_command>` is used to run `git`)
- :green_circle: git.commitMessageTemplate
- :green_circle: git.commitMessageTemplateFile
- :negative_squared_cross_mark: git.lfs (Start a discussion if you have a use case)

gitHub
- :green_circle: gitHub.refreshPeriod

gopass
- :black_circle: gopass.command
- :black_circle: gopass.mode

gpg
- :black_circle: gpg.args
- :black_circle: gpg.command
- :black_circle: gpg.recipient
- :black_circle: gpg.recipients
- :black_circle: gpg.suffix
- :black_circle: gpg.symmetric

hooks
- :black_circle: hooks.command.post.args
- :black_circle: hooks.command.post.command
- :black_circle: hooks.command.pre.args
- :black_circle: hooks.command.pre.command

interpreters
- :black_circle: interpreters.extension.args
- :black_circle: interpreters.extension.command

keepassxc
- :black_circle: keepassxc.args
- :black_circle: keepassxc.command
- :black_circle: keepassxc.database
- :black_circle: keepassxc.mode
- :black_circle: keepassxc.prompt

merge
- :black_circle: merge.args
- :black_circle: merge.command

pass
- :black_circle: pass.command

pinentry
- :black_circle: pinentry.args
- :black_circle: pinentry.command
- :black_circle: pinentry.options

rbw
- :black_circle: rbw.command

secret
- :black_circle: secret.args
- :black_circle: secret.command

status
- :green_square: status.pathStyle
- :green_square: status.exclude

template
- [x] `chezmoi re-add` directory
- :black_circle: template.options

textconv
- :black_circle: textconv

update
- :black_circle: update.apply
- :black_circle: update.args
- :black_circle: update.command
- :black_circle: update.recurseSubmodules

vault
- :black_circle: vault.command

verify
- :negative_squared_cross_mark: verify.exclude

warnings
- :black_circle: warnings

## Textual themes

Pick any textual theme to change the look, for example `tokyo-night`, see [Textual Themes](https://textual.textualize.io/guide/design/) to check out built in themes.

[Textual themes example](https://github.com/matmaer/chezmoi-mousse/wiki/Screenshots#textual-themes)

## Chezmoi or Git command not found

If the `chezmoi` or `git` command is not found by `shutil.which`, the app wil not start and only print a simple message to the terminal.

chezmoi-mousse

chezmoi-mousse 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

chezmoi-mousse

chezmoi-mousse 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README