{"id":28076802,"url":"https://github.com/jaredhanson/dotfiles","last_synced_at":"2025-05-13T01:52:15.379Z","repository":{"id":66002038,"uuid":"2094081","full_name":"jaredhanson/dotfiles","owner":"jaredhanson","description":"User-specific application configuration.","archived":false,"fork":false,"pushed_at":"2024-08-21T00:15:52.000Z","size":141,"stargazers_count":9,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-22T00:38:44.438Z","etag":null,"topics":[],"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/jaredhanson.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}},"created_at":"2011-07-23T18:34:20.000Z","updated_at":"2024-08-22T00:38:44.439Z","dependencies_parsed_at":"2023-04-15T20:17:13.585Z","dependency_job_id":"a718c991-5812-4cf2-ab27-39de27999cd5","html_url":"https://github.com/jaredhanson/dotfiles","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredhanson%2Fdotfiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredhanson%2Fdotfiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredhanson%2Fdotfiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredhanson%2Fdotfiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaredhanson","download_url":"https://codeload.github.com/jaredhanson/dotfiles/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253856619,"owners_count":21974576,"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":[],"created_at":"2025-05-13T01:52:14.814Z","updated_at":"2025-05-13T01:52:15.374Z","avatar_url":"https://github.com/jaredhanson.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dotfiles\n\n[Jared Hanson](https://www.jaredhanson.me/)'s user-specific application configuration.\n\n[dotfiles](https://en.wikipedia.org/wiki/Hidden_file_and_hidden_directory#Unix_and_Unix-like_environments)\nare configuration files that, by convention, start with a `.` character.\nApplications in UNIX-like operating systems (such as Linux and Mac OS X) load\nconfiguration from dotfiles.  This configuration is particularly applicable\nto software development tools.\n\nThis repository contains my personal dotfiles, configuring the tools I use in\nmy development environment.  In the spirit of [open collaboration](https://en.wikipedia.org/wiki/Open_collaboration),\nthey are shared with the [community](https://dotfiles.github.io/).  The\nrepository also serves as an effective mechanism for synchronizing settings\nacross machines.\n\nEach tool I use (and for which configuration is managed by this repository) has\na directory.  Within that directory is a `README` file that describes the\npurpose of the tool, how to install it, and tips on usage.  Because some of\nthese tools are used on an infrequent basis, the `README` serves as a refresher\nwhen using the tool in the future.  Configuration files for the tool, if any,\nare also located within the directory.\n\n## Usage\n\n[Stow](https://www.gnu.org/software/stow/) is used to manage configuration files\nin the home directory.\n\n### Initialize\n\nClone the repository to a subdirectory of `$HOME`.\n\n```sh\ngit clone git@github.com:jaredhanson/dotfiles.git $HOME/.dotfiles\n```\n\n`$HOME/.dotfiles` is the _stow directory_.  Subsequent `stow` commands must\nbe executed with the current directory set to the stow directory.\n\n```sh\ncd $HOME/.dotfiles\n```\n\n### Configure\n\nTo install the configuration files for a package (`git` in this example):\n\n```\nstow git\n```\n\nThis command will create a symbolic link from `$HOME/.gitconfig` to\n`$HOME/.dotfiles/git/.gitconfig`, as well as any other configuration files for\nthe package.\n\n### Unconfigure\n\nTo uninstall the configuration files for a package (`git` in this example):\n\n```sh\nstow -D git\n```\n\n## Set Up\n\n### Generate SSH Key\n\nAs a best practice, each machine should have its own SSH key.  This improves\nsecurity by allowing access to be managed and audited on a per-device basis.\nIn the event a device is lost or compromised, its access can be revoked without\nimpacting other devices.\n\nTo [generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key):\n\n```sh\nssh-keygen -t ed25519 -C \"jaredhanson@macbook-pro-2021.local\"\n```\n\n\u003e [!TIP]\n\u003e I like to use `user@host` format for the comment, where `host` is the device\n\u003e name.\n\n### Add SSH Key to GitHub account\n\nOnce the machine's SSH key has been generated, [add it to your GitHub account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account#adding-a-new-ssh-key-to-your-account).\n\nYou can now [clone this repository](https://github.com/jaredhanson/dotfiles?tab=readme-ov-file#initialization),\nand synchronize configuration across machines by pushing and pulling from the\nremote repository.\n\n### Prepare Operating System\n\nTo the extent possible, system-provided programs are used to install packages\nand manage configuration.  This minimizes the number of dependencies needed to\nset up a new machine.  In cases where these prerequisites are not provided, the\nfollowing instructions are used to prepare the operating system.\n\n#### macOS\n\n[macOS](https://www.apple.com/macos/) does not have a package manager, so\n[Homebrew](https://brew.sh/) is used as an alternative.\n\n##### Install Homebrew\n\nTo install Homebrew:\n\n```sh\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)\"\n```\n\n##### Install Stow\n\nTo install Stow:\n\n```sh\nbrew install stow\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredhanson%2Fdotfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaredhanson%2Fdotfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredhanson%2Fdotfiles/lists"}