{"id":18960257,"url":"https://github.com/gikeymarcia/mydot","last_synced_at":"2025-04-12T17:42:17.151Z","repository":{"id":57444353,"uuid":"385865432","full_name":"gikeymarcia/mydot","owner":"gikeymarcia","description":"Super-charged version of the Atlassian approach to managing dotfiles using a bare git repo + fzf magic! Quickly edit files, add changes, run scripts, grep through dotfiles, or discard work-tree changes with ease.","archived":false,"fork":false,"pushed_at":"2023-09-07T03:52:58.000Z","size":125,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T12:03:18.532Z","etag":null,"topics":["dotfiles","git","linux","python"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/mydot/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gikeymarcia.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-14T08:18:33.000Z","updated_at":"2023-10-31T03:56:29.000Z","dependencies_parsed_at":"2025-02-21T04:41:38.168Z","dependency_job_id":"bbbe06b3-5cce-4f84-b48b-ca52be0ad483","html_url":"https://github.com/gikeymarcia/mydot","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gikeymarcia%2Fmydot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gikeymarcia%2Fmydot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gikeymarcia%2Fmydot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gikeymarcia%2Fmydot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gikeymarcia","download_url":"https://codeload.github.com/gikeymarcia/mydot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248373267,"owners_count":21093151,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["dotfiles","git","linux","python"],"created_at":"2024-11-08T14:05:02.272Z","updated_at":"2025-04-12T17:42:17.130Z","avatar_url":"https://github.com/gikeymarcia.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mydot -- A Python module for managing dotfiles\n\nSuper-charged version of the [Atlassian][atlassian] approach to managing\ndotfiles using a bare git repo + [`fzf`][fzf] magic! Quickly edit files, add\nchanges, run scripts, grep through dotfiles, or discard work-tree changes with\nease.\n\n## Quick Start\n\n1. **Install dependencies:**\n\n    ```bash\n    sudo apt install fzf git    # Ubuntu/Debian\n    brew install fzf git        # MacOS/Homebrew\n    ```\n1. **Configure shell:** At the bottom of your `~/.bashrc` or `~/.zshhrc` add:\n\n    ```bash\n    export DOTFILES=\"$HOME/.config/dotfiles\"\n    alias config='/usr/bin/git --git-dir=$DOTFILES --work-tree=$HOME'\n    ```\n\n    _what and why?_:\n\n    - `DOTFILES`: variable pointing to your local `--bare` dotfiles repository\n    - `config`: git alias to directly address the `--bare` dotfiles repository\n\n2. **Initialize dotfiles repository:**\n\n    ```bash\n    # reload shell configu\n    source ~/.bashrc            # if using bash\n    source ~/.zshrcc            # if using zsh\n\n    mkdir -pv $DOTFILES         # create directory\n    git init --bare $DOTFILES   # initialize --bare git repository\n    ```\n\n3. **Install** `mydot` and disable viewing of untracked files\n\n    ```bash\n    pip install --user mydot    # if using pip\n    pipx install mydot          # if using pipx\n    mydot git config --local status.showUntrackedFiles no\n    ```\n\n3. **Add files** to your dotfiles repo\n\n    ```bash\n    mydot git add ~/.vimrc ~/.tmux.conf ~/.bashrc ~/.bash_aliases ~/.zshrc\n    mydot git commit -m \"the journey of a thousand miles begins with one step\"\n    ```\n\n    _protip:_ You can use all your regular git commands, including aliases, when\n    calling `mydot git`\n\n4. **Feel the power** with `mydot` (and the pre-installed alias `d.`)\n\n    ```bash\n    d. -e           # modify tracked files in your $EDITOR (tab in fzf for multiselect)\n    d. -a           # choose which modified files to stage for commit\n    d. git commit   # commit changes\n\n    d. -g \"EDITOR\"  # find all files with lines containing the string EDITOR\n                    # works with regex too! e.g, EDITOR$ something.*var ^$\n\n    d. -r           # run any executable script in your dotfiles repo\n    d. -s           # see the state of your repo\n    d. -l           # list all files under version control\n\n    d. --export     # make a tarball of your dotfiles + bare git repo\n    d. --clip       # put file paths into the clipboard\n\n    d. --restore    # remove files from staging area\n    d. --discard    # discard unstaged changes from work tree\n\n    d.              # see the help message detailing available commands\n    ```\n\n## Going Deeper\n\n### Useful aliases\n\n```bash\nalias es=\"mydot --edit\"     # quick select a file to edit\nalias rs=\"mydot --run\"      # quick select a script to run\n```\n\nIf you ever run into an issue where the `mydot` CLI is reading flags meant for \n`mydot git` you can fallback to the `config` alias from step 1 which acts as a \nspecial git command that only applies for the dotfiles repo.\n\nFor example `mydot git rm -r ~/.tmux` would see the `-r` flag and try to run an\nexecutable in your dotfiles. Instead use `config rm -r ~/.tmux` and the files\nin the directory will be removed recursively.\n\n### Source of Truth\n\nThis project is available on [GitHub][github] and [GitLab][gitlab]. Each push\nto `master` automatically goes to both so choose whichever platform you prefer.\nAll releases are published to [PyPi][pypi]\n\n[github]: \u003chttps://github.com/gikeymarcia/mydot\u003e\n\"Follow and Contribute on GitHub\"\n[gitlab]: \u003chttps://gitlab.com/gikeymarcia/mydot\u003e\n\"Follow and Contribute on GitLab\"\n[pypi]: \u003chttps://pypi.org/project/mydot/\u003e\n\"mydot project homepage on PyPi.org\"\n[atlassian]: \u003chttps://www.atlassian.com/git/tutorials/dotfiles\u003e\n\"The best way to store your dotfiles: A bare Git repository\"\n[fzf]: \u003chttps://github.com/junegunn/fzf\u003e\n\"A command-line fuzzy finder\"\n[template]: \u003chttps://github.com/gikeymarcia/super-python-project-template\u003e\n\"Super Python Project Template @ GitHub\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgikeymarcia%2Fmydot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgikeymarcia%2Fmydot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgikeymarcia%2Fmydot/lists"}