{"id":38333128,"url":"https://github.com/relnod/dotm","last_synced_at":"2026-01-17T02:54:05.527Z","repository":{"id":55395983,"uuid":"149147721","full_name":"relnod/dotm","owner":"relnod","description":"Dotfile Manager","archived":false,"fork":false,"pushed_at":"2021-01-03T09:18:33.000Z","size":1221,"stargazers_count":9,"open_issues_count":6,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-06-19T18:08:37.265Z","etag":null,"topics":["cli","dotfile-manager","golang"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/relnod.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-17T15:35:16.000Z","updated_at":"2023-04-20T18:29:25.000Z","dependencies_parsed_at":"2022-08-14T23:20:33.908Z","dependency_job_id":null,"html_url":"https://github.com/relnod/dotm","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/relnod/dotm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relnod%2Fdotm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relnod%2Fdotm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relnod%2Fdotm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relnod%2Fdotm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/relnod","download_url":"https://codeload.github.com/relnod/dotm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relnod%2Fdotm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28492590,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T02:39:23.645Z","status":"ssl_error","status_checked_at":"2026-01-17T02:34:19.649Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","dotfile-manager","golang"],"created_at":"2026-01-17T02:54:04.825Z","updated_at":"2026-01-17T02:54:05.521Z","avatar_url":"https://github.com/relnod.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dotm - Dotfile Manager\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/relnod/dotm.svg)](https://pkg.go.dev/github.com/relnod/dotm)\n![Test](https://github.com/relnod/dotm/workflows/Test/badge.svg)\n\ndotm is a dotfile manager. It works by symlinking the dotfiles from multiple\nprofiles to the `$HOME` directory. It expects the dotfile profile to be under\nsource controll by git. This makes it easy to share dotfiles.\n\n## Installation\n\n### Using installer\n\nThe `install.sh` script will automatically install the latest binary from the\ngithub release artifacts.\n\n```shell\n$ sh \u003c(curl -s https://raw.githubusercontent.com/relnod/dotm/master/install.sh)\n```\n\nBy adding the `--user` flag the install directory will be `$HOME/.local/bin`\ninstead of `/usr/local/bin`.\n\n### Using Go\n\nIf you have a working go environment, you can simply install it via `go get`.\n\n```shell\n$ go get github.com/relnod/dotm/cmd/dotm\n```\n\n#### Completion\n\n```shell\n# Bash completions can be generated with the following command\n$ dotm --genCompletions \u003e /etc/bash_completion.d/dotm\n\n# A cd helper can be generated with the following command\n$ dotm --genChangeDirectory \u003e\u003e ~/.bashrc\n\n$ dcd myprofile\n```\n\n## Usage\n\n`dotm` works by symlinking the files from a dotfile folder to its\ncorresponding place under the `$HOME` directory of the user.\n\n```shell\n$ dotm\nUsage:\n  dotm [flags]\n  dotm [command]\n\nAvailable Commands:\n  add         Add a new/existing file to the profile\n  config      Sets/Gets values from the configuration file.\n  fix         Tries to fix the configuration file\n  help        Help about any command\n  init        Initialize a new dotfile profile from the given path.\n  install     Install dotfiles from a remote git repository\n  list        Lists all profiles\n  new         Create a new dotfile profile\n  uninstall   Uninstall the profile\n  update      Updates the symlinks for a given profile.\n\nFlags:\n      --genChangeDirectory   generate bash change directory command\n      --genCompletions       generate bash completions\n  -h, --help                 help for dotm\n      --version              version for dotm\n\nUse \"dotm [command] --help\" for more information about a command.\n```\n\n**Examples**:\n\n```shell\n# New (empty) dotfile profile\n$ dotm new myprofile\n\n# New profile from an existing dotfile folder\n$ dotm init \u003cpath-to-existing-dotfile-folder\u003e\n$ dotm init --profile=myprofile \u003cpath-to-existing-dotfile-folder\u003e\n\n# New profile from a remote git repository\n$ dotm install \u003curl-to-remote-repository\u003e\n$ dotm install --profile=myprofile \u003curl-to-remote-repository\u003e\n\n# Updating a profile\n$ dotm update myprofile\n$ dotm update myprofile --fromRemote\n$ dotm update myprofile --no-hooks\n\n# Get/Set a configuration value\n$ dotm config ignore_prefix \"_\"\n$ dotm config profile.default.path\n$ dotm config profile.default.path \"/my/path\"\n```\n\n### Configuration file\n\nThe configuration file is located at `$HOME/.config/dotm/config.toml`. It can\nhold multiple profiles. Each profile consists of a path to the local dotfile\nlocation and an optional path to a remote git repository. It is also possible to\nspecify top level directories, that get included/excluded or add pre/post update\nhooks.\n\n**Example**:\n\n```toml\n# $HOME/.config/dotm/config.toml\n\n# You can define multiple profiles\n[profiles.default]\n\n# Upstream git repository\nremote = \"github.com/relnod/dotm\"\n\n# Path to the local dotfile folder\npath = \"$HOME/.config/dotm/profiles/default\"\n\n# Configs to be included\nincludes = [\n    \"bash\",\n    \"nvim\",\n    \"tmux\"\n]\n\n# Configs to be excluded\nexcludes = [\n    \"bash\",\n    \"nvim\",\n    \"tmux\"\n]\n\n# Pre update hooks\npre_update = [\n    \"echo 'pre update'\"\n]\n\n# Post update hooks\npost_update = [\n    \"echo 'post update'\"\n]\n\n# Map of variables used for template processing\n[profiles.default.vars]\nfoo = \"bar\"\nbar = \"foo\"\n```\n\n### Dotfiles folder\n\nA Dotfile folder consists of multiple top level directories to group similar\nconfiguration files (e.g. \"vim\" or \"tmux\"). The file structure below those top\nlevel directories are directly mapped to the `$HOME` directory.\n\n**Example**:\n\n```\ntmux/.tmux.conf             -\u003e $HOME/.tmux.conf\nbash/.bashrc                -\u003e $HOME/.bashrc\nnvim/.config/nvim/init.vim  -\u003e $HOME/.config/nvim/init.vim\n```\n\n### Template files\n\nTemplate files can be used to dynamically add user identifying information inside\nconfiguration files. All files with a `.tpl` file ending are treated as template\nfiles. Templates support the syntax from the go\n[text/template](https://golang.org/pkg/text/template/) package. Variables\ncan be configured per profile. When a template gets processed, a temporary file\nwith the same name plus a `.out` ending gets generated. This file will be\nsymlinked to the destination file without the `.tpl` suffix. Make sure to add\n`*.tpl.out` to your `.gitignore` when using templates to prevent adding those\nto git.\n\n**Example**:\n\n```text\n# $HOME/.config/dotm/profiles/myprofile/git/.gitconfig.tpl\n\n[user]\n    name = {{ .GitUser }}\n    email = {{ .GitEmail }}\n```\n\n### Hooks\n\nUpdate hooks can be applied via global config, at profile root or per top level\ndirectory. For hooks at profile root and top level directory you can create a\nhooks.toml. Note: This file won't be symlinked.\n\n**Example**:\n\n```toml\n# $HOME/.config/dotm/profiles/myprofile/nvim/hooks.toml\npre_update = [\n    \"nvim +PlugInstall +qall\"\n]\n```\n\n## Breaking Changes\n\nAlthough dotm is considered somewhat stable, some breaking changes are expected\nuntil a 1.0 release. When a breaking change is introduced try to run the fix\ncommand. This tries to restore the original behaviour by modifying the\nconfiguration file.\n\n```shell\n# Restore old behaviour by modifying the configuration file\n$ dotm fix\n```\n\n## Development\n\nThere is a Makefile at the repository root to help with development. Start by\nrunning `make` to execute tests and check for lint failures.\n\nTests are mostly wrtten using the [go internal testscript](https://github.com/rogpeppe/go-internal/tree/master/testscript)\npackage. The testscripts are located at `cmd/dotm/testdata`. For more\ninformation on how to use `testscript` see this [README](https://github.com/golang/go/blob/master/src/cmd/go/testdata/script/README)\nlocated in the go repository.\n\n## License\n\ndotm is licensed under the MIT License. See the [LICENSE](./LICENSE) details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelnod%2Fdotm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frelnod%2Fdotm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelnod%2Fdotm/lists"}