{"id":24387440,"url":"https://github.com/idcrook/i-dotfiles","last_synced_at":"2025-10-15T22:21:40.289Z","repository":{"id":41491622,"uuid":"184151106","full_name":"idcrook/i-dotfiles","owner":"idcrook","description":"GNU stow managed dotfiles for macOS and Linux with BASH and zsh (zprezto) and .emacs.d and more","archived":false,"fork":false,"pushed_at":"2025-08-05T20:29:44.000Z","size":2094,"stargazers_count":30,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-05T22:22:28.068Z","etag":null,"topics":["bash","bashrc-configs","dotfiles","emacs","emacs-configuration","homebrew","linux","macos","prezto","zprezto","zsh","zshrc"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/idcrook.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2019-04-29T22:08:53.000Z","updated_at":"2025-08-05T20:29:48.000Z","dependencies_parsed_at":"2024-01-12T20:54:37.290Z","dependency_job_id":"639908dd-db7c-4e58-b8b7-863c68b4ba27","html_url":"https://github.com/idcrook/i-dotfiles","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/idcrook/i-dotfiles","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idcrook%2Fi-dotfiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idcrook%2Fi-dotfiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idcrook%2Fi-dotfiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idcrook%2Fi-dotfiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/idcrook","download_url":"https://codeload.github.com/idcrook/i-dotfiles/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idcrook%2Fi-dotfiles/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269673603,"owners_count":24457161,"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","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["bash","bashrc-configs","dotfiles","emacs","emacs-configuration","homebrew","linux","macos","prezto","zprezto","zsh","zshrc"],"created_at":"2025-01-19T12:54:38.009Z","updated_at":"2025-10-15T22:21:35.263Z","avatar_url":"https://github.com/idcrook.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"i-dotfiles\n==========\n\nAn opinionated dotfiles organization scheme based on `stow`.\n\n-\tSupports BASH (now legacy for me) and `zsh`.\n\n-\tSupports Linux: x86 or amd64 or armhf or arm64.\n\n-\tSupports macOS, both Intel and Apple Silicon.\n\n-\tIncludes configs for **emacs** [emacs.d](https://github.com/idcrook/.emacs.d) and **zsh** [zprezto](https://github.com/idcrook/prezto) (managed as `git submodule` repos).\n\n-\tIncludes platform detection\n\n![platform detection in multiple platforms](%40macos/platform_recognition_zsh.jpg)\n\nInstall\n-------\n\n### General Idea\n\nAssumes `git` and GNU `stow` are available/already installed (usually via a package manager). Refer to specific \"Starting point\" `README.md` files below for specific details.\n\nIn general, it will go as follows:\n\n1.\tClone this repository:\n\n\t```shell\n\tgit clone --recurse-submodules \\\n\t  https://github.com/idcrook/i-dotfiles.git \\\n\t  ~/.dotfiles\n\tcd ~/.dotfiles\n\t```\n\n1.\tInstall config for `stow` itself\n\n\t```shell\n\tstow -t ~ stow\n\t```\n\n\t**IMPORTANT**: Confirm the hard-coded home directory path in `~/.stowrc` matches your system\n\n2.\tUse `stow` to install desired package(s) via `stow \u003cdirectory\u003e` \u003csup id=\"a1\"\u003e[1](#f1)\u003c/sup\u003e\n\n\t-\tAdditional installation instructions are present in respective platform and package `README.md`.\n\n### Starting Point\n\n-\t[macOS](%40macos/README-macos.md) (Both Intel and Apple Silicon)\n-\t[Linux](%40linux/README.md) variants including [Raspberry Pi OS](%40linux/README-RasPiOS.md) (based on Debian) and Ubuntu flavors [WSL2](%40linux/README-Ubuntu-WSL2-20.04.md) or [Ubuntu on Raspberry Pi](%40linux/README-Ubuntu-on-RasPi.md)\n\nRules\n-----\n\n### Sub-Directory Naming\n\n-\t*`lowercase`* - for packages to `stow` install in `$HOME` (the default)\n\n-\tleading `_` - for non-`stow`-able packages, e.g. [`_pip`](https://github.com/idcrook/i-dotfiles/blob/main/_pip) which describes python package installation\n\n-\t*`TitleCase`* - for packages which need `root` permissions, e.g. top-level of filesysyem at `/` [`@Apt`](https://github.com/idcrook/i-dotfiles/tree/main/%40linux/%40Apt)\n\n-\tleading `@` - for environment packages and subpackages, e.g. [`@macos`](https://github.com/idcrook/i-dotfiles/blob/main/%40macos/)\n\nHaving a convention for sub-package naming enables a [`.stow-global-ignore`](https://github.com/idcrook/i-dotfiles/blob/main/stow/.stow-global-ignore#L6) file such that sub-packages are not symlinked when stowing parent package.\n\n### Ignore files\n\nQuoting stow [documentation](https://www.gnu.org/software/stow/manual/html_node/Installing-Packages.html#Installing-Packages) :\n\n\u003e if Stow can create a single symlink that points to an entire subtree within the package tree, it will choose to do that rather than create a directory in the target tree and populate it with symlinks.\n\nBecause of this, using `.gitignore` in packages (which do not themselves get stow-ed, due to `stow-global-ignore`) can help avoid this `i-dotfiles` git repository getting cluttered with unknown files. For example, this happens when language package managers add files to certain directories.\n\n### Secrets files\n\nSecrets files, i.e., files that should not be committed to git repository, must have `*.secrets*` or `*/secrets/*` in their filepath to be ignored by the root `.gitignore` file.\n\nEach *secrets* file should be accompanied by an `*.example*` file that is, itself, instead commited to repository, to illustrate its contents by example.\n\nKeep your secrets files as short as possible to limit their influence as it complicates deployments (as they will not be available in `i-dotfiles` git repository).\n\nSee [example](https://github.com/idcrook/i-dotfiles/blob/main/git/.config/git/config.secrets.example).\n\nBackground\n----------\n\nI used to manage my macOS/Linux/WSL *dotfiles* in an \"`homedir.git`\" repository that was directly overlayed. This left things to be desired, and syncing multiple platforms sometimes presented unresolvable conflicts. Now, I use GNU Stow and this repository instead.\n\n`i-dotfiles` is an opinionated dotfiles organization scheme based on stow. Its priorities are ease-of-maintenance and deployment on both Linux and macOS. It was created originally as an implementation of [F-dotfiles](https://github.com/Kraymer/F-dotfiles), borrowing its philosophy as follows:\n\n-\t**`stow` powered:** symlink dotfiles and thus keep them always up-to-date in git repository\n-\t**topical organization:** organize dotfiles by application\n-\t**naming schemas:** the repository architecture is easy to browse while staying compatible with `stow` symlinking mechanism\n-\t**documentation:** each \"package\" directory has a *`README.md`* which presents its purpose. Install notes and requirements can be included. A separate *`TODO.md`* may be enlisted to track things still to be implemented.\n\nInspired heavily by:\n\n-\thttps://github.com/Kraymer/F-dotfiles\n-\thttps://github.com/andschwa/dotfiles\n-\thttp://dotfiles.github.io\n\n---\n\n\u003ci id=\"f1\"\u003e1\u003c/i\u003e it's because we installed `stow` package at step 2 that the flag `-t ~` can be omitted here, see [.stowrc](https://github.com/idcrook/i-dotfiles/blob/main/stow/.stowrc) [⤸](#a1)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidcrook%2Fi-dotfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fidcrook%2Fi-dotfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidcrook%2Fi-dotfiles/lists"}